Controller::getResponseKeyValue() - Code Metrics - Erdiko/core - Measure and Improve Code Quality continuously with Scrutinizer

Controller::getResponseKeyValue() A
last analyzed 2017-04-21 07:13 UTC

↳ Parent: Controller

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	4
rs	10
cc	1
eloc	2
nc	1
nop	1

<?php
/**
 * Controller
 * Base request handler, All controllers should be a child this class
 * or one of the subclasses (e.g. AjaxController or ApiController).
 *
 * @package     erdiko/core
 * @copyright   2012-2017 Arroyo Labs, Inc. http://www.arroyolabs.com
 * @author      John Arroyo <[email protected]>
 */
namespace erdiko\core;


class Controller
{
    /** Response */
    protected $_response;
    /** Webroot */
    protected $_webroot;
    /** Theme name */
    protected $_themeName = null;
    /** Request URI */
    protected $_pathInfo = null;
    /** Title (body title) */
    protected $_title = null;
    
    /**
     * Constructor
     */
    public function __construct()
    {
        $this->_webroot = ERDIKO_ROOT;
        $this->_response = new \erdiko\core\Response;

        if ($this->_themeName != null) {
            $this->_response->setThemeName($this->_themeName);
        }
    }

    /**
     * Before action hook
     * Anything here gets called immediately BEFORE the Action method runs.
     */
    public function _before()
    {
        // Set up the theme object
        $this->prepareTheme();
    }

    /**
     * After action hook
     * Anything here gets called immediately AFTER the Action method runs.
     */
    public function _after()
    {
        // do something...
    }

    /**
     * Get action
     *
     * @param mixed $var
     * @return mixed
     */
    public function get($var = null)
    {
        if (!empty($var)) {
        // load action based off of naming conventions
            return $this->_autoaction($var, 'get');

        } else {
            return $this->getIndex();

        }
    }

    /**
     * Put action
     *
     * @param mixed $var
     * @return mixed
     */
    public function put($var = null)
    {
        if (!empty($var)) {
        // load action based off of naming conventions
            return $this->_autoaction($var, 'put');

        } else {
            return $this->getIndex();

        }
    }

    /**
     * Post action
     *
     * @param mixed $var
     * @return mixed
     */
    public function post($var = null)
    {
        if (!empty($var)) {
        // load action based off of naming conventions
            return $this->_autoaction($var, 'post');

        } else {
            return $this->getIndex();

        }
    }

    /**
     * Delete action
     *
     * @param mixed $var
     * @return mixed
     */
    public function delete($var = null)
    {
        if (!empty($var)) {
        // load action based off of naming conventions
            return $this->_autoaction($var, 'delete');

        } else {
            return $this->getIndex();

        }
    }

    /**
     * Set Path Info (Requested URI)
     */
    public function setPathInfo($pathInfo)
    {
        $this->_pathInfo = $pathInfo;
    }

    /**
     * Prepare theme
     */
    public function prepareTheme()
    {
        $this->getResponse()->setTheme(new \erdiko\core\Theme($this->getThemeName()));
    }

    /**
     * Set the theme name in the response object
     * 
     * @param string $name, the name/id of the theme
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     */
    public function setThemeName($name)
    {
        $this->getResponse()->setThemeName($name);
    }

    /**
     * Set the theme name in both the response and the theme objects
     * 
     * @param string $name, the name/id of the theme
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     */
    public function setTheme($name)
    {
        $this->getResponse()->setThemeName($name);
        $this->getResponse()->getTheme()->setName($name);
    }

    /**
     * Get the theme name
     *
     * @return string $name
     */
    public function getThemeName()
    {
        return $this->getResponse()->getThemeName();
    }

    /**
     * Set the theme template used to render the page
     * @param string $template
     */
    public function setThemeTemplate($template)
    {
        $this->getResponse()->setThemeTemplate($template);
    }

    /**
     * Get Response object
     *
     * @return ResponseObject
     */
    public function getResponse()
    {
        return $this->_response;
    }

    /**
     * Send
     */
    final public function send()
    {
        echo $this->getResponse()->render();
    }

