Merge pull request #93 from ARCANEDEV/develop

Updating the package

.travis.yml

@@ -17,7 +17,7 @@ env:
 
 before_script:
   - travis_retry composer self-update
-  - travis_retry composer require --prefer-source --no-interaction --dev "orchestra/testbench-browser-kit:${TESTBENCH_VERSION}" "orchestra/database:${TESTBENCH_VERSION}"
+  - travis_retry composer require --prefer-dist --no-interaction "orchestra/testbench-browser-kit:${TESTBENCH_VERSION}"
 
 script:
   - composer validate

_docs/3-Usage.md

@@ -104,17 +104,14 @@ If you want to hide the default locale but always show other locales in the url,
 /**
  * Returns an URL adapted to $locale or current locale.
  *
- *
- * @param  string|bool   $locale
- * @param  string|false  $url
- * @param  array         $attributes
+ * @param  string|null  $locale
+ * @param  string|null  $url
+ * @param  array        $attributes
+ * @param  bool|false   $showHiddenLocale
  *
  * @return string|false
- *
- * @throws UndefinedSupportedLocalesException
- * @throws UnsupportedLocaleException
  */
-public function getLocalizedURL($locale = null, $url = null, $attributes = [])
+public function getLocalizedURL($locale = null, $url = null, array $attributes = [], $showHiddenLocale = false)
 
 // OR
 
@@ -124,8 +121,6 @@ public function getLocalizedURL($locale = null, $url = null, $attributes = [])
  * @param  string       $url
  * @param  string|null  $locale
  *
- * @throws UnsupportedLocaleException
- *
  * @return string
  */
 public function localizeURL($url = null, $locale = null);
@@ -157,13 +152,11 @@ It returns a clean URL of any localization.
  * @param  string|bool  $locale
  * @param  string       $transKey
  * @param  array        $attributes
+ * @param  bool|false   $showHiddenLocale
  *
  * @return string|false
- *
- * @throws UndefinedSupportedLocalesException
- * @throws UnsupportedLocaleException
  */
-public function getUrlFromRouteName($locale, $transKey, $attributes = [])
+public function getUrlFromRouteName($locale, $transKey, array $attributes = [], $showHiddenLocale = false)
 ```
 
 It returns a route, localized to the desired locale using the locale passed.
@@ -192,8 +185,6 @@ function localized_route($transRoute, array $attributes = [], $locale = null)
  * Return an array of all supported Locales.
  *
  * @return \Arcanedev\Localization\Entities\LocaleCollection
- *
- * @throws UndefinedSupportedLocalesException
  */
 public function getSupportedLocales()
 ```
@@ -207,8 +198,6 @@ It returns all locales as a `Arcanedev\Localization\Entities\LocaleCollection` C
  * Get supported locales keys.
  *
  * @return array
