pinepain/php-object-maps

ObjectMap structures for PHP

I'm moving away from PHP world and all my PHP projects going to be abandoned too. Abandoning this project too as I have no intent to continue working on it unless there would be strong request from community and commercial interest. No more updates or documentation will be made. If someone is interested, feels free to contact me using email specified in my GitHub profile., _(*1)

Weak-referenced data structures for PHP based on Ref php extension

, _(*2)

PLEASE READ:

Maintaining this project takes significant amount of time and efforts. If you like my work and want to show your appreciation, please consider supporting me at https://www.patreon.com/pinepain., _(*3)

Requirements

• PHP >= 7.2
• (optional, required only for maps weak behavior) php-ref extension

Installation:

composer require pinepain/php-object-maps

Docs:

This library offers two main classes: ObjectMap and ObjectBiMap. They are what their name is - classic object maps which map object keys to object values., _(*4)

The key difference between ObjectMap and ObjectBiMap is that ObjectBiMap require all values to be unique and it offers you to get mirrored ObjectBiMap map with keys and values from source map flipped. Note, that flipped map will still maintain connection to the original one and thus any modification to any ObjectBiMap in a chain will be reflected on all chain., _(*5)

Maps behavior

Both ObjectMap and ObjectBiMap offers weak variations (php-ref extension required) which could be specified by passing one of ObjectMapInterface::{WEAK_KEY,WEAK_VALUE,WEAK_KEY_VALUE} constants to the constructor. By default no weakness enabled. Note, that when weak behavior enable on key or/and value, their refcount won't be incremented by map internals and thus it is possible that they will be destructed without a need be purged from map., _(*6)

WEAK_KEY means that key-value pair will be removed as long as key will be destructed. WEAK_VALUE is the same for value and WEAK_KEY_VALUE will trigger removal when key or value will be destructed., _(*7)

For more details see tests., _(*8)

License

php-object-maps PHP library is licensed under the MIT license., _(*9)