CountryPrice_Page_Controller_Extension::addCountryCodeToUrlIfRequired() - Code Metrics - Inspection of "PATCH: url redirection fix" - sunnysideup/silverstripe-ecommerce_countries - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( efb352...721e90 )

by Nicolaas

created 2018-05-14 01:47 UTC

addCountryCodeToUrlIfRequired() B

↳ Parent: CountryPrice_Page_Controller_Extension

Complexity

Conditions	5
Paths	3

Size

Total Lines	16
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	16
rs	8.8571
c	0
b	0
f	0
cc	5
eloc	8
nc	3
nop	1

<?php


/**
 * www.mysite.com/mypage/?ecomlocale=AU
 * if there is a tranlsation page redirects to
 * URL with ?ecomlocale=AU
 *
 * if you go to a URL with ?ecomlocale=AU and the shop country does not match
 * the get param then you get redirected to that shop country.
 *
 *
 */

class CountryPrice_Page_Controller_Extension extends Extension
namespace YourVendor;

class YourClass { }
{

    /**
     * replaces `Title` and `Content` with translated content
     * where available.
     *
     * If the country code in the get parameter is not correct then
     * @return [type] [description]

     */
    public function onAfterInit()
    {
        $countryID = 0;
        //provided by stealth ...
        $countryObject = CountryPrice_EcommerceCountry::get_real_country();
        if ($countryObject) {

            //check if a redirect is required ...
            $this->checkForOffsiteRedirects($countryObject);

            $countryID = $countryObject->ID;
            //check that there is a translation
            if ($this->owner->dataRecord->thisPageHasTranslation($countryID)) {
                //if there is a translation but it is not showing in the URL then redirect
                $newURL = $this->addCountryCodeToUrlIfRequired($countryObject->Code);
                if ($newURL) {
                    if (Director::is_site_url($newURL)) {
                        $this->owner->redirect($newURL);
                    }
                }
            }
        }

        $this->owner->dataRecord->loadTranslatedValues($countryID, null);
    }

    /**
     * returns the best fieldname for
     * @param string $fieldName [description]
     */
    public function CountryDistributorBestContentValue($fieldName)

    {
        $countryObject = CountryPrice_EcommerceCountry::get_real_country();

        //check country
        if (!empty($countryObject->$fieldName)) {
            return $countryObject->$fieldName;
        }

        //check distributor
        $distributor = Distributor::get_one_for_country($countryObject->Code);
        if (!empty($distributor->$fieldName)) {
            return $distributor->$fieldName;
        }
        //check EcomConfig
        $distributor = Distributor::get_one_for_country($countryObject->Code);
        if (!empty($distributor->$fieldName)) {
            return $distributor->$fieldName;
        }
    }

    /**
     * caching variable
     *
     * @var integer
     */
    private static $_redirection_count = 0;

    /**
     * returns a string for the new url if a locale parameter can be added
     *
     * @return string | null
     */
    private function addCountryCodeToUrlIfRequired($countryCode = '')
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

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

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        if (isset($_POST) && count($_POST)) {
            return null;
        }
        //to do: add query here!

        $newURL = CountryPrice_Translation::get_country_url_provider()->replaceCountryCodeInUrl($countryCode);


