Trait \Prado\Collections\TWeakCollectionTrait

TWeakCollectionTrait trait

This is the common WeakMap caching implementation for Weak Collections. It constructs a WeakMap, where available, and tracks the number of times an object is \Prado\Collections\weakAdd to and \Prado\Collections\weakRemove from the Collection.

When the PHP environment invalidates a WeakReference, it is no longer linked in the WeakMap. The number of known objects is tracked and upon deviations in the WeakMap count then weakChanged becomes true. When weakChanged is true the implementing class can scrub the list of invalidated WeakReference.

There are utility functions for managing the WeakMap to \Prado\Collections\weakStart, \Prado\Collections\weakRestart, \Prado\Collections\weakClone, and \Prado\Collections\weakStop the WeakMap. The total number of objects in the WeakMap can be retrieved with weakCount and the count of each object with weakObjectCount.

Trait hierarchy

\Prado\Collections\TWeakCollectionTrait

Author: Brad Anderson <belisoful@icloud.com>
Since: 4.3.0

Methods summary
`protected`	`_weakZappableSleepProps(array<string\|int, mixed> &$exprops) : void`
`protected`	`weakAdd(object $object) : int` Adds or updates an object to track with the WeakMap.
`protected`	`weakChanged() : bool` Checks if the WeakMap has changed.
`protected`	`weakClone() : void` Stops the WeakMap cache.
`protected`	`weakCount() : int\|null`
`protected`	`weakObjectCount(object $object) : int\|null`
`protected`	`weakRemove(object $object) : int` Removes or updates an object from WeakMap tracking.
`protected`	`weakResetCount() : void` Resets the new number of known objects in the list to the current WeakMap count.
`protected`	`weakRestart() : void` Restarts the WeakMap cache if it exists.
`protected`	`weakStart() : void` Initializes a new WeakMap
`protected`	`weakStop() : void` Stops the WeakMap cache.

Inherited methods