 |
VOOZH | about |
|
VOOZH | about |
The HasPoolProxy trait provides a standardized way for host classes to manage multiple pool proxies with per-driver configuration and cleanup logic. This trait is designed to be used by classes that need to maintain multiple pooled resource connections (e.g., different database drivers, cache backends, or custom services).
For information about the PoolProxy class itself and how method interception works, see Pool Proxy. For information about creating and registering pools, see Pool Manager.
Sources: src/Traits/HasPoolProxy.php1-104
The HasPoolProxy trait enables a single host class to manage multiple object pools transparently through proxy objects. It provides a declarative approach to pool management by maintaining:
PoolProxy instancesThis trait is particularly useful for manager classes that need to support multiple backends (e.g., a cache manager supporting Redis, Memcached, and file-based caching).
Sources: src/Traits/HasPoolProxy.php1-104 src/PoolProxy.php1-67
Sources: src/Traits/HasPoolProxy.php11-104 src/PoolProxy.php12-66
The createPoolProxy() method serves as a factory for creating PoolProxy instances with appropriate configuration:
Key Implementation Details:
| Aspect | Implementation | Location |
|---|---|---|
| Pool Name Generation | static::class . ':' . $driver | src/Traits/HasPoolProxy.php35 |
| Proxy Class Flexibility | Supports custom proxy classes via poolProxyClass property | src/Traits/HasPoolProxy.php25-27 |
| Validation | Ensures proxy class extends PoolProxy::class | src/Traits/HasPoolProxy.php30-32 |
| Release Callback Integration | Automatically retrieves and passes driver-specific callback | src/Traits/HasPoolProxy.php38 |
Sources: src/Traits/HasPoolProxy.php19-40
Release callbacks enable driver-specific cleanup logic before objects return to the pool. This is essential for resetting connection state, clearing buffers, or performing other cleanup operations.
Methods:
| Method | Purpose | Return Type | Fluent |
|---|---|---|---|
setReleaseCallback(string $driver, Closure $callback) | Register cleanup callback for driver | static | Yes |
getReleaseCallback(string $driver) | Retrieve callback for driver | ?Closure | No |
Sources: src/Traits/HasPoolProxy.php42-58 src/PoolProxy.php60-62
The trait provides methods to manage a poolables array property, which typically declares which drivers should use object pooling. This allows selective pooling configuration.
Methods:
| Method | Behavior | Location |
|---|---|---|
addPoolable(string $driver) | Adds driver to poolables if not present; prevents duplicates | src/Traits/HasPoolProxy.php63-70 |
removePoolable(string $driver) | Removes driver from poolables; no-op if not found | src/Traits/HasPoolProxy.php74-85 |
getPoolables() | Returns the current poolables array | src/Traits/HasPoolProxy.php89-93 |
setPoolables(array $poolables) | Replaces the entire poolables array | src/Traits/HasPoolProxy.php97-103 |
Sources: src/Traits/HasPoolProxy.php60-104
The host class using this trait must define certain properties:
| Property | Required | Purpose | Default |
|---|---|---|---|
poolables | Yes | Array of driver names that should use pooling | N/A |
poolProxyClass | No | Custom PoolProxy subclass for specialized behavior | PoolProxy::class |
Sources: src/Traits/HasPoolProxy.php25-27 src/Traits/HasPoolProxy.php65 src/Traits/HasPoolProxy.php92
Sources: src/Traits/HasPoolProxy.php21-40
Signature:
Parameters:
| Parameter | Type | Description |
|---|---|---|
$driver | string | Driver identifier (e.g., "mysql", "redis") |
$resolver | Closure | Factory function to create new pooled objects |
$config | array | Pool configuration (see Pool Configuration) |
$proxyClass | ?string | Optional custom proxy class (must extend PoolProxy) |
Returns: An instance of PoolProxy (or custom subclass)
Throws: InvalidArgumentException if $proxyClass does not extend PoolProxy::class
Pool Naming Convention: Pools are named as {HostClassName}:{driver} to ensure uniqueness across different host classes using the same driver identifier.
Sources: src/Traits/HasPoolProxy.php19-40
Signature:
Purpose: Registers a cleanup callback that will be executed after a method call completes but before the object is returned to the pool.
Fluent Interface: Returns $this for method chaining.
Sources: src/Traits/HasPoolProxy.php44-50
Signature:
Returns: The registered callback for the driver, or null if none is registered.
Sources: src/Traits/HasPoolProxy.php54-58
Signature:
Purpose: Adds a driver to the poolables list if not already present. Uses in_array() check to prevent duplicates.
Fluent Interface: Returns $this for method chaining.
Sources: src/Traits/HasPoolProxy.php63-70
Signature:
Purpose: Removes a driver from the poolables list. If the driver is not in the list, this is a no-op.
Fluent Interface: Returns $this for method chaining.
Sources: src/Traits/HasPoolProxy.php74-85
Signature:
Returns: The current array of poolable driver names.
Sources: src/Traits/HasPoolProxy.php89-93
Signature:
Purpose: Replaces the entire poolables array with a new set of driver names.
Fluent Interface: Returns $this for method chaining.
Sources: src/Traits/HasPoolProxy.php97-103
The trait generates pool names using the pattern static::class . ':' . $driver. This ensures that:
Example:
App\Database\ConnectionManager:mysqlApp\Database\ConnectionManager:postgresApp\Cache\CacheManager:redisSources: src/Traits/HasPoolProxy.php35
The trait supports custom proxy classes by checking for a poolProxyClass property on the host class. This allows specialized behavior while maintaining the trait's convenience:
Sources: src/Traits/HasPoolProxy.php23-32
Release callbacks integrate seamlessly with the PoolProxy.__call() mechanism:
Sources: src/PoolProxy.php53-65 src/Traits/HasPoolProxy.php38
Refresh this wiki