RecommendedProductsModifier::Name() - Code Metrics - sunnysideup/silverstripe-ecommerce_alsorecommended - Measure and Improve Code Quality continuously with Scrutinizer

RecommendedProductsModifier::Name() A
last analyzed 2018-03-20 01:01 UTC

↳ Parent: RecommendedProductsModifier

Complexity

Conditions	2
Paths	2

Size

Total Lines	8
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	8
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	5
nc	2
nop	0

<?php

/**
 * @author Nicolaas [at] sunnysideup.co.nz
 * @package: ecommerce
 * @sub-package: ecommerce_modifiers
 * @description: shows a list of recommended products
 * the product page / dataobject need to have a function RecommendedProductsForCart
 * which returns an array of IDs
 */
class RecommendedProductsModifier extends OrderModifier
namespace YourVendor;

class YourClass { }
{

//--------------------------------------------------------------------  *** static variables

    private static $singular_name = "Recommended Product";

    public function i18n_singular_name()
    {
        return _t("RecommendedProductsModifier.SINGULAR_NAME", "Recommended Product");
    }

    private static $plural_name = "Recommended Products";

    public function i18n_plural_name()
    {
        return _t("RecommendedProductsModifier.PLURAL_NAME", "Recommended Products");
    }

    //--------------------------------------------------------------------  *** static functions
    // ######################################## *** form functions (e. g. Showform and getform)


    protected $recommendedBuyables = null;

    /**
     * standard Modifier Method
     * @return Boolean
     */
    public function ShowForm()
    {
        if (!$this->recommendedBuyables) {
            $this->recommendedBuyables = new ArrayList();
            $inCartIDArray = array();
            if ($items = $this->Order()->Items()) {
                foreach ($items as $item) {
                    $buyable = $item->Buyable();
                    if ($buyable instanceof Product) {
                        $codeOfBuyable = $buyable->ClassName.".".$buyable->ID;
                        $inCartIDArray[$codeOfBuyable] = $codeOfBuyable;
                    }
                }
                foreach ($items as $item) {
                    //get recommended products
                    if ($item) {
                        $buyable = $item->Buyable();
                        if ($buyable instanceof Product) {
                            unset($recommendedProducts);
                            $recommendedProducts = $buyable->EcommerceRecommendedProducts();
                            foreach ($recommendedProducts as $recommendedProduct) {
                                $codeOfRecommendedProduct = $recommendedProduct->ClassName.".".$recommendedProduct->ID;
                                if (!in_array($codeOfRecommendedProduct, $inCartIDArray)) {
                                    $this->recommendedBuyables->push($recommendedProduct);
                                }
                            }
                        }
                    }
                }
            }
        }
        return $this->recommendedBuyables->count();
    }

    /**
     * Should the form be included in the editable form
     * on the checkout page?
     * @return Boolean
     */
    public function ShowFormInEditableOrderTable()
    {
        return false;
    }

    /**
     *
     * @return Form

     */
    public function getModifierForm(Controller $optionalController = null, Validator $optionalValidator = null)
    {
        if ($this->ShowForm()) {
            return new RecommendedProductsModifier_Form(
                $optionalController,
                'RecommendedProducts',
                FieldList::create(),
                FieldList::create(),
                $optionalValidator,
                $this->recommendedBuyables
            );
        }
    }

    //-------------------------------------------------------------------- *** display functions
    public function ShowInTable()
    {
        return false;
    }

    public function CanRemove()
    {
        return false;
    }


    // -------------------------------------------------------------------- *** table values
    public function LiveCalculatedTotal()
    {
        return 0;
    }
    public function LiveTableValue()
    {
        return 0;
    }

    //-------------------------------------------------------------------- *** table titles
    public function LiveName()
    {
        return $this->i18n_singular_name();
    }

    public function Name()

    {
        if (!$this->canEdit()) {
            return $this->Name;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        } else {
            return $this->LiveName();
        }
    }

    //-------------------------------------------------------------------- ***  database functions
}


1			<?php
2
3			/**
4			* @author Nicolaas [at] sunnysideup.co.nz
5			* @package: ecommerce
6			* @sub-package: ecommerce_modifiers
7			* @description: shows a list of recommended products
8			* the product page / dataobject need to have a function RecommendedProductsForCart
9			* which returns an array of IDs
10			*/
11			class RecommendedProductsModifier extends OrderModifier
			0 ignored issues – show Coding Style Compatibility introduced 2017-01-03 00:30 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			//-------------------------------------------------------------------- *** static variables