    /**
     * Set Response key/value data
     * formerly called, setResponseDataValue()
     *
     * @param string $key
     * @param mixed $value
     */
    public function setResponseKeyValue($key, $value)
    {
        $this->getResponse()->setKeyValue($key, $value);
    }

    /**
     * Get Response data value
     *
     * @param string $key
     */
    public function getResponseKeyValue($key)
    {
        return $this->getResponse()->getKeyValue($key);
    }

    /**
     * Add page title text to current page
     *
     * @param string $title
     */
    public function setPageTitle($title)
    {
        $this->getResponse()->getTheme()->setPageTitle($title);
    }

    /**
     * Set page content title to be themed in the view
     *
     * @param string $title
     */
    public function setBodyTitle($title)
    {
        $this->getResponse()->getTheme()->setBodyTitle($title);
        $this->_title = $title;
    }

    /**
     * Get page content title to be themed in a layout or view
     *
     * @param string $title
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     */
    public function getBodyTitle()
    {
        return $this->getResponse()->getTheme()->getBodyTitle();
    }

    /**
     * Set both the title (header) and page title (body) at the same time
     * @param string $title
     */
    public function setTitle($title)
    {
        $this->setBodyTitle($title);
        $this->setPageTitle($title);
    }

    /**
     * Set both the title (header) and page title (body) at the same time
     * @param string $title
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     */
    public function getTitle()
    {
        return $this->_title;
    }

