CountryPrice_SiteTreeExtensions::getCountryPriceTranslations() - Code Metrics - Inspection of "MINOR: adding CMS Field of Parent Page" - sunnysideup/silverstripe-ecommerce_countries - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 894f14...355d7f )

by Nicolaas

created 2017-05-01 00:42 UTC

getCountryPriceTranslations() A

↳ Parent: CountryPrice_SiteTreeExtensions

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	6
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	3
nc	1
nop	0

<?php


class CountryPrice_SiteTreeExtensions extends SiteTreeExtension
namespace YourVendor;

class YourClass { }
{
    private static $has_many = array(

        'CountryPriceTranslations' => 'CountryPrice_Translation'
    );

    private static $field_labels = array(

        'CountryPriceTranslations' => 'Translations'
    );

    /**
     * Update Fields
     * @return FieldList
     */
    public function updateCMSFields(FieldList $fields)
    {
        $fields->addFieldsToTab(
            'Root.Translations',
            GridField::create(
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                'CountryPriceTranslations',
                'Translations',
                $this->owner->getCountryPriceTranslations(),
                GridFieldConfigForOrderItems::create()
            )
        );
        return $fields;
    }

    private static $_translations = array();

    /**
     *
     * @return DataList
     */
    public function AvailableTranslationLinks()
    {
        return $this->owner->getCountryPriceTranslations()
            ->innerJoin('EcommerceCountry', '"EcommerceCountry"."ID" = "CountryPrice_Translation"."EcommerceCountryID"');
    }

    /**
     *
     * @return CountryPrice_Translation | null
     */
    public function CanonicalLink()
    {
        return $this->owner->getCountryPriceTranslations()
            ->innerJoin('EcommerceCountry', '"EcommerceCountry"."ID" = "CountryPrice_Translation"."EcommerceCountryID"')
            ->filter(array('EcommerceCountry.IsBackupCountry' => 1))
            ->first();
    }

    public function loadTranslatedValues($countryID = 0, $variableOrMethod = '')

    {
        $translation = null;
        if (! $countryID) {
            $countryObject = CountryPrice_EcommerceCountry::get_real_country();
            if ($countryObject) {
                $countryID = $countryObject->ID;
            }
        }
        if ($countryID) {
            $key = $this->owner->ID.'_'.$countryID;
            if (isset(self::$_translations[$key])) {
                $translation = self::$_translations[$key];
            } else {
                $translation = $this->owner->getRealEcommerceTranslation($countryID);
                self::$_translations[$key] = $translation;
            }
        }
        if ($translation) {
            $fieldsToReplace = $translation->FieldsToReplace();
            foreach ($fieldsToReplace as $replaceFields) {
                $pageField = $replaceFields->PageField;
                $pageFieldTranslated = $pageField . 'Translated';
                $translationField = $replaceFields->TranslationField;
                if (! $variableOrMethod || $variableOrMethod === $pageField) {
                    if ($translation->hasMethod($translationField)) {
                        $this->owner->$pageField = $translation->$translationField();
                        $this->owner->$pageFieldTranslated = $translation->$translationField();
                    } else {
                        $this->owner->$pageField = $translation->$translationField;
                        $this->owner->$pageFieldTranslated = $translation->$translationField;
                    }
                }
                if ($variableOrMethod) {
                    return $this->owner->$pageField;
                }
            }
        } else {
            if ($variableOrMethod) {
                if ($translation->hasMethod($variableOrMethod)) {
                    return $this->owner->$variableOrMethod();
                } else {
                    return $this->owner->$variableOrMethod;
                }
            }
        }
    }

    /**
     * @var int $countryID
     *
     * @return CountryPrice_Translation | null

     */
    public function getRealEcommerceTranslation($countryID)
    {
        return CountryPrice_Translation::get()
            ->filter(
                array(
                    "EcommerceCountryID" => $countryID,
                    'ParentID' => $this->owner->ID
                )
            )
            ->exclude(
                array('WithoutTranslation' => 1)
            )
            ->first();
    }

    /**
     * @var int $countryID
     *
     * @return CountryPrice_Translation | null
     */
    public function getEcommerceTranslation($countryID)
    {
        return $this->owner
            ->getCountryPriceTranslations()
            ->filter(
                array(
                    "EcommerceCountryID" => $countryID,
                    'ParentID' => $this->owner->ID,
                )
            )
            ->first();
    }

    /**
     * @var int $countryID
     *
     * @return bool
     */
    public function hasCountryLocalInURL($countryID)
    {
        return $this->getEcommerceTranslation($countryID) ? true : false;
    }

    /**
     * we have added this because we got some weird mixups with magical methods
     * @return DataList (of CountryPrice_Translation objects)
     */
    function CountryPriceTranslations()

    {
        return $this->getCountryPriceTranslations();
    }

    /**
     * we have added this because we got some weird mixups with magical methods
     * @return DataList (of CountryPrice_Translation objects)
     */
    function getCountryPriceTranslations()

    {
        return CountryPrice_Translation::get()->filter(
            array('CountryPrice_Translation.ParentID' => $this->owner->ID)
        );
    }

}


1			<?php
2
3
4			class CountryPrice_SiteTreeExtensions extends SiteTreeExtension
			0 ignored issues – show Coding Style Compatibility introduced 2016-10-31 22:45 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...
