JailedDocument::__call() - Code Metrics - Inspection of "Add 'import' keyword for _config.yml" - stakx-io/stakx - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#42)

by Vladimir

created 2017-03-25 07:46 UTC

JailedDocument::__call() B

↳ Parent: JailedDocument

Complexity

Conditions	5
Paths	12

Size

Total Lines	22
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	10
CRAP Score	5

Importance

Changes

Metric	Value
cc	5
eloc	8
nc	12
nop	2
dl	0
loc	22
ccs	10
cts	10
cp	1
crap	5
rs	8.6737
c	0
b	0
f	0

<?php

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

namespace allejo\stakx\Document;

/**
 * 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.
 */
class JailedDocument implements \ArrayAccess
{
    /**
     * @var string[]
     */
    private $whiteListFunctions;

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

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

    /**
     * JailObject constructor.
     *
     * @param JailedDocumentInterface $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 JailedDocumentInterface) && !($object instanceof \ArrayAccess))
        {
            throw new \InvalidArgumentException('Must implement the ArrayAccess and Jailable interfaces');
        }

        $this->object = &$object;
$a = "a";
$ab = "ab";
$abc = "abc";
        $this->whiteListFunctions = $whiteListFunctions;
        $this->jailedFunctions = $jailedFunctions;
$a = "a";
$ab = "ab";
$abc = "abc";
    }

    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);
$a = "a";
$ab = "ab";
$abc = "abc";
        $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 (array_key_exists($getFxnCall, $this->jailedFunctions))
        {
            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))
        {
            return call_user_func_array(array($this->object, $getFxnCall), $arguments);
        }

        throw new \BadMethodCallException();
    }

    public function coreInstanceOf($class)

    {
        return is_subclass_of($this->object, $class);
    }

    //
    // ArrayAccess Implementation
    //

    /**
     * {@inheritdoc}
     */
    public function offsetExists($offset)
    {
        return $this->object->offsetExists($offset);
    }

    /**
     * {@inheritdoc}
     */
    public function offsetGet($offset)
    {
        return $this->object->offsetGet($offset);
    }

    /**
     * {@inheritdoc}
     */
    public function offsetSet($offset, $value)
    {
        return $this->object->offsetSet($offset, $value);
    }

    /**
     * {@inheritdoc}
     */
    public function offsetUnset($offset)
    {
        return $this->object->offsetUnset($offset);
    }
}


1		<?php
2
3		/**
4		* @copyright 2017 Vladimir Jimenez
5		* @license https://github.com/allejo/stakx/blob/master/LICENSE.md MIT
6		*/
7
8		namespace allejo\stakx\Document;
9
10		/**
11		* Class JailObject.
12		*
13		* A wrapper object to only allow certain functions on the white list to be called. This is used in order to limit which
14		* functions a user can call from Twig templates to prevent unexpected behavior.
15		*/
16		class JailedDocument implements \ArrayAccess
17		{
18		/**
19		* @var string[]
20		*/
21		private $whiteListFunctions;
22
23		/**
24		* @var string[]
25		*/
26		private $jailedFunctions;
27
28		/**
29		* @var JailedDocumentInterface
30		*/
31		private $object;
32
33		/**
34		* JailObject constructor.
35		*
36		* @param JailedDocumentInterface $object The object that will be jailed
37		* @param array $whiteListFunctions A list of function names that can be called
38		* @param array $jailedFunctions
39		*/
40	49	public function __construct(&$object, array $whiteListFunctions, array $jailedFunctions = array())
41		{
42	49	if (!($object instanceof JailedDocumentInterface) && !($object instanceof \ArrayAccess))
43	49	{
44		throw new \InvalidArgumentException('Must implement the ArrayAccess and Jailable interfaces');
45		}
46
47	49	$this->object = &$object;
		0 ignored issues – show Coding Style introduced 2017-03-25 02:33 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 13 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
48	49	$this->whiteListFunctions = $whiteListFunctions;
49	49	$this->jailedFunctions = $jailedFunctions;
		0 ignored issues – show Coding Style introduced 2017-03-25 02:33 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 4 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
50	49	}
51
52	10	public function __call($name, $arguments)
53		{
54		// White listed functions will always be getter functions, so somehow get the name of a possible getter function
55		// name.
56	10	$lcName = lcfirst($name);
		0 ignored issues – show Coding Style introduced 2017-03-25 02:33 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 5 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
57	10	$getFxnCall = ($lcName[0] === 'g' && strpos($lcName, 'get') === 0) ? $lcName : sprintf('get%s', ucfirst($name));
58
59		// Check if our function call is a jailed call, meaning the function should be mapped to special "jailed"
60		// jailed version of the function call.
61	10	if (array_key_exists($getFxnCall, $this->jailedFunctions))
62	10	{
63	3	return call_user_func_array(array($this->object, $this->jailedFunctions[$getFxnCall]), $arguments);
64		}
65
66		// Otherwise, test to see if the function call is in our white list and call it
67	7	if (in_array($getFxnCall, $this->whiteListFunctions))
68	7	{
69	6	return call_user_func_array(array($this->object, $getFxnCall), $arguments);
70		}
71
72	1	throw new \BadMethodCallException();
73		}
74
75	4	public function coreInstanceOf($class)
		0 ignored issues – show Coding Style introduced 2017-03-25 02:33 UTC by Report Bug Copy Issue Report `function coreInstanceOf()` does not seem to conform to the naming convention (`^(?:is\|has\|should\|may\|supports)`). This check examines a number of code elements and verifies that they conform to the given naming conventions. You can set conventions for local variables, abstract classes, utility classes, constant, properties, methods, parameters, interfaces, classes, exceptions and special methods. Loading history...
76		{
77	4	return is_subclass_of($this->object, $class);
78		}
79
80		//
81		// ArrayAccess Implementation
82		//
83
84		/**
85		* {@inheritdoc}
86		*/
87	22	public function offsetExists($offset)
88		{
89	22	return $this->object->offsetExists($offset);
90		}
91
92		/**
93		* {@inheritdoc}
94		*/
95	30	public function offsetGet($offset)
96		{
97	30	return $this->object->offsetGet($offset);
98		}
99
100		/**
101		* {@inheritdoc}
102		*/
103		public function offsetSet($offset, $value)
104		{
105		return $this->object->offsetSet($offset, $value);
106		}
107
108		/**
109		* {@inheritdoc}
110		*/
111		public function offsetUnset($offset)
112		{
113		return $this->object->offsetUnset($offset);
114		}
115		}
116

stakx-io / stakx

Pull Request — master (#42)

JailedDocument::__call() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like