EcommerceDashboardPanel

Complexity

Total Complexity

24

Size/Duplication

Total Lines	199
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	12

Importance

Changes

0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	getLabel()	0	4	1
A	getTitle()	0	8	2
A	getLabelPrefix()	0	4	1
A	getConfiguration()	0	8	1
A	openOrders()	0	11	1
A	submittedOrders()	0	9	1
A	archivedOrders()	0	12	1
A	getDashboard()	0	4	1
B	excludedMembersArray()	0	20	6
A	daysBackWhereStatement()	0	7	3
A	maxOrdersForLoop()	0	4	1
A	registered()	0	11	3
A	CalculatedDaysBack()	0	4	2

<?php

class EcommerceDashboardPanel extends DashboardPanel

PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions.

{


    /**
     * @var bool Show the configure form after creating. Used for panels that require
     * configuration in order to show data
     */
    private static $configure_on_create = true;

Consider using a different property name as you override a private property of the parent class.

The property $configure_on_create is not used and could be removed.

    private static $db = array(

Consider using a different property name as you override a private property of the parent class.

The property $db is not used and could be removed.

        'DaysBack' => 'Int'
    );

    private static $defaults = array(

Consider using a different property name as you override a private property of the parent class.

The property $defaults is not used and could be removed.

        'DaysBack' => 7
    );


    private static $icon = "ecommerce_dashboard/images/icons";

Consider using a different property name as you override a private property of the parent class.

The property $icon is not used and could be removed.

    public function getLabel()
    {
        return $this->getLabelPrefix();
    }

    public function getTitle()
    {
        $str = $this->getLabelPrefix();
        if ($this->DaysBack) {

The property DaysBack does not exist on object<EcommerceDashboardPanel>. Since you implemented __get, maybe consider adding a @property annotation.

            $str .= ' '.sprintf(_t('EcommerceDashboardPanel.IN_THE_LAST_XXX_DAYS', 'in the last %s days.'), $this->DaysBack);

The property DaysBack does not exist on object<EcommerceDashboardPanel>. Since you implemented __get, maybe consider adding a @property annotation.

        }
        return $str;
    }

    public function getLabelPrefix()
    {
        return 'please set in '.$this->ClassName;
    }

    public function getConfiguration()
    {
        $fields = parent::getConfiguration();
        $fields->push(NumericField::create("DaysBack", "Number of days back"));
        $fields->replaceField('Title', ReadonlyField::create('Title', ''));

        return $fields;
    }

    /**
     *
     *
     * @return DataList
     */
    protected function openOrders($numberOfDaysBack = 7)

The parameter $numberOfDaysBack is not used and could be removed.

    {
        $firstStep = DataObject::get_one('OrderStep');
        $orders = Order::get()
            ->LeftJoin('OrderStatusLog', '"Order"."ID" = "OrderStatusLog"."OrderID"')
            ->LeftJoin($submittedOrderStatusLogClassName, '"OrderStatusLog"."ID" = "'.$submittedOrderStatusLogClassName.'"."ID"')

The variable $submittedOrderStatusLogClassName does not exist. Did you forget to declare it?

            ->filter(array('StatusID' => $firstStep->ID))
            ->exclude(array('MemberID' => $this->excludedMembers()));

The method excludedMembers() does not exist on EcommerceDashboardPanel. Did you maybe mean excludedMembersArray()?

        return $orders;
    }

    /**
     *
     *
     * @return DataList
     */
    protected function submittedOrders($numberOfDaysBack = 0)
    {
        $orders = Order::get_datalist_of_orders_with_submit_record();
        $orders = $orders
            ->exclude(array('MemberID' => $this->excludedMembersArray()))
            ->where($this->daysBackWhereStatement($numberOfDaysBack));

        return $orders;
    }

    /**
     *
     *
     * @return DataList
     */
    protected function archivedOrders($numberOfDaysBack = 0)
    {
        $submittedOrderStatusLogClassName = EcommerceConfig::get('OrderStatusLog', 'order_status_log_class_used_for_submitting_order');
        $lastStep = OrderStep::last_order_step();
        return Order::get()
            ->LeftJoin('OrderStatusLog', '"Order"."ID" = "OrderStatusLog"."OrderID"')
            ->LeftJoin($submittedOrderStatusLogClassName, '"OrderStatusLog"."ID" = "'.$submittedOrderStatusLogClassName.'"."ID"')
            ->filter(array('StatusID' => $lastStep->ID))
            ->exclude(array('MemberID' => $this->excludedMembersArray()))
            ->where($this->daysBackWhereStatement($numberOfDaysBack));
        return $orders;

return $orders; does not seem to be reachable.

    }



    /**
     * An accessor to the Dashboard controller
     *
     * @return Dashboard
     */
    public function getDashboard()
    {
        return Injector::inst()->get("EcommerceDashboard");
    }

    /**
     *
     *
     * @var array
     */
    private static $_excluded_members_array = array();

    /**
     *
     *
     * @return array array of member IDs
     */
    protected function excludedMembersArray()
    {
        if (! count(self::$_excluded_members_array)) {
            self::$_excluded_members_array = array(-1 => -1);
            $adminGroup = EcommerceRole::get_admin_group();
            $assitantGroup = EcommerceRole::get_assistant_group();
            if ($adminGroup) {
                foreach ($adminGroup->Members() as $member) {
                    self::$_excluded_members_array[$member->ID] = $member->ID;
                }
            }
            if ($assitantGroup) {
                foreach ($assitantGroup->Members() as $member) {
                    self::$_excluded_members_array[$member->ID] = $member->ID;
                }
            }
        }

        return self::$_excluded_members_array;
    }

    /**
     *
     *
     * @return string where statement for orders that have been submitted.
     */
    protected function daysBackWhereStatement($daysBack = 0)
    {
        if (! $daysBack) {
            $daysBack = $this->DaysBack ? $this->DaysBack : $this->Config()->defaults['DaysBack'];

The property DaysBack does not exist on object<EcommerceDashboardPanel>. Since you implemented __get, maybe consider adding a @property annotation.

        }
        return '"OrderStatusLog"."Created" > ( NOW() - INTERVAL '.($daysBack).' DAY )';
    }

    /**
     * @var int The "weight" of the dashboard panel when listed in the available panels.
     *			Higher is lower in the list.
     */
    //private static $priority = 100;

50% of this comment could be valid code. Did you maybe forget this after debugging?

    /**
     * @var string The name of the template used for the contents of this panel.
     */
    //protected $template;

    public function maxOrdersForLoop()
    {
        return 500;
    }


    /**
     * Allows the panel to be added
     *
     * @return string
     */
    public function registered()
    {
        $enabled = Config::inst()->get($this->ClassName, 'enabled');
        if (is_bool($enabled)) {
            return self::config()->enabled;
        }
        if (strtolower(self::config()->enabled) == 'no') {

This if statement, and the following return statement can be replaced with return !(strtolower(self::config()->enabled) == 'no');.

            return false;
        }
        return true;
    }

    protected function CalculatedDaysBack()

The return type could not be reliably inferred; please add a @return annotation.

    {
        return $this->DaysBack ? : 7;

The property DaysBack does not exist on object<EcommerceDashboardPanel>. Since you implemented __get, maybe consider adding a @property annotation.

    }
}