Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add PHPDoc to facade #768

Merged
merged 1 commit into from
Oct 24, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions src/Mcamara/LaravelLocalization/Facades/LaravelLocalization.php
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
/**
Expand Down