Registration
extends EntityBase
in package
Registration
Tags
Table of Contents
Properties
- $date : int
- $event : Event
- $export : int
- $id : int
- $invite : Invite
- $langId : 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()
- $paid : int
- $paymentMethod : int
- $registrationFormFieldValues : RegistrationFormFieldValue
- $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
- $submissionDate : dateTime
- $type : int
- $userId : int
- $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
- addRegistrationFormFieldValue() : mixed
- Add registrationFormFieldValues
- getComponentController() : SystemComponent
- Returns the component controller for this component
- getDate() : int
- Get date
- getEvent() : Event
- Get event
- getExport() : int
- Get export
- getId() : int
- Get id
- getInvite() : Invite
- Get invite
- getKeyAsString() : string
- Returns this entity's key
- getLangId() : int
- Get langId
- getPaid() : int
- Get paid
- getPaymentMethod() : int
- Get paymentMethod
- getRegistrationFormFieldValueByFieldId() : null|RegistrationFormFieldValue
- Get RegistrationFormFieldValueByFieldId
- getRegistrationFormFieldValues() : Collection
- Get registrationFormFieldValues
- getSubmissionDate() : dateTime
- Get submissionDate
- getTranslatedFieldValue() : mixed
- Returns the value of a translatable field using fallback mechanisms
- getType() : int
- Get type
- getUserId() : int
- Get userId
- initializeValidators() : mixed
- Set $this->validators
- isVirtual() : bool
- Returns the virtuality of the entity
- removeRegistrationFormFieldValue() : mixed
- Remove registrationFormFieldValues
- setDate() : mixed
- Set date
- setEvent() : mixed
- Set event
- setExport() : mixed
- Set export
- setInvite() : mixed
- Set invite
- setLangId() : mixed
- Set langId
- setPaid() : mixed
- Set paid
- setPaymentMethod() : mixed
- Set paymentMethod
- setRegistrationFormFieldValues() : mixed
- set $registrationFormFieldValues
- setSubmissionDate() : mixed
- Set submissionDate
- setType() : mixed
- Set type
- setUserId() : mixed
- Set userId
- 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
$date
protected
int
$date
$event
protected
Event
$event
$export
protected
int
$export
$id
protected
int
$id
$invite
protected
Invite
$invite
$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
$nestingCount
Counts the nesting level of __call()
protected
static int
$nestingCount
= 0
$paid
protected
int
$paid
$paymentMethod
protected
int
$paymentMethod
$registrationFormFieldValues
protected
RegistrationFormFieldValue
$registrationFormFieldValues
$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
$submissionDate
protected
dateTime
$submissionDate
$type
protected
int
$type
$userId
protected
int
$userId
$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
addRegistrationFormFieldValue()
Add registrationFormFieldValues
public
addRegistrationFormFieldValue(RegistrationFormFieldValue $registrationFormFieldValue) : mixed
Parameters
- $registrationFormFieldValue : RegistrationFormFieldValue
getComponentController()
Returns the component controller for this component
public
getComponentController() : SystemComponent
Return values
SystemComponentgetDate()
Get date
public
getDate() : int
Return values
int —$date
getEvent()
Get event
public
getEvent() : Event
Return values
Event —$event
getExport()
Get export
public
getExport() : int
Return values
int —$export
getId()
Get id
public
getId() : int
Return values
int —$id
getInvite()
Get invite
public
getInvite() : Invite
Return values
Invite —$invite
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
getPaid()
Get paid
public
getPaid() : int
Return values
int —$paid
getPaymentMethod()
Get paymentMethod
public
getPaymentMethod() : int
Return values
int —$paymentMethod
getRegistrationFormFieldValueByFieldId()
Get RegistrationFormFieldValueByFieldId
public
getRegistrationFormFieldValueByFieldId(int $fieldId) : null|RegistrationFormFieldValue
Parameters
- $fieldId : int
-
field id
Return values
null|RegistrationFormFieldValuegetRegistrationFormFieldValues()
Get registrationFormFieldValues
public
getRegistrationFormFieldValues() : Collection
Return values
Collection —$registrationFormFieldValues
getSubmissionDate()
Get submissionDate
public
getSubmissionDate() : dateTime
Return values
dateTime —$submissionDate
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() : int
Return values
int —$type
getUserId()
Get userId
public
getUserId() : int
Return values
int —$userId
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
removeRegistrationFormFieldValue()
Remove registrationFormFieldValues
public
removeRegistrationFormFieldValue(RegistrationFormFieldValue $registrationFormFieldValues) : mixed
Parameters
- $registrationFormFieldValues : RegistrationFormFieldValue
setDate()
Set date
public
setDate(int $date) : mixed
Parameters
- $date : int
setEvent()
Set event
public
setEvent(Event $event) : mixed
Parameters
- $event : Event
setExport()
Set export
public
setExport(int $export) : mixed
Parameters
- $export : int
setInvite()
Set invite
public
setInvite(Invite $invite) : mixed
Parameters
- $invite : Invite
setLangId()
Set langId
public
setLangId(int $langId) : mixed
Parameters
- $langId : int
setPaid()
Set paid
public
setPaid(int $paid) : mixed
Parameters
- $paid : int
setPaymentMethod()
Set paymentMethod
public
setPaymentMethod(int $paymentMethod) : mixed
Parameters
- $paymentMethod : int
setRegistrationFormFieldValues()
set $registrationFormFieldValues
public
setRegistrationFormFieldValues(type $registrationFormFieldValues) : mixed
Parameters
- $registrationFormFieldValues : type
setSubmissionDate()
Set submissionDate
public
setSubmissionDate(dateTime $submissionDate) : mixed
Parameters
- $submissionDate : dateTime
setType()
Set type
public
setType(int $type) : mixed
Parameters
- $type : int
setUserId()
Set userId
public
setUserId(int $userId) : mixed
Parameters
- $userId : int
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