Add PHPDoc to facade (#768)

mcamara · Oct 24, 2021 · e511c76 · e511c76
1 parent c71bb11
commit e511c76
Showing 1 changed file with 36 additions and 0 deletions.
diff --git a/src/Mcamara/LaravelLocalization/Facades/LaravelLocalization.php b/src/Mcamara/LaravelLocalization/Facades/LaravelLocalization.php
@@ -4,6 +4,42 @@
 
 use Illuminate\Support\Facades\Facade;
 
+/**
+ * @method static string setLocale(string $locale = null)
+ * @method static bool isHiddenDefault(string $locale)
+ * @method static void setSupportedLocales(array $locales)
+ * @method static string localizeUrl(string $url = null, string|bool $locale = null)
+ * @method static string|false getLocalizedUrl(string|bool $locale = null, string|false $url = null, array $attributes = [], bool $forceDefaultLocation = false)
+ * @method static string|false getURLFromRouteNameTranslated(string|bool $locale, string $transKeyName, array $attributes = [], bool $forceDefaultLocation = false)
+ * @method static string getNonLocalizedURL(string|false $url = null)
+ * @method static string getDefaultLocale()
+ * @method static array getLocalesMapping()
+ * @method static string|null getLocalesFromMapping(string|null $locale)
+ * @method static string|null getInversedLocaleFromMapping(string|null $locale)
+ * @method static array getSupportedLocales()
+ * @method static array getLocalesOrder()
+ * @method static string getCurrentLocaleName()
+ * @method static string getCurrentLocaleNative()
+ * @method static string getCurrentLocaleDirection()
+ * @method static string getCurrentLocaleScript()
+ * @method static string getCurrentLocaleNativeReading()
+ * @method static string getCurrentLocale()
+ * @method static string getCurrentLocaleRegional()
+ * @method static array getSupportedLanguagesKeys()
+ * @method static bool checkLocaleInSupportedLocales(string|bool $locale)
+ * @method static void setRouteName(string $routeName)
+ * @method static string transRoute(string $routeName)
+ * @method static string|false getRouteNameFromAPath(string $path)
+ * @method static \Illuminate\Config\Repository getConfigRepository()
+ * @method static bool hideUrlAndAcceptHeader()
+ * @method static bool hideDefaultLocaleInURL()
+ * @method static string createUrlFromUri(string $uri)
+ * @method static void setBaseUrl(string $url)
+ * @method static string getSerializedTranslatedRoutes()
+ * @method static void setSerializedTranslatedRoutes(string $serializedRoutes)
+ *
+ * @see \Mcamara\LaravelLocalization\LaravelLocalization
+ */
 class LaravelLocalization extends Facade
 {
     /**