DMSDocumentCartCheckoutPage_Controller

Complexity

Total Complexity

16

Size/Duplication

Total Lines	181
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	10

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
B	DMSDocumentRequestForm()	0	26	3
B	send()	0	26	3
A	doRequestSend()	0	10	1
A	trackTimestampedPrintRequest()	0	9	2
A	getCart()	0	4	1
B	updateCartItems()	0	13	5
A	updateCartReceiverInfo()	0	5	1

<?php
/**
 * @property Text $ThanksMessage
 * @property Int  $CartEmailRecipientID
 *
 * @method Member CartEmailRecipient
 */
class DMSDocumentCartCheckoutPage extends Page

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.

        'ThanksMessage' => 'Text',
    );

    private static $has_one = array(

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

        'CartEmailRecipient'     => 'Member'
    );

    private static $defaults = array(

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

        'URLSegment'  => 'checkout',
        'ShowInMenus' => false,
    );

    public function getCMSFields()

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

    {
        $fields = parent::getCMSFields();
        $members = Member::get('Member');
        $recipientDropDown = DropdownField::create(
            'CartEmailRecipientID',
            _t('DMSDocumentCartCheckoutPage.CART_RECIPIENT', 'Account to receive document print requests'),
            $members->Map()->toArray()
        )->setEmptyString(_t(
            'DMSDocumentCartCheckoutPage.CART_RECIPIENT_EMPTY_STRING',
            'Select a member'
        ));
        $fields->insertBefore('Content', $recipientDropDown);

        $fields->insertBefore(
            'Content',
            TextareaField::create(
                'ThanksMessage',
                _t('DMSDocumentCartCheckoutPage.THANK_YOU_MESSAGE', 'Thank you message')
            )
        );

        return $fields;
    }
    /**
     * Automatically create a CheckoutPage if one is not found
     * on the site at the time the database is built (dev/build).
     */
    function requireDefaultRecords()

It is generally recommended to explicitly declare the visibility for methods.

    {
        parent::requireDefaultRecords();

        if (!SiteTree::get_one($this->class)) {
            /** @var DMSDocumentCartCheckoutPage $page */
            $page = self::create();
            $page->Title = 'Request a printed copy';
            $page->MenuTitle = 'Document Cart Checkout';
            $page->Content = '';
            $page->URLSegment = 'checkout';
            $page->ShowInMenus = 0;
            $page->ThanksMessage = 'Thanks for your request.';
            $page->write();
            $page->publish('Stage', 'Live');
            $page->flushCache();
            DB::alteration_message(
                _t(
                    'DMSDocumentCartCheckoutPage.ALTERATION_MESSAGE',
                    'Document Cart Checkout page \'Request a printed copy\' created'
                ),
                'created'
            );
        }
    }
}

class DMSDocumentCartCheckoutPage_Controller extends Page_Controller

PSR1 recommends that each class should be in its own file to aid autoloaders.

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

