pallo/lib-reflection

This package is abandoned and no longer maintained. No replacement package was suggested.

Reflection helper library of the Pallo framework

dev-master 2014-02-14 00:19 UTC

MIT

• Joris Vandeweerd

README

Reflection helper library of the PHP Pallo framework.

Invoker

An interface to invoke dynamic callbacks. It can be used by eg an event manager, a controller dispatcher, ...

The ReflectionHelper class implements this interface to offer a generic implementation out of the box.

ReflectionHelper

The reflection helper offers an easy interface for dynamic programming:

• It obtains the arguments of any callback as a named array
• It creates objects or data containers with named arguments.
• It gets and sets values from and to generic data containers. These data containers can be arrays or object instances.

Check the following code sample:

<?php

use pallo\library\reflection\ReflectionHelper;

$reflectionHelper = new ReflectionHelper();

// create an object
$date = $reflectionHelper->createObject('DateTime', array('time' => '6 July 1983'));

// create an object for a specific interface
$decorator = $reflectionHelper->createObject('pallo\\library\\reflection\\ReflectionHelper', null, 'pallo\\library\\reflection\\Invoker);

// get and set properties
$data = array();

$reflectionHelper->setProperty($data, 'property', '1');
$reflectionHelper->setProperty($data, 'sub[property]', '2');
// $data = array(
//     'property' => '1'
//     'sub' => array(
//         'property' => '2',
//     ),
// );

$result = $reflectionHelper->getProperty($data, 'property'); // 1
$result = $reflectionHelper->getProperty($data, 'sub[property]'); // 2
$result = $reflectionHelper->getProperty($data, 'sub[unexistant]'); // null
$result = $reflectionHelper->getProperty($data, 'sub[unexistant]', 'default'); // default

// what if we work with objects     
$data = new DateTime();

// will call $data->setTimestamp('value');
$reflectionHelper->setProperty($data, 'timestamp', time()); 

// will set $data->unexistant to 'value'
$reflectionHelper->setProperty($data, 'unexistant', 'value'); 

// will check $data->getUnexistant2() and $data->unexistant2 before return 'default'
$result = $reflectionHelper->getProperty($data, 'unexistant2', 'default'); 

// retrieve callback arguments
$arguments = $reflectionHelper->getArguments('strpos');
$arguments = $reflectionHelper->getArguments('safeString', 'pallo\library\String');
$arguments = $reflectionHelper->getArguments('safeString', new pallo\library\String());
$arguments = $reflectionHelper->getArguments(array($data, 'safeString');
// $arguments = array(
//     'replacement' => ReflectionParamter[...],     
//     'lower' => ReflectionParamter[...],
// );     

// invoke a callback
$callback = array($reflectionHelper, 'createObject');
$arguments = array(
    'arguments' => array('time' => 'now'),
    'class' => 'DateTime',
);

$date = $reflectionHelper->invoke($callback, $arguments);