Added support for custom order (#406)

* Added support for custom order

* Update Readme for custom order helper function

Author: sarotnem

README.md

@@ -254,6 +254,23 @@ It returns a route, localized to the desired locale using the locale passed. If
 
 This function will return all supported locales and their properties as an array.
 
+### Get Supported Locales Custom Order
+
+```php
+    /**
+     * Return an array of all supported Locales but in the order the user
+     * has specified in the config file. Useful for the language selector.
+     *
+     * @return array
+     */
+     public function getLocalesOrder()
+
+	//Should be called like this:
+	{{ LaravelLocalization::getLocalesOrder() }}
+```
+
+This function will return all supported locales but in the order specified in the configuration file. You can use this function to print locales in the language selector.
+
 ### Get Supported Locales Keys
 
 ```php

src/Mcamara/LaravelLocalization/LaravelLocalization.php

@@ -385,6 +385,27 @@ public function getSupportedLocales()
         return $locales;
     }
 
+    /**
+     * Return an array of all supported Locales but in the order the user
+     * has specified in the config file. Useful for the language selector.
+     *
+     * @return array
+     */
+    public function getLocalesOrder()
+    {
+        $locales = $this->getSupportedLocales();
+
+        $order = $this->configRepository->get('laravellocalization.localesOrder');
+
+        uksort($locales, function ($a, $b) use ($order) {
+            $pos_a = array_search($a, $order);
+            $pos_b = array_search($b, $order);
+            return $pos_a - $pos_b;
+        });
+
+        return $locales;
+    }
+
     /**
      * Returns current locale name.
      *
@@ -423,9 +444,9 @@ public function getCurrentLocaleDirection()
             case 'Mong':
             case 'Tfng':
             case 'Thaa':
-                return 'rtl';
+            return 'rtl';
             default:
-                return 'ltr';
+            return 'ltr';
         }
     }
 

src/config/config.php

@@ -309,4 +309,9 @@
     //
     'hideDefaultLocaleInURL' => false,
 
+    // If you want to display the locales in particular order in the language selector you should write the order here. 
+    //CAUTION: Please consider using the appropriate locale code otherwise it will not work
+    //Example: 'localesOrder' => ['es','en'],
+    'localesOrder' => [],
+
 ];