OrderProcessQueue

Complexity

Total Complexity

25

Size/Duplication

Total Lines	303
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	14

Importance

Changes

0

15 Methods

Rating	Name	Duplication	Size	Complexity
A	canCreate()	0	4	1
B	canView()	0	19	5
A	canEdit()	0	4	1
A	canDelete()	0	4	1
A	i18n_singular_name()	0	4	1
A	i18n_plural_name()	0	4	1
A	AddOrderToQueue()	0	17	3
A	process()	0	14	3
A	getQueueObject()	0	6	1
A	removeOrderFromQueue()	0	6	1
A	OrdersToBeProcessed()	0	21	2
A	isReadyToGo()	0	4	1
A	ToBeProcessedAt()	0	4	1
A	getToBeProcessedAt()	0	4	1
B	getCMSFields()	0	27	2

<?php
/**
 * This class provides a bunch of Meta Objects
 * that do not interact with the object at hand, but rather with the datalist as a whole.
 *
 */

class OrderProcessQueue extends DataObject

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

{
    private static $db = array(

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

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

        'DeferTimeInSeconds' => 'Int',
        'InProcess' => 'Boolean'
    );

    private static $has_one = array(

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

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

        'Order' => 'Order'
    );

    private static $indexes = array(

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

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

        'OrderID' => array(
            'type' => 'unique',
            'value' => '"OrderID"'
        ),
        'Created' => true,
        'DeferTimeInSeconds' => true
    );

    private static $casting = array(

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

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

        'ToBeProcessedAt' => 'SS_Datetime'
    );

    private static $default_sort = array(

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

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

        'Created' => 'DESC'
    );

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

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

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

        'Order.Title' => 'Order',
        'Order.Status.Title' => 'Current Step',
        'ToBeProcessedAt.Nice' => 'To be processed at',
        'ToBeProcessedAt.Ago' => 'That is ...',
        'InProcess.Nice' => 'Currently Running'
    );

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

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

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

        'OrderID' => array(
            'field' => 'NumericField',
            'title' => 'Order Number',
        )
    );


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

Should the type for parameter $member not be Member|null?

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

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

Should the type for parameter $member not be Member|null?

     *
     * @return bool

Should the return type not be boolean|string|null?

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

$member is of type object<DataObject>|null, but the function expects a object<Member>|integer.

        if ($extended !== null) {
            return $extended;
        }
        if (Permission::checkMember($member, Config::inst()->get('EcommerceRole', 'admin_permission_code'))) {
            return true;
        }
        //is the member is a shop assistant they can always view it
        if (EcommerceRole::current_member_is_shop_assistant($member)) {
            return true;
        }

        return parent::canView($member);

It seems like $member defined by \Member::currentUser() on line 84 can also be of type object<DataObject>; however, DataObject::canView() does only seem to accept object<Member>|null, maybe add an additional type check?

    }

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

