SecondHandProductAdmin - Code Metrics - sunnysideup/silverstripe-ecommerce_second_hand_product - Measure and Improve Code Quality continuously with Scrutinizer

SecondHandProductAdmin A
last analyzed 2018-06-20 01:12 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	129
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	12

Importance

Changes

Metric	Value
wmc	19
lcom	2
cbo	12
dl	0
loc	129
rs	10
c	0
b	0
f	0

5 Methods

Rating	Name	Size	Complexity
B	getEditForm()	15	5
A	doCancel()	4	1
B	archive()	31	5
B	restore()	32	5
A	ensureParentHasVersion()	11	3

<?php

/**
 * @description: for the management of Product and Product Groups only
 *
 *
 * @authors: Nicolaas [at] Sunny Side Up .co.nz
 * @package: ecommerce
 * @sub-package: cms
 **/

class SecondHandProductAdmin extends ModelAdminEcommerceBaseClass
namespace YourVendor;

class YourClass { }
{
    private static $menu_priority = 3.2;


    private static $url_segment = 'secondhandproducts';


    private static $menu_title = 'Second Hand';


    private static $managed_models = array(

        'SecondHandProduct',
        'SecondHandArchive'
    );

    private static $allowed_actions = array(

        "editinsitetree",
        "ItemEditForm",
        "archive" => true,
        "restore" => true,
    );

    /**
     * standard SS variable
     * @var String
     */
    private static $menu_icon = "ecommerce/images/icons/product-file.gif";



    public function getEditForm($id = null, $fields = null)
    {
        foreach (GoogleAddressField::js_requirements() as $jsFile) {
            Requirements::javascript($jsFile);
        }
        $form = parent::getEditForm();
        if (singleton($this->modelClass) instanceof SiteTree) {
            if ($gridField = $form->Fields()->dataFieldByName($this->sanitiseClassName($this->modelClass))) {
                if ($gridField instanceof GridField) {
                    $gridField->setConfig(GridFieldEditOriginalPageConfigSecondHandPage::create());
                }
            }
        }
        return $form;
    }


    public function doCancel($data, $form)

    {
        return $this->redirect(singleton('CMSMain')->Link());
    }

    public function archive($request)
// 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($_GET['productid'])) {
            $id = intval($_GET['productid']);
            if ($id) {
                $secondHandProduct = SecondHandProduct::get()->byID($id);
                $internalItemID = $secondHandProduct->InternalItemID;
                if (is_a($secondHandProduct, Object::getCustomClass('SiteTree'))) {
                    $secondHandProduct->deleteFromStage('Live');
                    $secondHandProduct->deleteFromStage('Stage');
                } else {
                    $secondHandProduct->delete();
                }
                //after deleting the product redirect to the archived page
                $archivedProduct = SecondHandArchive::get()->filter(['InternalItemID' => $internalItemID])->first();
                if ($archivedProduct) {
                    $this->getResponse()->addHeader(
                        'X-Status',
                        rawurlencode(_t(
                            'CMSMain.RESTORED',
                            "Archived '{title}' successfully",
                            array('title' => $archivedProduct->Title)
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                        ))
                    );
                    $cmsEditLink = '/admin/secondhandproducts/SecondHandArchive/EditForm/field/SecondHandArchive/item/'.$archivedProduct->ID.'/edit';
                    return Controller::curr()->redirect($cmsEditLink);
                }
            }
        }
        return new SS_HTTPResponse("ERROR!", 400);
    }

    public function restore($request)
// 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($_GET['productid'])) {
            $id = intval($_GET['productid']);
            if ($id) {
                $restoredPage = Versioned::get_latest_version("SiteTree", $id);
                $parentID = $restoredPage->ParentID;
                if ($parentID) {
                    var_dump($parentID);

                    $this->ensureParentHasVersion($parentID);
                    if (!$restoredPage) {
                        return new SS_HTTPResponse("SiteTree #$id not found", 400);
                    }
                    $restoredPage = $restoredPage->doRestoreToStage();
                    //$restoredPage->doPublish();

                    $this->getResponse()->addHeader(
                        'X-Status',
                        rawurlencode(_t(
                            'CMSMain.RESTORED',
                            "Restored '{title}' successfully",
                            array('title' => $restoredPage->Title)
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                        ))
                    );
                    $cmsEditLink = '/admin/secondhandproducts/SecondHandProduct/EditForm/field/SecondHandProduct/item/'.$id.'/edit';
                    return Controller::curr()->redirect($cmsEditLink);
                } else {
                    return new SS_HTTPResponse("Parent Page #$parentID is missing", 400);
                }
            }
        }
        return new SS_HTTPResponse("ERROR!", 400);
    }

    /**
     * little hack to fix parent if it is not versioned into versions table
     */
    public function ensureParentHasVersion($parentID)
    {
        $parentPage = Versioned::get_latest_version("SiteTree", $parentID);
        if (!$parentPage) {
            $parentPage = SiteTree::get()->byID($parentID);
            if ($parentPage) {
                $parentPage->writeToStage('Stage');
                $parentPage->publish('Stage', 'Live', true);
            }
        }
    }
}