    /**
     * Set the response content
     *
     * @param string $content
     */
    public function setContent($content)
    {
        $this->getResponse()->setContent($content);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    /**
     * Add/append html text to the response content
     *
     * @param string @content
     */
    public function appendContent($content)
    {
        $this->getResponse()->appendContent($content);
    }

    /**
     *  Autoaction
     *
     * @param string $var
     * @param string $httpMethod
     */
    protected function _autoaction($var, $httpMethod = 'get')
    {
        $method = $this->urlToActionName($var, $httpMethod);
        if (method_exists($this, $method)) {
            return $this->$method();
        } else {
            ToroHook::fire('404', array(
                "error" => "Controller ".get_class($this)." does not contain $method action",
                "path_info" => $this->_pathInfo ));
        }
    }

    /**
     * Call back for preg_replace in urlToActionName
     */
    private function _replaceActionName($parts)
    {
        return strtoupper($parts[1]);
    }

    /**
     * Modify the action name coming from the URL into proper action name
     * @param string $name: The raw controller action name
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @return string
     */
    public function urlToActionName($name, $httpMethod)
    {
        // convert to camelcase if there are dashes
        $function = preg_replace_callback("/\-(.)/", array($this, '_replaceActionName'), $name);

        return $httpMethod.ucfirst($function);
    }
    
    /**
     * Load a view with the given data
     *
     * @param string $viewName
     * @param array $data
     * @return string $html, view contents
     */
    public function getView($viewName, $data = null, $templateRootFolder = null)

    {
        $view = new \erdiko\core\View($viewName, $data);

        if ($templateRootFolder != null) {
            $view->setTemplateRootFolder($templateRootFolder);
        }

        return $view;
    }

    /**
     * Add a view from the current theme with the given data
     *
     * @param mixed $view, can be a string (view name) or object (view object)
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @param array $data
     * @return string $html, view contents
     */
    public function addView($view, $data = null)
    {
        if(!is_object($view))
            $view = new \erdiko\core\View($view, $data);
        if($data != null)
            $view->setData($data);
        
        $this->appendContent($view->toHtml());
    }

    /**
     * Load a layout with the given data
     *
     * @param string $layoutName
     * @param array $data
     * @return string $html, layout contents
     */
    public function getLayout($layoutName, $data = null, $templateRootFolder = null)
    {
        $layout = new \erdiko\core\Layout($layoutName, $data, $this->getThemeName());
        $layout->setTitle($this->getBodyTitle());

        if ($templateRootFolder != null) {
            $layout->setViewRootFolder($templateRootFolder);
            $layout->setTemplateRootFolder($templateRootFolder);
        }

        return  $layout->toHtml();
    }

    /**
     * Redirect to another url
     * @param string $url
     */
    public function redirect($url)
    {
        header("Location: $url");
        exit;

    }

    /**
     * Add Meta tags to the page
     *
     * @param string $name, html meta name (e.g. 'description' or 'keywords')
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @param string $content
     */
    public function addMeta($name, $content)
    {
        $this->getResponse()->getTheme()->addMeta($name, $content);
    }

    /**
     * Set multiple meta fields at once
     * @param array $meta
     */
    public function setMeta($meta)
    {
        foreach($meta as $name => $content)
            $this->getResponse()->getTheme()->addMeta($name, $content);
    }

    /**
     * Add Css includes to the page
     *
     * @param string $name
     * @param string $file
     * @param int $order
     * @param int $active
     */
    public function addCss($name, $file, $order = 10, $active = 1)
    {
       $this->getResponse()
            ->getTheme()
            ->addCss($name, $file, $order,$active);
    }

    /**
     * Add Css includes to the page
     *
     * @param string $name
     * @param string $file
     * @param int $order
     * @param int $active
     */
    public function addJs($name, $file, $order = 10, $active = 1)
    {
        $this->getResponse()
            ->getTheme()
            ->addJs($name, $file, $order,$active);
    }
    
    /**
     * Magic method experiments
     */
      
    /**
     * Get a value
     */
    public function __get($key)
    {
        return $this->getResponseKeyValue($key);
    }
  
    /**
     * Set a value
     */
    public function __set($key, $value)
    {
        return $this->setResponseKeyValue($key, $value);
    }


    /**
     *
     *
     * Code below is deprecated, do not use
     * @todo Should be deleted, refactored or moved!
     *
     *
     */


    /**
     * Add phpToJs variable to be set on the current page
     *
     * @param mixed $key
     * @param mixed $value
     */
    public function addPhpToJs($key, $value)
    {
        if (is_bool($value)) {
            $value = $value ? "true" : "false";
        } elseif (is_string($value)) {
            $value = "\"$value\"";
        } elseif (is_array($value)) {
            $value = json_encode($value);
        } elseif (is_object($value) && method_exists($value, "toArray")) {
            $value = json_encode($value->toArray());
        } else {
            throw new \Exception("Can not translate a parameter from PHP to JS\n".print_r($value, true));
        }

        $this->_themeExtras['phpToJs'][$key] = $value;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
    }
}


1		<?php
2		/**
3		* Controller
4		* Base request handler, All controllers should be a child this class
5		* or one of the subclasses (e.g. AjaxController or ApiController).
6		*
7		* @package erdiko/core
8		* @copyright 2012-2017 Arroyo Labs, Inc. http://www.arroyolabs.com
9		* @author John Arroyo <[email protected]>
10		*/
11		namespace erdiko\core;
12
13
14		class Controller
15		{
16		/** Response */
17		protected $_response;
18		/** Webroot */
19		protected $_webroot;
20		/** Theme name */
21		protected $_themeName = null;
22		/** Request URI */
23		protected $_pathInfo = null;
24		/** Title (body title) */
25		protected $_title = null;
26
27		/**
28		* Constructor
29		*/
30		public function __construct()
31		{
32		$this->_webroot = ERDIKO_ROOT;
33		$this->_response = new \erdiko\core\Response;
34
35		if ($this->_themeName != null) {
36		$this->_response->setThemeName($this->_themeName);
37		}
38		}
39
40		/**
41		* Before action hook
42		* Anything here gets called immediately BEFORE the Action method runs.
43		*/
44		public function _before()
45		{
46		// Set up the theme object
47		$this->prepareTheme();
48		}
49
50		/**
51		* After action hook
52		* Anything here gets called immediately AFTER the Action method runs.
53		*/
54		public function _after()
55		{
56		// do something...
57		}
58
59		/**
60		* Get action
61		*
62		* @param mixed $var
63		* @return mixed
64		*/
65		public function get($var = null)
66		{
67		if (!empty($var)) {
68		// load action based off of naming conventions
69		return $this->_autoaction($var, 'get');
70
71		} else {
72		return $this->getIndex();
		0 ignored issues – show Bug introduced 2017-01-06 19:47 UTC by Report Bug Copy Issue Report The method `getIndex()` does not seem to exist on `object<erdiko\core\Controller>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
73		}
74		}
75
76		/**
77		* Put action
78		*
79		* @param mixed $var
80		* @return mixed
81		*/
82		public function put($var = null)
83		{
84		if (!empty($var)) {
85		// load action based off of naming conventions
86		return $this->_autoaction($var, 'put');
87
88		} else {
89		return $this->getIndex();
		0 ignored issues – show Bug introduced 2017-01-06 19:47 UTC by Report Bug Copy Issue Report The method `getIndex()` does not seem to exist on `object<erdiko\core\Controller>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
90		}
91		}
92
93		/**
94		* Post action
95		*
96		* @param mixed $var
97		* @return mixed
98		*/
99		public function post($var = null)
100		{
101		if (!empty($var)) {
102		// load action based off of naming conventions
103		return $this->_autoaction($var, 'post');
104
105		} else {
106		return $this->getIndex();
		0 ignored issues – show Bug introduced 2017-01-06 19:47 UTC by Report Bug Copy Issue Report The method `getIndex()` does not seem to exist on `object<erdiko\core\Controller>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
107		}
108		}
109
110		/**
111		* Delete action
112		*
113		* @param mixed $var
114		* @return mixed
115		*/
116		public function delete($var = null)
117		{
118		if (!empty($var)) {
119		// load action based off of naming conventions
120		return $this->_autoaction($var, 'delete');
121
122		} else {
123		return $this->getIndex();
		0 ignored issues – show Bug introduced 2017-01-06 19:47 UTC by Report Bug Copy Issue Report The method `getIndex()` does not seem to exist on `object<erdiko\core\Controller>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
124		}
125		}
126
127		/**
128		* Set Path Info (Requested URI)
129		*/
130		public function setPathInfo($pathInfo)
131		{
132		$this->_pathInfo = $pathInfo;
133		}
134
135		/**
136		* Prepare theme
137		*/
138		public function prepareTheme()
139		{
140		$this->getResponse()->setTheme(new \erdiko\core\Theme($this->getThemeName()));
141		}
142
143		/**
144		* Set the theme name in the response object
145		*
146		* @param string $name, the name/id of the theme
		0 ignored issues – show Bug introduced 2017-01-06 19:47 UTC by Report Bug Copy Issue Report There is no parameter named `$name,`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
147		*/
148		public function setThemeName($name)
149		{
150		$this->getResponse()->setThemeName($name);
151		}
152
153		/**
154		* Set the theme name in both the response and the theme objects
155		*
156		* @param string $name, the name/id of the theme
		0 ignored issues – show Bug introduced 2017-01-06 19:47 UTC by Report Bug Copy Issue Report There is no parameter named `$name,`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
157		*/
158		public function setTheme($name)
159		{
160		$this->getResponse()->setThemeName($name);
161		$this->getResponse()->getTheme()->setName($name);
162		}
163
164		/**
165		* Get the theme name
166		*
167		* @return string $name
168		*/
169		public function getThemeName()
170		{
171		return $this->getResponse()->getThemeName();
172		}
173
174		/**
175		* Set the theme template used to render the page
176		* @param string $template
177		*/
178		public function setThemeTemplate($template)
179		{
180		$this->getResponse()->setThemeTemplate($template);
181		}
182
183		/**
184		* Get Response object
185		*
186		* @return ResponseObject
187		*/
188		public function getResponse()
189		{
190		return $this->_response;
191		}
192
193		/**
194		* Send
195		*/
196		final public function send()
197		{
198		echo $this->getResponse()->render();
199		}
200
201		/**
202		* Set Response key/value data
203		* formerly called, setResponseDataValue()
204		*
205		* @param string $key
206		* @param mixed $value
207		*/
208		public function setResponseKeyValue($key, $value)
209		{
210		$this->getResponse()->setKeyValue($key, $value);
211		}
212
213		/**
214		* Get Response data value
215		*
216		* @param string $key
217		*/
218		public function getResponseKeyValue($key)
219		{
220		return $this->getResponse()->getKeyValue($key);
221		}
222
223		/**
224		* Add page title text to current page
225		*
226		* @param string $title
227		*/
228		public function setPageTitle($title)
229		{
230		$this->getResponse()->getTheme()->setPageTitle($title);
231		}
232
233		/**
234		* Set page content title to be themed in the view
235		*
236		* @param string $title
237		*/
238		public function setBodyTitle($title)
239		{
240		$this->getResponse()->getTheme()->setBodyTitle($title);
241		$this->_title = $title;
242		}
243
244		/**
245		* Get page content title to be themed in a layout or view
246		*
247		* @param string $title
		0 ignored issues – show Bug introduced 2017-01-06 19:47 UTC by Report Bug Copy Issue Report There is no parameter named `$title`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
248		*/
249		public function getBodyTitle()
250		{
251		return $this->getResponse()->getTheme()->getBodyTitle();
252		}
253
254		/**
255		* Set both the title (header) and page title (body) at the same time
256		* @param string $title
257		*/
258		public function setTitle($title)
259		{
260		$this->setBodyTitle($title);
261		$this->setPageTitle($title);
262		}
263
264		/**
265		* Set both the title (header) and page title (body) at the same time
266		* @param string $title
		0 ignored issues – show Bug introduced 2017-01-06 19:47 UTC by Report Bug Copy Issue Report There is no parameter named `$title`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
267		*/
268		public function getTitle()
269		{
270		return $this->_title;
271		}
272
273		/**
274		* Set the response content
275		*
276		* @param string $content
277		*/
278		public function setContent($content)
279		{
280		$this->getResponse()->setContent($content);
		0 ignored issues – show Documentation introduced 2017-01-06 19:47 UTC by Report Bug Copy Issue Report `$content` is of type `string`, but the function expects a `object<erdiko\core\Container>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
281		}
282
283		/**
284		* Add/append html text to the response content
285		*
286		* @param string @content
287		*/
288		public function appendContent($content)
289		{
290		$this->getResponse()->appendContent($content);
291		}
292
293		/**
294		* Autoaction
295		*
296		* @param string $var
297		* @param string $httpMethod
298		*/
299		protected function _autoaction($var, $httpMethod = 'get')
300		{
301		$method = $this->urlToActionName($var, $httpMethod);
302		if (method_exists($this, $method)) {
303		return $this->$method();
304		} else {
305		ToroHook::fire('404', array(
306		"error" => "Controller ".get_class($this)." does not contain $method action",
307		"path_info" => $this->_pathInfo ));
308		}
309		}
310
311		/**
312		* Call back for preg_replace in urlToActionName
313		*/
314		private function _replaceActionName($parts)
315		{
316		return strtoupper($parts[1]);
317		}
318
319		/**
320		* Modify the action name coming from the URL into proper action name
321		* @param string $name: The raw controller action name
		0 ignored issues – show Bug introduced 2017-01-06 19:47 UTC by Report Bug Copy Issue Report There is no parameter named `$name:`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
322		* @return string
323		*/
324		public function urlToActionName($name, $httpMethod)
325		{
326		// convert to camelcase if there are dashes
327		$function = preg_replace_callback("/\-(.)/", array($this, '_replaceActionName'), $name);
328
329		return $httpMethod.ucfirst($function);
330		}
331
332		/**
333		* Load a view with the given data
334		*
335		* @param string $viewName
336		* @param array $data
337		* @return string $html, view contents
338		*/
339	View Code Duplication	public function getView($viewName, $data = null, $templateRootFolder = null)
		0 ignored issues – show Duplication introduced 2017-01-06 19:47 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
340		{
341		$view = new \erdiko\core\View($viewName, $data);
342
343		if ($templateRootFolder != null) {
344		$view->setTemplateRootFolder($templateRootFolder);
345		}
346
347		return $view;
348		}
349
350		/**
351		* Add a view from the current theme with the given data
352		*
353		* @param mixed $view, can be a string (view name) or object (view object)
		0 ignored issues – show Bug introduced 2017-01-06 19:47 UTC by Report Bug Copy Issue Report There is no parameter named `$view,`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
354		* @param array $data
355		* @return string $html, view contents
356		*/
357		public function addView($view, $data = null)
358		{
359		if(!is_object($view))
360		$view = new \erdiko\core\View($view, $data);
361		if($data != null)
362		$view->setData($data);
363
364		$this->appendContent($view->toHtml());
365		}
366
367		/**
368		* Load a layout with the given data
369		*
370		* @param string $layoutName
371		* @param array $data
372		* @return string $html, layout contents
373		*/
374		public function getLayout($layoutName, $data = null, $templateRootFolder = null)
375		{
376		$layout = new \erdiko\core\Layout($layoutName, $data, $this->getThemeName());
377		$layout->setTitle($this->getBodyTitle());
378
379		if ($templateRootFolder != null) {
380		$layout->setViewRootFolder($templateRootFolder);
381		$layout->setTemplateRootFolder($templateRootFolder);
382		}
383
384		return $layout->toHtml();
385		}
386
387		/**
388		* Redirect to another url
389		* @param string $url
390		*/
391		public function redirect($url)
392		{
393		header("Location: $url");
394		exit;
		0 ignored issues – show Coding Style Compatibility introduced 2017-01-06 19:47 UTC by Report Bug Copy Issue Report The method `redirect()` contains an exit expression. An exit expression should only be used in rare cases. For example, if you write a short command line script. In most cases however, using an `exit` expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage. Loading history...
395		}
396
397		/**
398		* Add Meta tags to the page
399		*
400		* @param string $name, html meta name (e.g. 'description' or 'keywords')
		0 ignored issues – show Bug introduced 2017-01-06 19:47 UTC by Report Bug Copy Issue Report There is no parameter named `$name,`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
401		* @param string $content
402		*/
403		public function addMeta($name, $content)
404		{
405		$this->getResponse()->getTheme()->addMeta($name, $content);
406		}
407
408		/**
409		* Set multiple meta fields at once
410		* @param array $meta
411		*/
412		public function setMeta($meta)
413		{
414		foreach($meta as $name => $content)
415		$this->getResponse()->getTheme()->addMeta($name, $content);
416		}
417
418		/**
419		* Add Css includes to the page
420		*
421		* @param string $name
422		* @param string $file
423		* @param int $order
424		* @param int $active
425		*/
426		public function addCss($name, $file, $order = 10, $active = 1)
427		{
428		$this->getResponse()
429		->getTheme()
430		->addCss($name, $file, $order,$active);
431		}
432
433		/**
434		* Add Css includes to the page
435		*
436		* @param string $name
437		* @param string $file
438		* @param int $order
439		* @param int $active
440		*/
441		public function addJs($name, $file, $order = 10, $active = 1)
442		{
443		$this->getResponse()
444		->getTheme()
445		->addJs($name, $file, $order,$active);
446		}
447
448		/**
449		* Magic method experiments
450		*/
451
452		/**
453		* Get a value
454		*/
455		public function __get($key)
456		{
457		return $this->getResponseKeyValue($key);
458		}
459
460		/**
461		* Set a value
462		*/
463		public function __set($key, $value)
464		{
465		return $this->setResponseKeyValue($key, $value);
466		}
467
468
469		/**
470		*
471		*
472		* Code below is deprecated, do not use
473		* @todo Should be deleted, refactored or moved!
474		*
475		*
476		*/
477
478
479		/**
480		* Add phpToJs variable to be set on the current page
481		*
482		* @param mixed $key
483		* @param mixed $value
484		*/
485		public function addPhpToJs($key, $value)
486		{
487		if (is_bool($value)) {
488		$value = $value ? "true" : "false";
489		} elseif (is_string($value)) {
490		$value = "\"$value\"";
491		} elseif (is_array($value)) {
492		$value = json_encode($value);
493		} elseif (is_object($value) && method_exists($value, "toArray")) {
494		$value = json_encode($value->toArray());
495		} else {
496		throw new \Exception("Can not translate a parameter from PHP to JS\n".print_r($value, true));
497		}
498
499		$this->_themeExtras['phpToJs'][$key] = $value;
		0 ignored issues – show Documentation introduced 2017-01-06 19:47 UTC by Report Bug Copy Issue Report The property `_themeExtras` does not exist on `object<erdiko\core\Controller>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
500		}
501		}
502

Erdiko / core

Controller::getResponseKeyValue() A last analyzed 2017-04-21 07:13 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Controller::getResponseKeyValue() A
last analyzed 2017-04-21 07:13 UTC