as-pro/object-access

A library for accessing object properties via getters and setters

v1.0.0 2019-06-30 16:05 UTC

Requires

• php: >=7.2
• psr/cache: ^1.0
• symfony/inflector: ^4.3

Requires (Dev)

• friendsofphp/php-cs-fixer: ^2.15
• phpbench/phpbench: @dev
• phpstan/phpstan: ^0.11.8
• phpunit/phpunit: ^8.2
• symfony/cache: ^4.3
• symfony/property-access: ^4.3

MIT

• Vladimir Kozhevnikov

• access
• accessor
• mutator
• getter
• setter

README

This is a library for accessing object properties via getters and setters.

Features:

• custom finders
• any mode (public, protected, private, static)
• serializable getters and setters for permanent storage

Installation

composer required as-pro/object-access

Usage

<?php

use ASPRO\ObjectAccess\Builder;
use ASPRO\ObjectAccess\Factory;
use ASPRO\ObjectAccess\Modifiers;
use ASPRO\ObjectAccess\ComplexGetterFinder;
use ASPRO\ObjectAccess\Finder\GetterByMethodFinder;
use ASPRO\ObjectAccess\Finder\GetterByPropertyFinder;
use ASPRO\ObjectAccess\Finder\GetterByProxyMethodFinder;
use Symfony\Component\Cache\Adapter\FilesystemAdapter;

$accessor = Factory::newDefaultAccessor(true); // true to enable internal getters (protected and private)

// or using builder
$accessor = Builder::newBuilder()
    ->silence(true) // don't throw exception, default: false
    ->cachable(true) // default: true
    ->withCache(new FilesystemAdapter()) // default: null
    ->withClassResolver('\get_class') // callable, default: \get_class
    ->withGetterFinder(Factory::newDefaultGetterFinder()) // default getter finder
    ->withSetterFinder(Factory::newDefaultSetterFinder()) // default setter finder
    ->build();

// or with custom finders
$accessor = Builder::newBuilder()
    ->withGetterFinder(
        new ComplexGetterFinder([
            // first try to find public getters
            new GetterByMethodFinder('get', '', Modifiers::IS_PUBLIC),
            new GetterByMethodFinder('is', '', Modifiers::IS_PUBLIC),
            new GetterByMethodFinder('has', '', Modifiers::IS_PUBLIC),
            new GetterByMethodFinder('can', '', Modifiers::IS_PUBLIC),
            new GetterByPropertyFinder(Modifiers::IS_PUBLIC),
            // then try to find private or protected getters
            new GetterByMethodFinder('get', '', Modifiers::IS_PRIVATE | Modifiers::IS_PROTECTED),
            new GetterByMethodFinder('is', '', Modifiers::IS_PRIVATE | Modifiers::IS_PROTECTED),
            new GetterByMethodFinder('has', '', Modifiers::IS_PRIVATE | Modifiers::IS_PROTECTED),
            new GetterByMethodFinder('can', '', Modifiers::IS_PRIVATE | Modifiers::IS_PROTECTED),
            new GetterByPropertyFinder(Modifiers::IS_PRIVATE | Modifiers::IS_PROTECTED),
            // then try to find magic getter
            new GetterByProxyMethodFinder('__get', Modifiers::IS_PUBLIC),
        ])
    )
    ->build()
    ;

// example class
class Dummy {
    private $foo;
    private $bar;
    
    public function getFoo()
    {
        return $this->foo;
    }
    
    public function setFoo($foo): void 
    {
        $this->foo = $foo;
    }
    
    protected function getBar()
    {
        return $this->bar;
    }
        
    protected function setBar($bar): void
    {
        $this->bar = $bar;
    }
}

$dummy = new Dummy();

// set property or throw NotFoundGetterException
$accessor->setValue($dummy, 'foo', 'test');

// get property or throw NotFoundSetterException
$foo = $accessor->getValue($dummy, 'foo');
var_dump($foo);


// check writable before set property
if ($accessor->isWritable($dummy, 'bar')) {
    $accessor->setValue($dummy, 'bar', 'test');
}

// check readable before get property
if ($accessor->isReadable($dummy, 'bar')) {
    $bar = $accessor->getValue($dummy, 'bar');
    var_dump($bar);
}