Should the type for parameter $member not be Member|null?

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

    /**
     * Standard SS method
     * logs can never be deleted...
     *
     * @param Member $member

Should the type for parameter $member not be Member|null?

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

    /**
     * standard SS variable.
     *
     * @var string
     */
    private static $singular_name = 'Order To Be Processed';

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

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

    public function i18n_singular_name()
    {
        return _t('OrderProcessQueue.SINGULAR_NAME', 'Order In Queue');
    }

    /**
     * standard SS variable.
     *
     * @var string
     */
    private static $plural_name = 'Orders to be Processed';

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

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

    public function i18n_plural_name()
    {
        return _t('OrderProcessQueue.PLURAL_NAME', 'Orders In Queue');
    }


    /**
     * META METHOD: Add an order to the job list.
     * If the order already exists, it will update the seconds and the creation  time.
     *
     * @param Order $order          [description]
     * @param Int   $deferInSeconds [description]

There is no parameter named $deferInSeconds. Was it maybe removed?

     */
    public function AddOrderToQueue($order, $deferTimeInSeconds)
    {
        $filter = array('OrderID' => $order->ID);
        $existingEntry = OrderProcessQueue::get()->filter($filter)->first();
        $filter['Created'] = SS_Datetime::now()->Rfc2822();
        $filter['DeferTimeInSeconds'] = $deferTimeInSeconds;
        if (! $existingEntry) {
            $existingEntry = OrderProcessQueue::create($filter);
        } else {
            foreach ($filter as $field => $value) {
                $existingEntry->$field = $value;
            }
        }
        $existingEntry->write();

        return $existingEntry;
    }

    /**
     * processes the order ...
     *
     * @param  Order $order
     */
    public function process($order)
    {
        $queueObjectSingleton = Injector::inst()->get('OrderProcessQueue');
        $myQueueObject = $queueObjectSingleton->getQueueObject($order);
        if ($myQueueObject && $myQueueObject->isReadyToGo()) {
            $myQueueObject->InProcess = true;
            $myQueueObject->write();
            $order->tryToFinaliseOrder(
                $tryAgain = false,
                $fromOrderQueue = true
            );
            $myQueueObject->delete();
        }
    }

    /**
     * META METHOD: returns the queue object if it exists
     *
     * @param  Order $order
     *
     * @return null |   OrderProcessQueue

Should the return type not be DataObject|null?

     */
    public function getQueueObject($order)
    {
        $filter = array('OrderID' => $order->ID);

        return OrderProcessQueue::get()->filter($filter)->first();
    }

    /**
     * META METHOD: Once you are done, you can remove the item like this ...
     *
     * @param  Order $order
     */
    public function removeOrderFromQueue($order)
    {
        $filter = array('OrderID' => $order->ID);
        $existingEntries = OrderProcessQueue::get()->filter($filter);
        $existingEntries->removeAll();
    }

    /**
     * META METHOD: returns a list of orders to be processed
     * @param int $id force this Order to be processed
     * @param int $limit total number of orders that can be retrieved at any one time
     * @return DataList (of orders)
     */
    public function OrdersToBeProcessed($id = 0, $limit = 9999)
    {
        $sql = '
            SELECT "OrderID"
            FROM "OrderProcessQueue"
            WHERE
                "InProcess" = 0
                AND
                (UNIX_TIMESTAMP("Created") + "DeferTimeInSeconds") < '.time().'
            ORDER BY "Created" DESC
            LIMIT '.$limit.';
        ';
        $rows = DB::query($sql);
        $orderIDs = array($id => $id);
        foreach ($rows as $row) {
            $orderIDs[$row['OrderID']] = $row['OrderID'];
        }

        return Order::get()
            ->filter(array('ID' => $orderIDs));
    }

    /**
     * non-database method of working out if an Order is ready to go.
     *
     * @return bool
     */
    public function isReadyToGo()
    {
        return (strtotime($this->Created) + $this->DeferTimeInSeconds) < time();

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

    }

    /**
     *
     * casted variable
     * @return SS_DateTime
     */
    public function ToBeProcessedAt()
    {
        return $this->getToBeProcessedAt();
    }

    /**
     *
     * casted variable
     * @return SS_DateTime
     */
    public function getToBeProcessedAt()
    {
        return DBField::create_field('SS_Datetime', (strtotime($this->Created) + $this->DeferTimeInSeconds));

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

    }


    /**
     * CMS Fields
     * @return FieldList
     */
    public function getCMSFields()
    {
        $fields = parent::getCMSFields();
        if($this->exists()) {
            $fields->addFieldToTab(
                'Root.Main',
                ReadonlyField::create(
                    'ToBeProcessedAtCompilations',
                    _t('OrderProcessQueue.TO_BE_PROCESSED', 'To Be Processed'),
                    $this->ToBeProcessedAt->Nice() . ' - ' . $this->getToBeProcessedAt()->Ago()

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

                ),
                'InProcess'
            );
            $fields->addFieldToTab(
                'Root.Main',
                LiteralField::create(
                    'processQueueNow',
                    '<h2>
                        <a href="/dev/tasks/EcommerceTaskProcessOrderQueue/?id='.$this->OrderID.'" target="_blank">'.

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

                            _t('OrderProcessQueue.PROCESS', 'Process now').
                        '</a>
                    </h2>'
                )
            );
        }
        return $fields;
    }
}