Locale
extends EntityBase
in package
Locale
Tags
Table of Contents
Properties
- $country : Country
- $fallback : Locale
- $frontends : Collection
- $id : int
- $iso1 : Language
- $label : string
- $localeCodes : array<string|int, mixed>
- List of locale codes ordered by translation fallback order per Cx instance
- $locales : Collection
- $nestingCount : int
- Counts the nesting level of __call()
- $orderNo : int
- $sourceLanguage : Language
- $stringRepresentationBlank : bool
- Whether blank string representations are valid
- $stringRepresentationFields : array<string|int, mixed>
- List of fields that should be available in the string representation
- $stringRepresentationFormat : string
- Sprintf format for the string representation
- $validators : array<string|int, mixed>
- Initialize this array as follows: array( 'columName' => Zend_Validate )
- $virtual : bool
- Defines if an entity is virtual and therefore not persistable.
Methods
- __call() : mixed
- Route methods like getName(), getType(), getDirectory(), etc.
- __construct() : mixed
- Locale constructor.
- __get() : mixed
- This is an ugly solution to allow $this->cx to be available in all entity classes Since the entity's constructor is not called when an entity is loaded from DB this cannot be assigned there.
- __toString() : string
- Returns this entity's identifying value
- addFrontend() : Locale
- Add frontends
- addFrontends() : mixed
- Add frontends
- addLocale() : Locale
- Add locales
- addLocales() : mixed
- Add locales
- getComponentController() : SystemComponent
- Returns the component controller for this component
- getCountry() : Country
- Get country
- getFallback() : Locale
- Get fallback
- getFrontends() : Collection
- Get frontends
- getId() : int
- Get id
- getIso1() : Language
- Get iso1
- getKeyAsString() : string
- Returns this entity's key
- getLabel() : string
- Get label
- getLocales() : Collection
- Get locales
- getOrderNo() : int
- Get order no
- getShortForm() : string
- Builds short form of locale containing iso1 and alpha2 code (if exists)
- getSourceLanguage() : Language
- Get sourceLanguage
- getTranslatedFieldValue() : mixed
- Returns the value of a translatable field using fallback mechanisms
- initializeValidators() : mixed
- Set $this->validators
- isVirtual() : bool
- Returns the virtuality of the entity
- removeFrontend() : mixed
- Remove frontends
- removeLocale() : mixed
- Remove locales
- setCountry() : mixed
- Set country
- setFallback() : mixed
- Set fallback
- setIso1() : mixed
- Set iso1
- setLabel() : mixed
- Set label
- setOrderNo() : mixed
- Set order no
- setSourceLanguage() : mixed
- Set sourceLanguage
- setVirtual() : mixed
- Set the virtuality of the entity
- validate() : mixed
- getFallbackLocaleCodes() : array<string|int, mixed>
- Returns a list of all locale codes ordered by fallback order
- getStringRepresentationBlank() : bool
- Whether blank string representations are valid
- getStringRepresentationFields() : array<string|int, mixed>
- Returns a list of fields available in the string representation
- getStringRepresentationFormat() : string
- Returns the sprintf() format for the string representation
Properties
$country
protected
Country
$country
$fallback
protected
Locale
$fallback
$frontends
protected
Collection
$frontends
$id
protected
int
$id
$iso1
protected
Language
$iso1
$label
protected
string
$label
$localeCodes
List of locale codes ordered by translation fallback order per Cx instance
protected
static array<string|int, mixed>
$localeCodes
= array()
Array in the form: array(<instanceId> => array(<localeCode>, ...))
Tags
$locales
protected
Collection
$locales
$nestingCount
Counts the nesting level of __call()
protected
static int
$nestingCount
= 0
$orderNo
protected
int
$orderNo
$sourceLanguage
protected
Language
$sourceLanguage
$stringRepresentationBlank
Whether blank string representations are valid
protected
bool
$stringRepresentationBlank
= false
Whether blank string representations are valid
Tags
$stringRepresentationFields
List of fields that should be available in the string representation
protected
array<string|int, mixed>
$stringRepresentationFields
= array()
List of field names
Tags
$stringRepresentationFormat
Sprintf format for the string representation
protected
string
$stringRepresentationFormat
= ''
Sprintf format string
Tags
$validators
Initialize this array as follows: array( 'columName' => Zend_Validate )
protected
array<string|int, mixed>
$validators
= array()
$virtual
Defines if an entity is virtual and therefore not persistable.
protected
bool
$virtual
= false
Defaults to FALSE - not virtual.
Methods
__call()
Route methods like getName(), getType(), getDirectory(), etc.
public
__call(string $methodName, array<string|int, mixed> $arguments) : mixed
Parameters
- $methodName : string
-
Name of method to call
- $arguments : array<string|int, mixed>
-
List of arguments for the method to call
Tags
Attributes
- #[ReturnTypeWillChange]
Return values
mixed —Return value of the method to call
__construct()
Locale constructor.
public
__construct() : mixed
Creates new instance of \Cx\Core\Locale\Model\Entity\Locale
__get()
This is an ugly solution to allow $this->cx to be available in all entity classes Since the entity's constructor is not called when an entity is loaded from DB this cannot be assigned there.
public
__get(mixed $name) : mixed
Parameters
- $name : mixed
Attributes
- #[ReturnTypeWillChange]
__toString()
Returns this entity's identifying value
public
__toString() : string
Return values
string —The locale's label
addFrontend()
Add frontends
public
addFrontend(Frontend $frontends) : Locale
Parameters
- $frontends : Frontend
Return values
LocaleaddFrontends()
Add frontends
public
addFrontends(Frontend $frontends) : mixed
Parameters
- $frontends : Frontend
addLocale()
Add locales
public
addLocale(Locale $locales) : Locale
Parameters
- $locales : Locale
Return values
LocaleaddLocales()
Add locales
public
addLocales(Locale $locales) : mixed
Parameters
- $locales : Locale
getComponentController()
Returns the component controller for this component
public
getComponentController() : SystemComponent
Return values
SystemComponentgetCountry()
Get country
public
getCountry() : Country
Return values
Country —$country
getFallback()
Get fallback
public
getFallback() : Locale
Return values
Locale —$fallback
getFrontends()
Get frontends
public
getFrontends() : Collection
Return values
Collection —$frontends
getId()
Get id
public
getId() : int
Return values
int —$id
getIso1()
Get iso1
public
getIso1() : Language
Return values
Language —$iso1
getKeyAsString()
Returns this entity's key
public
final getKeyAsString([string $separator = '/' ]) : string
If this entity has a composite key, the fields are separated by $separator.
Parameters
- $separator : string = '/'
-
(optional) Separator for composite key fields, default "/"
Return values
string —Entity key as string
getLabel()
Get label
public
getLabel() : string
Return values
string —$label
getLocales()
Get locales
public
getLocales() : Collection
Return values
Collection —$locales
getOrderNo()
Get order no
public
getOrderNo() : int
Return values
int —$orderNo
getShortForm()
Builds short form of locale containing iso1 and alpha2 code (if exists)
public
getShortForm() : string
Return values
string —the short form (example: de-CH for swiss german)
getSourceLanguage()
Get sourceLanguage
public
getSourceLanguage() : Language
Return values
Language —$sourceLanguage
getTranslatedFieldValue()
Returns the value of a translatable field using fallback mechanisms
public
getTranslatedFieldValue(string $fieldName) : mixed
If the field is not translatable its value is returned anyway. Tries to return the value in the following locales (if non-empty):
- Current locale
- Default locale
- All other locales
Parameters
- $fieldName : string
-
Name of a translatable field
initializeValidators()
Set $this->validators
public
initializeValidators() : mixed
Validators can be found in lib/FRAMEWORK/Validator.class.php These will be executed if validate() is called
isVirtual()
Returns the virtuality of the entity
public
isVirtual() : bool
Return values
bool —TRUE if the entity is virtual, otherwise FALSE
removeFrontend()
Remove frontends
public
removeFrontend(Frontend $frontends) : mixed
Parameters
- $frontends : Frontend
removeLocale()
Remove locales
public
removeLocale(Locale $locales) : mixed
Parameters
- $locales : Locale
setCountry()
Set country
public
setCountry([Country $country = null ]) : mixed
Parameters
- $country : Country = null
setFallback()
Set fallback
public
setFallback([Locale $fallback = null ]) : mixed
Parameters
- $fallback : Locale = null
setIso1()
Set iso1
public
setIso1(Language $iso1) : mixed
Parameters
- $iso1 : Language
setLabel()
Set label
public
setLabel(string $label) : mixed
Parameters
- $label : string
setOrderNo()
Set order no
public
setOrderNo(int $orderNo) : mixed
Parameters
- $orderNo : int
setSourceLanguage()
Set sourceLanguage
public
setSourceLanguage(Language $sourceLanguage) : mixed
Parameters
- $sourceLanguage : Language
setVirtual()
Set the virtuality of the entity
public
setVirtual(bool $virtual) : mixed
Parameters
- $virtual : bool
-
TRUE to set the entity as virtual or otherwise to FALSE
validate()
public
validate() : mixed
Tags
getFallbackLocaleCodes()
Returns a list of all locale codes ordered by fallback order
protected
getFallbackLocaleCodes() : array<string|int, mixed>
- First entry is the current locale
- Second entry is the default locale (if different from current, it's omitted otherwise)
- Then all other locales follow (in no particular order)
Tags
Return values
array<string|int, mixed> —List of locale codes
getStringRepresentationBlank()
Whether blank string representations are valid
protected
getStringRepresentationBlank() : bool
Return values
bool —Whether blank string representations are valid
getStringRepresentationFields()
Returns a list of fields available in the string representation
protected
getStringRepresentationFields() : array<string|int, mixed>
Return values
array<string|int, mixed> —List of field names
getStringRepresentationFormat()
Returns the sprintf() format for the string representation
protected
getStringRepresentationFormat() : string
Return values
string —sprintf() format string