CheckoutPage_StepDescription - Code Metrics - Inspection of "PATCH: fixing checkout steps" - sunnysideup/silverstripe-ecommerce - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( ebe629...4e95a5 )

by Nicolaas

created 2019-04-13 01:50 UTC

CheckoutPage_StepDescription A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	279
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	10

Importance

Changes

Metric	Value
wmc	31
lcom	2
cbo	10
dl	0
loc	279
rs	9.92
c	0
b	0
f	0

12 Methods

Rating	Name	Size	Complexity
A	i18n_singular_name()	4	1
A	i18n_plural_name()	4	1
A	canCreate()	4	1
A	canView()	15	4
A	canEdit()	15	4
A	canDelete()	19	5
A	getCMSFields()	9	1
A	CMSEditLink()	4	1
A	Title()	4	1
A	getTitle()	4	1
B	requireDefaultRecords()	28	7
A	getDefaultTitle()	16	4

<?php


/***
 * Class used to describe the steps in the checkout
 *
 */

class CheckoutPage_StepDescription extends DataObject implements EditableEcommerceObject
{
    /**
     * standard SS variable.
     *
     * @Var Array
     */
    private static $db = array(

        'Heading' => 'Varchar',
        'Above' => 'Text',
        'Below' => 'Text',
        'Code' => 'Varchar(100)'
    );

    /**
     * standard SS variable.
     *
     * @Var Array
     */
    private static $searchable_fields = array(

        'Heading' => 'PartialMatchFilter',
        'Above' => 'PartialMatchFilter',
        'Below' => 'PartialMatchFilter',
    );

    /**
     * standard SS variable.
     *
     * @Var Array
     */
    private static $field_labels = array(

        'Above' => 'Above Checkout Step',
        'Below' => 'Below Checkout Step',
    );

    /**
     * standard SS variable.
     *
     * @Var Array
     */
    private static $summary_fields = array(

        'ID' => 'Step Number',
        'Heading' => 'Heading',
    );

    private static $indexes = [

        'Code' => true
    ];

    /**
     * standard SS variable.
     *
     * @Var Array
     */
    private static $casting = array(

        'Title' => 'Varchar',
    );

    /**
     * standard SS variable.
     *
     * @Var String
     */
    private static $singular_name = 'Checkout Step Description';

    public function i18n_singular_name()
    {
        return _t('CheckoutPage.CHECKOUTSTEPDESCRIPTION', 'Checkout Step Description');
    }

    /**
     * standard SS variable.
     *
     * @Var String
     */
    private static $plural_name = 'Checkout Step Descriptions';

    public function i18n_plural_name()
    {
        return _t('CheckoutPage.CHECKOUTSTEPDESCRIPTIONS', 'Checkout Step Descriptions');
    }

    /**
     * Standard SS variable.
     *
     * @var string
     */
    private static $description = 'A step within the checkout process (e.g. confirm details).';


    /**
     * standard SS variable.
     *
     * @return bool
     */
    private static $can_create = false;


    /**
     * these are only created programmatically
     * standard SS method.
     *
     * @param Member $member

     *
     * @return bool
     */
    public function canCreate($member = null)
    {
        return false;
    }

    /**
     * standard SS method.
     *
     * @param Member $member

     *
     * @return bool

     */
    public function canView($member = null)
    {
        if (! $member) {
            $member = Member::currentUser();
        }
        $extended = $this->extendedCan(__FUNCTION__, $member);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        if ($extended !== null) {
            return $extended;
        }
        if (Permission::checkMember($member, Config::inst()->get('EcommerceRole', 'admin_permission_code'))) {
            return true;
        }

        return parent::canEdit($member);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
    }

    /**
     * standard SS method.
     *
     * @param Member $member

     *
     * @return bool

     */
    public function canEdit($member = null)
    {
        if (! $member) {
            $member = Member::currentUser();
        }
        $extended = $this->extendedCan(__FUNCTION__, $member);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        if ($extended !== null) {
            return $extended;
        }
        if (Permission::checkMember($member, Config::inst()->get('EcommerceRole', 'admin_permission_code'))) {
            return true;
        }

        return parent::canEdit($member);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
    }

