DMSDocumentCartController

Complexity

Total Complexity

37

Size/Duplication

Total Lines	285
Duplicated Lines	3.16 %

Coupling/Cohesion

Components	1
Dependencies	15

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	init()	0	5	1
A	items()	0	4	1
A	getReceiverInfo()	0	17	4
A	getIsCartEmpty()	0	4	1
D	add()	4	43	10
A	deduct()	5	17	4
A	remove()	0	12	2
B	validateAddRequest()	0	22	4
C	updateCartItems()	0	32	8
A	view()	0	12	1
A	DMSCartEditForm()	0	18	1

<?php

class DMSDocumentCartController extends DMSCartAbstractController

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

{
    private static $url_handlers = array(

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

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

        '$Action//$ID' => 'handleAction',
    );

    private static $allowed_actions = array(

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

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

        'DMSCartEditForm',
        'add',
        'deduct',
        'remove',
        'view'
    );

    public function init()
    {
        parent::init();
        Requirements::css(DMS_CART_DIR . '/css/dms-cart.css');
    }
    /**
     * See {@link DMSDocumentCart::getItems()}
     *
     * @return ArrayList
     */
    public function items()
    {
        return $this->getCart()->getItems();
    }

    /**
     * Prepares receiver info for the template.
     * Additionally it uses Zend_Locale to retrieve the localised spelling of the Country
     *
     * @return array
     */
    public function getReceiverInfo()
    {
        $receiverInfo = $this->getCart()->getReceiverInfo();

        if (isset($receiverInfo['DeliveryAddressCountry']) && $receiverInfo['DeliveryAddressCountry']) {
            $source = Zend_Locale::getTranslationList('territory', $receiverInfo['DeliveryAddressCountry'], 2);
            $receiverInfo['DeliveryAddressCountryLiteral'] = $source[$receiverInfo['DeliveryAddressCountry']];
        }

        if (!empty($receiverInfo)) {
            $result = $receiverInfo;
        } else {
            $result = array('Result' => 'no data');
        }

        return $result;
    }

    /**
     * See DMSDocumentCart::isCartEmpty()
     *
     * @return bool
     */
    public function getIsCartEmpty()
    {
        return $this->getCart()->isCartEmpty();
    }

    /**
     * Add quantity to an item that exists in {@link DMSDocumentCart}.
     * If the item does nt exist, try to add a new item of the particular
     * class given the URL parameters available.
     *
     * @param SS_HTTPRequest $request
     *
     * @return SS_HTTPResponse|string
     */
    public function add(SS_HTTPRequest $request)
    {
        $quantity = ($request->requestVar('quantity')) ? intval($request->requestVar('quantity')) : 1;
        $documentId = (int)$request->param('ID');
        $result = true;
        $message = '';

        if ($doc = DMSDocument::get()->byID($documentId)) {
            /** @var ValidationResult $validate */
            $validate = $this->validateAddRequest($quantity, $doc);

$doc of type object<DataObject> is not a sub-type of object<DMSDocument>. It seems like you assume a child class of the class DataObject to be always present.

            if ($validate->valid()) {
                if ($this->getCart()->getItem($documentId)) {
                    $this->getCart()->updateItemQuantity($documentId, $quantity);
                } else {
                    $requestItem = DMSRequestItem::create()->setDocument($doc)->setQuantity($quantity);

$doc of type object<DataObject> is not a sub-type of object<DMSDocument>. It seems like you assume a child class of the class DataObject to be always present.

                    $this->getCart()->addItem($requestItem);
                }
                $backURL = $request->getVar('BackURL');
                // make sure that backURL is a relative path (starts with /)
                if (isset($backURL) && preg_match('/^\//', $backURL)) {
                    $this->getCart()->setBackUrl($backURL);
                }
            } else {
                $message = $validate->starredList();
                $result = false;
            }
        }

        if ($request->isAjax()) {

This code seems to be duplicated across your project.

            $this->response->addHeader('Content-Type', 'application/json');
            return Convert::raw2json(array('result' => $result, 'message' => $message));
        }

        if (!$result) {
            Session::set('dms-cart-validation-message', $message);
        }

        if ($backURL = $request->getVar('BackURL')) {
            return $this->redirect($backURL);
        }

        return $this->redirectBack();
    }

    /**
     * Deduct quantity from an item that exists in {@link DMSDocumentCart}
     *
     * @param SS_HTTPRequest $request
     *
     * @return SS_HTTPResponse|string
     */
    public function deduct(SS_HTTPRequest $request)
    {
        $quantity = ($request->requestVar('quantity')) ? intval($request->requestVar('quantity')) : 1;
        $this->getCart()->updateItemQuantity((int)$request->param('ID'), $quantity);
        $this->redirectBack();

        if ($request->isAjax()) {

This code seems to be duplicated across your project.

            $this->response->addHeader('Content-Type', 'application/json');

            return Convert::raw2json(array('result' => true));
        }
        if ($backURL = $request->getVar('BackURL')) {
            return $this->redirect($backURL);
        }

        return $this->redirectBack();
    }

    /**
     * Completely remove an item that exists in {@link DMSDocumentCart}
     *
     * @param SS_HTTPRequest $request
     *
     * @return string

Should the return type not be string|SS_HTTPResponse|null|false?

     */
    public function remove(SS_HTTPRequest $request)
    {
        $this->getCart()->removeItemByID(intval($request->param('ID')));

        if ($request->isAjax()) {
            $this->response->addHeader('Content-Type', 'application/json');

            return Convert::raw2json(array('result' => !$this->getIsCartEmpty()));
        }

        return $this->redirectBack();
    }

    /**
     * Validates a request to add a document to the cart
     *
     * @param  int $quantity
     * @param  DMSDocument $document
     * @return ValidationResult
     */
    protected function validateAddRequest($quantity, DMSDocument $document)
    {
        $result = ValidationResult::create();

        if (!$document->isAllowedInCart()) {
            $result->error(
                _t('DMSDocumentCartController.ERROR_NOT_ALLOWED', 'You are not allowed to add this document')
            );
        }

        if ($document->getHasQuantityLimit() && $quantity > $document->getMaximumQuantity()) {
            $result->error(_t(
                'DMSDocumentCartController.ERROR_QUANTITY_EXCEEDED',
                'Maximum of {max} documents exceeded for "{title}", please select a lower quantity.',
                array('max' => $document->getMaximumQuantity(), 'title' => $document->getTitle())

array('max' => $document->getMaximumQuantity(), 'title' => $document->getTitle()) is of type array<string,?,{"max":"?","title":"string"}>, but the function expects a string.

            ));
        }

        $this->extend('updateValidateAddRequest', $result, $quantity, $document);

        return $result;
    }

    /**
     * Updates the document quantities just before the request is sent.
     *
     * @param array $data
     * @param Form $form
     * @param SS_HTTPRequest $request
     *
     * @return SS_HTTPResponse

Should the return type not be SS_HTTPResponse|null?

     */
    public function updateCartItems($data, Form $form, SS_HTTPRequest $request)

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

    {
        $errors = array();
        if (!empty($data['ItemQuantity'])) {
            foreach ($data['ItemQuantity'] as $itemID => $quantity) {
                if (!is_numeric($quantity) || $quantity < 0) {
                    continue;
                }
                // Only update if quantity has changed
                $item = $this->getCart()->getItem($itemID);
                if ($item->getQuantity() == $quantity) {
                    continue;
                }
                // No validate item
                $validate = $this->validateAddRequest($quantity, $item->getDocument());
                if ($validate->valid()) {
                    // Removes, then adds a item new item.
                    $this->getCart()->removeItem($item);

It seems like $item defined by $this->getCart()->getItem($itemID) on line 212 can also be of type boolean; however, DMSDocumentCart::removeItem() does only seem to accept object<DMSRequestItem>, maybe add an additional type check?

                    $this->getCart()->addItem($item->setQuantity($quantity));
                } else {
                    $errors[] = $validate->starredList();
                }
            }
        }

        if (!empty($errors)) {
            $form->sessionMessage(implode('<br>', $errors), 'bad', false);
            return $this->redirectBack();
        }

        return $this->redirect($this->getCart()->getBackUrl());
    }

    /**
     * Presents an interface for user to update the cart quantities
     *
     * @param SS_HTTPRequest $request
     * @return ViewableData_Customised
     */
    public function view(SS_HTTPRequest $request)

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

    {
        $this->getCart()->setViewOnly(true);
        $form = $this->DMSCartEditForm();
        return $this
            ->customise(
                array(
                'Form'  => $form,
                'Title' => _t(__CLASS__ . '.UPDATE_TITLE', 'Updating cart items')
                )
            );
    }

    /**
     * Gets and displays an editable list of items within the cart.
     *
     * To extend use the following from within an Extension subclass:
     *
     * <code>
     * public function updateDMSCartEditForm($form)
     * {
     *     // Do something here
     * }
     * </code>
     *
     * @return Form
     */
    public function DMSCartEditForm()
    {
        $actions = FieldList::create(
            FormAction::create(
                'updateCartItems',
                _t(__CLASS__ . '.SAVE_BUTTON', 'Save changes')
            )
        );
        $form = Form::create(
            $this,
            'DMSCartEditForm',
            FieldList::create(),
            $actions
        );
        $form->setTemplate('DMSDocumentRequestForm');
        $this->extend('updateDMSCartEditForm', $form);
        return $form;
    }
}