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

Passed

Push — master ( 6215ec...1255dc )

by Darío

created 2019-04-08 22:56 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
{
    /**
     * Current module instance
     *
     * @var AbstractModule
     */
    private $module;

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

    /**
     * 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;
    }

    /**
     * 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 mixed
     */
    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'");

                return $this->$method();
            }
            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			/**
23			* Current module instance
24			*
25			* @var AbstractModule
26			*/
27			private $module;
28
29			/**
30			* Current method
31			*
32			* @var string
33			*/
34			private $method = null;
35
36			/**
37			* Returns the current module instance
38			*
39			* @return AbstractModule
40			*/
41			public function getModule()
42			{
43			return $this->module;
44			}
45
46			/**
47			* Returns the current method
48			*
49			* @return string
50			*/
51			public function getMethod()
52			{
53			return $this->method;
54			}
55
56			/**
57			* Sets module instance
58			*
59			* @param AbstractModule $module
60			*
61			* @return null
62			*/
63			public function setModule(AbstractModule $module)
64			{
65			$this->module = $module;
66			}
67
68			/**
69			* Sets the method attribute
70			*
71			* @param string $method
72			*
73			* @return null
74			*/
75			public function setMethod($method)
76			{
77			$this->method = $method;
78			}
79
80			/**
81			* Executes the controller
82			*
83			* @return mixed
84			*/
85			public function execute()
86			{
87			$method = $this->method;
88
89			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...
90			# This error is thrown because of 'setMethod' method has not been executed
91			throw new \LogicException("No method has been setted to execute!");
92
93			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...
94			throw new Exception\MethodExecutionNotAllowedException("Method execution is not allowed");
95			else
96			{
97			if (method_exists($this, $method))
98			{
99			$class = __CLASS__;
100
101			$reflection = new \ReflectionMethod($this, $method);
102
103			if (!$reflection->isPublic())
104			throw new Exception\PrivateMethodExecutionException("The method '$method' is not public in the control class '$class'");
105
106			return $this->$method();
107			}
108			else
109			{
110			$class = __CLASS__;
111			throw new Exception\MethodNotFoundException("The method '$method' doesn't exists in the control class '$class'");
112			}
113			}
114			}
115
116			/**
117			* Returns the class name
118			*
119			* @return string
120			*/
121			public static function getClassName()
122			{
123			return __CLASS__;
124			}
125
126			/**
127			* Returns $_POST contents
128			*
129			* @return array
130			*/
131			public function getPost()
132			{
133			if ($_SERVER['REQUEST_METHOD'] == 'POST' && empty($_POST))
134			$_POST = json_decode(file_get_contents('php://input'), true);
135
136			return (array) $_POST;
137			}
138
139			/**
140			* Returns json contents
141			*
142			* @throws LogicException
143			*
144			* @return array
145			*/
146			public function getJson()
147			{
148			if ($_SERVER['REQUEST_METHOD'] != 'JSON')
149			throw new \LogicException("Request method is not JSON");
150
151			$input = file_get_contents('php://input');
152			$array = explode("&", $input);
153
154			$result = [];
155
156			foreach ($array as $value)
157			{
158			$io = explode("=", $value);
159			$result[$io[0]] = $io[1];
160			}
161
162			return $result;
163			}
164
165			/**
166			* Checks if the current request is XmlHttpRequest (AJAX)
167			*
168			* @return boolean
169			*/
170			public function isXmlHttpRequest()
171			{
172			# non standard (HTTP_X_REQUESTED_WITH is not a part of PHP)
173			if (isset($_SERVER['HTTP_X_REQUESTED_WITH']))
174			return true;
175			return false;
176			}
177
178			/**
179			* Checks if the current request is POST
180			*
181			* @return boolean
182			*/
183			public function isPost()
184			{
185			if ($_SERVER["REQUEST_METHOD"] == "POST")
186			return true;
187			return false;
188			}
189
190			/**
191			* Checks if the current request is GET
192			*
193			* @return boolean
194			*/
195			public function isGet()
196			{
197			if ($_SERVER["REQUEST_METHOD"] == "GET")
198			return true;
199			return false;
200			}
201			}

Pleets / dronephp

Push — master ( 6215ec...1255dc )

AbstractController::setModule() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like