    /**
     * standard SS method.
     *
     * @param Member $member

     *
     * @return bool

     */
    public function canDelete($member = null)
    {
        $array = EcommerceConfig::get('CheckoutPage_Controller', 'checkout_steps');
        if (in_array($this->getCode, $array)) {
<?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.");
        }
    }

}
            return false;
        }
        if (! $member) {
            $member = Member::currentUser();
        }
        $extended = $this->extendedCan(__FUNCTION__, $member);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        if ($extended !== null) {
            return $extended;
        }
        if (Permission::checkMember($member, Config::inst()->get('EcommerceRole', 'admin_permission_code'))) {
            return true;
        }

        return parent::canEdit($member);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
    }

    /**
     * standard SS method.
     *
     * @return FieldList
     */
    public function getCMSFields()
    {
        $fields = parent::getCMSFields();
        $fields->replaceField('Description', new TextareaField('Description', _t('Checkout.DESCRIPTION', 'Description')));
        $fields->replaceField('Above', new TextareaField('Above', _t('Checkout.ABOVE', 'Top of section note')));
        $fields->replaceField('Below', new TextareaField('Below', _t('Checkout.BELOW', 'Bottom of section note')));

        return $fields;
    }

    /**
     * link to edit the record.
     *
     * @param string | Null $action - e.g. edit
     *
     * @return string

     */
    public function CMSEditLink($action = null)
    {
        return CMSEditLinkAPI::find_edit_link_for_object($this, $action);
    }


    /**
     * casted variable.
     *
     * @return string
     */
    public function Title()
    {
        return $this->getTitle();
    }

    public function getTitle()

    {
        return $this->Heading;
<?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.");
        }
    }

}
    }

    /**
     * standard SS method.
     */
    public function requireDefaultRecords()
    {
        parent::requireDefaultRecords();
        $steps = EcommerceConfig::get('CheckoutPage_Controller', 'checkout_steps');
        if (is_array($steps) && count($steps)) {
            $idArray = [];
            foreach ($steps as $id => $code) {
                $filter = ['Code' => $code];
                $obj = CheckoutPage_StepDescription::get()->filter($filter)->first();
                if ($obj) {
                    //do nothing
                } else {
                    $obj = CheckoutPage_StepDescription::create($filter);
                    $obj->Heading = $this->getDefaultTitle($code);
<?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.");
        }
    }

}
                    $obj->write();
                    DB::alteration_message("Creating CheckoutPage_StepDescription $code", 'created');
                }
                $idArray[$obj->ID] = $obj->ID;
            }
            $toDeleteObjects = CheckoutPage_StepDescription::get()->exclude(array('ID' => $idArray));
            if ($toDeleteObjects->count()) {
                foreach ($toDeleteObjects as $toDeleteObject) {
                    DB::alteration_message('Deleting CheckoutPage_StepDescription '.$toDeleteObject->Code, 'deleted');
                    $toDeleteObject->delete();
                }
            }
        }
    }

    /**
     * turns code into title (default values).
     *
     * @param string $code - code
     *
     * @return string
     */
    private function getDefaultTitle($code)
    {
        switch ($code) {
            case 'orderitems':
                return _t('CheckoutPage.ORDERITEMS', 'Order items');
                break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
            case 'orderformaddress':
                return _t('CheckoutPage.ORDERFORMADDRESS', 'Your details');
                break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
            case 'orderconfirmationandpayment':
                return _t('CheckoutPage.ORDERCONFIRMATIONANDPAYMENT', 'Confirm and pay');
                break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
        }

        return $code;
    }
}


1			<?php
2
3
4			/***
5			* Class used to describe the steps in the checkout
6			*
7			*/
8
9			class CheckoutPage_StepDescription extends DataObject implements EditableEcommerceObject
10			{
11			/**
12			* standard SS variable.
13			*
14			* @Var Array
15			*/
16			private static $db = array(
			0 ignored issues – show Unused Code introduced 2016-10-31 23:06 UTC by Report Bug Copy Issue Report The property `$db` 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... Comprehensibility introduced 2016-12-20 03:49 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...
17			'Heading' => 'Varchar',
18			'Above' => 'Text',
19			'Below' => 'Text',
20			'Code' => 'Varchar(100)'
21			);
22
23			/**
24			* standard SS variable.
25			*
26			* @Var Array
27			*/
28			private static $searchable_fields = array(
			0 ignored issues – show Comprehensibility introduced 2016-12-20 03:49 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 2016-10-31 23:06 UTC by Report Bug Copy Issue Report The property `$searchable_fields` 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...
29			'Heading' => 'PartialMatchFilter',
30			'Above' => 'PartialMatchFilter',
31			'Below' => 'PartialMatchFilter',
32			);
33
34			/**
35			* standard SS variable.
36			*
37			* @Var Array
38			*/

sunnysideup / silverstripe-ecommerce

Push — master ( ebe629...4e95a5 )

CheckoutPage_StepDescription A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

12 Methods

Duplication Side-by-Side

Filter issues like