Locale
extends Locale
in package
implements
Proxy
DO NOT EDIT THIS FILE - IT WAS CREATED BY DOCTRINE'S PROXY GENERATOR
Table of Contents
Interfaces
- Proxy
Properties
- $__cloner__ : Closure
- $__initializer__ : Closure
- $__isInitialized__ : bool
- $lazyPropertiesDefaults : array<string|int, mixed>
- $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
- {@inheritDoc}
- __clone() : mixed
- __construct() : mixed
- Locale constructor.
- __get() : mixed
- {@inheritDoc}
- __getCloner() : mixed
- {@inheritDoc}
- __getInitializer() : mixed
- {@inheritDoc}
- __getLazyProperties() : mixed
- {@inheritDoc}
- __isInitialized() : mixed
- {@inheritDoc}
- __load() : mixed
- Forces initialization of the proxy
- __setCloner() : mixed
- {@inheritDoc}
- __setInitialized() : mixed
- {@inheritDoc}
- __setInitializer() : mixed
- {@inheritDoc}
- __sleep() : array<string|int, mixed>
- __toString() : string
- Returns this entity's identifying value
- __wakeup() : mixed
- addFrontend() : Locale
- Add frontends
- addFrontends() : mixed
- Add frontends
- addLocale() : Locale
- Add locales
- addLocales() : mixed
- Add locales
- getComponentController() : mixed
- {@inheritDoc}
- 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
- {@inheritDoc}
- initializeValidators() : mixed
- {@inheritDoc}
- isVirtual() : mixed
- {@inheritDoc}
- 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
- {@inheritDoc}
- validate() : mixed
- {@inheritDoc}
- 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
$__cloner__
public
Closure
$__cloner__
the callback responsible of loading properties that need to be copied in the cloned object
Tags
$__initializer__
public
Closure
$__initializer__
the callback responsible for loading properties in the proxy object. This callback is called with three parameters, being respectively the proxy object to be initialized, the method that triggered the initialization process and an array of ordered parameters that were passed to that method.
Tags
$__isInitialized__
public
bool
$__isInitialized__
= false
flag indicating if this object was already initialized
Tags
$lazyPropertiesDefaults
public
static array<string|int, mixed>
$lazyPropertiesDefaults
= array()
properties to be lazy loaded, with keys being the property names and values being their default values
Tags
$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()
{@inheritDoc}
public
__call(mixed $methodName, mixed $arguments) : mixed
Parameters
- $methodName : mixed
- $arguments : mixed
__clone()
public
__clone() : mixed
__construct()
Locale constructor.
public
__construct([Closure $initializer = null ][, Closure $cloner = null ]) : mixed
Parameters
- $initializer : Closure = null
- $cloner : Closure = null
__get()
{@inheritDoc}
public
__get(string $name) : mixed
Parameters
- $name : string
__getCloner()
{@inheritDoc}
public
__getCloner() : mixed
Tags
__getInitializer()
{@inheritDoc}
public
__getInitializer() : mixed
Tags
__getLazyProperties()
{@inheritDoc}
public
__getLazyProperties() : mixed
Tags
__isInitialized()
{@inheritDoc}
public
__isInitialized() : mixed
Tags
__load()
Forces initialization of the proxy
public
__load() : mixed
__setCloner()
{@inheritDoc}
public
__setCloner([Closure $cloner = null ]) : mixed
Parameters
- $cloner : Closure = null
Tags
__setInitialized()
{@inheritDoc}
public
__setInitialized(mixed $initialized) : mixed
Parameters
- $initialized : mixed
Tags
__setInitializer()
{@inheritDoc}
public
__setInitializer([Closure $initializer = null ]) : mixed
Parameters
- $initializer : Closure = null
Tags
__sleep()
public
__sleep() : array<string|int, mixed>
Return values
array<string|int, mixed>__toString()
Returns this entity's identifying value
public
__toString() : string
Return values
string —The locale's label
__wakeup()
public
__wakeup() : mixed
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()
{@inheritDoc}
public
getComponentController() : mixed
getCountry()
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()
{@inheritDoc}
public
getTranslatedFieldValue(mixed $fieldName) : mixed
Parameters
- $fieldName : mixed
initializeValidators()
{@inheritDoc}
public
initializeValidators() : mixed
isVirtual()
{@inheritDoc}
public
isVirtual() : mixed
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(mixed $label) : mixed
Parameters
- $label : mixed
setOrderNo()
Set order no
public
setOrderNo(mixed $orderNo) : mixed
Parameters
- $orderNo : mixed
setSourceLanguage()
Set sourceLanguage
public
setSourceLanguage(Language $sourceLanguage) : mixed
Parameters
- $sourceLanguage : Language
setVirtual()
{@inheritDoc}
public
setVirtual(mixed $virtual) : mixed
Parameters
- $virtual : mixed
validate()
{@inheritDoc}
public
validate() : mixed
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