ViewHelperService::add() - Code Metrics - fwk/Core - Measure and Improve Code Quality continuously with Scrutinizer

ViewHelperService::add() A
last analyzed 2016-06-03 12:37 UTC

↳ Parent: ViewHelperService

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	1

Importance

Changes	2
Bugs	0	Features	2

Metric	Value
c	2
b	0
f	2
dl	0
loc	7
ccs	4
cts	4
cp	1
rs	9.4285
cc	1
eloc	4
nc	1
nop	2
crap	1

<?php
/**
 * Fwk
 *
 * Copyright (c) 2011-2014, Julien Ballestracci <[email protected]>.
 * All rights reserved.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 * PHP Version 5.3
 *
 * @category   Core
 * @package    Fwk\Core
 * @subpackage Components
 * @author     Julien Ballestracci <[email protected]>
 * @copyright  2011-2014 Julien Ballestracci <[email protected]>
 * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
 * @link       http://www.phpfwk.com
 */
namespace Fwk\Core\Components\ViewHelper;

use Fwk\Core\Context;
use Fwk\Core\Application;

/**
 * This is the View Helper
 *
 * @category   Utilities
 * @package    Fwk\Core
 * @subpackage Components
 * @author     Julien Ballestracci <[email protected]>
 * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
 * @link       http://www.phpfwk.com
 */
class ViewHelperService
{
    /**
     * Name of the property where the ViewHelper should be placed
     */
    const DEFAULT_PROP_NAME = '_helper';

    /**
     * @var array
     */
    protected $helpers = array();

    /**
     * Should the viewHelper fail silently or throw exceptions?
     *
     * @var boolean
     */
    private $throwExceptions = true;

    /**
     * The current context
     *
     * @var Context
     */
    protected $context;
    
    /**
     * Property of the ViewHelperService in Action's data
     * 
     * @var string
     */
    protected $propName = self::DEFAULT_PROP_NAME;

    /**
     * The running Application
     * 
     * @var Application
     */
    protected $application;
    
    /**
     * Constructor
     * 
     * @param string  $propName        Name of the ViewHelperService property
     * @param boolean $throwExceptions Should the Service throw exceptions or fail
     * silently
     * 
     * @return void

     */
    public function __construct($propName = self::DEFAULT_PROP_NAME, 
        $throwExceptions = true
    ) {
        $this->propName         = $propName;
        $this->throwExceptions  = $throwExceptions;
    }

    /**
     *
     * @param string $name
     * @param ViewHelper $helper
     *
     * @return ViewHelperService
     */
    public function add($name, ViewHelper $helper)
    {
        $this->helpers[strtolower($name)] = $helper;
        $helper->setViewHelperService($this);

        return $this;
    }

    /**
     *
     * @param array $helpers
     *
     * @return ViewHelperService
     */
    public function addAll(array $helpers)
    {
        foreach ($helpers as $key => $helper) {
            $this->add($key, $helper);
        }

        return $this;
    }

    /**
     *
     * @param string $helperName
     *
     * @return ViewHelperService
     * @throws Exception if helper not registered
     */
    public function remove($helperName)
    {
        if (!isset($this->helpers[$helperName])) {
            throw new Exception(sprintf("Unregistered helper '%s'", $helperName));
        }
        
        unset($this->helpers[strtolower($helperName)]);

        return $this;
    }

    /**
     *
     * @param string $name
     *
     * @return ViewHelper
     * @throws Exception if helper not registered
     */
    public function helper($name)
    {
        $name = strtolower($name);
        if (!isset($this->helpers[$name])) {
            throw new Exception(sprintf("Unregistered helper '%s'", $name));
        }

        return $this->helpers[$name];
    }

    /**
     *
     * @param boolean $bool
     *
     * @return ViewHelper

     */
    public function throwExceptions($bool)
    {
        $this->throwExceptions = (bool)$bool;

        return $this;
    }

    /**
     * Tells if the service throws exceptions or fail silently
     * 
     * @return boolean
     */
    public function isThrowExceptions()
    {
        return $this->throwExceptions;
    }
    
