CheckoutPage

Complexity

Total Complexity

6

Size/Duplication

Total Lines	70
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	4

Test Coverage

Coverage

16.22%

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	find_link()	0	8	2
B	getCMSFields()	0	24	1
A	requireDefaultRecords()	0	17	3

<?php

/**
 * CheckoutPage is a CMS page-type that shows the order
 * details to the customer for their current shopping
 * cart on the site.
 *
 * @see     CheckoutPage_Controller->Order()
 *
 * @package shop
 */
class CheckoutPage extends Page
{
    private static $db   = array(
        'PurchaseComplete' => 'HTMLText',
    );

    private static $icon = 'silvershop/images/icons/money';

    /**
     * Returns the link to the checkout page on this site
     *
     * @param boolean $urlSegment If set to TRUE, only returns the URLSegment field
     *
     * @return string Link to checkout page
     */
    public static function find_link($urlSegment = false, $action = null, $id = null)
    {
        $base = CheckoutPage_Controller::config()->url_segment;
        if ($page = self::get()->first()) {
            $base = $page->Link();
        }
        return Controller::join_links($base, $action, $id);
    }

    public function getCMSFields()
    {
        $this->beforeUpdateCMSFields(function(FieldList $fields) {
            $fields->addFieldsToTab(
                'Root.Main',
                array(
                    HtmlEditorField::create(
                        'PurchaseComplete',
                        _t('CheckoutPage.db_PurchaseComplete', 'Purchase Complete'),
                        4
                    )
                        ->setDescription(
                            _t(
                                'CheckoutPage.PurchaseCompleteDescription',
                                "This message is included in reciept email, after the customer submits the checkout"
                            )
                        ),
                ),
                'Metadata'
            );
        });

        return parent::getCMSFields();
    }

    /**
     * This module always requires a page model.
     */
    public function requireDefaultRecords()
    {
        parent::requireDefaultRecords();
        if (!self::get()->exists() && $this->config()->create_default_pages) {
            $page = self::create(
                array(
                    'Title'       => 'Checkout',
                    'URLSegment'  => CheckoutPage_Controller::config()->url_segment,
                    'ShowInMenus' => 0,
                )
            );
            $page->write();
            $page->publish('Stage', 'Live');
            $page->flushCache();
            DB::alteration_message('Checkout page created', 'created');
        }
    }
}

/**
 * @package shop
 * @mixin CheckoutPage
 * @mixin SteppedCheckout
 * @mixin CheckoutStep_Address
 * @mixin CheckoutStep_AddressBook
 * @mixin CheckoutStep_ContactDetails
 * @mixin CheckoutStep_Membership
 * @mixin CheckoutStep_PaymentMethod
 * @mixin CheckoutStep_Summary
 */
class CheckoutPage_Controller extends Page_Controller
{
    private static $url_segment     = 'checkout';

    private static $allowed_actions = array(
        'OrderForm',
        'payment',
        'PaymentForm',
    );

    public function Title()
    {
        if ($this->Title) {
            return $this->Title;
        }

        return _t('CheckoutPage.DefaultTitle', "Checkout");
    }

    public function OrderForm()
    {
        if (!(bool)$this->Cart()) {
            return false;
        }

        /** @var CheckoutComponentConfig $config */
        $config = Injector::inst()->create("CheckoutComponentConfig", ShoppingCart::curr());
        $form = PaymentForm::create($this, 'OrderForm', $config);

        // Normally, the payment is on a second page, either offsite or through /checkout/payment
        // If the site has customised the checkout component config to include an onsite payment
        // component, we should honor that and change the button label. PaymentForm::checkoutSubmit
        // will also check this and process payment if needed.
        if ($config->getComponentByType('OnsitePaymentCheckoutComponent')) {
            $form->setActions(
                FieldList::create(
                    FormAction::create('checkoutSubmit', _t('CheckoutForm.SubmitPayment', 'Submit Payment'))
                )
            );
        }

        $form->Cart = $this->Cart();
        $this->extend('updateOrderForm', $form);

        return $form;
    }

    /**
     * Action for making on-site payments
     */
    public function payment()
    {
        if (!$this->Cart()) {
            return $this->redirect($this->Link());
        }

        return array(
            'Title'     => 'Make Payment',
            'OrderForm' => $this->PaymentForm(),
        );
    }

    public function PaymentForm()
    {
        if (!(bool)$this->Cart()) {
            return false;
        }

        $config = new CheckoutComponentConfig(ShoppingCart::curr(), false);
        $config->addComponent(OnsitePaymentCheckoutComponent::create());

        $form = PaymentForm::create($this, "PaymentForm", $config);

        $form->setActions(
            FieldList::create(
                FormAction::create("submitpayment", _t('CheckoutPage.SubmitPayment', "Submit Payment"))
            )
        );

        $form->setFailureLink($this->Link());
        $this->extend('updatePaymentForm', $form);

        return $form;
    }

    /**
     * Retrieves error messages for the latest payment (if existing).
     * This can originate e.g. from an earlier offsite gateway API response.
     *
     * @return string
     */
    public function PaymentErrorMessage()
    {
        $order = $this->Cart();
        if (!$order) {
            return false;

The return type of return false; (false) is incompatible with the return type documented by CheckoutPage_Controller::PaymentErrorMessage of type string.

        }

        $lastPayment = $order->Payments()->sort('Created', 'DESC')->first();
        if (!$lastPayment) {
            return false;

The return type of return false; (false) is incompatible with the return type documented by CheckoutPage_Controller::PaymentErrorMessage of type string.

        }

        $errorMessages = $lastPayment->Messages()->exclude('Message', '')->sort('Created', 'DESC');
        $lastErrorMessage = null;
        foreach ($errorMessages as $errorMessage) {
            if ($errorMessage instanceof GatewayErrorMessage) {
                $lastErrorMessage = $errorMessage;
                break;
            }
        }
        if (!$lastErrorMessage) {
            return false;

The return type of return false; (false) is incompatible with the return type documented by CheckoutPage_Controller::PaymentErrorMessage of type string.

        }

        return $lastErrorMessage->Message;
    }
}