TodoController::index() - Code Metrics - Inspection of "Merge branch 'master' of https://github.com/OmarEl..." - OmarElGabry/miniPHP - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( a382bd...b35cf7 )

by Omar El

created 2015-11-27 16:37 UTC

TodoController::index() A

↳ Parent: TodoController

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Metric	Value
dl	0
loc	7
rs	9.4286
cc	1
eloc	3
nc	1
nop	0

<?php

/**
 * Todo Controller
 *
 * @license    http://opensource.org/licenses/MIT The MIT License (MIT)
 * @author     Omar El Gabry <[email protected]>
 */

class TodoController extends Controller{
namespace YourVendor;

class YourClass { }

    // override this method to perform any logic before calling action method as explained above
    public function beforeAction(){

        parent::beforeAction();

        // define the actions in this Controller
        $action = $this->request->param('action');

        // restrict the request to action methods
        // $this->Security->requireAjax(['create', 'delete']);

        $this->Security->requirePost(['create', 'delete']);
<?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.");
        }
    }

}

        // define the expected form fields for every action if exist
        switch($action){

            case "create":
                // you can exclude form fields if you don't care if they were sent with form fields or not
                $this->Security->config("form", [ 'fields' => ['content'], 'exclude' => ['submit']]);
<?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.");
        }
    }

}
                break;
            case "delete":
                // if you don't want to validate the CSRF Token, then assign 'validateCsrfToken' to false
                // $this->Security->config("validateCsrfToken", false);

                $this->Security->config("form", [ 'fields' => ['todo_id'], 'exclude' => ['submit']]);
<?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.");
        }
    }

}
                break;
        }
    }

    public function index(){

        $html  = $this->view->renderWithLayouts(Config::get('VIEWS_PATH') . "layout/todo/", Config::get('VIEWS_PATH') . 'todo/index.php');

        // display todo list
        echo $html;
    }

    public function create(){

        $content  = $this->request->data("content");
        $todo     = $this->todo->create(Session::getUserId(), $content);
<?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(!$todo){

            // in case of normal post request
            Session::set('error', $this->todo->errors());
<?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.");
        }
    }

}
            Redirector::to(PUBLIC_ROOT . "Todo");

            // in case of ajax
            // echo $this->view->renderErrors($this->todo->errors());


        }else{

            // in case of normal post request
            Session::set('success', "Todo has been created");
            Redirector::to(PUBLIC_ROOT . "Todo");

            // in case of ajax
            // echo $this->view->JSONEncode(array("success" => "Todo has been created"));

        }
    }

    public function delete(){

        $todoId = Encryption::decryptIdWithDash($this->request->data("todo_id"));
        $this->todo->delete($todoId);
<?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.");
        }
    }

}

        // in case of normal post request
        Session::set('success', "Todo has been deleted");
        Redirector::to(PUBLIC_ROOT . "Todo");

        // in case of ajax
        // echo $this->view->JSONEncode(array("success" => "Todo has been deleted"));

    }

    public function isAuthorized(){

        $action = $this->request->param('action');
        $role = Session::getUserRole();
        $resource = "todo";

        // only for admins
        Permission::allow('admin', $resource, ['*']);

        // only for normal users
        Permission::allow('user', $resource, ['delete'], 'owner');

        $todoId = $this->request->data("todo_id");

        if(!empty($todoId)){
            $todoId = Encryption::decryptIdWithDash($todoId);
        }

        $config = [
            "user_id" => Session::getUserId(),
            "table" => "todo",
            "id" => $todoId];

        return Permission::check($role, $resource, $action, $config);
    }
}

