OrderAttribute - Code Metrics - sunnysideup/silverstripe-ecommerce - Measure and Improve Code Quality continuously with Scrutinizer

OrderAttribute F
last analyzed 2019-09-15 09:38 UTC

↳ Parent: Project
Complexity

Total Complexity
Size/Duplication

Total Lines	535
Duplicated Lines	0 %
Coupling/Cohesion

Components	3
Dependencies	13
Importance

Changes
Metric	Value
dl	0
loc	535
rs	3.52
c	0
b	0
f	0
wmc	61
lcom	3
cbo	13
34 Methods

Rating	Name	Size	Complexity
A	i18n_singular_name()	4	1
A	i18n_plural_name()	4	1
A	init()	4	1
A	canCreate()	15	4
B	canView()	27	9
A	canEdit()	18	6
A	canDelete()	4	1
A	CMSEditLink()	4	1
A	set_price_has_been_fixed()	5	1
A	get_price_has_been_fixed()	6	2
A	priceHasBeenFixed()	16	6
A	OrderAttributeType()	4	1
A	Order()	4	1
A	Classes()	14	4
A	AJAXDefinitions()	4	1
A	EcomConfig()	4	1
A	ShowInTable()	4	1
A	ShowInCart()	4	1
A	TableTitle()	4	1
A	getTableTitle()	4	1
A	CartTitle()	4	1
A	getCartTitle()	4	1
A	TableSubTitle()	4	1
A	getTableSubTitle()	4	1
A	TableSubTitleNOHTML()	4	1
A	getTableSubTitleNOHTML()	4	1
A	CartSubTitle()	4	1
A	getCartSubTitle()	4	1
A	CalculatedTotalAsMoney()	4	1
A	getCalculatedTotalAsMoney()	4	1
A	runUpdate()	4	1
A	onBeforeWrite()	9	3
A	onAfterWrite()	6	1
A	debug()	6	1
How to fix Complexity

<?php
/**
 * @description: base class for OrderItem (item in cart) and OrderModifier (extra - e.g. Tax)
 *
 * @see OrderModifier
 * @see OrderItem
 *
 *
 * @authors: Nicolaas [at] Sunny Side Up .co.nz
 * @package: ecommerce
 * @sub-package: model
 * @inspiration: Silverstripe Ltd, Jeremy
 **/
class OrderAttribute extends DataObject implements EditableEcommerceObject
{
    /**
     * what variables are accessible through  http://mysite.com/api/ecommerce/v1/ShippingAddress/.
     *
     * @var array
     */
    private static $api_access = array(

        'view' => array(
            'CalculatedTotal',
            'Sort',
            'GroupSort',
            'TableTitle',
            'TableSubTitleNOHTML',
            'CartTitle',
            'CartSubTitle',
            'Order',
        ),
     );

    /**
     * Standard SS variable.
     *
     * @var array
     */
    private static $db = array(

        'CalculatedTotal' => 'Currency',
        'Sort' => 'Int',
        'GroupSort' => 'Int',
    );

    /**
     * Standard SS variable.
     *
     * @var array
     */
    private static $has_one = array(

        'Order' => 'Order',
    );

    /**
     * Standard SS variable.
     *
     * @var array
     */
    private static $casting = array(

        'TableTitle' => 'HTMLText',
        'TableSubTitle' => 'HTMLText',
        'TableSubTitleNOHTML' => 'Text',
        'CartTitle' => 'HTMLText',
        'CartSubTitle' => 'HTMLText',
        'CalculatedTotalAsMoney' => 'Money',
    );

    /**
     * Standard SS variable.
     *
     * @var string
     **/
    private static $default_sort = [

        'OrderAttribute.GroupSort' => 'ASC',
        'OrderAttribute.Sort' => 'ASC',
        'OrderAttribute.ID' => 'ASC'
    ];

    /**
     * Standard SS variable.
     *
     * @var array
     */
    private static $indexes = array(

        'GroupSort' => true,
        'Sort' => true,
        'ID' => true
    );

    /**
     * Standard SS variable.
     *
     * @var string
     */
    private static $singular_name = 'Order Entry';

    public function i18n_singular_name()
    {
        return _t('OrderAttribute.ORDERENTRY', 'Order Entry');
    }

    /**
     * Standard SS variable.
     *
     * @var string
     */
    private static $plural_name = 'Order Extra Descriptions';