        if ($newURL && self::$_redirection_count < 3) {
            self::$_redirection_count++;

            return $newURL;
        }
        return null;
    }


    /**
     *
     *
     * @return ArrayList
     */
    public function ChooseNewCountryList()
    {
        $countries = CountryPrice_EcommerceCountry::get_real_countries_list();
        $currentCode = '';
        if ($obj = CountryPrice_EcommerceCountry::get_real_country()) {
            $currentCode = $obj->Code;
        }
        $al = ArrayList::create();
        foreach ($countries as $country) {
            $isCurrentOne = $currentCode == $country->Code ? true : false;
            $currency = null;
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
            $currency = CountryPrice_EcommerceCurrency::get_currency_for_country($country->Code);
            $currencyCode = CountryPrice_EcommerceCurrency::get_currency_for_country($country->Code);
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
            $al->push(
                ArrayData::create(
                    array(
                        'Link' => CountryPrices_ChangeCountryController::new_country_link($country->Code),
                        'Title' => $country->Name,
                        'CountryCode' => $country->Code,
                        'LinkingMode' => ($isCurrentOne ? 'current' : 'link'),
                        'Currency' => $currency,
                        'CurrencyCode' => $currency
                    )
                )
            );
        }
        return $al;
    }

    /**
     *
     * @return DataList

     */
    public function AlternativeHrefLangLinksCachingKey()
    {
        $countryObject = CountryPrice_EcommerceCountry::get_real_country();
        if ($countryObject && $countryObject->Code) {
            return 'AlternativeHrefLangLinksCachingKey-'.$countryObject->Code.'-'.$this->owner->dataRecord->ID.'-'.strtotime($this->owner->dataRecord->LastEdited);
        }
        return 'AlternativeHrefLangLinksCachingKey'.$this->owner->dataRecord->ID.'-'.$this->owner->dataRecord->ID.'-'.strtotime($this->owner->dataRecord->LastEdited);
    }

    /**
     *
     * @param string $link - passed by reference
     */
    public function UpdateCanonicalLink(&$link)

    {
        $obj = $this->owner->dataRecord->CanonicalObject();
        if ($obj) {
            $link = $obj->Link();
        } else {
            $link = $this->owner->dataRecord->AbsoluteLink();
        }
        return $link;
    }

    /**
     * redirects visitors to another website if they are listed as such in
     * CountryPrices_ChangeCountryController.off_site_url_redirects
     *
     * @param  EcommerceCountry $countryObject current country of visitor
     *
     * @return null|SS_HTTPResponse
     */
    protected function checkForOffsiteRedirects($countryObject)
    {
        $redirectsArray = Config::inst()->get('CountryPrices_ChangeCountryController', 'off_site_url_redirects');
        $myCountryCode = strtoupper($countryObject->Code);
        if (isset($redirectsArray[$myCountryCode])) {
            return $this->redirect($redirectsArray[$myCountryCode]);

        }
    }
}


1			<?php
2
3
4			/**
5			* www.mysite.com/mypage/?ecomlocale=AU
6			* if there is a tranlsation page redirects to
7			* URL with ?ecomlocale=AU
8			*
9			* if you go to a URL with ?ecomlocale=AU and the shop country does not match
10			* the get param then you get redirected to that shop country.
11			*
12			*
13			*/
14
15			class CountryPrice_Page_Controller_Extension extends Extension
			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...