15
16			private static $singular_name = "Recommended Product";
			0 ignored issues – show Comprehensibility introduced 2017-01-03 00:30 UTC by Report Bug Copy Issue Report Consider using a different property name as you override a private property of the parent class. Loading history... Unused Code introduced 2017-01-03 00:30 UTC by Report Bug Copy Issue Report The property `$singular_name` 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...
17			public function i18n_singular_name()
18			{
19			return _t("RecommendedProductsModifier.SINGULAR_NAME", "Recommended Product");
20			}
21
22			private static $plural_name = "Recommended Products";
			0 ignored issues – show Comprehensibility introduced 2017-01-03 00:30 UTC by Report Bug Copy Issue Report Consider using a different property name as you override a private property of the parent class. Loading history... Unused Code introduced 2017-01-03 00:30 UTC by Report Bug Copy Issue Report The property `$plural_name` 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...
23			public function i18n_plural_name()
24			{
25			return _t("RecommendedProductsModifier.PLURAL_NAME", "Recommended Products");
26			}
27
28			//-------------------------------------------------------------------- *** static functions
29			// ######################################## *** form functions (e. g. Showform and getform)
30
31
32			protected $recommendedBuyables = null;
33
34			/**
35			* standard Modifier Method
36			* @return Boolean
37			*/
38			public function ShowForm()
39			{
40			if (!$this->recommendedBuyables) {
41			$this->recommendedBuyables = new ArrayList();
42			$inCartIDArray = array();
43			if ($items = $this->Order()->Items()) {
44			foreach ($items as $item) {
45			$buyable = $item->Buyable();
46			if ($buyable instanceof Product) {
47			$codeOfBuyable = $buyable->ClassName.".".$buyable->ID;
48			$inCartIDArray[$codeOfBuyable] = $codeOfBuyable;
49			}
50			}
51			foreach ($items as $item) {
52			//get recommended products
53			if ($item) {
54			$buyable = $item->Buyable();
55			if ($buyable instanceof Product) {
56			unset($recommendedProducts);
57			$recommendedProducts = $buyable->EcommerceRecommendedProducts();
58			foreach ($recommendedProducts as $recommendedProduct) {
59			$codeOfRecommendedProduct = $recommendedProduct->ClassName.".".$recommendedProduct->ID;
60			if (!in_array($codeOfRecommendedProduct, $inCartIDArray)) {
61			$this->recommendedBuyables->push($recommendedProduct);
62			}
63			}
64			}
65			}
66			}
67			}
68			}
69			return $this->recommendedBuyables->count();
70			}
71
72			/**
73			* Should the form be included in the editable form
74			* on the checkout page?
75			* @return Boolean
76			*/
77			public function ShowFormInEditableOrderTable()
78			{
79			return false;
80			}
81
82			/**
83			*
84			* @return Form
			0 ignored issues – show Documentation introduced 2017-01-03 00:30 UTC by Report Bug Copy Issue Report Should the return type not be `RecommendedProductsModifier_Form\|null`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
85			*/
86			public function getModifierForm(Controller $optionalController = null, Validator $optionalValidator = null)
87			{
88			if ($this->ShowForm()) {
89			return new RecommendedProductsModifier_Form(
90			$optionalController,
91			'RecommendedProducts',
92			FieldList::create(),
93			FieldList::create(),
94			$optionalValidator,
95			$this->recommendedBuyables
96			);
97			}
98			}
99
100			//-------------------------------------------------------------------- *** display functions
101			public function ShowInTable()
102			{
103			return false;
104			}
105
106			public function CanRemove()
107			{
108			return false;
109			}
110
111
112			// -------------------------------------------------------------------- *** table values
113			public function LiveCalculatedTotal()
114			{
115			return 0;
116			}
117			public function LiveTableValue()
118			{
119			return 0;
120			}
121
122			//-------------------------------------------------------------------- *** table titles
123			public function LiveName()
124			{
125			return $this->i18n_singular_name();
126			}
127
128			public function Name()
			0 ignored issues – show Documentation introduced 2017-08-04 00:35 UTC by Report Bug Copy Issue Report The return type could not be reliably inferred; please add a `@return` annotation. Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a `@return` annotation as described here. Loading history...
129			{
130			if (!$this->canEdit()) {
131			return $this->Name;
			0 ignored issues – show Documentation introduced 2017-01-03 00:30 UTC by Report Bug Copy Issue Report The property `Name` does not exist on `object<RecommendedProductsModifier>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
132			} else {
133			return $this->LiveName();
134			}
135			}
136
137			//-------------------------------------------------------------------- *** database functions
138			}
139

sunnysideup / silverstripe-ecommerce_alsorecommended

RecommendedProductsModifier::Name() A last analyzed 2018-03-20 01:01 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

RecommendedProductsModifier::Name() A
last analyzed 2018-03-20 01:01 UTC