Proxy method and property interactions in PHP.
Provides a Proxy class that can be used to intercept method calls, property access and updates.
Support development
If you would like to support the on going maintenance and development of this package, please consider sponsoring me on GitHub.
Installation
You can install the package via Composer:
composer require ryangjchandler/proxy
Usage
This package provides a Proxy class that you can use to wrap any object. It allows you to intercept property access and assignments, as well as method calls.
Here's an example:
class Target
{
public $firstName = 'Ryan';
public $lastName = 'Chandler';
}
$proxy = new Proxy(new Target, [
'get' => function (Target $target, string $property) {
if ($property === 'fullName') {
return $target->firstName . ' ' . $target->lastName;
}
return $target->{$property};
},
]);
$proxy->fullName; // 'Ryan Chandler'
If you would like to handle "setting" a property's value, you can add a set key and callback function to the handlers array.
$proxy = new Proxy(new Target, [
'set' => function (Target $target, string $property, mixed $value) {
if ($property === 'fullName') {
$parts = explode(' ', $value);
$target->firstName = $parts[0];
$target->lastName = $parts[1];
} else {
$target->{$property} = $value;
}
},
]);
To intercept method calls, add a call key to the array.
class Target
{
public int $number = 10;
}
$proxy = new Proxy(new Target, [
'call' => function (Target $target, string $method, array $arguments) {
if ($method === 'toInt') {
return $target->number;
}
return $target->{$method}(...$arguments);
},
]);
$proxy->toInt(); // 10
Testing
composer test
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security Vulnerabilities
Please review our security policy on how to report security vulnerabilities.
Credits
License
The MIT License (MIT). Please see License File for more information.
61 Dec 3, 2022
5 Sep 16, 2022
72 Dec 23, 2022
3 Aug 26, 2022
153 Dec 21, 2022
63 Dec 31, 2022
5 Aug 19, 2022
2 Nov 3, 2022
13 Nov 28, 2022
15 Nov 17, 2022
649 Dec 26, 2022
1 Nov 15, 2021
1.9k Dec 26, 2022
12 Nov 17, 2022
3.5k Dec 31, 2022
3.1k Jan 5, 2023
846 Dec 6, 2022
4 Jul 28, 2021