DataObjectSortBaseClass::init() - Code Metrics - Inspection of "MINOR: replacing all object getters that only get..." - sunnysideup/silverstripe-dataobjectsorter - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 0030fe...fe94fe )

unknown

created 2017-04-28 04:21 UTC

DataObjectSortBaseClass::init() A

↳ Parent: DataObjectSortBaseClass

Complexity

Conditions	2
Paths	2

Size

Total Lines	8
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	8
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	4
nc	2
nop	0

<?php




class DataObjectSortBaseClass extends Controller implements PermissionProvider
namespace YourVendor;

class YourClass { }
{
    private static $allowed_actions = array(

        "show" => 'DATA_OBJECT_SORT_AND_EDIT_PERMISSION'
    );

    /**
     * Permission for user management.
     *
     * @var string
     */
    const CAN_DO_STUFF = 'DATA_OBJECT_SORT_AND_EDIT_PERMISSION';

    public function providePermissions()
    {
        return array(
            DataObjectSortBaseClass::CAN_DO_STUFF => array(
                'name' => _t(
                    'DataObjectSortBaseClass.PERMISSION_MANAGE_USERS_DESCRIPTION',
                    'Quick updates and edits'
                ),
                'help' => _t(
                    'DataObjectSortBaseClass.PERMISSION_MANAGE_USERS_HELP',
                    'Allows for certain data to be sorted, edited, etc... This is around quick edits'
                ),
                'category' => _t('DataObjectSortBaseClass.PERMISSIONS_CATEGORY', 'Miscellaneous'),
                'sort' => 100
            )
        );
    }


    public function init()
    {
        // Only administrators can run this method
        parent::init();
        if (! Permission::check("DATA_OBJECT_SORT_AND_EDIT_PERMISSION")) {
            return $this->permissionFailureStandard();
        }
    }

    public function show()
    {
        return array();
    }


    /**
     *
     * @return string

     */
    protected function SecureFieldToBeUpdated()
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        if (isset($_POST["Field"])) {
            return addslashes($_POST["Field"]);
        }
        $field = $this->getRequest()->param("OtherID");
        if ($table = $this->SecureTableToBeUpdated()) {
            if ($tableObject = DataObject::get_one($table)) {
                if ($tableObject->hasDatabaseField($field)) {
                    return $field;
                } else {
                    user_error("$field does not exist on $table", E_USER_ERROR);
                }
            } else {
                user_error("there are no records in $table", E_USER_ERROR);
            }
        } else {
            user_error("there is no table specified", E_USER_ERROR);
        }
    }

    /**
     *
     * @return string

     */
    protected function SecureTableToBeUpdated()
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        if (isset($_POST["Table"])) {
            $table = addslashes($_POST["Table"]);
        } else {
            $table = $this->getRequest()->param("ID");
        }
        if (class_exists($table)) {
            return $table;
        } else {
            user_error("could not find record: $table", E_USER_ERROR);
        }
    }


    /**
     *
     * @return int
     */
    protected function SecureRecordToBeUpdated()
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        if (isset($_POST["Record"])) {
            return intval($_POST["Record"]);
        }
        if (isset($_GET["id"])) {
            $record = $_GET["id"];
            return intval($record);
        }
        return 0;
    }


    /**
     *
     *
     * @param  DataObject $obj       [description]
     * @param  string $fieldName     [description]
     * @return FormField
     */
    protected function getFormField($obj, $fieldName)
    {
        if (!self::$field) {
            self::$field  = $obj->dbObject($fieldName)->scaffoldFormField($obj->Title);
        }
        return self::$field;
    }

    /**
     *
     * @return string
     */
    protected function HumanReadableTableName()
    {
        return singleton($this->SecureTableToBeUpdated())->plural_name();
    }

    /**
     *
     * @return string
     */
    public function Link($action = null)
    {
        $link = Config::inst()->get($this->class, 'url_segment').'/';
        if ($action) {
            $link .= "$action/";
        }
        return $link;
    }

    public function permissionFailureStandard()
    {
        return Security::permissionFailure($this, _t('Security.PERMFAILURE', ' This page is secured and you need administrator rights to access it. Enter your credentials below and we will send you right along.'));
    }
}


1			<?php
2
3
4
5
6			class DataObjectSortBaseClass extends Controller implements PermissionProvider
			0 ignored issues – show Coding Style Compatibility introduced 2017-01-03 00:26 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...