    /**
     *
     * @param string $name
     * @param mixed $arguments
     *
     * @return mixed
     * @throws Exception (if invalid callback && throwExceptions = true)
     */
    public function __call($name, $arguments)
    {
        try {
            $helper = $this->helper($name);
        } catch(Exception $exc) {
            if ($this->throwExceptions) {
                throw $exc;
            }

            return false;
        }

        $result = false;
        try {
            $result = $helper->execute($arguments);
        } catch(\Exception $exp) {
            if ($this->throwExceptions) {
                throw new Exception(
                    'ViewHelper '. get_class($helper) .' execution failed', 
                    $exp->getCode(), 
                    $exp
                );
            }
        }
        
        return $result;
    }

    /**
     *
     * @param Context $context
     *
     * @return ViewHelper

     */
    public function setContext(Context $context)
    {
        $this->context = $context;

        return $this;
    }

    /**
     *
     * @return Context
     */
    public function getContext()
    {
        return $this->context;
    }
    
    public function getPropName()
    {
        return $this->propName;
    }

    /**
     * 
     * @param string $propName
     * 
     * @return ViewHelperService
     */
    public function setPropName($propName)
    {
        $this->propName = $propName;
        
        return $this;
    }
    
    /**
     * 
     * @return Application
     */
    public function getApplication()
    {
        return $this->application;
    }

    /**
     * 
     * @param Application $application
     * 
     * @return ViewHelperService
     */
    public function setApplication(Application $application)
    {
        $this->application = $application;
        
        return $this;
    }


}