1		<?php
2
3		/**
4		* Todo Controller
5		*
6		* @license http://opensource.org/licenses/MIT The MIT License (MIT)
7		* @author Omar El Gabry <[email protected]>
8		*/
9
10		class TodoController extends Controller{
		0 ignored issues – show Coding Style Compatibility introduced 2015-11-27 16:40 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
11
12		// override this method to perform any logic before calling action method as explained above
13		public function beforeAction(){
14
15		parent::beforeAction();
16
17		// define the actions in this Controller
18		$action = $this->request->param('action');
19
20		// restrict the request to action methods
21		// $this->Security->requireAjax(['create', 'delete']);
		0 ignored issues – show Unused Code Comprehensibility introduced 2015-11-27 16:40 UTC by Report Bug Copy Issue Report `74%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
22		$this->Security->requirePost(['create', 'delete']);
		0 ignored issues – show Documentation introduced 2015-11-27 16:40 UTC by Report Bug Copy Issue Report The property `Security` does not exist on `object<TodoController>`. 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...
23
24		// define the expected form fields for every action if exist
25	View Code Duplication	switch($action){
		0 ignored issues – show Duplication introduced 2015-11-27 16:40 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
26		case "create":
27		// you can exclude form fields if you don't care if they were sent with form fields or not
28		$this->Security->config("form", [ 'fields' => ['content'], 'exclude' => ['submit']]);
		0 ignored issues – show Documentation introduced 2015-11-27 16:40 UTC by Report Bug Copy Issue Report The property `Security` does not exist on `object<TodoController>`. 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...
29		break;
30		case "delete":
31		// if you don't want to validate the CSRF Token, then assign 'validateCsrfToken' to false
32		// $this->Security->config("validateCsrfToken", false);
		0 ignored issues – show Unused Code Comprehensibility introduced 2015-11-27 16:40 UTC by Report Bug Copy Issue Report `70%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
33		$this->Security->config("form", [ 'fields' => ['todo_id'], 'exclude' => ['submit']]);
		0 ignored issues – show Documentation introduced 2015-11-27 16:40 UTC by Report Bug Copy Issue Report The property `Security` does not exist on `object<TodoController>`. 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...
34		break;
35		}
36		}
37
38		public function index(){
39
40		$html = $this->view->renderWithLayouts(Config::get('VIEWS_PATH') . "layout/todo/", Config::get('VIEWS_PATH') . 'todo/index.php');
41
42		// display todo list
43		echo $html;
44		}
45
46		public function create(){
47
48		$content = $this->request->data("content");
49		$todo = $this->todo->create(Session::getUserId(), $content);
		0 ignored issues – show Documentation introduced 2015-11-27 16:40 UTC by Report Bug Copy Issue Report The property `todo` does not exist on `object<TodoController>`. 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...
50
51		if(!$todo){
52
53		// in case of normal post request
54		Session::set('error', $this->todo->errors());
		0 ignored issues – show Documentation introduced 2015-11-27 16:40 UTC by Report Bug Copy Issue Report The property `todo` does not exist on `object<TodoController>`. 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...
55		Redirector::to(PUBLIC_ROOT . "Todo");
56
57		// in case of ajax
58		// echo $this->view->renderErrors($this->todo->errors());
		0 ignored issues – show Unused Code Comprehensibility introduced 2015-11-27 16:40 UTC by Report Bug Copy Issue Report `67%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
59
60		}else{
61
62		// in case of normal post request
63		Session::set('success', "Todo has been created");
64		Redirector::to(PUBLIC_ROOT . "Todo");
65
66		// in case of ajax
67		// echo $this->view->JSONEncode(array("success" => "Todo has been created"));
		0 ignored issues – show Unused Code Comprehensibility introduced 2015-11-27 16:40 UTC by Report Bug Copy Issue Report `69%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
68		}
69		}
70
71		public function delete(){
72
73		$todoId = Encryption::decryptIdWithDash($this->request->data("todo_id"));
74		$this->todo->delete($todoId);
		0 ignored issues – show Documentation introduced 2015-11-27 16:40 UTC by Report Bug Copy Issue Report The property `todo` does not exist on `object<TodoController>`. 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...
75
76		// in case of normal post request
77		Session::set('success', "Todo has been deleted");
78		Redirector::to(PUBLIC_ROOT . "Todo");
79
80		// in case of ajax
81		// echo $this->view->JSONEncode(array("success" => "Todo has been deleted"));
		0 ignored issues – show Unused Code Comprehensibility introduced 2015-11-27 16:40 UTC by Report Bug Copy Issue Report `69%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
82		}
83
84		public function isAuthorized(){
85
86		$action = $this->request->param('action');
87		$role = Session::getUserRole();
88		$resource = "todo";
89
90		// only for admins
91		Permission::allow('admin', $resource, ['*']);
92
93		// only for normal users
94		Permission::allow('user', $resource, ['delete'], 'owner');
95
96		$todoId = $this->request->data("todo_id");
97
98		if(!empty($todoId)){
99		$todoId = Encryption::decryptIdWithDash($todoId);
100		}
101
102		$config = [
103		"user_id" => Session::getUserId(),
104		"table" => "todo",
105		"id" => $todoId];
106
107		return Permission::check($role, $resource, $action, $config);
108		}
109		}

OmarElGabry / miniPHP

GitHub Access Token became invalid

Push — master ( a382bd...b35cf7 )

TodoController::index() A

Complexity

Size

Duplication

Duplication Side-by-Side

Filter issues like