PHP Класс Arcanedev\Localization\Localization

Автор: ARCANEDEV ([email protected])
Наследование: implements Arcanedev\Localization\Contracts\LocalizationInterface
Показать файл Открыть проект

Защищенные свойства (Protected)

Свойство Тип Описание
$baseUrl string Base url.
$routeTranslator Arcanedev\Localization\Contracts\RouteTranslatorInterface The RouteTranslator instance.

Открытые методы

Метод Описание
__construct ( Illuminate\Foundation\Application $app, Arcanedev\Localization\Contracts\RouteTranslatorInterface $routeTranslator, Arcanedev\Localization\Contracts\LocalesManagerInterface $localesManager ) Creates new instance.
createUrlFromUri ( string $uri ) : string Create an url from the uri.
getAllLocales ( ) : Arcanedev\Localization\Entities\LocaleCollection Get all locales.
getCurrentLocale ( ) : string Returns current language.
getCurrentLocaleDirection ( ) : string Returns current locale direction.
getCurrentLocaleEntity ( ) : Arcanedev\Localization\Entities\Locale Returns current language.
getCurrentLocaleName ( ) : string Returns current locale name.
getCurrentLocaleNative ( ) : string Returns current locale native name.
getCurrentLocaleRegional ( ) : string Returns current locale regional.
getCurrentLocaleScript ( ) : string Returns current locale script.
getDefaultLocale ( ) : string Returns default locale.
getLocalizedURL ( string | null $locale = null, string | null $url = null, array $attributes = [] ) : string | false Returns an URL adapted to $locale or current locale.
getNonLocalizedURL ( string | null $url = null ) : string It returns an URL without locale (if it has it).
getSupportedLocales ( ) : Arcanedev\Localization\Entities\LocaleCollection Return an array of all supported Locales.
getSupportedLocalesKeys ( ) : array Get supported locales keys.
getUrlFromRouteName ( string $locale, string $transKey, array $attributes = [] ) : string | false Returns an URL adapted to the route name and the locale given.
isDefaultLocaleHiddenInUrl ( ) : boolean Hide the default locale in URL ??
isLocaleSupported ( string | boolean $locale ) : boolean Check if Locale exists on the supported locales collection.
localesNavbar ( ) : string Get locales navigation bar.
localizeURL ( string | null $url = null, string | null $locale = null ) : string Returns an URL adapted to $locale or current locale.
setBaseUrl ( string $url ) : self Sets the base url for the site.
setLocale ( string | null $locale = null ) : string Set and return current locale.
setRouteNameFromRequest ( Illuminate\Http\Request $request ) Set route name from request.
setSupportedLocales ( array $supportedLocales ) : self Set the supported locales.
transRoute ( string $routeName ) : string Translate routes and save them to the translated routes array (used in the localize route filter).

Приватные методы

Метод Описание
findTranslatedRouteByUrl ( string $url, array $attributes, string $locale ) : string | false Returns the translated route for an url and the attributes given and a locale
isLocaleSupportedOrFail ( string $locale ) Check if the locale is supported or fail if not.
request ( ) : Illuminate\Http\Request Get Request instance.

Описание методов

__construct() публичный метод

Creates new instance.
public __construct ( Illuminate\Foundation\Application $app, Arcanedev\Localization\Contracts\RouteTranslatorInterface $routeTranslator, Arcanedev\Localization\Contracts\LocalesManagerInterface $localesManager )
$app Illuminate\Foundation\Application
$routeTranslator Arcanedev\Localization\Contracts\RouteTranslatorInterface
$localesManager Arcanedev\Localization\Contracts\LocalesManagerInterface

createUrlFromUri() публичный метод

Create an url from the uri.
public createUrlFromUri ( string $uri ) : string
$uri string
Результат string

getAllLocales() публичный метод

Get all locales.
public getAllLocales ( ) : Arcanedev\Localization\Entities\LocaleCollection
Результат Arcanedev\Localization\Entities\LocaleCollection