1		<?php
2		/**
3		* Fwk
4		*
5		* Copyright (c) 2011-2014, Julien Ballestracci <[email protected]>.
6		* All rights reserved.
7		*
8		* For the full copyright and license information, please view the LICENSE
9		* file that was distributed with this source code.
10		*
11		* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
12		* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
13		* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
14		* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
15		* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
16		* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
17		* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
18		* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
19		* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
20		* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
21		* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
22		* POSSIBILITY OF SUCH DAMAGE.
23		*
24		* PHP Version 5.3
25		*
26		* @category Core
27		* @package Fwk\Core
28		* @subpackage Components
29		* @author Julien Ballestracci <[email protected]>
30		* @copyright 2011-2014 Julien Ballestracci <[email protected]>
31		* @license http://www.opensource.org/licenses/bsd-license.php BSD License
32		* @link http://www.phpfwk.com
33		*/
34		namespace Fwk\Core\Components\ViewHelper;
35
36		use Fwk\Core\Context;
37		use Fwk\Core\Application;
38
39		/**
40		* This is the View Helper
41		*
42		* @category Utilities
43		* @package Fwk\Core
44		* @subpackage Components
45		* @author Julien Ballestracci <[email protected]>
46		* @license http://www.opensource.org/licenses/bsd-license.php BSD License
47		* @link http://www.phpfwk.com
48		*/
49		class ViewHelperService
50		{
51		/**
52		* Name of the property where the ViewHelper should be placed
53		*/
54		const DEFAULT_PROP_NAME = '_helper';
55
56		/**
57		* @var array
58		*/
59		protected $helpers = array();
60
61		/**
62		* Should the viewHelper fail silently or throw exceptions?
63		*
64		* @var boolean
65		*/
66		private $throwExceptions = true;
67
68		/**
69		* The current context
70		*
71		* @var Context
72		*/
73		protected $context;
74
75		/**
76		* Property of the ViewHelperService in Action's data
77		*
78		* @var string
79		*/
80		protected $propName = self::DEFAULT_PROP_NAME;
81
82		/**
83		* The running Application
84		*
85		* @var Application
86		*/
87		protected $application;
88
89		/**
90		* Constructor
91		*
92		* @param string $propName Name of the ViewHelperService property
93		* @param boolean $throwExceptions Should the Service throw exceptions or fail
94		* silently
95		*
96		* @return void
		0 ignored issues – show Comprehensibility Best Practice introduced 2016-06-03 12:37 UTC by Report Bug Copy Issue Report Adding a `@return` annotation to constructors is generally not recommended as a constructor does not have a meaningful return value. Adding a `@return` annotation to a constructor is not recommended, since a constructor does not have a meaningful return value. Please refer to the PHP core documentation on constructors. Loading history...
97		*/
98	12	public function __construct($propName = self::DEFAULT_PROP_NAME,
99		$throwExceptions = true
100		) {
101	12	$this->propName = $propName;
102	12	$this->throwExceptions = $throwExceptions;
103	12	}
104
105		/**
106		*
107		* @param string $name
108		* @param ViewHelper $helper
109		*
110		* @return ViewHelperService
111		*/
112	6	public function add($name, ViewHelper $helper)
113		{
114	6	$this->helpers[strtolower($name)] = $helper;
115	6	$helper->setViewHelperService($this);
116
117	6	return $this;
118		}
119
120		/**
121		*
122		* @param array $helpers
123		*
124		* @return ViewHelperService
125		*/
126	1	public function addAll(array $helpers)
127		{
128	1	foreach ($helpers as $key => $helper) {
129	1	$this->add($key, $helper);
130	1	}
131
132	1	return $this;
133		}
134
135		/**
136		*
137		* @param string $helperName
138		*
139		* @return ViewHelperService
140		* @throws Exception if helper not registered
141		*/
142	1	public function remove($helperName)
143		{
144	1	if (!isset($this->helpers[$helperName])) {
145	1	throw new Exception(sprintf("Unregistered helper '%s'", $helperName));
146		}
147
148	1	unset($this->helpers[strtolower($helperName)]);
149
150	1	return $this;
151		}
152
153		/**
154		*
155		* @param string $name
156		*
157		* @return ViewHelper
158		* @throws Exception if helper not registered
159		*/
160	8	public function helper($name)
161		{
162	8	$name = strtolower($name);
163	8	if (!isset($this->helpers[$name])) {
164	3	throw new Exception(sprintf("Unregistered helper '%s'", $name));
165		}
166
167	5	return $this->helpers[$name];
168		}
169
170		/**
171		*
172		* @param boolean $bool
173		*
174		* @return ViewHelper
		0 ignored issues – show Documentation introduced 2016-06-03 12:37 UTC by Report Bug Copy Issue Report Should the return type not be `ViewHelperService`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
175		*/
176	3	public function throwExceptions($bool)
177		{
178	3	$this->throwExceptions = (bool)$bool;
179
180	3	return $this;
181		}
182
183		/**
184		* Tells if the service throws exceptions or fail silently
185		*
186		* @return boolean
187		*/
188	1	public function isThrowExceptions()
189		{
190	1	return $this->throwExceptions;
191		}
192
193		/**
194		*
195		* @param string $name
196		* @param mixed $arguments
197		*
198		* @return mixed
199		* @throws Exception (if invalid callback && throwExceptions = true)
200		*/
201	5	public function __call($name, $arguments)
202		{
203		try {
204	5	$helper = $this->helper($name);
205	5	} catch(Exception $exc) {
206	2	if ($this->throwExceptions) {
207	1	throw $exc;
208		}
209
210	1	return false;
211		}
212
213	3	$result = false;
214		try {
215	3	$result = $helper->execute($arguments);
216	3	} catch(\Exception $exp) {
217	2	if ($this->throwExceptions) {
218	1	throw new Exception(
219	1	'ViewHelper '. get_class($helper) .' execution failed',
220	1	$exp->getCode(),
221		$exp
222	1	);
223		}
224		}
225
226	2	return $result;
227		}
228
229		/**
230		*
231		* @param Context $context
232		*
233		* @return ViewHelper
		0 ignored issues – show Documentation introduced 2016-06-03 12:37 UTC by Report Bug Copy Issue Report Should the return type not be `ViewHelperService`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
234		*/
235	3	public function setContext(Context $context)
236		{
237	3	$this->context = $context;
238
239	3	return $this;
240		}
241
242		/**
243		*
244		* @return Context
245		*/
246		public function getContext()
247		{
248		return $this->context;
249		}
250
251	4	public function getPropName()
252		{
253	4	return $this->propName;
254		}
255
256		/**
257		*
258		* @param string $propName
259		*
260		* @return ViewHelperService
261		*/
262	1	public function setPropName($propName)
263		{
264	1	$this->propName = $propName;
265
266	1	return $this;
267		}
268
269		/**
270		*
271		* @return Application
272		*/
273		public function getApplication()
274		{
275		return $this->application;
276		}
277
278		/**
279		*
280		* @param Application $application
281		*
282		* @return ViewHelperService
283		*/
284	3	public function setApplication(Application $application)
285		{
286	3	$this->application = $application;
287
288	3	return $this;
289		}
290
291
292		}

fwk / Core

ViewHelperService::add() A last analyzed 2016-06-03 12:37 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

ViewHelperService::add() A
last analyzed 2016-06-03 12:37 UTC