5			{
6			private static $has_many = array(
			0 ignored issues – show Unused Code introduced 2016-10-31 22:45 UTC by Report Bug Copy Issue Report The property `$has_many` 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...
7			'CountryPriceTranslations' => 'CountryPrice_Translation'
8			);
9
10			private static $field_labels = array(
			0 ignored issues – show Unused Code introduced 2016-10-31 22:45 UTC by Report Bug Copy Issue Report The property `$field_labels` 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...
11			'CountryPriceTranslations' => 'Translations'
12			);
13
14			/**
15			* Update Fields
16			* @return FieldList
17			*/
18			public function updateCMSFields(FieldList $fields)
19			{
20			$fields->addFieldsToTab(
21			'Root.Translations',
22			GridField::create(
			0 ignored issues – show Documentation introduced 2017-05-01 00:45 UTC by Report Bug Copy Issue Report `\GridField::create('Coun...orOrderItems::create())` is of type `object<GridField>`, but the function expects a `array`. 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...
23			'CountryPriceTranslations',
24			'Translations',
25			$this->owner->getCountryPriceTranslations(),
26			GridFieldConfigForOrderItems::create()
27			)
28			);
29			return $fields;
30			}
31
32			private static $_translations = array();
33
34			/**
35			*
36			* @return DataList
37			*/
38			public function AvailableTranslationLinks()
39			{
40			return $this->owner->getCountryPriceTranslations()
41			->innerJoin('EcommerceCountry', '"EcommerceCountry"."ID" = "CountryPrice_Translation"."EcommerceCountryID"');
42			}
43
44			/**
45			*
46			* @return CountryPrice_Translation \| null
47			*/
48			public function CanonicalLink()
49			{
50			return $this->owner->getCountryPriceTranslations()
51			->innerJoin('EcommerceCountry', '"EcommerceCountry"."ID" = "CountryPrice_Translation"."EcommerceCountryID"')
52			->filter(array('EcommerceCountry.IsBackupCountry' => 1))
53			->first();
54			}
55
56			public function loadTranslatedValues($countryID = 0, $variableOrMethod = '')
			0 ignored issues – show Documentation introduced 2016-10-31 22:45 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...
57			{
58			$translation = null;
59			if (! $countryID) {
60			$countryObject = CountryPrice_EcommerceCountry::get_real_country();
61			if ($countryObject) {
62			$countryID = $countryObject->ID;
63			}
64			}
65			if ($countryID) {
66			$key = $this->owner->ID.'_'.$countryID;
67			if (isset(self::$_translations[$key])) {
68			$translation = self::$_translations[$key];
69			} else {
70			$translation = $this->owner->getRealEcommerceTranslation($countryID);
71			self::$_translations[$key] = $translation;
72			}
73			}
74			if ($translation) {
75			$fieldsToReplace = $translation->FieldsToReplace();
76			foreach ($fieldsToReplace as $replaceFields) {
77			$pageField = $replaceFields->PageField;
78			$pageFieldTranslated = $pageField . 'Translated';
79			$translationField = $replaceFields->TranslationField;
80			if (! $variableOrMethod \|\| $variableOrMethod === $pageField) {
81			if ($translation->hasMethod($translationField)) {
82			$this->owner->$pageField = $translation->$translationField();
83			$this->owner->$pageFieldTranslated = $translation->$translationField();
84			} else {
85			$this->owner->$pageField = $translation->$translationField;
86			$this->owner->$pageFieldTranslated = $translation->$translationField;
87			}
88			}
89			if ($variableOrMethod) {
90			return $this->owner->$pageField;
91			}
92			}
93			} else {
94			if ($variableOrMethod) {
95			if ($translation->hasMethod($variableOrMethod)) {
96			return $this->owner->$variableOrMethod();
97			} else {
98			return $this->owner->$variableOrMethod;
99			}
100			}
101			}
102			}
103
104			/**
105			* @var int $countryID
106			*
107			* @return CountryPrice_Translation \| null
			0 ignored issues – show Documentation introduced 2016-12-20 03:49 UTC by Report Bug Copy Issue Report Should the return type not be `CountryPrice_Translation\|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...
108			*/
109			public function getRealEcommerceTranslation($countryID)
110			{
111			return CountryPrice_Translation::get()
112			->filter(
113			array(
114			"EcommerceCountryID" => $countryID,
115			'ParentID' => $this->owner->ID
116			)
117			)
118			->exclude(
119			array('WithoutTranslation' => 1)
120			)
121			->first();
122			}
123
124			/**
125			* @var int $countryID
126			*
127			* @return CountryPrice_Translation \| null
128			*/
129			public function getEcommerceTranslation($countryID)
130			{
131			return $this->owner
132			->getCountryPriceTranslations()
133			->filter(
134			array(
135			"EcommerceCountryID" => $countryID,
136			'ParentID' => $this->owner->ID,
137			)
138			)
139			->first();
140			}
141
142			/**
143			* @var int $countryID
144			*
145			* @return bool
146			*/
147			public function hasCountryLocalInURL($countryID)
148			{
149			return $this->getEcommerceTranslation($countryID) ? true : false;
150			}
151
152			/**
153			* we have added this because we got some weird mixups with magical methods
154			* @return DataList (of CountryPrice_Translation objects)
155			*/
156			function CountryPriceTranslations()
			0 ignored issues – show Best Practice introduced 2017-05-01 00:45 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
157			{
158			return $this->getCountryPriceTranslations();
159			}
160
161			/**
162			* we have added this because we got some weird mixups with magical methods
163			* @return DataList (of CountryPrice_Translation objects)
164			*/
165			function getCountryPriceTranslations()
			0 ignored issues – show Best Practice introduced 2017-05-01 00:45 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
166			{
167			return CountryPrice_Translation::get()->filter(
168			array('CountryPrice_Translation.ParentID' => $this->owner->ID)
169			);
170			}
171
172			}
173

sunnysideup / silverstripe-ecommerce_countries

Push — master ( 894f14...355d7f )

getCountryPriceTranslations() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like