- *
- * @throws UndefinedSupportedLocalesException
  */
 public function getSupportedLocalesKeys()
 ```
@@ -370,8 +359,6 @@ public function setBaseUrl($url)
  *
  * @param  string|bool  $locale
  *
- * @throws UndefinedSupportedLocalesException
- *
  * @return bool
  */
 public function isLocaleSupported($locale)

composer.json

@@ -33,7 +33,7 @@
         }
     },
     "scripts": {
-        "testbench": "composer require --dev \"orchestra/testbench-browser-kit=~3.4\" \"orchestra/database=~3.4\""
+        "testbench": "composer require --dev \"orchestra/testbench-browser-kit=~3.4\""
     },
     "suggest": {
         "ext-intl": "Use Intl extension for 'Locale' class (an identifier used to get language)."

src/Contracts/LocalesManager.php

@@ -12,6 +12,7 @@ interface LocalesManager
      |  Getters & Setters
      | -----------------------------------------------------------------
      */
+
     /**
      * Set and return current locale.
      *
@@ -94,6 +95,7 @@ public function setSupportedLocales(array $supportedLocales);
      |  Check Methods
      | -----------------------------------------------------------------
      */
+
     /**
      * Check if default is supported.
      *

src/Contracts/Localization.php

@@ -14,6 +14,7 @@ interface Localization
      |  Getters & Setters
      | -----------------------------------------------------------------
      */
+
     /**
      * Returns default locale.
      *
@@ -127,6 +128,7 @@ public function setRouteNameFromRequest(Request $request);
      |  Main Methods
      | -----------------------------------------------------------------
      */
+
     /**
      * Translate routes and save them to the translated routes array (used in the localize route filter).
      *
@@ -158,13 +160,14 @@ public function getNonLocalizedURL($url = null);
     /**
      * Returns an URL adapted to $locale.
      *
-     * @param  string|bool   $locale
-     * @param  string|false  $url
-     * @param  array         $attributes
+     * @param  string|null  $locale
+     * @param  string|null  $url
+     * @param  array        $attributes
+     * @param  bool|bool    $showHiddenLocale
      *
      * @return string|false
      */
-    public function getLocalizedURL($locale = null, $url = null, $attributes = []);
+    public function getLocalizedURL($locale = null, $url = null, array $attributes = [], $showHiddenLocale = false);
 
     /**
      * Create an url from the uri.
@@ -185,15 +188,17 @@ public function createUrlFromUri($uri);
      * @param  string|bool  $locale
      * @param  string       $transKey
      * @param  array        $attributes
+     * @param  bool|false   $showHiddenLocale
      *
      * @return string|false
      */
-    public function getUrlFromRouteName($locale, $transKey, $attributes = []);
+    public function getUrlFromRouteName($locale, $transKey, array $attributes = [], $showHiddenLocale = false);
 
     /* -----------------------------------------------------------------
      |  Check Methods
      | -----------------------------------------------------------------
      */
+
     /**
      * Hide the default locale in URL ??
      *

src/Contracts/Negotiator.php

@@ -15,6 +15,7 @@ interface Negotiator
      |  Main Methods
      | -----------------------------------------------------------------
      */
+
     /**
      * Make Negotiator instance.
      *

src/Contracts/RouteBindable.php

@@ -8,6 +8,11 @@
  */
 interface RouteBindable
 {
+    /* -----------------------------------------------------------------
+     |  Main Methods
+     | -----------------------------------------------------------------
+     */
+
     /**
      * Get the wildcard value from the class.
      *

src/Contracts/RouteTranslator.php

@@ -14,6 +14,7 @@ interface RouteTranslator
      |  Getters & Setters
      | -----------------------------------------------------------------
      */
+
     /**
      * Get current route.
      *
@@ -41,6 +42,7 @@ public function getTranslatedRoutes();
      |  Main Methods
      | -----------------------------------------------------------------
      */
+
     /**
      * Translate routes and save them to the translated routes array (used in the localize route filter).
      *
@@ -93,17 +95,19 @@ public function findTranslatedRouteByPath($path, $locale);
      * @param  string      $transKey
      * @param  array       $attributes
      * @param  bool|false  $defaultHidden
+     * @param  bool|false  $showHiddenLocale
      *
      * @return string
      */
     public function getUrlFromRouteName(
-        $locale, $defaultLocale, $transKey, $attributes = [], $defaultHidden = false
+        $locale, $defaultLocale, $transKey, $attributes = [], $defaultHidden = false, $showHiddenLocale = false
     );
 
     /* -----------------------------------------------------------------
      |  Check Methods
      | -----------------------------------------------------------------
      */
+
     /**
      * Check if has current route.
      *

src/Contracts/Url.php

@@ -12,6 +12,7 @@ interface Url
      |  Main Methods
      | -----------------------------------------------------------------
      */
+
     /**
      * Extract attributes for current url.
      *

src/Entities/Locale.php

@@ -16,6 +16,7 @@ class Locale implements Arrayable, Jsonable, JsonSerializable
      |  Properties
      | -----------------------------------------------------------------
      */
+
     /**
      * Locale key.
      *
@@ -69,6 +70,7 @@ class Locale implements Arrayable, Jsonable, JsonSerializable
      |  Constructor
      | -----------------------------------------------------------------
      */
+
     /**
      * Create Locale instance.
      *
@@ -89,6 +91,7 @@ public function __construct($key, array $data)
      |  Getters & Setters
      | -----------------------------------------------------------------
      */
+
     /**
      * Get local key.
      *
@@ -268,6 +271,7 @@ private function setDefault()
      |  Main Methods
      | -----------------------------------------------------------------
      */
+
     /**
      * Create Locale instance.
      *
@@ -285,6 +289,7 @@ public static function make($key, array $data)
      |  Other Methods
      | -----------------------------------------------------------------
      */
+
     /**
      * Get the locale entity as an array.
      *

src/Entities/LocaleCollection.php

@@ -14,6 +14,7 @@ class LocaleCollection extends Collection
      |  Properties
      | -----------------------------------------------------------------
      */
+
     /**
      * Supported locales.
      *
@@ -25,6 +26,7 @@ class LocaleCollection extends Collection
      |  Getters & Setters
      | -----------------------------------------------------------------
      */
+
     /**
      * Set supported locales keys.
      *
@@ -43,13 +45,14 @@ public function setSupportedKeys(array $supported)
      |  Main Methods
      | -----------------------------------------------------------------
      */
+
     /**
      * Get the first locale from the collection.
      *
      * @param  callable|null  $callback
      * @param  mixed          $default
      *
-     * @return Locale|mixed
+     * @return \Arcanedev\Localization\Entities\Locale|mixed
      */
     public function first(callable $callback = null, $default = null)
     {