Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ryangjchandler/proxy
Proxy method and property interactions in PHP. ⚡️
https://github.com/ryangjchandler/proxy
Last synced: 3 months ago
JSON representation
Proxy method and property interactions in PHP. ⚡️
- Host: GitHub
- URL: https://github.com/ryangjchandler/proxy
- Owner: ryangjchandler
- License: mit
- Created: 2021-09-06T17:26:58.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-09-07T08:53:34.000Z (over 3 years ago)
- Last Synced: 2024-06-06T07:11:20.024Z (7 months ago)
- Language: PHP
- Size: 26.4 KB
- Stars: 7
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# Proxy method and property interactions in PHP.
[](https://packagist.org/packages/ryangjchandler/proxy)
[](https://github.com/ryangjchandler/proxy/actions?query=workflow%3Arun-tests+branch%3Amain)
[](https://github.com/ryangjchandler/proxy/actions?query=workflow%3A"Check+%26+fix+styling"+branch%3Amain)
[](https://packagist.org/packages/ryangjchandler/proxy)
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](https://github.com/sponsors/ryangjchandler).
## Installation
You can install the package via Composer:
```bash
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:
```php
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.
```php
$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.
```php
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
```bash
composer test
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.
## Security Vulnerabilities
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
## Credits
- [Ryan Chandler](https://github.com/ryangjchandler)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.