CheckoutPage::getCMSFields() - Code Metrics - Inspection of "Migrate to using beforeUpdateCMSFields (Fixes #609..." - silvershop/silvershop-core - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#610)

by Will

created 2017-07-28 03:25 UTC

CheckoutPage::getCMSFields() B

↳ Parent: CheckoutPage

Complexity

Conditions	1
Paths	1

Size

Total Lines	24
Code Lines	15

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	24
ccs	0
cts	17
cp	0
rs	8.9713
c	0
b	0
f	0
cc	1
eloc	15
nc	1
nop	0
crap	2

<?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;
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
        }

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

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
        }

        $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;
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
        }

        return $lastErrorMessage->Message;
    }
}


1		<?php
2
3		/**
4		* CheckoutPage is a CMS page-type that shows the order
5		* details to the customer for their current shopping
6		* cart on the site.
7		*
8		* @see CheckoutPage_Controller->Order()
9		*
10		* @package shop
11		*/
12		class CheckoutPage extends Page
13		{
14		private static $db = array(
15		'PurchaseComplete' => 'HTMLText',
16		);
17
18		private static $icon = 'silvershop/images/icons/money';
19
20		/**
21		* Returns the link to the checkout page on this site
22		*
23		* @param boolean $urlSegment If set to TRUE, only returns the URLSegment field
24		*
25		* @return string Link to checkout page
26		*/
27	4	public static function find_link($urlSegment = false, $action = null, $id = null)
28		{
29	4	$base = CheckoutPage_Controller::config()->url_segment;
30	4	if ($page = self::get()->first()) {
31	4	$base = $page->Link();
32	4	}
33	4	return Controller::join_links($base, $action, $id);
34		}
35
36		public function getCMSFields()
37		{
38		$this->beforeUpdateCMSFields(function(FieldList $fields) {
39		$fields->addFieldsToTab(
40		'Root.Main',
41		array(
42		HtmlEditorField::create(
43		'PurchaseComplete',
44		_t('CheckoutPage.db_PurchaseComplete', 'Purchase Complete'),
45		4
46		)
47		->setDescription(
48		_t(
49		'CheckoutPage.PurchaseCompleteDescription',
50		"This message is included in reciept email, after the customer submits the checkout"
51		)
52		),
53		),
54		'Metadata'
55		);
56		});
57
58		return parent::getCMSFields();
59		}
60
61		/**
62		* This module always requires a page model.
63		*/
64		public function requireDefaultRecords()
65		{
66		parent::requireDefaultRecords();
67		if (!self::get()->exists() && $this->config()->create_default_pages) {
68		$page = self::create(
69		array(
70		'Title' => 'Checkout',
71		'URLSegment' => CheckoutPage_Controller::config()->url_segment,
72		'ShowInMenus' => 0,
73		)
74		);
75		$page->write();
76		$page->publish('Stage', 'Live');
77		$page->flushCache();
78		DB::alteration_message('Checkout page created', 'created');
79		}
80		}
81		}
82
83		/**
84		* @package shop
85		* @mixin CheckoutPage
86		* @mixin SteppedCheckout
87		* @mixin CheckoutStep_Address
88		* @mixin CheckoutStep_AddressBook
89		* @mixin CheckoutStep_ContactDetails
90		* @mixin CheckoutStep_Membership
91		* @mixin CheckoutStep_PaymentMethod
92		* @mixin CheckoutStep_Summary
93		*/
94		class CheckoutPage_Controller extends Page_Controller
95		{
96		private static $url_segment = 'checkout';
97
98		private static $allowed_actions = array(
99		'OrderForm',
100		'payment',
101		'PaymentForm',
102		);
103
104	6	public function Title()
105		{
106	6	if ($this->Title) {
107	3	return $this->Title;
108		}
109
110	6	return _t('CheckoutPage.DefaultTitle', "Checkout");
111		}
112
113		public function OrderForm()
114		{
115		if (!(bool)$this->Cart()) {
116		return false;
117		}
118
119		/** @var CheckoutComponentConfig $config */
120		$config = Injector::inst()->create("CheckoutComponentConfig", ShoppingCart::curr());
121		$form = PaymentForm::create($this, 'OrderForm', $config);
122
123		// Normally, the payment is on a second page, either offsite or through /checkout/payment
124		// If the site has customised the checkout component config to include an onsite payment
125		// component, we should honor that and change the button label. PaymentForm::checkoutSubmit
126		// will also check this and process payment if needed.
127		if ($config->getComponentByType('OnsitePaymentCheckoutComponent')) {
128		$form->setActions(
129		FieldList::create(
130		FormAction::create('checkoutSubmit', _t('CheckoutForm.SubmitPayment', 'Submit Payment'))
131		)
132		);
133		}
134
135		$form->Cart = $this->Cart();
136		$this->extend('updateOrderForm', $form);
137
138		return $form;
139		}
140
141		/**
142		* Action for making on-site payments
143		*/
144		public function payment()
145		{
146		if (!$this->Cart()) {
147		return $this->redirect($this->Link());
148		}
149
150		return array(
151		'Title' => 'Make Payment',
152		'OrderForm' => $this->PaymentForm(),
153		);
154		}
155
156		public function PaymentForm()
157		{
158		if (!(bool)$this->Cart()) {
159		return false;
160		}
161
162		$config = new CheckoutComponentConfig(ShoppingCart::curr(), false);
163		$config->addComponent(OnsitePaymentCheckoutComponent::create());
164
165		$form = PaymentForm::create($this, "PaymentForm", $config);
166
167		$form->setActions(
168		FieldList::create(
169		FormAction::create("submitpayment", _t('CheckoutPage.SubmitPayment', "Submit Payment"))
170		)
171		);
172
173		$form->setFailureLink($this->Link());
174		$this->extend('updatePaymentForm', $form);
175
176		return $form;
177		}
178
179		/**
180		* Retrieves error messages for the latest payment (if existing).
181		* This can originate e.g. from an earlier offsite gateway API response.
182		*
183		* @return string
184		*/
185		public function PaymentErrorMessage()
186		{
187		$order = $this->Cart();
188		if (!$order) {
189		return false;
		0 ignored issues – show Bug Best Practice introduced 2016-02-23 23:20 UTC by Report Bug Copy Issue Report The return type of `return false;` (`false`) is incompatible with the return type documented by `CheckoutPage_Controller::PaymentErrorMessage` of type `string`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
190		}
191
192		$lastPayment = $order->Payments()->sort('Created', 'DESC')->first();
193		if (!$lastPayment) {
194		return false;
		0 ignored issues – show Bug Best Practice introduced 2016-02-23 23:20 UTC by Report Bug Copy Issue Report The return type of `return false;` (`false`) is incompatible with the return type documented by `CheckoutPage_Controller::PaymentErrorMessage` of type `string`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
195		}
196
197		$errorMessages = $lastPayment->Messages()->exclude('Message', '')->sort('Created', 'DESC');
198		$lastErrorMessage = null;
199		foreach ($errorMessages as $errorMessage) {
200		if ($errorMessage instanceof GatewayErrorMessage) {
201		$lastErrorMessage = $errorMessage;
202		break;
203		}
204		}
205		if (!$lastErrorMessage) {
206		return false;
		0 ignored issues – show Bug Best Practice introduced 2016-02-23 23:20 UTC by Report Bug Copy Issue Report The return type of `return false;` (`false`) is incompatible with the return type documented by `CheckoutPage_Controller::PaymentErrorMessage` of type `string`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
207		}
208
209		return $lastErrorMessage->Message;
210		}
211		}
212

silvershop / silvershop-core

Pull Request — master (#610)

CheckoutPage::getCMSFields() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like