{
    private static $allowed_actions = array(

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

        'DMSDocumentRequestForm'
    );

    /**
     * An array containing the recipients basic information
     *
     * @var array
     */
    public static $receiverInfo = array(
        'ReceiverName'            => '',
        'ReceiverPhone'           => '',
        'ReceiverEmail'           => '',
        'DeliveryAddressLine1'    => '',
        'DeliveryAddressLine2'    => '',
        'DeliveryAddressCountry'  => '',
        'DeliveryAddressPostCode' => '',
    );

    /**
     * Gets and displays an editable list of items within the cart, as well as a contact form with entry
     * fields for the recipients information.
     *
     * To extend use the following from within an Extension subclass:
     *
     * <code>
     * public function updateDMSDocumentRequestForm($form)
     * {
     *     // Do something here
     * }
     * </code>
     *
     * @return DMSDocumentRequestForm
     */
    public function DMSDocumentRequestForm()
    {
        $fields = DMSDocumentCartSubmission::create()->scaffoldFormFields();
        $fields->replaceField('DeliveryAddressLine2', TextField::create('DeliveryAddressLine2', ''));
        $fields->replaceField(
            'DeliveryAddressCountry',
            CountryDropdownField::create(
                'DeliveryAddressCountry',
                _t('DMSDocumentCartCheckoutPage.RECEIVER_COUNTRY', 'Country')
            )->setValue('NZ')
        );

        $form = DMSDocumentRequestForm::create($this, 'DMSDocumentRequestForm', $fields, FieldList::create());
        if ($receiverInfo = $this->getCart()->getReceiverInfo()) {
            $form->loadDataFrom($receiverInfo);
        }

        if ($message = $this->request->getVar('message')) {

$message is not used, you could remove the assignment.

            $form->sessionMessage($this->ThanksMessage, 'good');
        } else {
            $form->clearMessage();
        }
        $this->extend('updateDMSDocumentRequestForm', $form);

        return $form;
    }

    /**
     * Sends an email to both the configured recipient as well as the requester. The
     * configured recipient is bcc'ed to the email in order to fulfill it.
     *
     * To extend use the following from within an Extension subclass:
     *
     * <code>
     * public function updateSend($email)
     * {
     *     // Do something here
     * }
     * </code>
     * @return mixed
     *
     * @throws DMSDocumentCartException
     */
    public function send()
    {
        $member = $this->CartEmailRecipient();
        if ($member->exists()) {
            $cart = $this->getCart();
            $from = Config::inst()->get('Email', 'admin_email');
            $emailAddress = ($info = $cart->getReceiverInfo()) ? $info['ReceiverEmail'] : $from;
            $email = Email::create(
                $from,
                $emailAddress,
                _t('DMSDocumentCartCheckoutPage.EMAIL_SUBJECT', 'Request for Printed Publications')
            );
            $email->setBcc($member->Email);
            $renderedCart = $cart->renderWith('DocumentCart_email');
            $body = _t(
                'DMSDocumentCartCheckoutPage.EMAIL_BODY',
                '<p>A request for printed publications has been submitted with the following details:</p>'
            );
            $body .= $renderedCart->getValue();
            $email->setBody($body)->setReplyTo($emailAddress);
            $this->extend('updateSend', $email);
            return $email->send();
        } else {
            throw new DMSDocumentCartException('No recipient has been configured. Please do so from the CMS');
        }
    }

    /**
     * Handles form submission.
     * Totals requested are updated, delivery details added, email sent for fulfillment
     * and print request totals updated.
     *
     * @param array          $data
     * @param Form           $form
     * @param SS_HTTPRequest $request
     *
     * @return SS_HTTPResponse
     */
    public function doRequestSend($data, Form $form, SS_HTTPRequest $request)
    {
        $this->updateCartItems($data);
        $this->updateCartReceiverInfo($data);
        $this->send();
        $this->trackTimestampedPrintRequest();
        $this->getCart()->saveSubmission($form);
        $this->getCart()->emptyCart();
        return $this->redirect("{$this->Link()}?message=1");
    }

    /**
     * Increments the print counts of all documents which were successfully sent.
     */
    public function trackTimestampedPrintRequest()
    {
        /** @var DMSRequestItem $item */
        foreach ($this->getCart()->getItems() as $item) {
            /** @var DMSDocument|DMSDocumentCartExtension $doc */
            $doc = $item->getDocument();
            $doc->incrementPrintRequest();

The method incrementPrintRequest does only exist in DMSDocumentCartExtension, but not in DMSDocument.

        }
    }

    /**
     * Retrieves a {@link DMSDocumentCart} instance
     *
     * @return DMSDocumentCart
     */
    public function getCart()
    {
        return singleton('DMSDocumentCart');
    }

    /**
     * Updates the document quantities just before the request is sent.
     *
     * @param array $data
     */
    public function updateCartItems($data)
    {
        if (isset($data['ItemQuantity']) && !empty($data['ItemQuantity'])) {
            foreach ($data['ItemQuantity'] as $itemID => $quantity) {
                // Only update if quantity has changed
                $item = $this->getCart()->getItem($itemID);
                if ($item->getQuantity() == $quantity) {
                    continue;
                }
                $this->getCart()->updateItemQuantity($itemID, $quantity - 1);
            }
        }
    }

    /**
     * Updates the cart receiver info just before the request is sent.
     *
     * @param array          $data
     */
    public function updateCartReceiverInfo($data)
    {
        $info = array_merge(self::$receiverInfo, $data);
        $this->getCart()->setReceiverInfo($info);
    }
}