AbstractController::setModule() - Code Metrics - Inspection of "Improve MVC approach and add some test" - Pleets/dronephp - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 40eec0...6215ec )

by Darío

created 2019-04-04 16:42 UTC

AbstractController::setModule() A

↳ Parent: AbstractController

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php
/**
 * DronePHP (http://www.dronephp.com)
 *
 * @link      http://github.com/Pleets/DronePHP
 * @copyright Copyright (c) 2016-2018 Pleets. (http://www.pleets.org)
 * @license   http://www.dronephp.com/license
 * @author    Darío Rivera <[email protected]>
 */

namespace Drone\Mvc;

use Drone\Mvc\Exception;

/**
 * AbstractionController class
 *
 * This class manages the interaction between models and views
 */
abstract class AbstractController
{
    use \Drone\Util\ParamTrait;

    /**
     * Current module instance
     *
     * @var AbstractModule
     */
    private $module;

    /**
     * Current method
     *
     * @var string
     */
    private $method = null;

    /**
     * Layout name
     *
     * @var string
     */
    private $layout = "default";

    /**
     * Terminal mode
     *
     * @var boolean
     */
    private $terminal = true;

    /**
     * Indicates if the controller must show the views
     *
     * @var boolean
     */
    private $showView = true;

    /**
     * Returns the current module instance
     *
     * @return AbstractModule
     */
    public function getModule()
    {
        return $this->module;
    }

    /**
     * Returns the current method
     *
     * @return string
     */
    public function getMethod()
    {
        return $this->method;
    }

    /**
     * Returns the mode of visualization
     *
     * @return boolean
     */
    public function getTerminal()
    {
        return $this->terminal;
    }

    /**
     * Returns the mode of viewing
     *
     * @return boolean
     */
    public function getShowView()
    {
        return $this->showView;
    }

    /**
     * Returns the current layout
     *
     * @return string
     */
    public function getLayout()
    {
        return $this->layout;
    }

    /**
     * Sets the terminal mode
     *
     * @param boolean $terminal
     *
     * @return null
     */
    public function setTerminal($terminal = true)
    {
        $this->terminal = $terminal;
    }

    /**
     * Sets the showView parameter
     *
     * @param boolean $show
     *
     * @return null
     */
    public function setShowView($show = true)
    {
        $this->showView = $show;
    }

    /**
     * Sets layout name
     *
     * @param string $layout
     *
     * @return null
     */
    public function setLayout($layout)
    {
        $this->layout = $layout;
    }

    /**
     * Sets module instance
     *
     * @param AbstractModule $module
     *
     * @return null
     */
    public function setModule(AbstractModule $module)
    {
        $this->module = $module;
    }

    /**
     * Sets the method attribute
     *
     * @param string $method
     *
     * @return null
     */
    public function setMethod($method)
    {
        $this->method = $method;
    }

    /**
     * Executes the controller
     *
     * @return null
     */
    public function execute()
    {
        $method = $this->method;

        if (is_null($method))

            # This error is thrown because of 'setMethod' method has not been executed
            throw new \LogicException("No method has been setted to execute!");

        if (!is_null($this->module) && !$this->module->executionIsAllowed())
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
            throw new Exception\MethodExecutionNotAllowedException("Method execution is not allowed");
        else
        {
            if (method_exists($this, $method))
            {
                $class = __CLASS__;

                $reflection = new \ReflectionMethod($this, $method);

                if (!$reflection->isPublic())
                    throw new Exception\PrivateMethodExecutionException("The method '$method' is not public in the control class '$class'");

                # Get the returned value of the method to send to the view
                $this->params = $this->$method();

                # The only way to manage views is through an AbstractModule
                if (!is_null($this->module))
                {
                    $params = $this->getParams();

                    $layout_params = (count($params) && array_key_exists('::Layout', $params)) ? $params["::Layout"] : [];

                    $layout = new Layout;
                    $layout->setParams($layout_params);
                    $layout->fromController($this);
                }
            }
            else
            {
                $class = __CLASS__;
                throw new Exception\MethodNotFoundException("The method '$method' doesn't exists in the control class '$class'");
            }
        }
    }

    /**
     * Returns the class name
     *
     * @return string
     */
    public static function getClassName()
    {
        return __CLASS__;
    }

