Rename $locale property to $full

Author: ivanvermeyen

src/BrowserLocale.php

@@ -41,7 +41,7 @@ public function getLocale()
      * If a property filter is specified, a flattened array of locale information,
      * containing only the requested property values will be returned instead.
      *
-     * @param string $propertyFilter locale|language|country|weight
+     * @param string $propertyFilter full|language|country|weight
      *
      * @return array
      */
@@ -94,7 +94,7 @@ protected function parseAcceptLanguage($httpAcceptLanguage)
 
         if ($locale !== null) {
             $localeInstance = new Locale();
-            $localeInstance->locale = $locale;
+            $localeInstance->full = $locale;
             $localeInstance->language = $this->getLanguage($locale);
             $localeInstance->country = $this->getCountry($locale);
             $localeInstance->weight = $this->getWeight($weight);
@@ -210,7 +210,7 @@ protected function sortLocales()
      */
     protected function filterLocaleInfo($property)
     {
-        $filters = ['locale', 'language', 'country', 'weight'];
+        $filters = ['full', 'language', 'country', 'weight'];
         $locales = $this->locales;
 
         if ( ! in_array($property, $filters)) {

src/Locale.php

@@ -9,7 +9,7 @@ class Locale
      *
      * @var string
      */
-    public $locale;
+    public $full;
 
     /**
      * Language code of the locale.

tests/BrowserLocaleTest.php

@@ -13,7 +13,7 @@ public function it_returns_the_most_preferred_locale()
         $browser = new BrowserLocale('en-US,en;q=0.8,nl-NL;q=0.6,nl;q=0.4');
         $locale = $browser->getLocale();
 
-        $this->assertEquals('en-US', $locale->locale);
+        $this->assertEquals('en-US', $locale->full);
         $this->assertEquals('en', $locale->language);
         $this->assertEquals('US', $locale->country);
         $this->assertEquals(1.0, $locale->weight);
@@ -25,7 +25,7 @@ public function it_returns_the_first_locale_if_two_have_the_same_weight()
         $browser = new BrowserLocale('nl-NL,en-US,nl;q=0.4');
         $locale = $browser->getLocale();
 
-        $this->assertEquals('nl-NL', $locale->locale);
+        $this->assertEquals('nl-NL', $locale->full);
         $this->assertEquals('nl', $locale->language);
         $this->assertEquals('NL', $locale->country);
         $this->assertEquals(1.0, $locale->weight);
@@ -37,33 +37,33 @@ public function it_returns_an_array_of_all_preferred_locales()
         $browser = new BrowserLocale('en-US,en;q=0.8,nl-NL;q=0.6,nl;q=0.4');
         $locales = $browser->getLocales();
 
-        $this->assertEquals('en-US', $locales[0]->locale);
+        $this->assertEquals('en-US', $locales[0]->full);
         $this->assertEquals('en', $locales[0]->language);
         $this->assertEquals('US', $locales[0]->country);
         $this->assertEquals(1.0, $locales[0]->weight);
 
-        $this->assertEquals('en', $locales[1]->locale);
+        $this->assertEquals('en', $locales[1]->full);
         $this->assertEquals('en', $locales[1]->language);
         $this->assertEquals('', $locales[1]->country);
         $this->assertEquals(0.8, $locales[1]->weight);
 
-        $this->assertEquals('nl-NL', $locales[2]->locale);
+        $this->assertEquals('nl-NL', $locales[2]->full);
         $this->assertEquals('nl', $locales[2]->language);
         $this->assertEquals('NL', $locales[2]->country);
         $this->assertEquals(0.6, $locales[2]->weight);
 
-        $this->assertEquals('nl', $locales[3]->locale);
+        $this->assertEquals('nl', $locales[3]->full);
         $this->assertEquals('nl', $locales[3]->language);
         $this->assertEquals('', $locales[3]->country);
         $this->assertEquals(0.4, $locales[3]->weight);
     }
 
     /** @test */
-    public function it_returns_a_simple_array_of_locales()
+    public function it_returns_a_simple_array_of_full_locales()
     {
         $browser = new BrowserLocale('en-US,en;q=0.8,nl-NL;q=0.6,nl;q=0.4');
 
-        $locales = $browser->getLocales('locale');
+        $locales = $browser->getLocales('full');
 
         $this->assertEquals(['en-US', 'en', 'nl-NL', 'nl'], $locales);
     }
@@ -105,7 +105,7 @@ public function it_returns_null_or_an_empty_array_if_no_locale_exists()
 
         $this->assertEquals(null, $browser->getLocale());
         $this->assertEquals([], $browser->getLocales());
-        $this->assertEquals([], $browser->getLocales('locales'));
+        $this->assertEquals([], $browser->getLocales('full'));
         $this->assertEquals([], $browser->getLocales('language'));
         $this->assertEquals([], $browser->getLocales('country'));
         $this->assertEquals([], $browser->getLocales('weight'));