    public function i18n_plural_name()
    {
        return _t('OrderAttribute.ORDERENTRIES', 'Order Entries');
    }

    /**
     * Standard SS variable.
     *
     * @var string
     */
    private static $description = 'Any item that is added to the order - be it before (e.g. product) or after the subtotal (e.g. tax).';

    /**
     * save edit status for speed's sake.
     *
     * @var bool
     */
    protected $_canEdit = null;

    /**
     * save view status for speed's sake.
     *
     * @var bool
     */
    protected $_canView = null;

    /**
     * we use this variable to make sure that the parent::runUpdate() is called in all child classes
     * this is similar to the checks run for parent::init in the controller class.
     *
     * @var bool
     **/
    protected $baseInitCalled = false;

    /**
     * extended in OrderModifier and OrderItem
     * Starts up the order Atribute
     * TODO: introduce system like we have for Controller
     * which makes sure that all parent init methods are called.
     */
    public function init()
    {
        return true;
    }

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

     *
     * @return bool

     **/
    public function canCreate($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
     * This is an important 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 (!$this->exists()) {
            return true;
        }
        if ($this->_canView === null) {
            $this->_canView = false;
            if ($this->OrderID) {
<?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 ($o = $this->Order()) {
                    if ($o->exists()) {
                        if ($o->canView($member)) {
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
                            $this->_canView = true;
                        }
                    }
                }
            }
        }

        return $this->_canView;
    }

    /**
     * Standard SS method
     * This is an important 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 (!$this->exists()) {
            return true;
        }
        if ($this->_canEdit === null) {
            $this->_canEdit = $this->priceHasBeenFixed() ? false : true;
        }

        return $this->_canEdit;
    }

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

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

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


    /**
     * Helps in speeding up code.
     * This can be a static variable as it is the same for all OrderItems for an Order.
     *
     * @var array
     */
    private static $_price_has_been_fixed = array();


    /**
     * @param int $orderID
     * @param bool $value
     */
    public static function set_price_has_been_fixed($orderID = 0, $value = false)
    {
        $orderID = ShoppingCart::current_order_id($orderID);
        self::$_price_has_been_fixed[$orderID] = $value;
    }

    /**
     * @param int $orderID
     * @return bool|null
     */
    public static function get_price_has_been_fixed($orderID = 0)
    {
        $orderID = ShoppingCart::current_order_id($orderID);

        return isset(self::$_price_has_been_fixed[$orderID]) ? self::$_price_has_been_fixed[$orderID] : null;
    }

    /**
     * @description - tells you if an order item price has been "fixed"
     * meaning that is has been saved in the CalculatedTotal field so that
     * it can not be altered.
     *
     * Default returns false; this is good for uncompleted orders
     * but not so good for completed ones.
     *
     * We use direct calls to self::$_price_has_been_fixed to make the code simpler and faster.
     *
     * @return bool
     **/
    protected function priceHasBeenFixed($recalculate = false)
    {
        if (self::get_price_has_been_fixed($this->OrderID) === null || $recalculate) {
<?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.");
        }
    }

}
            self::$_price_has_been_fixed[$this->OrderID] = false;
<?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 ($order = $this->Order()) {
                if ($order->IsSubmitted()) {
                    self::$_price_has_been_fixed[$this->OrderID] = true;
<?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 ($recalculate) {
                        user_error('You are trying to recalculate an order that is already submitted.', E_USER_NOTICE);
                    }
                }
            }
        }

        return self::$_price_has_been_fixed[$this->OrderID];
