Versions
extends AbstractBase
in package
implements
TranslatorAwareInterface
Uses
TranslatorAwareTrait
Versions tab
Tags
Interfaces, Classes, Traits and Enums
- TranslatorAwareInterface
- Lightweight translator aware marker interface (used as an alternative to \Laminas\I18n\Translator\TranslatorAwareInterface, which requires an excessive number of methods to be implemented).
Table of Contents
- $accessPermission : string
- Permission that must be granted to access this module (null for no restriction)
- $config : Config
- Main configuration
- $driver : AbstractBase|null
- Record driver associated with the tab
- $request : Request|bool
- User request associated with the tab (false for none)
- $searchOptionsManager : PluginManager
- Search options plugin manager
- $translator : TranslatorInterface
- Translator
- __construct() : mixed
- Constructor
- getDescription() : string
- Get the on-screen description for this tab.
- getTranslator() : TranslatorInterface
- Get translator object.
- getTranslatorLocale() : string
- Get the locale from the translator.
- isActive() : bool
- Is this tab active?
- isVisible() : bool
- Is this tab initially visible?
- setRecordDriver() : AbstractBase
- Set the record driver
- setRequest() : AbstractBase
- Set the user request
- setTranslator() : TranslatorAwareInterface
- Set a translator
- supportsAjax() : bool
- Can this tab be loaded via AJAX?
- translate() : string
- Translate a string (or string-castable object)
- translateWithPrefix() : string
- Translate a string (or string-castable object) using a prefix, or without the prefix if a prefixed translation is not found.
- extractTextDomain() : array<string|int, mixed>
- Given a translation string with or without a text domain, return an array with the raw string and the text domain separated.
- getDebugTranslation() : string
- Build a debug-mode translation
- getRecordDriver() : AbstractBase
- Get the record driver
- getRequest() : Request|bool
- Get the user request (or false if unavailable)
- sanitizeTranslationKey() : string
- Make sure there are not any illegal characters in the translation key that might prevent successful lookup in language files.
- translateString() : string
- Get translation for a string
Properties
$accessPermission
Permission that must be granted to access this module (null for no restriction)
protected
string
$accessPermission
= null
$config
Main configuration
protected
Config
$config
$driver
Record driver associated with the tab
protected
AbstractBase|null
$driver
= null
$request
User request associated with the tab (false for none)
protected
Request|bool
$request
= false
$searchOptionsManager
Search options plugin manager
protected
PluginManager
$searchOptionsManager
$translator
Translator
protected
TranslatorInterface
$translator
= null
Methods
__construct()
Constructor
public
__construct(Config $config, PluginManager $som) : mixed
Parameters
- $config : Config
-
Configuration
- $som : PluginManager
-
Search options plugin manager
Return values
mixed —getDescription()
Get the on-screen description for this tab.
public
getDescription() : string
Return values
string —getTranslator()
Get translator object.
public
getTranslator() : TranslatorInterface
Return values
TranslatorInterface —getTranslatorLocale()
Get the locale from the translator.
public
getTranslatorLocale([string $default = 'en' ]) : string
Parameters
- $default : string = 'en'
-
Default to use if translator absent.
Return values
string —isActive()
Is this tab active?
public
isActive() : bool
Return values
bool —isVisible()
Is this tab initially visible?
public
isVisible() : bool
Return values
bool —setRecordDriver()
Set the record driver
public
setRecordDriver(AbstractBase $driver) : AbstractBase
Parameters
- $driver : AbstractBase
-
Record driver
Return values
AbstractBase —setRequest()
Set the user request
public
setRequest(Request $request) : AbstractBase
Parameters
- $request : Request
-
Request
Return values
AbstractBase —setTranslator()
Set a translator
public
setTranslator(TranslatorInterface $translator) : TranslatorAwareInterface
Parameters
- $translator : TranslatorInterface
-
Translator
Return values
TranslatorAwareInterface —supportsAjax()
Can this tab be loaded via AJAX?
public
supportsAjax() : bool
Return values
bool —translate()
Translate a string (or string-castable object)
public
translate(string|object|array<string|int, mixed> $target[, array<string|int, mixed> $tokens = [] ][, string $default = null ][, bool $useIcuFormatter = false ][, array<string|int, string> $fallbackDomains = [] ]) : string
Parameters
- $target : string|object|array<string|int, mixed>
-
String to translate or an array of text domain and string to translate
- $tokens : array<string|int, mixed> = []
-
Tokens to inject into the translated string
- $default : string = null
-
Default value to use if no translation is found (null for no default).
- $useIcuFormatter : bool = false
-
Should we use an ICU message formatter instead of the default behavior?
- $fallbackDomains : array<string|int, string> = []
-
Text domains to check if no match is found in the domain specified in $target
Return values
string —translateWithPrefix()
Translate a string (or string-castable object) using a prefix, or without the prefix if a prefixed translation is not found.
public
translateWithPrefix(string $prefix, string|object|array<string|int, mixed> $target[, array<string|int, mixed> $tokens = [] ][, string $default = null ][, bool $useIcuFormatter = false ][, array<string|int, string> $fallbackDomains = [] ]) : string
Parameters
- $prefix : string
-
Translation key prefix
- $target : string|object|array<string|int, mixed>
-
String to translate or an array of text domain and string to translate
- $tokens : array<string|int, mixed> = []
-
Tokens to inject into the translated string
- $default : string = null
-
Default value to use if no translation is found (null for no default).
- $useIcuFormatter : bool = false
-
Should we use an ICU message formatter instead of the default behavior?
- $fallbackDomains : array<string|int, string> = []
-
Text domains to check if no match is found in the domain specified in $target
Return values
string —extractTextDomain()
Given a translation string with or without a text domain, return an array with the raw string and the text domain separated.
protected
extractTextDomain(string|object|array<string|int, mixed> $target) : array<string|int, mixed>
Parameters
- $target : string|object|array<string|int, mixed>
-
String to translate or an array of text domain and string to translate
Return values
array<string|int, mixed> —getDebugTranslation()
Build a debug-mode translation
protected
getDebugTranslation(string $domain, string $str, array<string|int, mixed> $tokens) : string
Parameters
- $domain : string
-
Text domain
- $str : string
-
String to translate
- $tokens : array<string|int, mixed>
-
Tokens to inject into the translated string
Return values
string —getRecordDriver()
Get the record driver
protected
getRecordDriver() : AbstractBase
Tags
Return values
AbstractBase —getRequest()
Get the user request (or false if unavailable)
protected
getRequest() : Request|bool
Return values
Request|bool —sanitizeTranslationKey()
Make sure there are not any illegal characters in the translation key that might prevent successful lookup in language files.
protected
sanitizeTranslationKey(string $key) : string
Parameters
- $key : string
-
Key to sanitize
Return values
string —Sanitized key
translateString()
Get translation for a string
protected
translateString(string $rawStr[, array<string|int, mixed> $tokens = [] ][, string $default = null ][, string $domain = 'default' ][, bool $useIcuFormatter = false ]) : string
Parameters
- $rawStr : string
-
String to translate
- $tokens : array<string|int, mixed> = []
-
Tokens to inject into the translated string
- $default : string = null
-
Default value to use if no translation is found (null for no default).
- $domain : string = 'default'
-
Text domain (omit for default)
- $useIcuFormatter : bool = false
-
Should we use an ICU message formatter instead of the default behavior?