getCurrentLocale() публичный метод

Returns current language.
public getCurrentLocale ( ) : string
Результат string

getCurrentLocaleDirection() публичный метод

Returns current locale direction.
public getCurrentLocaleDirection ( ) : string
Результат string

getCurrentLocaleEntity() публичный метод

Returns current language.
public getCurrentLocaleEntity ( ) : Arcanedev\Localization\Entities\Locale
Результат Arcanedev\Localization\Entities\Locale

getCurrentLocaleName() публичный метод

Returns current locale name.
public getCurrentLocaleName ( ) : string
Результат string

getCurrentLocaleNative() публичный метод

Returns current locale native name.
public getCurrentLocaleNative ( ) : string
Результат string

getCurrentLocaleRegional() публичный метод

Returns current locale regional.
public getCurrentLocaleRegional ( ) : string
Результат string

getCurrentLocaleScript() публичный метод

Returns current locale script.
public getCurrentLocaleScript ( ) : string
Результат string

getDefaultLocale() публичный метод

Returns default locale.
public getDefaultLocale ( ) : string
Результат string

getLocalizedURL() публичный метод

Returns an URL adapted to $locale or current locale.
public getLocalizedURL ( string | null $locale = null, string | null $url = null, array $attributes = [] ) : string | false
$locale string | null
$url string | null
$attributes array
Результат string | false

getNonLocalizedURL() публичный метод

It returns an URL without locale (if it has it).
public getNonLocalizedURL ( string | null $url = null ) : string
$url string | null
Результат string

getSupportedLocales() публичный метод

Return an array of all supported Locales.
public getSupportedLocales ( ) : Arcanedev\Localization\Entities\LocaleCollection
Результат Arcanedev\Localization\Entities\LocaleCollection

getSupportedLocalesKeys() публичный метод

Get supported locales keys.
public getSupportedLocalesKeys ( ) : array
Результат array

getUrlFromRouteName() публичный метод

Returns an URL adapted to the route name and the locale given.
public getUrlFromRouteName ( string $locale, string $transKey, array $attributes = [] ) : string | false
$locale string
$transKey string
$attributes array
Результат string | false

isDefaultLocaleHiddenInUrl() публичный метод

Hide the default locale in URL ??
public isDefaultLocaleHiddenInUrl ( ) : boolean
Результат boolean

isLocaleSupported() публичный метод

Check if Locale exists on the supported locales collection.
public isLocaleSupported ( string | boolean $locale ) : boolean
$locale string | boolean
Результат boolean

localesNavbar() публичный метод

Get locales navigation bar.
public localesNavbar ( ) : string
Результат string

localizeURL() публичный метод

Returns an URL adapted to $locale or current locale.
public localizeURL ( string | null $url = null, string | null $locale = null ) : string
$url string | null
$locale string | null
Результат string

setBaseUrl() публичный метод

Sets the base url for the site.
public setBaseUrl ( string $url ) : self
$url string
Результат self

setLocale() публичный метод

Set and return current locale.
public setLocale ( string | null $locale = null ) : string
$locale string | null
Результат string

setRouteNameFromRequest() публичный метод

Set route name from request.
public setRouteNameFromRequest ( Illuminate\Http\Request $request )
$request Illuminate\Http\Request

setSupportedLocales() публичный метод

Set the supported locales.
public setSupportedLocales ( array $supportedLocales ) : self
$supportedLocales array
Результат self

transRoute() публичный метод

Translate routes and save them to the translated routes array (used in the localize route filter).
public transRoute ( string $routeName ) : string
$routeName string
Результат string

Описание свойств

$baseUrl защищенное свойство

Base url.
protected string $baseUrl
Результат string

$routeTranslator защищенное свойство

The RouteTranslator instance.
protected RouteTranslatorInterface,Arcanedev\Localization\Contracts $routeTranslator
Результат Arcanedev\Localization\Contracts\RouteTranslatorInterface