sunnysideup / silverstripe-ecommerce_countries

code/control/CountryPrice_Page_Controller_Extension.php

Doc Comments +1 added lines, -1 removed lines

@@ -157,7 +157,7 @@
 
     /**
      *
-     * @return DataList
+     * @return string
      */
     public function AlternativeHrefLangLinksCachingKey()
     {

Braces +1 added lines, -2 removed lines

@@ -101,8 +101,7 @@
         $hasCountrySegment = CountryPrice_Translation::get_country_url_provider()->hasCountrySegment($oldURL);
         if($hasCountrySegment){
             $newURL = CountryPrice_Translation::get_country_url_provider()->replaceCountryCodeInUrl($countryCode, $oldURL);
-        }
-        else {
+        } else {
             $newURL = CountryPrice_Translation::get_country_url_provider()->addCountryCodeToUrl($countryCode, $oldURL);
         }
         if ($oldURL !== $newURL && self::$_redirection_count < 3) {

Spacing +7 added lines, -7 removed lines

@@ -28,17 +28,17 @@ 
         //provided by stealth ...
         $param = Config::inst()->get('CountryPrice_Translation', 'locale_get_parameter');
         $countryObject = CountryPrice_EcommerceCountry::get_real_country();
-        if($countryObject && $countryObject->Code) {
+        if ($countryObject && $countryObject->Code) {
             $oldCountryCode = strtoupper($countryObject->Code);
         } else {
             $oldCountryCode = 'XX';
         }
         if (isset($_GET[$param])) {
             $urlCountryCode = preg_replace("/[^A-Z]+/", "", strtoupper(Convert::raw2sql($_GET[$param])));
-            if($countryCode) {
+            if ($countryCode) {
                 if ($oldCountryCode !== $urlCountryCode) {
                     $countryObject = DataObject::get_one('EcommerceCountry', ['Code' => $urlCountryCode]);
-                    if($countryObject) {
+                    if ($countryObject) {
                         //change country Object
                         //reset everything ...
                         CountryPrices_ChangeCountryController::set_new_country($urlCountryCode);
@@ -48,7 +48,7 @@ 
                 }
             }
         }
-        if($countryObject) {
+        if ($countryObject) {
 
             //check if a redirect is required ...
             $this->checkForOffsiteRedirects($countryObject);
@@ -114,7 +114,7 @@ 
         $oldURL = $protocol.$_SERVER['HTTP_HOST'].$_SERVER['REQUEST_URI'];
 
         $hasCountrySegment = CountryPrice_Translation::get_country_url_provider()->hasCountrySegment($oldURL);
-        if($hasCountrySegment){
+        if ($hasCountrySegment) {
             $newURL = CountryPrice_Translation::get_country_url_provider()->replaceCountryCodeInUrl($countryCode, $oldURL);
         }
         else {
@@ -169,7 +169,7 @@ 
     public function AlternativeHrefLangLinksCachingKey()
     {
         $countryObject = CountryPrice_EcommerceCountry::get_real_country();
-        if($countryObject && $countryObject->Code) {
+        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);
@@ -182,7 +182,7 @@ 
     public function UpdateCanonicalLink(&$link)
     {
         $obj = $this->owner->dataRecord->CanonicalObject();
-        if($obj) {
+        if ($obj) {
             $link = $obj->Link();
         } else {
             $link = $this->owner->dataRecord->AbsoluteLink();

code/model/money/CountryPrice_EcommerceCurrency.php

Spacing +3 added lines, -3 removed lines

@@ -44,10 +44,10 @@ 
             $currencyCode = isset($currencyPerCountry[$countryCode]) ? $currencyPerCountry[$countryCode] : EcommerceCurrency::default_currency_code();
             $currencyDO = EcommerceCurrency::get_one_from_code($currencyCode);
         }
-        if (! $currencyDO) {
+        if (!$currencyDO) {
             $currencyDO = EcommerceCurrency::create_new($currencyCode);
         }
-        if (! $currencyDO) {
+        if (!$currencyDO) {
             $currencyDO = EcommerceCurrency::get_default();
         }
         return $currencyDO;
@@ -67,7 +67,7 @@ 
     {
         $cachekey = "EcommerceCurrencyCountryMatrix";
         $cache = SS_Cache::factory('CountryPrice_EcommerceCurrency');
-        if (! ($serializedArray = $cache->load($cachekey))) {
+        if (!($serializedArray = $cache->load($cachekey))) {
             $countries = CountryPrice_EcommerceCountry::get_real_countries_list();
             $unserializedArray = array();
             $defaultCurrencyCode = EcommerceCurrency::default_currency_code();

code/model/translations/CountryPrice_SiteTreeExtensions.php

Doc Comments +1 added lines

@@ -123,6 +123,7 @@
     /**
      * @var int $countryID
      *
+     * @param integer $countryID
      * @return CountryPrice_Translation | null
      */
     public function getEcommerceTranslation($countryID)

Spacing +6 added lines, -6 removed lines

@@ -48,12 +48,12 @@ 
     public function CanonicalObject()
     {
         $countryObject = CountryPrice_EcommerceCountry::get_real_country();
-        if($countryObject && $countryObject->Code) {
+        if ($countryObject && $countryObject->Code) {
             $object = $this->owner->CountryPriceTranslations()
                 ->innerJoin('EcommerceCountry', '"EcommerceCountry"."ID" = "CountryPrice_Translation"."EcommerceCountryID"')
                 ->filter(array('EcommerceCountry.Code' => $countryObject->Code))
                 ->first();
-            if($object && $object->exists()) {
+            if ($object && $object->exists()) {
                 return $object;
             }
         }
@@ -63,7 +63,7 @@ 
     public function loadTranslatedValues($countryID = 0, $variableOrMethod = '')
     {
         $translation = null;
-        if (! $countryID) {
+        if (!$countryID) {
             $countryObject = CountryPrice_EcommerceCountry::get_real_country();
             if ($countryObject) {
                 $countryID = $countryObject->ID;
@@ -82,9 +82,9 @@ 
             $fieldsToReplace = $translation->FieldsToReplace();
             foreach ($fieldsToReplace as $replaceFields) {
                 $pageField = $replaceFields->PageField;
-                $pageFieldTranslated = $pageField . 'Translated';
+                $pageFieldTranslated = $pageField.'Translated';
                 $translationField = $replaceFields->TranslationField;
-                if (! $variableOrMethod || $variableOrMethod === $pageField) {
+                if (!$variableOrMethod || $variableOrMethod === $pageField) {
                     if ($translation->hasMethod($translationField)) {
                         $this->owner->$pageField = $translation->$translationField();
                         $this->owner->$pageFieldTranslated = $translation->$translationField();
@@ -147,7 +147,7 @@ 
      */
     public function getEcommerceTranslation($countryID)
     {
-        if(!isset($this->_translations_all_cache[$countryID])) {
+        if (!isset($this->_translations_all_cache[$countryID])) {
             $this->_translations_all_cache[$countryID] = $this->owner
                 ->CountryPriceTranslations()
                 ->filter(

code/interfaces/CountryURLProviderInterface.php

Doc Comments +3 added lines

@@ -3,14 +3,17 @@
 interface CountryURLProviderInterface
 {
     /**
+     * @return boolean
      */
     public function hasCountrySegment($url = '');
 
     /**
+     * @return string
      */
     public function replaceCountryCodeInUrl($countryCode, $url = '');
 
     /**
+     * @return string
      */
     public function addCountryCodeToUrl($countryCode, $url = '');
 

code/model/translations/CountryPrice_Translation.php

Braces +1 added lines, -2 removed lines

@@ -225,8 +225,7 @@
             $hasCountrySegment = CountryPrice_Translation::get_country_url_provider()->hasCountrySegment($link);
             if($hasCountrySegment){
                 $link = CountryPrice_Translation::get_country_url_provider()->replaceCountryCodeInUrl($this->EcommerceCountry()->Code, $link);
-            }
-            else {
+            } else {
                 $link = CountryPrice_Translation::get_country_url_provider()->addCountryCodeToUrl($this->EcommerceCountry()->Code, $link);
             }
         }

Spacing +22 added lines, -22 removed lines

@@ -99,11 +99,11 @@ 
         $countryDropdownField = DropdownField::create(
             'EcommerceCountryID',
             $fields->dataFieldByName('EcommerceCountryID')->Title(),
-            array('' => '-- make sure to select a country --')+$countries
+            array('' => '-- make sure to select a country --') + $countries
         );
 
         // //$fields->removeFieldFromTab("Root.Main", 'ParentID');
-        if($this->WithoutTranslation) {
+        if ($this->WithoutTranslation) {
             return FieldList::create(
                 array(
                     $countryDropdownField,
@@ -123,19 +123,19 @@ 
             );
         }
         $dbFields = $this->inheritedDatabaseFields();
-        foreach($dbFields as $dbField => $fieldType) {
+        foreach ($dbFields as $dbField => $fieldType) {
             $useField = 'UseOriginal'.$dbField;
-            if(!empty($this->$useField)) {
+            if (!empty($this->$useField)) {
                 $fields->replaceField(
                     $dbField,
                     $fields->dataFieldByName($dbField)->performReadonlyTransformation()
                 );
             }
-            if($fields->dataFieldByName($useField)){
-                $fields->dataFieldByName($useField)->setDescription(_t('CountryPrice_Translation.IGNORE', 'Use untranslated value for ') . $dbField);
+            if ($fields->dataFieldByName($useField)) {
+                $fields->dataFieldByName($useField)->setDescription(_t('CountryPrice_Translation.IGNORE', 'Use untranslated value for ').$dbField);
             }
         }
-        if($this->exists() && $this->ParentID) {
+        if ($this->exists() && $this->ParentID) {
             $fields->addFieldToTab(
                 'Root.ParentPage',
                 CMSEditLinkField::create(
@@ -210,9 +210,9 @@ 
             )
         );
         $this->extend('updateFieldsToReplace', $al);
-        foreach($al as $fieldToReplace) {
-            $ignoreField = 'UseOriginal' . $fieldToReplace->PageField;
-            if(!empty($this->owner->$ignoreField)) {
+        foreach ($al as $fieldToReplace) {
+            $ignoreField = 'UseOriginal'.$fieldToReplace->PageField;
+            if (!empty($this->owner->$ignoreField)) {
                 $al->remove($fieldToReplace);
             }
         }
@@ -235,7 +235,7 @@ 
         $link = $this->Parent()->Link();
         if ($this->EcommerceCountryID) {
             $hasCountrySegment = CountryPrice_Translation::get_country_url_provider()->hasCountrySegment($link);
-            if($hasCountrySegment){
+            if ($hasCountrySegment) {
                 $link = CountryPrice_Translation::get_country_url_provider()->replaceCountryCodeInUrl($this->EcommerceCountry()->Code, $link);
             }
             else {
@@ -250,20 +250,20 @@ 
         parent::requireDefaultRecords();
         //get rid of rogue entries:
         DB::query('DELETE FROM CountryPrice_Translation WHERE EcommerceCountryID = 0 OR ParentID = 0');
-        if(Config::inst()->get('CountryPrice_Translation', 'automatically_create_dummy_translations_for_products_and_productgroups')) {
+        if (Config::inst()->get('CountryPrice_Translation', 'automatically_create_dummy_translations_for_products_and_productgroups')) {
             $prices = CountryPrice::get();
             $ecommerceCountries = array();
-            foreach($prices as $price) {
-                if($countryObject = $price->CountryObject()) {
-                    if($buyable = $price->Buyable()) {
-                        if($buyable instanceof Product) {
-                            if($buyable->ID && $countryObject->ID) {
+            foreach ($prices as $price) {
+                if ($countryObject = $price->CountryObject()) {
+                    if ($buyable = $price->Buyable()) {
+                        if ($buyable instanceof Product) {
+                            if ($buyable->ID && $countryObject->ID) {
                                 $filter = array(
                                     'EcommerceCountryID' => $countryObject->ID,
                                     'ParentID' => $buyable->ID
                                 );
                                 $ecommerceCountries[$countryObject->ID] = $countryObject;
-                                if(! CountryPrice_Translation::get()->filter($filter)->first()) {
+                                if (!CountryPrice_Translation::get()->filter($filter)->first()) {
                                     DB::alteration_message(
                                         'Creating fake translation for '.$buyable->Title.' for country '.$countryObject->Code,
                                         'created'
@@ -277,14 +277,14 @@ 
                     }
                 }
             }
-            if(count($ecommerceCountries)) {
-                foreach(ProductGroup::get() as $productGroup) {
-                    foreach($ecommerceCountries as $countryID => $countryObject) {
+            if (count($ecommerceCountries)) {
+                foreach (ProductGroup::get() as $productGroup) {
+                    foreach ($ecommerceCountries as $countryID => $countryObject) {
                         $filter = array(
                             'EcommerceCountryID' => $countryObject->ID,
                             'ParentID' => $productGroup->ID
                         );
-                        if(! CountryPrice_Translation::get()->filter($filter)->first()) {
+                        if (!CountryPrice_Translation::get()->filter($filter)->first()) {
                             DB::alteration_message(
                                 'Creating fake translation for '.$productGroup->Title.' for country '.$countryObject->Code,
                                 'created'

code/api/CountryURLProvider.php

Spacing +19 added lines, -19 removed lines

@@ -10,62 +10,62 @@
 
 class CountryURLProvider extends Object implements CountryURLProviderInterface
 {
-    private static $country_segments  = array('nz', 'au', 'gb', 'eu', 'jp', 'us', 'zz');
+    private static $country_segments = array('nz', 'au', 'gb', 'eu', 'jp', 'us', 'zz');
 
-    public function hasCountrySegment($url = ''){
+    public function hasCountrySegment($url = '') {
         $url = $this->getDefaultURL($url);
         $parsedUrl = parse_url($url);
         $pathSegments = explode("/", $parsedUrl['path']);
         $firstSegment = '';
-        $countries =  Config::inst()->get('CountryURLProvider', 'country_segments');
-        foreach ($pathSegments as $position => $segment){
-            if($segment){
+        $countries = Config::inst()->get('CountryURLProvider', 'country_segments');
+        foreach ($pathSegments as $position => $segment) {
+            if ($segment) {
                 $firstSegment = $segment;
                 break;
             }
         }
-        if(in_array($firstSegment, $countries)){
+        if (in_array($firstSegment, $countries)) {
             return true;
         }
         return false;
     }
 
-    public function replaceCountryCodeInUrl($countryCode, $url = ''){
+    public function replaceCountryCodeInUrl($countryCode, $url = '') {
         $url = $this->getDefaultURL($url);
         $parsedUrl = parse_url($url);
         $pathParts = explode('/', $parsedUrl['path']);
-        $countries =  Config::inst()->get('CountryURLProvider', 'country_segments');
-        foreach($pathParts as $pathPartsKey => $pathPart) {
+        $countries = Config::inst()->get('CountryURLProvider', 'country_segments');
+        foreach ($pathParts as $pathPartsKey => $pathPart) {
             //check for first match
-            if(in_array($pathPart, $countries)) {
+            if (in_array($pathPart, $countries)) {
                 $pathParts[$pathPartsKey] = strtolower($countryCode);
                 break;
             }
         }
         $parsedUrl['path'] = implode('/', $pathParts);
-        $url = $parsedUrl['scheme']. '://'. $parsedUrl['host']. $parsedUrl['path'];
-        if(isset($parsedUrl['query'])){
-            $url = $url . $parsedUrl['query'];
+        $url = $parsedUrl['scheme'].'://'.$parsedUrl['host'].$parsedUrl['path'];
+        if (isset($parsedUrl['query'])) {
+            $url = $url.$parsedUrl['query'];
         }
         return $url;
     }
 
-    public function addCountryCodeToUrl($countryCode, $url = ''){
+    public function addCountryCodeToUrl($countryCode, $url = '') {
         $url = $this->getDefaultURL($url);
         $parsedUrl = parse_url($url);
-        $url = $parsedUrl['scheme']. '://'. $parsedUrl['host']. '/'. strtolower($countryCode) . $parsedUrl['path'];
-        if(isset($parsedUrl['query'])){
-            $url = $url . $parsedUrl['query'];
+        $url = $parsedUrl['scheme'].'://'.$parsedUrl['host'].'/'.strtolower($countryCode).$parsedUrl['path'];
+        if (isset($parsedUrl['query'])) {
+            $url = $url.$parsedUrl['query'];
         }
         return $url;
     }
 
     private function getDefaultURL($url = '')
     {
-        if($url) {
+        if ($url) {
             return Director::absoluteURL($url);
         }
-        return (isset($_SERVER['HTTPS']) ? "https" : "http") . "://$_SERVER[HTTP_HOST]$_SERVER[REQUEST_URI]";
+        return (isset($_SERVER['HTTPS']) ? "https" : "http")."://$_SERVER[HTTP_HOST]$_SERVER[REQUEST_URI]";
     }
 
 }

code/model/buyables/CountryPrice_BuyableExtension.php

Doc Comments +3 added lines, -3 removed lines

@@ -99,9 +99,9 @@ 
     /**
      * This is called from /ecommerce/code/Product
      * returning NULL is like returning TRUE OR FALSE, i.e. ignore this.
-     * @param Member (optional)   $member
+     * @param Member Member   $member
      * @param bool (optional)     $checkPrice
-     * @return false | null
+     * @return null|false | null
      */
     public function canPurchaseByCountry(Member $member = null, $checkPrice = true, $countryCode = '')
     {
@@ -399,7 +399,7 @@ 
      * as long as we do not give distributors access to the Products
      * this is fairly safe.
      * @param member (optiona) $member
-     * @return null / bool
+     * @return boolean / bool
      */
     public function canEdit($member = null)
     {

Spacing +12 added lines, -12 removed lines

@@ -107,11 +107,11 @@ 
     {
         $countryObject = CountryPrice_EcommerceCountry::get_real_country($countryCode);
         if ($countryObject) {
-            if ($this->debug) {debug::log('found country object: '.$countryObject->Code);}
+            if ($this->debug) {debug::log('found country object: '.$countryObject->Code); }
             $countryCode = $countryObject->Code;
         }
         if ($countryCode == '') {
-            if ($this->debug) {debug::log('There is no country Code! ');}
+            if ($this->debug) {debug::log('There is no country Code! '); }
 
             //we can not decide
             return null;
@@ -121,7 +121,7 @@ 
             //easy  ... overrules all ...
             if ($this->owner->AllCountries) {
                 //is there a valid price ???
-                if ($this->debug) {debug::log('All countries applies - updated  ... new price = '.floatval($this->owner->updateCalculatedPrice()));}
+                if ($this->debug) {debug::log('All countries applies - updated  ... new price = '.floatval($this->owner->updateCalculatedPrice())); }
                 $canSell = true;
             } else {
 
@@ -129,7 +129,7 @@ 
                 //excluded first...
                 $excluded = $this->owner->getManyManyComponents('ExcludedCountries', "\"Code\" = '$countryCode'")->Count();
                 if ($excluded) {
-                    if ($this->debug) {debug::log('excluded country');}
+                    if ($this->debug) {debug::log('excluded country'); }
 
                     //no!
                     return false;
@@ -137,12 +137,12 @@ 
 
                 //default country is included by default ...
                 if ($countryCode == EcommerceConfig::get('EcommerceCountry', 'default_country_code')) {
-                    if ($this->debug) {debug::log('we are in the default country! exiting now ... ');}
+                    if ($this->debug) {debug::log('we are in the default country! exiting now ... '); }
                     $canSell = true;
-                } elseif($this->owner->IncludedCountries()->count()) {
+                } elseif ($this->owner->IncludedCountries()->count()) {
                     $included = $this->owner->getManyManyComponents('IncludedCountries', "\"Code\" = '$countryCode'")->Count();
                     if ($included) {
-                        if ($this->debug) {debug::log('In included countries');}
+                        if ($this->debug) {debug::log('In included countries'); }
                         //null basically means - ignore ...
                         $canSell = true;
                     } else {
@@ -151,11 +151,11 @@ 
                     }
                 }
             }
-            if ($this->debug) {debug::log('the product is '.($canSell ? '' : 'NOT ').' for sale - lets check price ... ');}
+            if ($this->debug) {debug::log('the product is '.($canSell ? '' : 'NOT ').' for sale - lets check price ... '); }
 
             //is there a valid price ???
             $countryPrice = $this->owner->getCalculatedPrice();
-            if ($this->debug) {debug::log('nothing applies, but we have a country price... '.$countryPrice);}
+            if ($this->debug) {debug::log('nothing applies, but we have a country price... '.$countryPrice); }
 
             return floatval($countryPrice) > 0 ? null : false;
         }
@@ -218,7 +218,7 @@ 
             return null;
         }
         $key = $this->owner->ClassName."___".$this->owner->ID.'____'.$countryCode;
-        if (! isset(self::$_buyable_price[$key])) {
+        if (!isset(self::$_buyable_price[$key])) {
             //basics
             $currency = null;
             $currencyCode = null;
@@ -306,7 +306,7 @@ 
                 }
             }
             //order must have a country and a currency
-            if (! $currencyCode ||  ! $countryCode) {
+            if (!$currencyCode || !$countryCode) {
                 if ($this->debug) {
                     debug::log('No currency ('.$currencyCode.') or no country code ('.$countryCode.') for order: ');
                 }
@@ -403,7 +403,7 @@ 
      */
     public function canEdit($member = null)
     {
-        if (! $member) {
+        if (!$member) {
             $member = Member::currentUser();
         }
         if ($member) {

code/control/CountryPrice_ChangeCountryController.php

Braces +1 added lines, -2 removed lines

@@ -120,8 +120,7 @@
             $hasCountrySegment = CountryPrice_Translation::get_country_url_provider()->hasCountrySegment($url);
             if($hasCountrySegment){
                 $url = CountryPrice_Translation::get_country_url_provider()->replaceCountryCodeInUrl($newCountryCode, $url);
-            }
-            else {
+            } else {
                 $url = CountryPrice_Translation::get_country_url_provider()->addCountryCodeToUrl($newCountryCode, $url);
             }
             return $url.$query;

Spacing +5 added lines, -5 removed lines

@@ -84,11 +84,11 @@ 
 
         //redirect now
         $param = Config::inst()->get('CountryPrice_Translation', 'locale_get_parameter');
-        if(isset($_GET['force']) && $_GET['force']) {
+        if (isset($_GET['force']) && $_GET['force']) {
 
-            return $this->redirect(self::$url_segment . '/changeto/' .$newCountryCode . '/'. '?force-back-home');
+            return $this->redirect(self::$url_segment.'/changeto/'.$newCountryCode.'/'.'?force-back-home');
         }
-        if(isset($_GET['force-back-home']) || $_GET['force-back-home']) {
+        if (isset($_GET['force-back-home']) || $_GET['force-back-home']) {
 
             return $this->redirect('/');
         }
@@ -149,10 +149,10 @@ 
 
             $path = isset($parsedUrl['path']) ? $parsedUrl['path'] : '';
 
-            $query = !empty($query) ? '?'. http_build_query($query) : '';
+            $query = !empty($query) ? '?'.http_build_query($query) : '';
 
             $hasCountrySegment = CountryPrice_Translation::get_country_url_provider()->hasCountrySegment($url);
-            if($hasCountrySegment){
+            if ($hasCountrySegment) {
                 $url = CountryPrice_Translation::get_country_url_provider()->replaceCountryCodeInUrl($newCountryCode, $url);
             }
             else {