PHP Интерфейс Arcanedev\Localization\Contracts\RouteTranslatorInterface

Автор: ARCANEDEV ([email protected])
Показать файл Открыть проект Примеры использования интерфейса

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

Метод Описание
findTranslatedRouteByPath ( string $path, string $locale ) : string | false Returns the translated route for the path and the url given.
getCurrentRoute ( ) : string Get current route.
getRouteNameFromPath ( string $uri, string $locale ) : false | string Returns the translation key for a given path.
getTranslatedRoute ( string $baseUrl, array | false &$parsedUrl, string $defaultLocale, Arcanedev\Localization\Entities\LocaleCollection $supportedLocales ) : string | false Get the translated route.
getTranslatedRoutes ( ) : array Get translated routes.
getUrlFromRouteName ( string $locale, string $defaultLocale, string $transKey, array $attributes = [], boolean | false $defaultHidden = false ) : string Get URL from route name.
hasCurrentRoute ( ) : boolean Check if has current route.
hasTranslation ( string $key, string $locale = null ) : boolean Determine if a translation exists.
setCurrentRoute ( false | string $currentRoute ) : self Set the current route.
trans ( string $route, string | null $locale = null ) : string Translate routes and save them to the translated routes array (used in the localize route filter).

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

findTranslatedRouteByPath() публичный Метод

Returns the translated route for the path and the url given.
public findTranslatedRouteByPath ( string $path, string $locale ) : string | false
$path string - Path to check if it is a translated route
$locale string - Language to check if the path exists
Результат string | false

getCurrentRoute() публичный Метод

Get current route.
public getCurrentRoute ( ) : string
Результат string

getRouteNameFromPath() публичный Метод

Returns the translation key for a given path.
public getRouteNameFromPath ( string $uri, string $locale ) : false | string
$uri string
$locale string
Результат false | string

getTranslatedRoute() публичный Метод

Get the translated route.
public getTranslatedRoute ( string $baseUrl, array | false &$parsedUrl, string $defaultLocale, Arcanedev\Localization\Entities\LocaleCollection $supportedLocales ) : string | false
$baseUrl string
$parsedUrl array | false
$defaultLocale string
$supportedLocales Arcanedev\Localization\Entities\LocaleCollection
Результат string | false

getTranslatedRoutes() публичный Метод

Get translated routes.
public getTranslatedRoutes ( ) : array
Результат array

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

Get URL from route name.
public getUrlFromRouteName ( string $locale, string $defaultLocale, string $transKey, array $attributes = [], boolean | false $defaultHidden = false ) : string
$locale string
$defaultLocale string
$transKey string
$attributes array
$defaultHidden boolean | false
Результат string

hasCurrentRoute() публичный Метод

Check if has current route.
public hasCurrentRoute ( ) : boolean
Результат boolean

hasTranslation() публичный Метод

Determine if a translation exists.
public hasTranslation ( string $key, string $locale = null ) : boolean
$key string
$locale string
Результат boolean

setCurrentRoute() публичный Метод

Set the current route.
public setCurrentRoute ( false | string $currentRoute ) : self
$currentRoute false | string
Результат self

trans() публичный Метод

Translate routes and save them to the translated routes array (used in the localize route filter).
public trans ( string $route, string | null $locale = null ) : string
$route string
$locale string | null
Результат string