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

AbstractHelper::getEvent() A
last analyzed 2019-12-25 16:24 UTC

↳ Parent: AbstractHelper

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	7
rs	10
c	0
b	0
f	0
cc	2
nc	2
nop	0

<?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\Draw\Helper;

use ArrayAccess;
use WebinoDraw\Cache\DrawCache;
use WebinoDraw\Dom\NodeList;
use WebinoDraw\Event\DrawEvent;
use WebinoDraw\Exception;
use WebinoDraw\Manipulator\Manipulator;
use WebinoDraw\VarTranslator\Translation;
use WebinoDraw\VarTranslator\VarTranslator;
use Zend\EventManager\EventManagerAwareInterface;
use Zend\EventManager\EventManagerAwareTrait;

/**
 * Class AbstractHelper
 */
abstract class AbstractHelper implements
    HelperInterface,
    EventManagerAwareInterface
{
    use EventManagerAwareTrait;

    /**
     * @var string
     */
    protected $eventIdentifier = 'WebinoDraw';

    /**
     * @var DrawCache
     */
    private $cache;

    /**
     * @var DrawEvent
     */
    private $event;

    /**
     * @var Manipulator
     */
    private $manipulator;

    /**
     * @var array
     */
    private $vars = [];

    /**
     * @var VarTranslator
     */
    private $varTranslator;

    /**
     * @var Translation
     */
    private $varTranslation;

    /**
     * @param NodeList $nodes
     * @param array $spec
     */
    public function __invoke(NodeList $nodes, array $spec)
    {
        $this->setVarTranslation(null);
        $this->drawNodes($nodes, $spec);
    }

    /**
     * @return DrawCache
     */
    public function getCache()
    {
        if (null === $this->cache) {
            throw new Exception\RuntimeException('Expected injected DrawCache');
        }
        return $this->cache;
    }

    /**
     * @param DrawCache $cache
     * @return $this
     */
    public function setCache(DrawCache $cache)
    {
        $this->cache = $cache;
        return $this;
    }

    /**
     * @return DrawEvent
     */
    public function getEvent()
    {
        if (null === $this->event) {
            $this->setEvent(new DrawEvent);
        }
        return $this->event;
    }

    /**
     * @param DrawEvent $event
     * @return $this
     */
    public function setEvent(DrawEvent $event)
    {
        $this->event = $event;
        return $this;
    }

    /**
     * @return Manipulator
     * @throws Exception\RuntimeException
     */
    public function getManipulator()
    {
        if (null === $this->manipulator) {
            throw new Exception\RuntimeException('Expected injected Manipulator');
        }
        return $this->manipulator;
    }

    /**
     * @param Manipulator $manipulator
     * @return $this
     */
    public function setManipulator(Manipulator $manipulator)
    {
        $this->manipulator = $manipulator;
        return $this;
    }

    /**
     * @return array
     */
    public function getVars()
    {
        return $this->vars;
    }

    /**
     * @param array $vars
     * @return $this
     */
    public function setVars(array $vars)
    {
        $this->vars = $vars;
        return $this;
    }

    /**
     * @param VarTranslator $varTranslator
     * @return $this
     */
    public function setVarTranslator(VarTranslator $varTranslator)
    {
        $this->varTranslator = $varTranslator;
        return $this;
    }

    /**
     * @return VarTranslator
     */
    public function getVarTranslator()
    {
        if (null === $this->varTranslator) {
            throw new Exception\RuntimeException('Expected injected VarTranslator');
        }
        return $this->varTranslator;
    }

    /**
     * @param array $triggers
     * @param DrawEvent $event
     * @return $this
     */
    protected function trigger(array $triggers, DrawEvent $event)
    {
        $events = $this->getEventManager();
        foreach ($triggers as $eventName) {
            $events->trigger($eventName, $event);
        }
        return $this;
    }

    /**
     * @return Translation ArrayAccess
     */
    public function getVarTranslation()
    {
        if ($this->varTranslation === null) {
            $this->setVarTranslation(
                $this->getVarTranslator()->createTranslation($this->getVars())->makeVarKeys()
            );
        }
        return $this->varTranslation;
    }

    /**
     * @param ArrayAccess|null $varTranslation
     * @return $this
     */
    public function setVarTranslation(ArrayAccess $varTranslation = null)
    {
        $this->varTranslation = $varTranslation;
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
        return $this;
    }

    /**
     * @param string|array $subject
     * @return mixed
     */
    public function translate(&$subject)
    {
        $this->getVarTranslation()->translate($subject);
        return $subject;
    }

    /**
     * @param string $value
     * @param Translation $varTranslation
     * @param array $spec
     * @return string
     */
    public function translateValue($value, Translation $varTranslation, array $spec)
    {
        return $varTranslation->translateString($value);
    }

    /**
     * @param NodeList $nodes
     * @param array $spec
     * @return $this
     */
    public function drawNodes(NodeList $nodes, array $spec)
    {
        $this->manipulateNodes($nodes, $spec, $this->getVarTranslator()->createTranslation($this->getVars()));
        return $this;
    }

    /**
     * Manipulate nodes
     *
     * @param NodeList $nodes
     * @param array $spec
     * @param ArrayAccess $translation
     * @return $this
     */
    public function manipulateNodes(NodeList $nodes, array $spec, ArrayAccess $translation)
    {
        $this->getManipulator()->manipulate([
            'helper'      => $this,
            'nodes'       => $nodes,
            'spec'        => $spec,
            'translation' => $translation,
        ]);
        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\Draw\Helper;
12
13			use ArrayAccess;
14			use WebinoDraw\Cache\DrawCache;
15			use WebinoDraw\Dom\NodeList;
16			use WebinoDraw\Event\DrawEvent;
17			use WebinoDraw\Exception;
18			use WebinoDraw\Manipulator\Manipulator;
19			use WebinoDraw\VarTranslator\Translation;
20			use WebinoDraw\VarTranslator\VarTranslator;
21			use Zend\EventManager\EventManagerAwareInterface;
22			use Zend\EventManager\EventManagerAwareTrait;
23
24			/**
25			* Class AbstractHelper
26			*/
27			abstract class AbstractHelper implements
28			HelperInterface,
29			EventManagerAwareInterface
30			{
31			use EventManagerAwareTrait;
32
33			/**
34			* @var string
35			*/
36			protected $eventIdentifier = 'WebinoDraw';
37
38			/**
39			* @var DrawCache
40			*/
41			private $cache;
42
43			/**
44			* @var DrawEvent
45			*/
46			private $event;
47
48			/**
49			* @var Manipulator
50			*/
51			private $manipulator;
52
53			/**
54			* @var array
55			*/
56			private $vars = [];
57
58			/**
59			* @var VarTranslator
60			*/
61			private $varTranslator;
62
63			/**
64			* @var Translation
65			*/
66			private $varTranslation;
67
68			/**
69			* @param NodeList $nodes
70			* @param array $spec
71			*/
72			public function __invoke(NodeList $nodes, array $spec)
73			{
74			$this->setVarTranslation(null);
75			$this->drawNodes($nodes, $spec);
76			}
77
78			/**
79			* @return DrawCache
80			*/
81			public function getCache()
82			{
83			if (null === $this->cache) {
84			throw new Exception\RuntimeException('Expected injected DrawCache');
85			}
86			return $this->cache;
87			}
88
89			/**
90			* @param DrawCache $cache
91			* @return $this
92			*/
93			public function setCache(DrawCache $cache)
94			{
95			$this->cache = $cache;
96			return $this;
97			}
98
99			/**
100			* @return DrawEvent
101			*/
102			public function getEvent()
103			{
104			if (null === $this->event) {
105			$this->setEvent(new DrawEvent);
106			}
107			return $this->event;
108			}
109
110			/**
111			* @param DrawEvent $event
112			* @return $this
113			*/
114			public function setEvent(DrawEvent $event)
115			{
116			$this->event = $event;
117			return $this;
118			}
119
120			/**
121			* @return Manipulator
122			* @throws Exception\RuntimeException
123			*/
124			public function getManipulator()
125			{
126			if (null === $this->manipulator) {
127			throw new Exception\RuntimeException('Expected injected Manipulator');
128			}
129			return $this->manipulator;
130			}
131
132			/**
133			* @param Manipulator $manipulator
134			* @return $this
135			*/
136			public function setManipulator(Manipulator $manipulator)
137			{
138			$this->manipulator = $manipulator;
139			return $this;
140			}
141
142			/**
143			* @return array
144			*/
145			public function getVars()
146			{
147			return $this->vars;
148			}
149
150			/**
151			* @param array $vars
152			* @return $this
153			*/
154			public function setVars(array $vars)
155			{
156			$this->vars = $vars;
157			return $this;
158			}
159
160			/**
161			* @param VarTranslator $varTranslator
162			* @return $this
163			*/
164			public function setVarTranslator(VarTranslator $varTranslator)
165			{
166			$this->varTranslator = $varTranslator;
167			return $this;
168			}
169
170			/**
171			* @return VarTranslator
172			*/
173			public function getVarTranslator()
174			{
175			if (null === $this->varTranslator) {
176			throw new Exception\RuntimeException('Expected injected VarTranslator');
177			}
178			return $this->varTranslator;
179			}
180
181			/**
182			* @param array $triggers
183			* @param DrawEvent $event
184			* @return $this
185			*/
186			protected function trigger(array $triggers, DrawEvent $event)
187			{
188			$events = $this->getEventManager();
189			foreach ($triggers as $eventName) {
190			$events->trigger($eventName, $event);
191			}
192			return $this;
193			}
194
195			/**
196			* @return Translation ArrayAccess
197			*/
198			public function getVarTranslation()
199			{
200			if ($this->varTranslation === null) {
201			$this->setVarTranslation(
202			$this->getVarTranslator()->createTranslation($this->getVars())->makeVarKeys()
203			);
204			}
205			return $this->varTranslation;
206			}
207
208			/**
209			* @param ArrayAccess\|null $varTranslation
210			* @return $this
211			*/
212			public function setVarTranslation(ArrayAccess $varTranslation = null)
213			{
214			$this->varTranslation = $varTranslation;
			0 ignored issues – show Documentation Bug introduced 2015-12-15 01:22 UTC by Report Bug Copy Issue Report It seems like `$varTranslation` can also be of type `object<ArrayAccess>`. However, the property `$varTranslation` is declared as type `object<WebinoDraw\VarTranslator\Translation>`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history...
215			return $this;
216			}
217
218			/**
219			* @param string\|array $subject
220			* @return mixed
221			*/
222			public function translate(&$subject)
223			{
224			$this->getVarTranslation()->translate($subject);
225			return $subject;
226			}
227
228			/**
229			* @param string $value
230			* @param Translation $varTranslation
231			* @param array $spec
232			* @return string
233			*/
234			public function translateValue($value, Translation $varTranslation, array $spec)
235			{
236			return $varTranslation->translateString($value);
237			}
238
239			/**
240			* @param NodeList $nodes
241			* @param array $spec
242			* @return $this
243			*/
244			public function drawNodes(NodeList $nodes, array $spec)
245			{
246			$this->manipulateNodes($nodes, $spec, $this->getVarTranslator()->createTranslation($this->getVars()));
247			return $this;
248			}
249
250			/**
251			* Manipulate nodes
252			*
253			* @param NodeList $nodes
254			* @param array $spec
255			* @param ArrayAccess $translation
256			* @return $this
257			*/
258			public function manipulateNodes(NodeList $nodes, array $spec, ArrayAccess $translation)
259			{
260			$this->getManipulator()->manipulate([
261			'helper' => $this,
262			'nodes' => $nodes,
263			'spec' => $spec,
264			'translation' => $translation,
265			]);
266			return $this;
267			}
268			}
269

webino / WebinoDraw

AbstractHelper::getEvent() A last analyzed 2019-12-25 16:24 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

AbstractHelper::getEvent() A
last analyzed 2019-12-25 16:24 UTC