Invite
extends EntityBase
in package
Invite
Tags
Table of Contents
Constants
- HTTP_REQUEST_PARAM_DATE = 'date'
- HTTP_REQUEST_PARAM_EVENT = 'id'
- HTTP_REQUEST_PARAM_ID = 'i'
- HTTP_REQUEST_PARAM_RANDOM = 'r'
- HTTP_REQUEST_PARAM_TOKEN = 't'
Properties
- $email : string
- $event : Event
- $id : int
- $inviteeId : int
- $inviteeType : string
- $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()
- $registration : Registration
- $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
- $timestamp : int
- $token : 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
- getComponentController() : SystemComponent
- Returns the component controller for this component
- getDate() : DateTime
- Get date
- getEmail() : string
- Get email
- getEvent() : Event
- Get event
- getId() : int
- Get id
- getInviteeId() : int
- Get invitee id
- getInviteeType() : string
- Get invitee type
- getKeyAsString() : string
- Returns this entity's key
- getRegistration() : Registration
- Get registration
- getTimestamp() : int
- Get timestamp
- getToken() : string
- Get token
- 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
- setDate() : mixed
- Set date
- setEmail() : mixed
- Set email
- setEvent() : mixed
- Set event
- setId() : mixed
- Set id
- setInviteeId() : mixed
- Set invitee id
- setInviteeType() : mixed
- Set invitee type
- setRegistration() : mixed
- Set registration
- setTimestamp() : mixed
- Set timestamp
- setToken() : mixed
- Set token
- 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
Constants
HTTP_REQUEST_PARAM_DATE
public
mixed
HTTP_REQUEST_PARAM_DATE
= 'date'
HTTP_REQUEST_PARAM_EVENT
public
mixed
HTTP_REQUEST_PARAM_EVENT
= 'id'
HTTP_REQUEST_PARAM_ID
public
mixed
HTTP_REQUEST_PARAM_ID
= 'i'
HTTP_REQUEST_PARAM_RANDOM
public
mixed
HTTP_REQUEST_PARAM_RANDOM
= 'r'
HTTP_REQUEST_PARAM_TOKEN
public
mixed
HTTP_REQUEST_PARAM_TOKEN
= 't'
Properties
protected
string
$email
aemail$
$event
protected
Event
$event
$id
protected
int
$id
$inviteeId
protected
int
$inviteeId
$inviteeType
protected
string
$inviteeType
$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
$registration
protected
Registration
$registration
$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
$timestamp
protected
int
$timestamp
$token
protected
string
$token
token$
$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
getComponentController()
Returns the component controller for this component
public
getComponentController() : SystemComponent
Return values
SystemComponentgetDate()
Get date
public
getDate() : DateTime
Return values
DateTime —$date
getEmail()
Get email
public
getEmail() : string
Return values
string —getEvent()
Get event
public
getEvent() : Event
Return values
Event —$event
getId()
Get id
public
getId() : int
Return values
int —$id
getInviteeId()
Get invitee id
public
getInviteeId() : int
Return values
int —$inviteeId
getInviteeType()
Get invitee type
public
getInviteeType() : string
Return values
string —$inviteeType
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
getRegistration()
Get registration
public
getRegistration() : Registration
Return values
Registration —$registration
getTimestamp()
Get timestamp
public
getTimestamp() : int
Return values
int —$timestamp
getToken()
Get token
public
getToken() : string
Return values
string —$token
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
setDate()
Set date
public
setDate(DateTime $dateTime) : mixed
Parameters
- $dateTime : DateTime
setEmail()
Set email
public
setEmail(string $email) : mixed
Parameters
- $email : string
setEvent()
Set event
public
setEvent(Event $event) : mixed
Parameters
- $event : Event
setId()
Set id
public
setId(int $id) : mixed
Parameters
- $id : int
setInviteeId()
Set invitee id
public
setInviteeId(int $inviteeId) : mixed
Parameters
- $inviteeId : int
setInviteeType()
Set invitee type
public
setInviteeType(string $inviteeType) : mixed
Parameters
- $inviteeType : string
setRegistration()
Set registration
public
setRegistration(Registration $registration) : mixed
Parameters
- $registration : Registration
setTimestamp()
Set timestamp
public
setTimestamp(int $timestamp) : mixed
Parameters
- $timestamp : int
setToken()
Set token
public
setToken(string $token) : mixed
Parameters
- $token : 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