DMSDocumentCartExtension::incrementPrintRequest() - Code Metrics - Inspection of "NEW Feature/checkout page" - silverstripe/silverstripe-dms-cart - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#10)

by Franco

created 2017-05-24 07:18 UTC

DMSDocumentCartExtension::incrementPrintRequest() A

↳ Parent: DMSDocumentCartExtension

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	7
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	4
nc	1
nop	0

<?php

/**
 * Class DMSDocumentCartExtension
 *
 * @property Boolean     AllowedInCart
 * @property Int         PrintRequestCount
 *
 * @property DMSDocument owner
 */
class DMSDocumentCartExtension extends DataExtension
namespace YourVendor;

class YourClass { }
{
    /**
     * @var DMSDocumentCartController
     */
    private $cartController;

    private static $db = array(

        'AllowedInCart'     => 'Boolean',
        // Running total of print requests on this document
        'PrintRequestCount' => 'Int',
    );

    /**
     * Returns if a Document is permitted to reflect in a cart
     *
     * @return boolean
     */
    public function isAllowedInCart()
    {
        return $this->owner->AllowedInCart;
    }

    public function updateCMSFields(FieldList $fields)
    {
        $fields->insertBefore(CheckboxField::create(
            'AllowedInCart',
            _t('DMSDocumentCart.ALLOWED_IN_CART', 'Allowed in document cart')
        ), 'Description');
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    /**
     * Increments the number of times a document was printed
     *
     * @return DMSDocument
     */
    public function incrementPrintRequest()
    {
        $this->owner->PrintRequestCount++;
        $this->owner->write();

        return $this->owner;
    }

    /**
     * Checks if a given document already exists within the Cart. True if it does, false otherwise
     *
     * @return bool
     */
    public function isInCart()
    {
        return (bool) $this->getCart()->isInCart($this->owner->ID);
    }

    /**
     * Builds and returns a valid DMSDocumentController URL from the given $action link
     *
     * @param string $action Can be either 'add', 'remove' or 'checkout
     *
     * @return string
     *
     * @throws InvalidArgumentException if the provided $action is not allowed.
     */
    public function getActionLink($action = 'add')
    {
        $action = strtolower($action);
        $allowedActions = array_merge($this->getCartController()->allowedActions(), array('checkout'));
        if (!in_array($action, $allowedActions)) {
            throw new InvalidArgumentException("{$action} is not accepted for this method.");
        }

        if ($action !== 'checkout') {
            $result = Controller::join_links('documentcart', $action, $this->owner->ID);
        } else {
            $result = SiteTree::get_one('DMSDocumentCartCheckoutPage')->Link();
        }

        return $result;
    }

    /**
     * Retrieves a DMSDocumentCartController handle
     *
     * @return DMSDocumentCartController
     */
    public function getCartController()
    {
        if (!$this->cartController) {
            $this->cartController = DMSDocumentCartController::create();
        }

        return $this->cartController;
    }

    /**
     * Retrieves a DMSDocumentCart handle
     *
     * @return DMSDocumentCart
     */
    public function getCart()
    {
        return $this->getCartController()->getCart();
    }
}


1			<?php
2
3			/**
4			* Class DMSDocumentCartExtension
5			*
6			* @property Boolean AllowedInCart
7			* @property Int PrintRequestCount
8			*
9			* @property DMSDocument owner
10			*/
11			class DMSDocumentCartExtension extends DataExtension
			0 ignored issues – show Coding Style Compatibility introduced 2017-05-23 04:54 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
12			{
13			/**
14			* @var DMSDocumentCartController
15			*/
16			private $cartController;
17
18			private static $db = array(
			0 ignored issues – show Unused Code introduced 2017-05-24 00:49 UTC by Report Bug Copy Issue Report The property `$db` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
19			'AllowedInCart' => 'Boolean',
20			// Running total of print requests on this document
21			'PrintRequestCount' => 'Int',
22			);
23
24			/**
25			* Returns if a Document is permitted to reflect in a cart
26			*
27			* @return boolean
28			*/
29			public function isAllowedInCart()
30			{
31			return $this->owner->AllowedInCart;
32			}
33
34			public function updateCMSFields(FieldList $fields)
35			{
36			$fields->insertBefore(CheckboxField::create(
37			'AllowedInCart',
38			_t('DMSDocumentCart.ALLOWED_IN_CART', 'Allowed in document cart')
39			), 'Description');
			0 ignored issues – show Documentation introduced 2017-05-24 00:49 UTC by Report Bug Copy Issue Report `'Description'` is of type `string`, but the function expects a `object<FormField>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
40			}
41
42			/**
43			* Increments the number of times a document was printed
44			*
45			* @return DMSDocument
46			*/
47			public function incrementPrintRequest()
48			{
49			$this->owner->PrintRequestCount++;
50			$this->owner->write();
51
52			return $this->owner;
53			}
54
55			/**
56			* Checks if a given document already exists within the Cart. True if it does, false otherwise
57			*
58			* @return bool
59			*/
60			public function isInCart()
61			{
62			return (bool) $this->getCart()->isInCart($this->owner->ID);
63			}
64
65			/**
66			* Builds and returns a valid DMSDocumentController URL from the given $action link
67			*
68			* @param string $action Can be either 'add', 'remove' or 'checkout
69			*
70			* @return string
71			*
72			* @throws InvalidArgumentException if the provided $action is not allowed.
73			*/
74			public function getActionLink($action = 'add')
75			{
76			$action = strtolower($action);
77			$allowedActions = array_merge($this->getCartController()->allowedActions(), array('checkout'));
78			if (!in_array($action, $allowedActions)) {
79			throw new InvalidArgumentException("{$action} is not accepted for this method.");
80			}
81
82			if ($action !== 'checkout') {
83			$result = Controller::join_links('documentcart', $action, $this->owner->ID);
84			} else {
85			$result = SiteTree::get_one('DMSDocumentCartCheckoutPage')->Link();
86			}
87
88			return $result;
89			}
90
91			/**
92			* Retrieves a DMSDocumentCartController handle
93			*
94			* @return DMSDocumentCartController
95			*/
96			public function getCartController()
97			{
98			if (!$this->cartController) {
99			$this->cartController = DMSDocumentCartController::create();
100			}
101
102			return $this->cartController;
103			}
104
105			/**
106			* Retrieves a DMSDocumentCart handle
107			*
108			* @return DMSDocumentCart
109			*/
110			public function getCart()
111			{
112			return $this->getCartController()->getCart();
113			}
114			}
115

silverstripe / silverstripe-dms-cart

Pull Request — master (#10)

DMSDocumentCartExtension::incrementPrintRequest() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like