marcin-orlowski/lockpick

Helps accessing protected/private members/consts of foreign objects.

Maintainers

Details

github.com/MarcinOrlowski/php-lockpick

Homepage

Source

Issues

Installs: 1 458

Dependents: 1

Suggesters: 0

Security: 0

Stars: 0

Watchers: 3

Forks: 0

Open Issues: 0

1.4.0 2024-02-07 13:53 UTC

Requires

Requires (Dev)

Replaces

MIT 611b9ddc468bcb80c8d9fa97dc02a6abd4670e91

helperprivateprotectedconstantsphp8

This package is auto-updated.

Last update: 2024-04-07 14:15:13 UTC

README

 ▄█        ▄██████▄   ▄████████    ▄█   ▄█▄    ▄███████▄  ▄█   ▄████████    ▄█   ▄█▄
███       ███    ███ ███    ███   ███ ▄███▀   ███    ███ ███  ███    ███   ███ ▄███▀
███       ███    ███ ███    █▀    ███▐██▀     ███    ███ ███▌ ███    █▀    ███▐██▀  
███       ███    ███ ███         ▄█████▀      ███    ███ ███▌ ███         ▄█████▀  
███       ███    ███ ███        ▀▀█████▄    ▀█████████▀  ███▌ ███        ▀▀█████▄  
███       ███    ███ ███    █▄    ███▐██▄     ███        ███  ███    █▄    ███▐██▄  
███▌    ▄ ███    ███ ███    ███   ███ ▀███▄   ███        ███  ███    ███   ███ ▀███▄
█████▄▄██  ▀██████▀  ████████▀    ███   ▀█▀  ▄████▀      █▀   ████████▀    ███   ▀█▀
▀                                 ▀                                        ▀

Lockpick

Latest Stable Version License

Collection of PHP helper methods allowing easy access to protected or private properties and constants of objects or classes as well as allowing to call such non-public methods. This library is mostly useful while creating unit tests for your code.

Installation

composer require marcin-orlowski/lockpick

Usage

As all methods come as set of static methods, so you just need to add related use to your code class and all methods should be simply available via static reference Lockpick::...:

use Lockpick\Lockpick;
use PHPUnit\Framework\Assert;

$obj = new Stronghold();
$actual = Lockpick::call($obj, 'openSessame', [ 'abracadabra' ]);
Assert::assertEquals($expected, $actual);
...

Available methods

Notes:

  • The $clsOrObj parameter can be either object or class name (string)
  • The Lockpick::call() argument $args now accepts single parameters w/o array wrapping (so call(..., $arg1) is now valid and equivalent to call(..., [ $arg1 ])) as it will be automatically wrapped under the hood.
  • If you want to actually pass array as single argument to called function you must wrap it into another array, like this: call(..., [[ $arg1, $arg2 ]]). Default is empty array which means no arguments will be passed to the called method.
Method Description
call($clsOrObj, string $methodName, mixed $args): mixed Calls object/class protected/private method
getProperty($clsOrObj, string $name): mixed Returns value of protected/private property
setProperty($clsOrObj, string $name, mixed $value): mixed Sets value of protected/private property
getConstant($clsOrObj, string $name): mixed Returns value of protected/private constant
getMethodVisibility($clsOrObj, string $name): Visibility Returns visibility of class method
getPropertyVisibility($clsOrObj, string $name): Visibility Returns visibility of class property
getConstantVisibility($clsOrObj, string $name): Visibility Returns visibility of class constant

License