RegistrationFormFieldName
extends EntityBase
in package
RegistrationFormFieldName
Tags
Table of Contents
Properties
- $default : text
- $fieldId : int
- $formId : int
- $langId : int
- $localeCodes : array<string|int, mixed>
- List of locale codes ordered by translation fallback order per Cx instance
- $name : string
- $nestingCount : int
- Counts the nesting level of __call()
- $registrationFormField : RegistrationFormField
- $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.
- __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
- getComponentController() : SystemComponent
- Returns the component controller for this component
- getDefault() : text
- Get default
- getFieldId() : int
- Get fieldId
- getFormId() : int
- Get formId
- getKeyAsString() : string
- Returns this entity's key
- getLangId() : int
- Get langId
- getName() : string
- Get name
- getRegistrationFormField() : RegistrationFormField
- Get registrationFormField
- 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
- setDefault() : mixed
- Set default
- setFieldId() : mixed
- Set fieldId
- setFormId() : mixed
- Set formId
- setLangId() : mixed
- Set langId
- setName() : mixed
- Set name
- setRegistrationFormField() : mixed
- Set registrationFormField
- 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
$default
protected
text
$default
$fieldId
protected
int
$fieldId
$formId
protected
int
$formId
$langId
protected
int
$langId
$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
$name
protected
string
$name
$nestingCount
Counts the nesting level of __call()
protected
static int
$nestingCount
= 0
$registrationFormField
protected
RegistrationFormField
$registrationFormField
$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
Return values
mixed —Return value of the method to call
__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
__toString()
Returns this entity's identifying value
public
__toString() : string
By default this returns the same as getKeyAsString(), but this method might get overridden by subclasses.
Return values
string —Identifying value for this entity
getComponentController()
Returns the component controller for this component
public
getComponentController() : SystemComponent
Return values
SystemComponentgetDefault()
Get default
public
getDefault() : text
Return values
text —$default
getFieldId()
Get fieldId
public
getFieldId() : int
Return values
int —$fieldId
getFormId()
Get formId
public
getFormId() : int
Return values
int —$formId
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
getLangId()
Get langId
public
getLangId() : int
Return values
int —$langId
getName()
Get name
public
getName() : string
Return values
string —$name
getRegistrationFormField()
Get registrationFormField
public
getRegistrationFormField() : RegistrationFormField
Return values
RegistrationFormField —$registrationFormField
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
setDefault()
Set default
public
setDefault(text $default) : mixed
Parameters
- $default : text
setFieldId()
Set fieldId
public
setFieldId(int $fieldId) : mixed
Parameters
- $fieldId : int
setFormId()
Set formId
public
setFormId(int $formId) : mixed
Parameters
- $formId : int
setLangId()
Set langId
public
setLangId(int $langId) : mixed
Parameters
- $langId : int
setName()
Set name
public
setName(string $name) : mixed
Parameters
- $name : string
setRegistrationFormField()
Set registrationFormField
public
setRegistrationFormField(RegistrationFormField $registrationFormField) : mixed
Parameters
- $registrationFormField : RegistrationFormField
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