1			<?php
2
3			/**
4			* @description: for the management of Product and Product Groups only
5			*
6			*
7			* @authors: Nicolaas [at] Sunny Side Up .co.nz
8			* @package: ecommerce
9			* @sub-package: cms
10			**/
11
12			class SecondHandProductAdmin extends ModelAdminEcommerceBaseClass
			0 ignored issues – show Coding Style Compatibility introduced 2017-01-03 01:12 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...
13			{
14			private static $menu_priority = 3.2;
			0 ignored issues – show Comprehensibility introduced 2017-01-03 01:12 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 01:12 UTC by Report Bug Copy Issue Report The property `$menu_priority` 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...
15
16			private static $url_segment = 'secondhandproducts';
			0 ignored issues – show Comprehensibility introduced 2017-01-03 01:12 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 01:12 UTC by Report Bug Copy Issue Report The property `$url_segment` 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...
17
18			private static $menu_title = 'Second Hand';
			0 ignored issues – show Comprehensibility introduced 2017-01-03 01:12 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 01:12 UTC by Report Bug Copy Issue Report The property `$menu_title` 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...
19
20			private static $managed_models = array(
			0 ignored issues – show Comprehensibility introduced 2017-01-03 01:12 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 01:12 UTC by Report Bug Copy Issue Report The property `$managed_models` 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...
21			'SecondHandProduct',
22			'SecondHandArchive'
23			);
24
25			private static $allowed_actions = array(
			0 ignored issues – show Comprehensibility introduced 2017-01-03 01:12 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 01:12 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...
26			"editinsitetree",
27			"ItemEditForm",
28			"archive" => true,
29			"restore" => true,
30			);
31
32			/**
33			* standard SS variable
34			* @var String
35			*/
36			private static $menu_icon = "ecommerce/images/icons/product-file.gif";
			0 ignored issues – show Comprehensibility introduced 2017-01-03 01:12 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 01:12 UTC by Report Bug Copy Issue Report The property `$menu_icon` 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...
37
38
39			public function getEditForm($id = null, $fields = null)
40			{
41			foreach (GoogleAddressField::js_requirements() as $jsFile) {
42			Requirements::javascript($jsFile);
43			}
44			$form = parent::getEditForm();
45			if (singleton($this->modelClass) instanceof SiteTree) {
46			if ($gridField = $form->Fields()->dataFieldByName($this->sanitiseClassName($this->modelClass))) {
47			if ($gridField instanceof GridField) {
48			$gridField->setConfig(GridFieldEditOriginalPageConfigSecondHandPage::create());
49			}
50			}
51			}
52			return $form;
53			}
54
55
56			public function doCancel($data, $form)
			0 ignored issues – show Unused Code introduced 2017-08-24 01:32 UTC by Report Bug Copy Issue Report The parameter `$data` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history... Unused Code introduced 2017-08-24 01:32 UTC by Report Bug Copy Issue Report The parameter `$form` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
57			{
58			return $this->redirect(singleton('CMSMain')->Link());
59			}
60
61			public function archive($request)
			0 ignored issues – show Unused Code introduced 2017-03-29 23:22 UTC by Report Bug Copy Issue Report The parameter `$request` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history... Coding Style introduced 2018-01-25 00:49 UTC by Report Bug Copy Issue Report `archive` 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...
62			{
63			if (isset($_GET['productid'])) {
64			$id = intval($_GET['productid']);
65			if ($id) {
66			$secondHandProduct = SecondHandProduct::get()->byID($id);
67			$internalItemID = $secondHandProduct->InternalItemID;
68			if (is_a($secondHandProduct, Object::getCustomClass('SiteTree'))) {
69			$secondHandProduct->deleteFromStage('Live');
70			$secondHandProduct->deleteFromStage('Stage');
71			} else {
72			$secondHandProduct->delete();
73			}
74			//after deleting the product redirect to the archived page
75			$archivedProduct = SecondHandArchive::get()->filter(['InternalItemID' => $internalItemID])->first();
76			if ($archivedProduct) {
77			$this->getResponse()->addHeader(
78			'X-Status',
79			rawurlencode(_t(
80			'CMSMain.RESTORED',
81			"Archived '{title}' successfully",
82			array('title' => $archivedProduct->Title)
			0 ignored issues – show Documentation introduced 2018-01-25 00:49 UTC by Report Bug Copy Issue Report `array('title' => $archivedProduct->Title)` is of type `array<string,?,{"title":"?"}>`, but the function expects a `string`. 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...
83			))
84			);
85			$cmsEditLink = '/admin/secondhandproducts/SecondHandArchive/EditForm/field/SecondHandArchive/item/'.$archivedProduct->ID.'/edit';
86			return Controller::curr()->redirect($cmsEditLink);
87			}
88			}
89			}
90			return new SS_HTTPResponse("ERROR!", 400);
91			}
92
93			public function restore($request)
			0 ignored issues – show Unused Code introduced 2018-01-25 00:49 UTC by Report Bug Copy Issue Report The parameter `$request` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history... Coding Style introduced 2018-01-25 00:49 UTC by Report Bug Copy Issue Report `restore` 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...
94			{
95			if (isset($_GET['productid'])) {
96			$id = intval($_GET['productid']);
97			if ($id) {
98			$restoredPage = Versioned::get_latest_version("SiteTree", $id);
99			$parentID = $restoredPage->ParentID;
100			if ($parentID) {
101			var_dump($parentID);
			0 ignored issues – show Security Debugging Code introduced 2018-06-18 05:17 UTC by Report Bug Copy Issue Report `var_dump($parentID);` looks like debug code. Are you sure you do not want to remove it? This might expose sensitive data. Loading history...
102			$this->ensureParentHasVersion($parentID);
103			if (!$restoredPage) {
104			return new SS_HTTPResponse("SiteTree #$id not found", 400);
105			}
106			$restoredPage = $restoredPage->doRestoreToStage();
107			//$restoredPage->doPublish();
			0 ignored issues – show Unused Code Comprehensibility introduced 2018-06-18 05:17 UTC by Report Bug Copy Issue Report `84%` 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...
108			$this->getResponse()->addHeader(
109			'X-Status',
110			rawurlencode(_t(
111			'CMSMain.RESTORED',
112			"Restored '{title}' successfully",
113			array('title' => $restoredPage->Title)
			0 ignored issues – show Documentation introduced 2017-03-29 23:22 UTC by Report Bug Copy Issue Report `array('title' => $restoredPage->Title)` is of type `array<string,?,{"title":"?"}>`, but the function expects a `string`. 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...
114			))
115			);
116			$cmsEditLink = '/admin/secondhandproducts/SecondHandProduct/EditForm/field/SecondHandProduct/item/'.$id.'/edit';
117			return Controller::curr()->redirect($cmsEditLink);
118			} else {
119			return new SS_HTTPResponse("Parent Page #$parentID is missing", 400);
120			}
121			}
122			}
123			return new SS_HTTPResponse("ERROR!", 400);
124			}
125
126			/**
127			* little hack to fix parent if it is not versioned into versions table
128			*/
129			public function ensureParentHasVersion($parentID)
130			{
131			$parentPage = Versioned::get_latest_version("SiteTree", $parentID);
132			if (!$parentPage) {
133			$parentPage = SiteTree::get()->byID($parentID);
134			if ($parentPage) {
135			$parentPage->writeToStage('Stage');
136			$parentPage->publish('Stage', 'Live', true);
137			}
138			}
139			}
140			}
141

sunnysideup / silverstripe-ecommerce_second_hand_product

GitHub Access Token became invalid

SecondHandProductAdmin A last analyzed 2018-06-20 01:12 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

5 Methods

Duplication Side-by-Side

Filter issues like

SecondHandProductAdmin A
last analyzed 2018-06-20 01:12 UTC