<?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.");
        }
    }

}
    }

    ######################
    ## TEMPLATE METHODS ##
    ######################

    /**
     * This is a key function that returns the type of the
     * object.  In principle anything can be returned
     * but the intention is to only return a few options
     * e.g. OrderItem, Tax, Delivery, etc... so that
     * computations can be carried out based on the type of
     * OrderAttribute we are looking at.
     * It also allows to get a group of Order Attributes that
     * contains both modifiers and orderItems.
     *
     * @return string
     */
    public function OrderAttributeType()
    {
        return $this->ClassName;
    }

    /**
     * returns the order - for some unknown reason it seems we need this.
     *
     * @return Order | null

     */
    public function Order()
    {
        return Order::get()->byID($this->OrderID);
<?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 a string of class names, in order
     * of hierarchy from OrderAttribute for the
     * current attribute.
     *
     * e.g.: "product_orderitem orderitem
     * orderattribute".
     *
     * Used by the templates and for ajax updating functionality.
     *
     * @return string
     */
    public function Classes()
    {
        $class = get_class($this);
        $classes = array();
        $classes[] = strtolower($class);
        while (get_parent_class($class) != 'DataObject' && $class = get_parent_class($class)) {
            $classes[] = strtolower($class);
        }
        if (is_a($this, Object::getCustomClass('OrderItem'))) {
            $classes[] = strtolower($this->BuyableClassName);

        }

        return implode(' ', $classes);
    }

    /**
     * returns the instance of EcommerceConfigAjax for use in templates.
     * In templates, it is used like this:
     * $EcommerceConfigAjax.TableID.
     *
     * @return EcommerceConfigAjax

     **/
    public function AJAXDefinitions()
    {
        return EcommerceConfigAjax::get_one($this);
    }

    /**
     * returns the instance of EcommerceDBConfig.
     *
     * @return EcommerceDBConfig
     **/
    public function EcomConfig()
    {
        return EcommerceDBConfig::current_ecommerce_db_config();
    }

    /*
     * Should this item be shown on check out page table?
     * @return bool
     **/
    public function ShowInTable()
    {
        return true;
    }

    /**
     *Should this item be shown on in the cart (which is on other pages than the checkout page).
     *
     *@return bool
     **/
    public function ShowInCart()
    {
        return $this->ShowInTable();
    }

    /**
     * Return a name of what this attribute is
     * called e.g. "Product 21" or "Discount".
     *
     * @return string
     */
    public function TableTitle()
    {
        return $this->getTableTitle();
    }
    public function getTableTitle()
    {
        return $this->i18n_singular_name();
    }

    /**
     * Return a name of what this attribute is
     * called e.g. "Product 21" or "Discount"
     * Cart is a short version of table.
     *
     * @return string
     */
    public function CartTitle()
    {
        return $this->getCartTitle();
    }
    public function getCartTitle()
    {
        return $this->TableTitle();
    }

    /**
     * the sub title for the order item or order modifier.
     *
     * @return string
     **/
    public function TableSubTitle()
    {
        return $this->getTableSubTitle();
    }
    public function getTableSubTitle()
    {
        return '';
    }

    /**
     * the sub title for the order item or order modifier.
     *
     * @return string
     **/
    public function TableSubTitleNOHTML()
    {
        return $this->getTableSubTitleNOHTML();
    }
    public function getTableSubTitleNOHTML()
    {
        return str_replace("\n", '', strip_tags($this->getTableSubTitle()));
    }

    /**
     * the sub title for the order item or order modifier.
     * Cart is a short version of table.
     *
     * @return string
     **/
    public function CartSubTitle()
    {
        return $this->getCartSubTitle();
    }
    public function getCartSubTitle()
    {
        return $this->TableSubTitle();
    }

    /**
     * Returns the Money object of the CalculatedTotal.
     *
     * @return Money
     **/
    public function CalculatedTotalAsMoney()
    {
        return $this->getCalculatedTotalAsMoney();
    }
    public function getCalculatedTotalAsMoney()
    {
        return EcommerceCurrency::get_money_object_from_order_currency($this->CalculatedTotal, $this->Order());
<?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.");
        }
    }

}
    }

    public function runUpdate($force = false)
    {
        $this->baseRunUpdateCalled = true;
<?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
     * We add the Sort value from the OrderAttribute_Group to the OrderAttribute.
     */
    public function onBeforeWrite()
    {
        parent::onBeforeWrite();
        if ($this->OrderAttribute_GroupID) {
<?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 ($group = $this->OrderAttribute_Group()) {
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
                $this->GroupSort = $group->Sort;
<?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 onAfterWrite()
    {
        parent::onAfterWrite();
        //crucial!
        Order::set_needs_recalculating(true, $this->OrderID);
<?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.");
        }
    }

}
    }

    /**
     * Debug helper method.
     * Access through : /shoppingcart/debug/.
     */
    public function debug()
    {
        $html = EcommerceTaskDebugCart::debug_object($this);

        return $html;
    }
}

sunnysideup / silverstripe-ecommerce

OrderAttribute F last analyzed 2019-09-15 09:38 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

34 Methods

How to fix Complexity

Complex Class

Duplication Side-by-Side

Filter issues like

OrderAttribute F
last analyzed 2019-09-15 09:38 UTC