7			{
8			private static $allowed_actions = array(
			0 ignored issues – show Comprehensibility introduced 2017-01-03 00:26 UTC by Report Bug Copy Issue Report Consider using a different property name as you override a private property of the parent class. Loading history... Unused Code introduced 2017-01-03 00:26 UTC by Report Bug Copy Issue Report The property `$allowed_actions` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
9			"show" => 'DATA_OBJECT_SORT_AND_EDIT_PERMISSION'
10			);
11
12			/**
13			* Permission for user management.
14			*
15			* @var string
16			*/
17			const CAN_DO_STUFF = 'DATA_OBJECT_SORT_AND_EDIT_PERMISSION';
18
19			public function providePermissions()
20			{
21			return array(
22			DataObjectSortBaseClass::CAN_DO_STUFF => array(
23			'name' => _t(
24			'DataObjectSortBaseClass.PERMISSION_MANAGE_USERS_DESCRIPTION',
25			'Quick updates and edits'
26			),
27			'help' => _t(
28			'DataObjectSortBaseClass.PERMISSION_MANAGE_USERS_HELP',
29			'Allows for certain data to be sorted, edited, etc... This is around quick edits'
30			),
31			'category' => _t('DataObjectSortBaseClass.PERMISSIONS_CATEGORY', 'Miscellaneous'),
32			'sort' => 100
33			)
34			);
35			}
36
37
38			public function init()
39			{
40			// Only administrators can run this method
41			parent::init();
42			if (! Permission::check("DATA_OBJECT_SORT_AND_EDIT_PERMISSION")) {
43			return $this->permissionFailureStandard();
44			}
45			}
46
47			public function show()
48			{
49			return array();
50			}
51
52
53			/**
54			*
55			* @return string
			0 ignored issues – show Documentation introduced 2017-01-03 00:26 UTC by Report Bug Copy Issue Report Should the return type not be `string\|null`? 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...
56			*/
57			protected function SecureFieldToBeUpdated()
			0 ignored issues – show Coding Style introduced 2017-01-03 00:26 UTC by Report Bug Copy Issue Report `SecureFieldToBeUpdated` uses the super-global variable `$_POST` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history...
58			{
59			if (isset($_POST["Field"])) {
60			return addslashes($_POST["Field"]);
61			}
62			$field = $this->getRequest()->param("OtherID");
63			if ($table = $this->SecureTableToBeUpdated()) {
64			if ($tableObject = DataObject::get_one($table)) {
65			if ($tableObject->hasDatabaseField($field)) {
66			return $field;
67			} else {
68			user_error("$field does not exist on $table", E_USER_ERROR);
69			}
70			} else {
71			user_error("there are no records in $table", E_USER_ERROR);
72			}
73			} else {
74			user_error("there is no table specified", E_USER_ERROR);
75			}
76			}
77
78			/**
79			*
80			* @return string
			0 ignored issues – show Documentation introduced 2017-01-03 00:26 UTC by Report Bug Copy Issue Report Should the return type not be `string\|null`? 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...
81			*/
82			protected function SecureTableToBeUpdated()
			0 ignored issues – show Coding Style introduced 2017-01-03 00:26 UTC by Report Bug Copy Issue Report `SecureTableToBeUpdated` uses the super-global variable `$_POST` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history...
83			{
84			if (isset($_POST["Table"])) {
85			$table = addslashes($_POST["Table"]);
86			} else {
87			$table = $this->getRequest()->param("ID");
88			}
89			if (class_exists($table)) {
90			return $table;
91			} else {
92			user_error("could not find record: $table", E_USER_ERROR);
93			}
94			}
95
96
97			/**
98			*
99			* @return int
100			*/
101			protected function SecureRecordToBeUpdated()
			0 ignored issues – show Coding Style introduced 2017-01-03 00:26 UTC by Report Bug Copy Issue Report `SecureRecordToBeUpdated` uses the super-global variable `$_POST` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history... Coding Style introduced 2017-01-03 00:26 UTC by Report Bug Copy Issue Report `SecureRecordToBeUpdated` uses the super-global variable `$_GET` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history...
102			{
103			if (isset($_POST["Record"])) {
104			return intval($_POST["Record"]);
105			}
106			if (isset($_GET["id"])) {
107			$record = $_GET["id"];
108			return intval($record);
109			}
110			return 0;
111			}
112
113
114			/**
115			*
116			*
117			* @param DataObject $obj [description]
118			* @param string $fieldName [description]
119			* @return FormField
120			*/
121			protected function getFormField($obj, $fieldName)
122			{
123			if (!self::$field) {
124			self::$field = $obj->dbObject($fieldName)->scaffoldFormField($obj->Title);
125			}
126			return self::$field;
127			}
128
129			/**
130			*
131			* @return string
132			*/
133			protected function HumanReadableTableName()
134			{
135			return singleton($this->SecureTableToBeUpdated())->plural_name();
136			}
137
138			/**
139			*
140			* @return string
141			*/
142			public function Link($action = null)
143			{
144			$link = Config::inst()->get($this->class, 'url_segment').'/';
145			if ($action) {
146			$link .= "$action/";
147			}
148			return $link;
149			}
150
151			public function permissionFailureStandard()
152			{
153			return Security::permissionFailure($this, _t('Security.PERMFAILURE', ' This page is secured and you need administrator rights to access it. Enter your credentials below and we will send you right along.'));
154			}
155			}
156

sunnysideup / silverstripe-dataobjectsorter

Push — master ( 0030fe...fe94fe )

DataObjectSortBaseClass::init() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like