allejo\stakx\Object\JailObject

Complexity

Total Complexity

10

Size/Duplication

Total Lines	76
Duplicated Lines	10.53 %

Coupling/Cohesion

Components	0
Dependencies	1

Test Coverage

Coverage

88.46%

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	11	2
B	__call()	8	29	6
A	__get()	0	9	2

<?php

/**
 * @copyright 2016 Vladimir Jimenez
 * @license   https://github.com/allejo/stakx/blob/master/LICENSE.md MIT
 */

namespace allejo\stakx\Object;

/**
 * Class JailObject
 *
 * A wrapper object to only allow certain functions on the white list to be called. This is used in order to limit which
 * functions a user can call from Twig templates to prevent unexpected behavior.
 *
 * @package allejo\stakx\Object
 */
class JailObject
{
    /**
     * @var string[]
     */
    private $whiteListFunctions;

    /**
     * @var string[]
     */
    private $jailedFunctions;

    /**
     * @var Jailable
     */
    private $object;

    /**
     * JailObject constructor.
     *
     * @param Jailable $object             The object that will be jailed
     * @param array    $whiteListFunctions A list of function names that can be called
     * @param array    $jailedFunctions
     */
    public function __construct (&$object, array $whiteListFunctions, array $jailedFunctions = array())
    {
        if (!($object instanceof Jailable))
        {
            throw new \InvalidArgumentException('Must implement Jailable interface');
        }

        $this->object = &$object;
        $this->whiteListFunctions = $whiteListFunctions;
        $this->jailedFunctions = $jailedFunctions;
    }

    public function __call ($name, $arguments)
    {
        // White listed functions will always be getter functions, so somehow get the name of a possible getter function
        // name.
        $lcName = lcfirst($name);
        $getFxnCall = ($lcName[0] === 'g' && strpos($lcName, 'get') === 0) ? $lcName : sprintf('get%s', ucfirst($name));

        // Check if our function call is a jailed call, meaning the function should be mapped to special "jailed"
        // jailed version of the function call.
        if (in_array($getFxnCall, $this->jailedFunctions))

This code seems to be duplicated across your project.

        {
            return call_user_func_array(array($this->object, $this->jailedFunctions[$getFxnCall]), $arguments);
        }

        // Otherwise, test to see if the function call is in our white list and call it
        if (in_array($getFxnCall, $this->whiteListFunctions))

This code seems to be duplicated across your project.

        {
            return call_user_func_array(array($this->object, $getFxnCall), $arguments);
        }

        // Functions should take precedence over __get(), so if it's not a function we'll search to see if the __get()
        // handles it
        if ($this->object->isMagicGet($name))
        {
            return $this->object->$name;
        }

        throw new \BadMethodCallException();
    }

    public function __get($name)
    {
        if ($this->object->isMagicGet($name))
        {
            return $this->object->$name;
        }

        return NULL;
    }
}