16			{
17
18			/**
19			* replaces `Title` and `Content` with translated content
20			* where available.
21			*
22			* If the country code in the get parameter is not correct then
23			* @return [type] [description]
			0 ignored issues – show Documentation introduced 2016-10-31 22:45 UTC by Report Bug Copy Issue Report The doc-type `[type]` could not be parsed: Unknown type name "" at position 0. [(view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
24			*/
25			public function onAfterInit()
26			{
27			$countryID = 0;
28			//provided by stealth ...
29			$countryObject = CountryPrice_EcommerceCountry::get_real_country();
30			if ($countryObject) {
31
32			//check if a redirect is required ...
33			$this->checkForOffsiteRedirects($countryObject);
34
35			$countryID = $countryObject->ID;
36			//check that there is a translation
37			if ($this->owner->dataRecord->thisPageHasTranslation($countryID)) {
38			//if there is a translation but it is not showing in the URL then redirect
39			$newURL = $this->addCountryCodeToUrlIfRequired($countryObject->Code);
40			if ($newURL) {
41			if (Director::is_site_url($newURL)) {
42			$this->owner->redirect($newURL);
43			}
44			}
45			}
46			}
47
48			$this->owner->dataRecord->loadTranslatedValues($countryID, null);
49			}
50
51			/**
52			* returns the best fieldname for
53			* @param string $fieldName [description]
54			*/
55			public function CountryDistributorBestContentValue($fieldName)
			0 ignored issues – show Documentation introduced 2017-10-18 01:15 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...
56			{
57			$countryObject = CountryPrice_EcommerceCountry::get_real_country();
58
59			//check country
60			if (!empty($countryObject->$fieldName)) {
61			return $countryObject->$fieldName;
62			}
63
64			//check distributor
65			$distributor = Distributor::get_one_for_country($countryObject->Code);
66			if (!empty($distributor->$fieldName)) {
67			return $distributor->$fieldName;
68			}
69			//check EcomConfig
70			$distributor = Distributor::get_one_for_country($countryObject->Code);
71			if (!empty($distributor->$fieldName)) {
72			return $distributor->$fieldName;
73			}
74			}
75
76			/**
77			* caching variable
78			*
79			* @var integer
80			*/
81			private static $_redirection_count = 0;
82
83			/**
84			* returns a string for the new url if a locale parameter can be added
85			*
86			* @return string \| null
87			*/
88			private function addCountryCodeToUrlIfRequired($countryCode = '')
			0 ignored issues – show Coding Style introduced 2017-10-18 01:15 UTC by Report Bug Copy Issue Report `addCountryCodeToUrlIfRequired` uses the super-global variable `$_POST` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history...
89			{
90			if (isset($_POST) && count($_POST)) {
91			return null;
92			}
93			//to do: add query here!
94
95			$newURL = CountryPrice_Translation::get_country_url_provider()->replaceCountryCodeInUrl($countryCode);
			0 ignored issues – show Bug introduced 2018-02-14 08:36 UTC by Report Bug Copy Issue Report The method `replaceCountryCodeInUrl` cannot be called on `\CountryPrice_Translatio..._country_url_provider()` (of type `string`). Methods can only be called on objects. This check looks for methods being called on variables that have been inferred to never be objects. Loading history...
96
97			if ($newURL && self::$_redirection_count < 3) {
98			self::$_redirection_count++;
99
100			return $newURL;
101			}
102			return null;
103			}
104
105
106			/**
107			*
108			*
109			* @return ArrayList
110			*/
111			public function ChooseNewCountryList()
112			{
113			$countries = CountryPrice_EcommerceCountry::get_real_countries_list();
114			$currentCode = '';
115			if ($obj = CountryPrice_EcommerceCountry::get_real_country()) {
116			$currentCode = $obj->Code;
117			}
118			$al = ArrayList::create();
119			foreach ($countries as $country) {
120			$isCurrentOne = $currentCode == $country->Code ? true : false;
121			$currency = null;
			0 ignored issues – show Unused Code introduced 2016-10-31 22:45 UTC by Report Bug Copy Issue Report `$currency` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
122			$currency = CountryPrice_EcommerceCurrency::get_currency_for_country($country->Code);
123			$currencyCode = CountryPrice_EcommerceCurrency::get_currency_for_country($country->Code);
			0 ignored issues – show Unused Code introduced 2016-10-31 22:45 UTC by Report Bug Copy Issue Report `$currencyCode` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
124			$al->push(
125			ArrayData::create(
126			array(
127			'Link' => CountryPrices_ChangeCountryController::new_country_link($country->Code),
128			'Title' => $country->Name,
129			'CountryCode' => $country->Code,
130			'LinkingMode' => ($isCurrentOne ? 'current' : 'link'),
131			'Currency' => $currency,
132			'CurrencyCode' => $currency
133			)
134			)
135			);
136			}
137			return $al;
138			}
139
140			/**
141			*
142			* @return DataList
			0 ignored issues – show Documentation introduced 2016-12-20 03:49 UTC by Report Bug Copy Issue Report Should the return type not be `string`? 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...
143			*/
144			public function AlternativeHrefLangLinksCachingKey()
145			{
146			$countryObject = CountryPrice_EcommerceCountry::get_real_country();
147			if ($countryObject && $countryObject->Code) {
148			return 'AlternativeHrefLangLinksCachingKey-'.$countryObject->Code.'-'.$this->owner->dataRecord->ID.'-'.strtotime($this->owner->dataRecord->LastEdited);
149			}
150			return 'AlternativeHrefLangLinksCachingKey'.$this->owner->dataRecord->ID.'-'.$this->owner->dataRecord->ID.'-'.strtotime($this->owner->dataRecord->LastEdited);
151			}
152
153			/**
154			*
155			* @param string $link - passed by reference
156			*/
157			public function UpdateCanonicalLink(&$link)
			0 ignored issues – show Documentation introduced 2017-10-18 01:15 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...
158			{
159			$obj = $this->owner->dataRecord->CanonicalObject();
160			if ($obj) {
161			$link = $obj->Link();
162			} else {
163			$link = $this->owner->dataRecord->AbsoluteLink();
164			}
165			return $link;
166			}
167
168			/**
169			* redirects visitors to another website if they are listed as such in
170			* CountryPrices_ChangeCountryController.off_site_url_redirects
171			*
172			* @param EcommerceCountry $countryObject current country of visitor
173			*
174			* @return null\|SS_HTTPResponse
175			*/
176			protected function checkForOffsiteRedirects($countryObject)
177			{
178			$redirectsArray = Config::inst()->get('CountryPrices_ChangeCountryController', 'off_site_url_redirects');
179			$myCountryCode = strtoupper($countryObject->Code);
180			if (isset($redirectsArray[$myCountryCode])) {
181			return $this->redirect($redirectsArray[$myCountryCode]);
			0 ignored issues – show Bug introduced 2018-01-16 22:48 UTC by Report Bug Copy Issue Report The method `redirect()` does not exist on `CountryPrice_Page_Controller_Extension`. Did you maybe mean `checkForOffsiteRedirects()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
182			}
183			}
184			}
185

sunnysideup / silverstripe-ecommerce_countries

Push — master ( efb352...721e90 )

addCountryCodeToUrlIfRequired() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like