CountryPrice_Page_Controller_Extension

Complexity

Total Complexity

27

Size/Duplication

Total Lines	174
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	11

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	CountryDistributorBestContentValue()	0	20	4
B	onAfterInit()	0	24	4
B	addCountryCodeToUrlIfRequired()	0	21	7
B	ChooseNewCountryList()	0	28	5
A	AlternativeHrefLangLinksCachingKey()	0	8	3
A	UpdateCanonicalLink()	0	10	2
A	checkForOffsiteRedirects()	0	8	2

<?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

PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions.

{

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

The doc-type [type] could not be parsed: Unknown type name "" at position 0. [(view supported doc-types)

     */
    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) {
                    $this->owner->redirect($newURL);
                }
            }
        }

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

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

The return type could not be reliably inferred; please add a @return annotation.

    {
        $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 = '')

addCountryCodeToUrlIfRequired uses the super-global variable $_POST which is generally not recommended.

addCountryCodeToUrlIfRequired uses the super-global variable $_SERVER which is generally not recommended.

    {
        if (isset($_POST) && count($_POST)) {
            return null;
        }
        //to do: add query here!
        $protocol = Director::is_https() ? 'https://' : 'http://';
        $oldURL = $protocol.$_SERVER['HTTP_HOST'].$_SERVER['REQUEST_URI'];

        $hasCountrySegment = CountryPrice_Translation::get_country_url_provider()->hasCountrySegment($oldURL);
        if ($hasCountrySegment) {
            $newURL = CountryPrice_Translation::get_country_url_provider()->replaceCountryCodeInUrl($countryCode, $oldURL);
        } else {
            $newURL = CountryPrice_Translation::get_country_url_provider()->addCountryCodeToUrl($countryCode, $oldURL);
        }
        if ($oldURL !== $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;

$currency is not used, you could remove the assignment.

            $currency = CountryPrice_EcommerceCurrency::get_currency_for_country($country->Code);
            $currencyCode = CountryPrice_EcommerceCurrency::get_currency_for_country($country->Code);

$currencyCode is not used, you could remove the assignment.

            $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

Should the return type not be string?

     */
    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)

The return type could not be reliably inferred; please add a @return annotation.

    {
        $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]);

The method redirect() does not exist on CountryPrice_Page_Controller_Extension. Did you maybe mean checkForOffsiteRedirects()?

        }
    }
}