Documentation

Language extends EntityBase
in package

Language

Tags
copyright

Cloudrexx AG

author

Nicola Tommasi nicola.tommasi@comvation.com

subpackage

core_locale

version
5.0.0

Table of Contents

Properties

$backend  : Backend
$iso1  : string
$iso3  : string
$localeCodes  : array<string|int, mixed>
List of locale codes ordered by translation fallback order per Cx instance
$localeRelatedByIso1s  : Collection
$localeRelatedBySourceLanguages  : Collection
$nestingCount  : int
Counts the nesting level of __call()
$source  : bool
$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
Language 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 the language and the iso1 code using the php \Locale class
addLocaleRelatedByIso1()  : Language
Add localeRelatedByIso1s
addLocaleRelatedByIso1s()  : mixed
Add localeRelatedByIso1s
addLocaleRelatedBySourceLanguage()  : Language
Add localeRelatedBySourceLanguages
addLocaleRelatedBySourceLanguages()  : mixed
Add localeRelatedBySourceLanguages
getBackend()  : Backend
Get backend
getComponentController()  : SystemComponent
Returns the component controller for this component
getId()  : string
Get iso1 This method fixes the error when getting the identifier in the metadata class info, which automatically calls getId() on an entity to get the identifier
getIso1()  : string
Get iso1
getIso3()  : string
Get iso3
getKeyAsString()  : string
Returns this entity's key
getLocaleRelatedByIso1s()  : Collection
Get localeRelatedByIso1s
getLocaleRelatedBySourceLanguages()  : Collection
Get localeRelatedBySourceLanguages
getSource()  : bool
Get source
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
removeLocaleRelatedByIso1()  : mixed
Remove localeRelatedByIso1s
removeLocaleRelatedBySourceLanguage()  : mixed
Remove localeRelatedBySourceLanguages
setBackend()  : mixed
Set backend
setId()  : mixed
Set iso1
setIso1()  : mixed
Set iso1
setIso3()  : mixed
Set iso3
setSource()  : mixed
Set source
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

$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
see
getFallbackLocaleCodes()

$localeRelatedByIso1s

protected Collection $localeRelatedByIso1s

$localeRelatedBySourceLanguages

protected Collection $localeRelatedBySourceLanguages

$nestingCount

Counts the nesting level of __call()

protected static int $nestingCount = 0

$stringRepresentationBlank

Whether blank string representations are valid

protected bool $stringRepresentationBlank = false

Whether blank string representations are valid

Tags
see
getStringRepresentationBlank()

$stringRepresentationFields

List of fields that should be available in the string representation

protected array<string|int, mixed> $stringRepresentationFields = array()

List of field names

Tags
see
getStringRepresentationFields()

$stringRepresentationFormat

Sprintf format for the string representation

protected string $stringRepresentationFormat = ''

Sprintf format string

Tags
see
getStringRepresentationFormat()

$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
throws
Exception

If __call() nesting level reaches 20

Attributes
#[ReturnTypeWillChange]
Return values
mixed —

Return value of the method to call

__construct()

Language constructor.

public __construct() : mixed

Creates new instance of \Cx\Core\Locale\Model\Entity\Language

__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 the language and the iso1 code using the php \Locale class

public __toString() : string

The language is translated in the front/backend language

Return values
string —

for example "German (de)"

addLocaleRelatedByIso1s()

Add localeRelatedByIso1s

public addLocaleRelatedByIso1s(Locale $localeRelatedByIso1s) : mixed
Parameters
$localeRelatedByIso1s : Locale

addLocaleRelatedBySourceLanguage()

Add localeRelatedBySourceLanguages

public addLocaleRelatedBySourceLanguage(Locale $localeRelatedBySourceLanguages) : Language
Parameters
$localeRelatedBySourceLanguages : Locale
Return values
Language

addLocaleRelatedBySourceLanguages()

Add localeRelatedBySourceLanguages

public addLocaleRelatedBySourceLanguages(Locale $localeRelatedBySourceLanguages) : mixed
Parameters
$localeRelatedBySourceLanguages : Locale

getId()

Get iso1 This method fixes the error when getting the identifier in the metadata class info, which automatically calls getId() on an entity to get the identifier

public getId() : string
Tags
todo:

Remove this method after doctrine update

Return values
string —

$iso1

getIso1()

Get iso1

public getIso1() : string
Return values
string —

$iso1

getIso3()

Get iso3

public getIso3() : string
Return values
string —

$iso3

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

getLocaleRelatedByIso1s()

Get localeRelatedByIso1s

public getLocaleRelatedByIso1s() : Collection
Return values
Collection —

$localeRelatedByIso1s

getLocaleRelatedBySourceLanguages()

Get localeRelatedBySourceLanguages

public getLocaleRelatedBySourceLanguages() : Collection
Return values
Collection —

$localeRelatedBySourceLanguages

getSource()

Get source

public getSource() : bool
Return values
bool —

$source

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

removeLocaleRelatedByIso1()

Remove localeRelatedByIso1s

public removeLocaleRelatedByIso1(Locale $localeRelatedByIso1s) : mixed
Parameters
$localeRelatedByIso1s : Locale

removeLocaleRelatedBySourceLanguage()

Remove localeRelatedBySourceLanguages

public removeLocaleRelatedBySourceLanguage(Locale $localeRelatedBySourceLanguages) : mixed
Parameters
$localeRelatedBySourceLanguages : Locale

setId()

Set iso1

public setId(string $iso1) : mixed
Parameters
$iso1 : string
Tags
todo:

Remove this method after doctrine update

setIso1()

Set iso1

public setIso1(string $iso1) : mixed
Parameters
$iso1 : string

setIso3()

Set iso3

public setIso3([string $iso3 = null ]) : mixed
Parameters
$iso3 : string = null

setSource()

Set source

public setSource(bool $source) : mixed
Parameters
$source : bool

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

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
todo

Order the array by the fallback order (same as in ContentManager)

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


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results