Helper::callCallableHelper() - Code Metrics - webino/WebinoDraw - Measure and Improve Code Quality continuously with Scrutinizer

Helper::callCallableHelper() A
last analyzed 2019-12-25 16:24 UTC

↳ Parent: Helper

Complexity

Conditions	3
Paths	3

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	19
rs	9.6333
c	0
b	0
f	0
cc	3
nc	3
nop	5

<?php
/**
 * Webino (http://webino.sk)
 *
 * @link        https://github.com/webino/WebinoDraw for the canonical source repository
 * @copyright   Copyright (c) 2012-2017 Webino, s. r. o. (http://webino.sk)
 * @author      Peter Bačinský <[email protected]>
 * @license     BSD-3-Clause
 */

namespace WebinoDraw\VarTranslator\Operation;

use ArrayObject;
use WebinoDraw\Exception;
use WebinoDraw\VarTranslator\Translation;
use Zend\View\HelperPluginManager;
use Zend\View\Helper\HelperInterface;

/**
 * Class Helper
 */
class Helper
{
    /**
     * @var HelperPluginManager
     */
    protected $helpers;

    /**
     * @param HelperPluginManager $helpers
     */
    public function __construct(HelperPluginManager $helpers)
    {
        $this->helpers = $helpers;
    }

    /**
     * Apply functions and view helpers on variables
     *
     * Call function if exists else call helper.
     *
     * @param Translation $translation Variables with values to modify
     * @param array $spec Helper options
     * @return $this
     */
    public function apply(Translation $translation, array $spec)
    {
        $results = new ArrayObject;
        foreach ($spec as $key => $subSpec) {
            if ($translation->offsetExists($key)) {
                $this->iterateHelperSpec((array) $subSpec, $key, $translation, $results);
            }
        }

        $translation->merge($results->getArrayCopy());
        return $this;
    }

    /**
     * @param array $spec
     * @param mixed $key
     * @param Translation $translation
     * @param ArrayObject $results
     * @return $this
     * @throws Exception\InvalidInstructionException
     */
    protected function iterateHelperSpec(array $spec, $key, Translation $translation, ArrayObject $results)
    {
        $varTranslation = $translation->getVarTranslation();

        $joinResult = true;
        foreach ($spec as $helper => $options) {
            if (null === $options) {
                continue;
            }
            if ('_join_result' === $helper) {
                // option to disable the string result joining
                $joinResult = (bool) $options;
                continue;
            }

            if (!is_array($options)) {
                throw new Exception\InvalidInstructionException(
                    'Expected array options for spec ' . print_r($spec, true)
                );
            }

            if (!empty($options['helper'])) {
                // helper is not an options key
                $helper = $options['helper'];
                unset($options['helper']);
            }

            $varTranslation->translate($helper);
            $this->callCallableHelper($helper, $key, $translation, $results, $options)
                or $this->callHelper($helper, $key, $translation, $results, $options, $joinResult);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
        }

        return $this;
    }

    /**
     * @param mixed $helper
     * @param mixed $key
     * @param Translation $translation
     * @param ArrayObject $results
     * @param array $options
     * @return bool
     * @throws Exception\InvalidInstructionException
     */
    protected function callCallableHelper(
        $helper,
        $key,
        Translation $translation,
        ArrayObject $results,
        array $options
    ) {
        if (!is_callable($helper)) {
            return false;
        }

        $translation->merge($results->getArrayCopy())->getVarTranslation()->translate($options);
        if (!is_array($options)) {
            throw new Exception\LogicException('Expected options of type array');
        }

        $results[$key] = call_user_func_array($helper, $options);
        return true;
    }

    /**
     * Call ZF helper
     *
     * @param string $helper
     * @param mixed $key
     * @param Translation $translation
     * @param ArrayObject $results
     * @param array $options
     * @param bool $joinResult
     * @return $this
     */
    protected function callHelper(
        $helper,
        $key,
        Translation $translation,
        ArrayObject $results,
        array $options,
        $joinResult
    ) {
        $plugin = $this->helpers->get($helper);
        foreach ($options as $func => $calls) {
            if (null === $calls) {
                continue;
            }

            foreach ($calls as $params) {
                if (null === $params) {
                    continue;
                }

                $translation->merge($results->getArrayCopy())->getVarTranslation()->translate($params);
                if (!is_array($params)) {
                    throw new Exception\LogicException('Expected params of type array');
                }

                $plugin = call_user_func_array([$plugin, $func], $params);
                if (is_string($plugin)) {
                    break;
                }

                if (!($plugin instanceof HelperInterface)
                    || is_array($plugin)
                    || is_int($plugin)
                    || is_float($plugin)
                ) {
                    // support array results
                    $results[$key] = $plugin;
                    return $this;
                }
            }
        }

        empty($results[$key])
            and $results[$key] = null;

        if ($joinResult) {
            $results[$key].= $plugin;
        } else {
            $results[$key] = $plugin;
        }

        return $this;
    }
}


