DMSCheckoutController

Complexity

Total Complexity

20

Size/Duplication

Total Lines	252
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	14

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	init()	0	6	1
A	index()	0	10	1
B	DMSDocumentRequestForm()	0	41	4
B	send()	0	29	3
A	doRequestSend()	0	10	1
A	complete()	0	14	1
A	getCart()	0	4	1
A	updateCartItems()	0	13	4
A	updateCartReceiverInfo()	0	5	1
A	Link()	0	4	1
A	getConfirmationBcc()	0	9	2

<?php

class DMSCheckoutController extends ContentController

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

{
    private static $allowed_actions = array(

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

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

        'DMSDocumentRequestForm',
        'index',
        'complete',
        'send'
    );

    /**
     * An array containing the recipients basic information
     *
     * @config
     * @var array
     */
    private static $receiver_info = array(

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

        'ReceiverName'            => '',
        'ReceiverPhone'           => '',
        'ReceiverEmail'           => '',
        'DeliveryAddressLine1'    => '',
        'DeliveryAddressLine2'    => '',
        'DeliveryAddressCountry'  => '',
        'DeliveryAddressPostCode' => '',
    );

    public function init()
    {
        parent::init();

        Requirements::css(DMS_CART_DIR . '/css/dms-cart.css');
    }

    public function index()
    {
        $form = $this->DMSDocumentRequestForm();
        return $this
            ->customise(array(
                'Form' => $form,
                'Title' => _t(__CLASS__ . '.CHECKOUT_TITLE', 'Checkout')
            ))
            ->renderWith(array('Page', 'DMSDocumentRequestForm'));
    }

    /**
     * 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 Form
     */
    public function DMSDocumentRequestForm()
    {
        $fields = DMSDocumentCartSubmission::create()->scaffoldFormFields();
        $fields->replaceField('DeliveryAddressLine2', TextField::create('DeliveryAddressLine2', ''));
        $fields->replaceField('DeliveryAddressCountry', CountryDropdownField::create(
            'DeliveryAddressCountry',
            _t(__CLASS__ . '.RECEIVER_COUNTRY', 'Country')
        )->setValue('NZ'));

        $requiredFields = array(
            'ReceiverName',
            'ReceiverPhone',
            'ReceiverEmail',
            'DeliveryAddressLine1',
            'DeliveryAddressCountry',
            'DeliveryAddressPostCode',
        );
        foreach ($fields as $field) {
            if (in_array($field->name, $requiredFields)) {
                $field->addExtraClass('requiredField');
            }
        }
        $validator = RequiredFields::create($requiredFields);
        $actions = FieldList::create(
            FormAction::create(
                'doRequestSend',
                _t(__CLASS__ . '.SEND_ACTION', 'Send your request')
            )
        );

        $form = Form::create($this, 'DMSDocumentRequestForm', $fields, $actions, $validator);

        if ($receiverInfo = $this->getCart()->getReceiverInfo()) {
            $form->loadDataFrom($receiverInfo);
        }

        $form->setTemplate('DMSDocumentRequestForm');
        $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
     */
    public function send()
    {
        $cart = $this->getCart();
        $from = Config::inst()->get('Email', 'admin_email');
        $emailAddress = ($info = $cart->getReceiverInfo()) ? $info['ReceiverEmail'] : $from;
        $email = Email::create(
            $from,
            $emailAddress,
            _t(__CLASS__ . '.EMAIL_SUBJECT', 'Request for Printed Publications')
        );

        if ($bcc = $this->getConfirmationBcc()) {
            $email->setBcc($bcc);
        }

        $renderedCart = $cart->renderWith('DocumentCart_email');
        $body = sprintf(
            '<p>%s</p>',
            _t(
                __CLASS__ . '.EMAIL_BODY',
                'A request for printed publications has been submitted with the following details:'
            )
        );
        $body .= $renderedCart->getValue();
        $email->setBody($body)->setReplyTo($emailAddress);
        $this->extend('updateSend', $email);

        return $email->send();
    }

    /**
     * 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

Should the return type not be SS_HTTPResponse|null?

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

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

    {
        $this->updateCartItems($data);
        $this->updateCartReceiverInfo($data);
        $this->send();
        $this->getCart()->saveSubmission($form);
        $this->getCart()->emptyCart();

        return $this->redirect($this->Link('complete'));
    }

    /**
     * Displays the preconfigured thank you message to the user upon completion
     *
     * @return ViewableData
     */
    public function complete()
    {
        $data = array(
            'Title' => _t(__CLASS__ . '.COMPLETE_THANKS', 'Thanks!'),
            'Content' => _t(
                __CLASS__ . '.COMPLETE_MESSAGE',
                'Thank you. You will receive a confirmation email shortly.'
            )
        );

        $this->extend('updateCompleteMessage', $data);

        return $this->customise($data)->renderWith('Page');
    }

    /**
     * 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 (!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(static::config()->get('receiver_info'), $data);
        $this->getCart()->setReceiverInfo($info);
    }

    /**
     * Ensure that links for this controller use the customised route
     *
     * @param  string $action

Should the type for parameter $action not be string|null?

     * @return string
     */
    public function Link($action = null)
    {
        return $this->join_links('checkout', $action);
    }

    /**
     * If BCC email addresses are configured, return the addresses to send to in comma delimited format
     *
     * @return string

Should the return type not be false|string?

     */
    protected function getConfirmationBcc()
    {
        $emails = (array) static::config()->get('recipient_emails');
        if (empty($emails)) {
            return false;
        }

        return implode(',', $emails);
    }
}