    /**
     * Returns $_POST contents
     *
     * @return array
     */
    public function getPost()
    {
        if ($_SERVER['REQUEST_METHOD'] == 'POST' && empty($_POST))
            $_POST = json_decode(file_get_contents('php://input'), true);

        return (array) $_POST;
    }

    /**
     * Returns json contents
     *
     * @throws LogicException
     *
     * @return array
     */
    public function getJson()
    {
        if ($_SERVER['REQUEST_METHOD'] != 'JSON')
            throw new \LogicException("Request method is not JSON");

        $input =  file_get_contents('php://input');
        $array = explode("&", $input);

        $result = [];

        foreach ($array as $value)
        {
            $io = explode("=", $value);
            $result[$io[0]] = $io[1];
        }

        return $result;
    }

    /**
     * Checks if the current request is XmlHttpRequest (AJAX)
     *
     * @return boolean
     */
    public function isXmlHttpRequest()
    {
        # non standard (HTTP_X_REQUESTED_WITH is not a part of PHP)
        if (isset($_SERVER['HTTP_X_REQUESTED_WITH']))
            return true;
        return false;
    }

    /**
     * Checks if the current request is POST
     *
     * @return boolean
     */
    public function isPost()
    {
        if ($_SERVER["REQUEST_METHOD"] == "POST")
            return true;
        return false;
    }

    /**
     * Checks if the current request is GET
     *
     * @return boolean
     */
    public function isGet()
    {
        if ($_SERVER["REQUEST_METHOD"] == "GET")
            return true;
        return false;
    }
}

