Multilanguage
Multilanguage trait
Table of Contents
Properties
- $messages : array<string|int, mixed>
- Response messages
- $messagesComponentName : string
- Messages component name
- $messagesLoaded : bool
- Messages loaded
Methods
- getDefaultLanguage() : string
- Get default language
- getMessage() : string|null
- Get message
- getPageLanguage() : string
- Get page language
- isLanguageChange() : bool
- Return true if page load is with new language code
- loadMessages() : void
- Load messages from html component json file
- message() : ApiController
- Add message to response, first find in messages array if not found display name value as message
- loadMesasgesComponent() : void
- Load messages component
Properties
$messages
Response messages
protected
array<string|int, mixed>
$messages
= []
$messagesComponentName
Messages component name
protected
string
$messagesComponentName
= ''
$messagesLoaded
Messages loaded
protected
bool
$messagesLoaded
= false
Methods
getDefaultLanguage()
Get default language
public
getDefaultLanguage() : string
Return values
stringgetMessage()
Get message
public
getMessage(string $name) : string|null
Parameters
- $name : string
Return values
string|nullgetPageLanguage()
Get page language
public
getPageLanguage([array<string|int, mixed> $data = [] ][, bool $skipSession = false ]) : string
Parameters
- $data : array<string|int, mixed> = []
- $skipSession : bool = false
Return values
stringisLanguageChange()
Return true if page load is with new language code
public
isLanguageChange(array<string|int, mixed> $data) : bool
Parameters
- $data : array<string|int, mixed>
Return values
boolloadMessages()
Load messages from html component json file
public
loadMessages(string $componentName) : void
Parameters
- $componentName : string
message()
Add message to response, first find in messages array if not found display name value as message
public
message(string $name[, string|null $default = null ]) : ApiController
Parameters
- $name : string
- $default : string|null = null
Return values
ApiControllerloadMesasgesComponent()
Load messages component
protected
loadMesasgesComponent([string|null $language = null ]) : void
Parameters
- $language : string|null = null