PHP Interface Arcanedev\Localization\Contracts\RouteTranslatorInterface

Author: ARCANEDEV ([email protected])
Afficher le fichier Open project: arcanedev/localization Interface Usage Examples

Méthodes publiques

Méthode Description
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).

Method Details

findTranslatedRouteByPath() public méthode

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
Résultat string | false

getCurrentRoute() public méthode

Get current route.
public getCurrentRoute ( ) : string
Résultat string

getRouteNameFromPath() public méthode

Returns the translation key for a given path.
public getRouteNameFromPath ( string $uri, string $locale ) : false | string
$uri string
$locale string
Résultat false | string

getTranslatedRoute() public méthode

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
Résultat string | false

getTranslatedRoutes() public méthode

Get translated routes.
public getTranslatedRoutes ( ) : array
Résultat array

getUrlFromRouteName() public méthode

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
Résultat string

hasCurrentRoute() public méthode

Check if has current route.
public hasCurrentRoute ( ) : boolean
Résultat boolean

hasTranslation() public méthode

Determine if a translation exists.
public hasTranslation ( string $key, string $locale = null ) : boolean
$key string
$locale string
Résultat boolean

setCurrentRoute() public méthode

Set the current route.
public setCurrentRoute ( false | string $currentRoute ) : self
$currentRoute false | string
Résultat self

trans() public méthode

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
Résultat string