1			<?php
2			/**
3			* DronePHP (http://www.dronephp.com)
4			*
5			* @link http://github.com/Pleets/DronePHP
6			* @copyright Copyright (c) 2016-2018 Pleets. (http://www.pleets.org)
7			* @license http://www.dronephp.com/license
8			* @author Darío Rivera <[email protected]>
9			*/
10
11			namespace Drone\Mvc;
12
13			use Drone\Mvc\Exception;
14
15			/**
16			* AbstractionController class
17			*
18			* This class manages the interaction between models and views
19			*/
20			abstract class AbstractController
21			{
22			use \Drone\Util\ParamTrait;
23
24			/**
25			* Current module instance
26			*
27			* @var AbstractModule
28			*/
29			private $module;
30
31			/**
32			* Current method
33			*
34			* @var string
35			*/
36			private $method = null;
37
38			/**
39			* Layout name
40			*
41			* @var string
42			*/
43			private $layout = "default";
44
45			/**
46			* Terminal mode
47			*
48			* @var boolean
49			*/
50			private $terminal = true;
51
52			/**
53			* Indicates if the controller must show the views
54			*
55			* @var boolean
56			*/
57			private $showView = true;
58
59			/**
60			* Returns the current module instance
61			*
62			* @return AbstractModule
63			*/
64			public function getModule()
65			{
66			return $this->module;
67			}
68
69			/**
70			* Returns the current method
71			*
72			* @return string
73			*/
74			public function getMethod()
75			{
76			return $this->method;
77			}
78
79			/**
80			* Returns the mode of visualization
81			*
82			* @return boolean
83			*/
84			public function getTerminal()
85			{
86			return $this->terminal;
87			}
88
89			/**
90			* Returns the mode of viewing
91			*
92			* @return boolean
93			*/
94			public function getShowView()
95			{
96			return $this->showView;
97			}
98
99			/**
100			* Returns the current layout
101			*
102			* @return string
103			*/
104			public function getLayout()
105			{
106			return $this->layout;
107			}
108
109			/**
110			* Sets the terminal mode
111			*
112			* @param boolean $terminal
113			*
114			* @return null
115			*/
116			public function setTerminal($terminal = true)
117			{
118			$this->terminal = $terminal;
119			}
120
121			/**
122			* Sets the showView parameter
123			*
124			* @param boolean $show
125			*
126			* @return null
127			*/
128			public function setShowView($show = true)
129			{
130			$this->showView = $show;
131			}
132
133			/**
134			* Sets layout name
135			*
136			* @param string $layout
137			*
138			* @return null
139			*/
140			public function setLayout($layout)
141			{
142			$this->layout = $layout;
143			}
144
145			/**
146			* Sets module instance
147			*
148			* @param AbstractModule $module
149			*
150			* @return null
151			*/
152			public function setModule(AbstractModule $module)
153			{
154			$this->module = $module;
155			}
156
157			/**
158			* Sets the method attribute
159			*
160			* @param string $method
161			*
162			* @return null
163			*/
164			public function setMethod($method)
165			{
166			$this->method = $method;
167			}
168
169			/**
170			* Executes the controller
171			*
172			* @return null
173			*/
174			public function execute()
175			{
176			$method = $this->method;
177
178			if (is_null($method))
			0 ignored issues – show introduced 2019-03-29 20:11 UTC by Report Bug Copy Issue Report The condition `is_null($method)` is always `false`. Loading history...
179			# This error is thrown because of 'setMethod' method has not been executed
180			throw new \LogicException("No method has been setted to execute!");
181
182			if (!is_null($this->module) && !$this->module->executionIsAllowed())
			0 ignored issues – show Bug introduced 2019-04-04 16:44 UTC by Report Bug Copy Issue Report Are you sure the usage of `$this->module->executionIsAllowed()` targeting `Drone\Mvc\AbstractModule::executionIsAllowed()` seems to always return null. This check looks for function or method calls that always return null and whose return value is used. class A { function getObject() { return null; } } $a = new A(); if ($a->getObject()) { The method `getObject()` can return nothing but null, so it makes no sense to use the return value. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
183			throw new Exception\MethodExecutionNotAllowedException("Method execution is not allowed");
184			else
185			{
186			if (method_exists($this, $method))
187			{
188			$class = __CLASS__;
189
190			$reflection = new \ReflectionMethod($this, $method);
191
192			if (!$reflection->isPublic())
193			throw new Exception\PrivateMethodExecutionException("The method '$method' is not public in the control class '$class'");
194
195			# Get the returned value of the method to send to the view
196			$this->params = $this->$method();
197
198			# The only way to manage views is through an AbstractModule
199			if (!is_null($this->module))
200			{
201			$params = $this->getParams();
202
203			$layout_params = (count($params) && array_key_exists('::Layout', $params)) ? $params["::Layout"] : [];
204
205			$layout = new Layout;
206			$layout->setParams($layout_params);
207			$layout->fromController($this);
208			}
209			}
210			else
211			{
212			$class = __CLASS__;
213			throw new Exception\MethodNotFoundException("The method '$method' doesn't exists in the control class '$class'");
214			}
215			}
216			}
217
218			/**
219			* Returns the class name
220			*
221			* @return string
222			*/
223			public static function getClassName()
224			{
225			return __CLASS__;
226			}
227
228			/**
229			* Returns $_POST contents
230			*
231			* @return array
232			*/
233			public function getPost()
234			{
235			if ($_SERVER['REQUEST_METHOD'] == 'POST' && empty($_POST))
236			$_POST = json_decode(file_get_contents('php://input'), true);
237
238			return (array) $_POST;
239			}
240
241			/**
242			* Returns json contents
243			*
244			* @throws LogicException
245			*
246			* @return array
247			*/
248			public function getJson()
249			{
250			if ($_SERVER['REQUEST_METHOD'] != 'JSON')
251			throw new \LogicException("Request method is not JSON");
252
253			$input = file_get_contents('php://input');
254			$array = explode("&", $input);
255
256			$result = [];
257
258			foreach ($array as $value)
259			{
260			$io = explode("=", $value);
261			$result[$io[0]] = $io[1];
262			}
263
264			return $result;
265			}
266
267			/**
268			* Checks if the current request is XmlHttpRequest (AJAX)
269			*
270			* @return boolean
271			*/
272			public function isXmlHttpRequest()
273			{
274			# non standard (HTTP_X_REQUESTED_WITH is not a part of PHP)
275			if (isset($_SERVER['HTTP_X_REQUESTED_WITH']))
276			return true;
277			return false;
278			}
279
280			/**
281			* Checks if the current request is POST
282			*
283			* @return boolean
284			*/
285			public function isPost()
286			{
287			if ($_SERVER["REQUEST_METHOD"] == "POST")
288			return true;
289			return false;
290			}
291
292			/**
293			* Checks if the current request is GET
294			*
295			* @return boolean
296			*/
297			public function isGet()
298			{
299			if ($_SERVER["REQUEST_METHOD"] == "GET")
300			return true;
301			return false;
302			}
303			}

Pleets / dronephp

Push — master ( 40eec0...6215ec )

AbstractController::setModule() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like