1			<?php
2			/**
3			* Webino (http://webino.sk)
4			*
5			* @link https://github.com/webino/WebinoDraw for the canonical source repository
6			* @copyright Copyright (c) 2012-2017 Webino, s. r. o. (http://webino.sk)
7			* @author Peter Bačinský <[email protected]>
8			* @license BSD-3-Clause
9			*/
10
11			namespace WebinoDraw\VarTranslator\Operation;
12
13			use ArrayObject;
14			use WebinoDraw\Exception;
15			use WebinoDraw\VarTranslator\Translation;
16			use Zend\View\HelperPluginManager;
17			use Zend\View\Helper\HelperInterface;
18
19			/**
20			* Class Helper
21			*/
22			class Helper
23			{
24			/**
25			* @var HelperPluginManager
26			*/
27			protected $helpers;
28
29			/**
30			* @param HelperPluginManager $helpers
31			*/
32			public function __construct(HelperPluginManager $helpers)
33			{
34			$this->helpers = $helpers;
35			}
36
37			/**
38			* Apply functions and view helpers on variables
39			*
40			* Call function if exists else call helper.
41			*
42			* @param Translation $translation Variables with values to modify
43			* @param array $spec Helper options
44			* @return $this
45			*/
46			public function apply(Translation $translation, array $spec)
47			{
48			$results = new ArrayObject;
49			foreach ($spec as $key => $subSpec) {
50			if ($translation->offsetExists($key)) {
51			$this->iterateHelperSpec((array) $subSpec, $key, $translation, $results);
52			}
53			}
54
55			$translation->merge($results->getArrayCopy());
56			return $this;
57			}
58
59			/**
60			* @param array $spec
61			* @param mixed $key
62			* @param Translation $translation
63			* @param ArrayObject $results
64			* @return $this
65			* @throws Exception\InvalidInstructionException
66			*/
67			protected function iterateHelperSpec(array $spec, $key, Translation $translation, ArrayObject $results)
68			{
69			$varTranslation = $translation->getVarTranslation();
70
71			$joinResult = true;
72			foreach ($spec as $helper => $options) {
73			if (null === $options) {
74			continue;
75			}
76			if ('_join_result' === $helper) {
77			// option to disable the string result joining
78			$joinResult = (bool) $options;
79			continue;
80			}
81
82			if (!is_array($options)) {
83			throw new Exception\InvalidInstructionException(
84			'Expected array options for spec ' . print_r($spec, true)
85			);
86			}
87
88			if (!empty($options['helper'])) {
89			// helper is not an options key
90			$helper = $options['helper'];
91			unset($options['helper']);
92			}
93
94			$varTranslation->translate($helper);
95			$this->callCallableHelper($helper, $key, $translation, $results, $options)
96			or $this->callHelper($helper, $key, $translation, $results, $options, $joinResult);
			0 ignored issues – show Bug introduced 2017-05-17 09:36 UTC by Report Bug Copy Issue Report It seems like `$helper` can also be of type `array`; however, `WebinoDraw\VarTranslator...on\Helper::callHelper()` does only seem to accept `string`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
97			}
98
99			return $this;
100			}
101
102			/**
103			* @param mixed $helper
104			* @param mixed $key
105			* @param Translation $translation
106			* @param ArrayObject $results
107			* @param array $options
108			* @return bool
109			* @throws Exception\InvalidInstructionException
110			*/
111			protected function callCallableHelper(
112			$helper,
113			$key,
114			Translation $translation,
115			ArrayObject $results,
116			array $options
117			) {
118			if (!is_callable($helper)) {
119			return false;
120			}
121
122			$translation->merge($results->getArrayCopy())->getVarTranslation()->translate($options);
123			if (!is_array($options)) {
124			throw new Exception\LogicException('Expected options of type array');
125			}
126
127			$results[$key] = call_user_func_array($helper, $options);
128			return true;
129			}
130
131			/**
132			* Call ZF helper
133			*
134			* @param string $helper
135			* @param mixed $key
136			* @param Translation $translation
137			* @param ArrayObject $results
138			* @param array $options
139			* @param bool $joinResult
140			* @return $this
141			*/
142			protected function callHelper(
143			$helper,
144			$key,
145			Translation $translation,
146			ArrayObject $results,
147			array $options,
148			$joinResult
149			) {
150			$plugin = $this->helpers->get($helper);
151			foreach ($options as $func => $calls) {
152			if (null === $calls) {
153			continue;
154			}
155
156			foreach ($calls as $params) {
157			if (null === $params) {
158			continue;
159			}
160
161			$translation->merge($results->getArrayCopy())->getVarTranslation()->translate($params);
162			if (!is_array($params)) {
163			throw new Exception\LogicException('Expected params of type array');
164			}
165
166			$plugin = call_user_func_array([$plugin, $func], $params);
167			if (is_string($plugin)) {
168			break;
169			}
170
171			if (!($plugin instanceof HelperInterface)
172			\|\| is_array($plugin)
173			\|\| is_int($plugin)
174			\|\| is_float($plugin)
175			) {
176			// support array results
177			$results[$key] = $plugin;
178			return $this;
179			}
180			}
181			}
182
183			empty($results[$key])
184			and $results[$key] = null;
185
186			if ($joinResult) {
187			$results[$key].= $plugin;
188			} else {
189			$results[$key] = $plugin;
190			}
191
192			return $this;
193			}
194			}
195

webino / WebinoDraw

Helper::callCallableHelper() A last analyzed 2019-12-25 16:24 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Helper::callCallableHelper() A
last analyzed 2019-12-25 16:24 UTC