https://github.com/spatie/invade
A PHP function to work with private properties and methods
https://github.com/spatie/invade
consenting-adults php
Last synced: 9 months ago
JSON representation
A PHP function to work with private properties and methods
- Host: GitHub
- URL: https://github.com/spatie/invade
- Owner: spatie
- License: mit
- Created: 2022-02-11T14:47:16.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2025-05-12T05:32:56.000Z (9 months ago)
- Last Synced: 2025-05-12T06:33:47.748Z (9 months ago)
- Topics: consenting-adults, php
- Language: PHP
- Homepage: https://spatie.be/open-source
- Size: 527 KB
- Stars: 320
- Watchers: 4
- Forks: 17
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# A PHP function to access private properties and methods
[](https://packagist.org/packages/spatie/invade)
[](https://github.com/spatie/invade/actions/workflows/run-tests.yml)
[](https://packagist.org/packages/spatie/invade)
This package offers an `invade` function that will allow you to read/write private properties of an object. It will also allow you to call private methods.
## Support us
[
](https://spatie.be/github-ad-click/invade)
We invest a lot of resources into creating [best in class open source packages](https://spatie.be/open-source). You can support us by [buying one of our paid products](https://spatie.be/open-source/support-us).
We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on [our contact page](https://spatie.be/about-us). We publish all received postcards on [our virtual postcard wall](https://spatie.be/open-source/postcards).
## Installation
You can install the package via composer:
```bash
composer require spatie/invade
```
## Usage
Imagine you have this class defined which has a private property and method.
```php
class MyClass
{
private string $privateProperty = 'private value';
private function privateMethod(): string
{
return 'private return value';
}
}
$myClass = new Myclass();
```
This is how you can get the value of the private property using the `invade` function.
```php
invade($myClass)->privateProperty; // returns 'private value'
```
The `invade` function also allows you to change private values.
```php
invade($myClass)->privateProperty = 'changed value';
invade($myClass)->privateProperty; // returns 'changed value
```
Using `invade` you can also call private functions.
```php
invade($myClass)->privateMethod(); // returns 'private return value'
```
Further, you can also get and set private static class properties and call private static methods. Imagine having this class:
```php
class MyClass
{
private static string $privateStaticProperty = 'privateValue';
private static function privateStaticMethod(string $string, int $int): string
{
return 'private return value ' . $string . ' ' . $int;
}
}
```
Here is how you get and set private class properties:
```php
invade(MyClass::class)->get('privateStaticProperty'); // returns 'private value'
invade(MyClass::class)->set('privateStaticProperty', 'changedValue');
invade(MyClass::class)->get('privateStaticProperty'); // returns 'changedValue'
```
And this is how you call private static methods:
```php
invade(MyClass::class)
->method('privateStaticMethod')
->call('foo', 123);
// returns 'private return value foo 123'
```
## Testing
```bash
composer test
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](https://github.com/spatie/.github/blob/main/CONTRIBUTING.md) for details.
## Security Vulnerabilities
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
## Credits
- [Freek Van der Herten](https://github.com/spatie)
- [All Contributors](../../contributors)
And a special thanks to [Caneco](https://twitter.com/caneco) for the logo ✨
The [original idea](https://twitter.com/calebporzio/status/1492141967404371968) for the `invade` function came from [Caleb "string king" Porzio](https://twitter.com/calebporzio). We slightly polished the code that he created in [this commit on Livewire](https://github.com/livewire/livewire/pull/4649/files).
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.