Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Ocramius/LazyMap
:rainbow: A lazy-initializing high performance service map
https://github.com/Ocramius/LazyMap
Last synced: about 2 months ago
JSON representation
:rainbow: A lazy-initializing high performance service map
- Host: GitHub
- URL: https://github.com/Ocramius/LazyMap
- Owner: Ocramius
- License: mit
- Archived: true
- Created: 2013-11-05T02:25:57.000Z (almost 11 years ago)
- Default Branch: 2.9.x
- Last Pushed: 2023-09-19T12:10:40.000Z (about 1 year ago)
- Last Synced: 2024-07-27T21:48:08.151Z (about 2 months ago)
- Language: PHP
- Homepage:
- Size: 928 KB
- Stars: 87
- Watchers: 4
- Forks: 2
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Lazy Map
This small library aims at providing a very simple and efficient map of lazy-instantiating objects.
[](https://packagist.org/packages/ocramius/lazy-map)
[](https://packagist.org/packages/ocramius/lazy-map)
[](https://packagist.org/packages/ocramius/lazy-map)
[](https://dashboard.stryker-mutator.io/reports/github.com/Ocramius/LazyMap/2.5.x)
## Abandoned
Starting with PHP 8.3, dynamic properties are [no longer allowed "out of the box"](https://wiki.php.net/rfc/deprecate_dynamic_properties).
While it is still possible to have dynamic properties via explicit declaration (the `#[\AllowDynamicProperties]` attribute), the approach
of this package is no longer to be considered safe nor efficient long-term.
Based on that, this package is deprecated and abandoned: please use traditional PHP `array`s instead.
## Installation
The suggested installation method is via [composer](https://getcomposer.org/):
```sh
composer require ocramius/lazy-map
```
## Usage
The current implementation is very simple and allows to define a map of "services" through a
`LazyMap\CallbackLazyMap`:
```php
$map = new \LazyMap\CallbackLazyMap(function ($name) {
$object = new \stdClass();
$object->name = $name;
return $object;
});
var_dump($map->foo);
var_dump($map->bar);
var_dump($map->{'something special'});
```
## Purpose
The idea behind the library is to avoid un-efficient lazy-loading operations like following:
```php
private function getSomething($name)
{
if (isset($this->initialized[$name]) || array_key_exists($name, $this->initialized)) {
return $this->initialized[$name];
}
return $this->initialized[$name] = new Something($name);
}
```
This reduces overhead greatly when you'd otherwise call `getSomething()` thousands of times.
That's especially useful when mapping a lot of different services and iterating over them
over and over again.
## Performance
LazyMap actually performs much better than the "un-efficient" example that I've shown above.
You can look directly at the performance test suite for details on the tested implementations,
but here are some results for you to have an idea of the boost:
#### Initialized Map Performance:
|Method Name |Ops/s |Relative|
|--------------------------------|---------------|--------|
|initializedArrayPerformance |2,277,272.90002|100.00% |
|initializedArrayMapPerformance |1,536,988.76108|148.16% |
|initializedLazyMapPerformance |4,446,227.23514|51.22% |
#### Un-Initialized Map Performance:
|Method Name |Ops/s |Relative|
|--------------------------------|---------------|--------|
|unInitializedArrayPerformance : |1,091,720.80627|100.00% |
|unInitializedArrayMapPerformance|688,132.30083 |158.65% |
|unInitializedLazyMapPerformance:|912,191.90744 |119.68% |