RegistrationFormField
extends EntityBase
in package
RegistrationFormField
Tags
Table of Contents
Properties
- $affiliation : string
- $id : int
- $localeCodes : array<string|int, mixed>
- List of locale codes ordered by translation fallback order per Cx instance
- $nestingCount : int
- Counts the nesting level of __call()
- $order : int
- $registrationForm : RegistrationForm
- $registrationFormFieldNames : Collection
- $registrationFormFieldValues : Collection
- $required : int
- $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
- $type : string
- $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
- __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
- addRegistrationFormFieldName() : mixed
- Add registrationFormFieldName
- addRegistrationFormFieldValue() : mixed
- Add registrationFormFieldValue
- getAffiliation() : string
- Get affiliation
- getComponentController() : SystemComponent
- Returns the component controller for this component
- getId() : int
- Get id
- getKeyAsString() : string
- Returns this entity's key
- getOrder() : int
- Get order
- getRegistrationForm() : RegistrationForm
- Get registrationForm
- getRegistrationFormFieldNames() : Collection
- Get registrationFormFieldNames
- getRegistrationFormFieldNamesByLangId() : null|RegistrationFormFieldName
- Get registrationFormFieldNames by langId
- getRegistrationFormFieldValues() : Collection
- Get registrationFormFieldValues
- getRequired() : int
- Get required
- getTranslatedFieldValue() : mixed
- Returns the value of a translatable field using fallback mechanisms
- getType() : string
- Get type
- initializeValidators() : mixed
- Set $this->validators
- isVirtual() : bool
- Returns the virtuality of the entity
- removeRegistrationFormFieldName() : mixed
- Remove registrationFormFieldNames
- removeRegistrationFormFieldValue() : mixed
- Remove registrationFormFieldValues
- setAffiliation() : mixed
- Set affiliation
- setOrder() : mixed
- Set order
- setRegistrationForm() : mixed
- Set registrationForm
- setRegistrationFormFieldNames() : mixed
- Set registrationFormFieldNames
- setRegistrationFormFieldValues() : mixed
- Set registrationFormFieldValues
- setRequired() : mixed
- Set required
- setType() : mixed
- Set type
- 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
$affiliation
protected
string
$affiliation
$id
protected
int
$id
$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
$nestingCount
Counts the nesting level of __call()
protected
static int
$nestingCount
= 0
$order
protected
int
$order
$registrationForm
protected
RegistrationForm
$registrationForm
$registrationFormFieldNames
protected
Collection
$registrationFormFieldNames
$registrationFormFieldValues
protected
Collection
$registrationFormFieldValues
$required
protected
int
$required
$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
$type
protected
string
$type
$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
__construct()
public
__construct() : mixed
__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
addRegistrationFormFieldName()
Add registrationFormFieldName
public
addRegistrationFormFieldName(RegistrationFormFieldName $registrationFormFieldName) : mixed
Parameters
- $registrationFormFieldName : RegistrationFormFieldName
addRegistrationFormFieldValue()
Add registrationFormFieldValue
public
addRegistrationFormFieldValue(RegistrationFormFieldValue $registrationFormFieldValue) : mixed
Parameters
- $registrationFormFieldValue : RegistrationFormFieldValue
getAffiliation()
Get affiliation
public
getAffiliation() : string
Return values
string —$affiliation
getComponentController()
Returns the component controller for this component
public
getComponentController() : SystemComponent
Return values
SystemComponentgetId()
Get id
public
getId() : int
Return values
int —$id
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
getOrder()
Get order
public
getOrder() : int
Return values
int —$order
getRegistrationForm()
Get registrationForm
public
getRegistrationForm() : RegistrationForm
Return values
RegistrationForm —$registrationForm
getRegistrationFormFieldNames()
Get registrationFormFieldNames
public
getRegistrationFormFieldNames() : Collection
Return values
Collection —$registrationFormFieldNames
getRegistrationFormFieldNamesByLangId()
Get registrationFormFieldNames by langId
public
getRegistrationFormFieldNamesByLangId(int $langId) : null|RegistrationFormFieldName
Parameters
- $langId : int
-
lang id
Return values
null|RegistrationFormFieldNamegetRegistrationFormFieldValues()
Get registrationFormFieldValues
public
getRegistrationFormFieldValues() : Collection
Return values
Collection —$registrationFormFieldValues
getRequired()
Get required
public
getRequired() : int
Return values
int —$required
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
getType()
Get type
public
getType() : string
Return values
string —$type
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
removeRegistrationFormFieldName()
Remove registrationFormFieldNames
public
removeRegistrationFormFieldName(RegistrationFormFieldName $registrationFormFieldNames) : mixed
Parameters
- $registrationFormFieldNames : RegistrationFormFieldName
removeRegistrationFormFieldValue()
Remove registrationFormFieldValues
public
removeRegistrationFormFieldValue(RegistrationFormFieldValue $registrationFormFieldValues) : mixed
Parameters
- $registrationFormFieldValues : RegistrationFormFieldValue
setAffiliation()
Set affiliation
public
setAffiliation(string $affiliation) : mixed
Parameters
- $affiliation : string
setOrder()
Set order
public
setOrder(int $order) : mixed
Parameters
- $order : int
setRegistrationForm()
Set registrationForm
public
setRegistrationForm(RegistrationForm $registrationForm) : mixed
Parameters
- $registrationForm : RegistrationForm
setRegistrationFormFieldNames()
Set registrationFormFieldNames
public
setRegistrationFormFieldNames(ArrayCollection $registrationFormFieldNames) : mixed
Parameters
- $registrationFormFieldNames : ArrayCollection
setRegistrationFormFieldValues()
Set registrationFormFieldValues
public
setRegistrationFormFieldValues(Collection $registrationFormFieldValues) : mixed
Parameters
- $registrationFormFieldValues : Collection
setRequired()
Set required
public
setRequired(int $required) : mixed
Parameters
- $required : int
setType()
Set type
public
setType(string $type) : mixed
Parameters
- $type : string
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