Cookie
extends EntityBase
in package
implements
JsonSerializable, Translatable
Class Cookie
Tags
Table of Contents
Interfaces
- JsonSerializable
- Translatable
Properties
- $active : bool
- $category : int
- $component : string
- $cookieNames : array<string|int, mixed>
- $description : string
- $host : string
- $id : int
- $identifier : string
- $locale : string
- $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()
- $ord : int
- $privacyStatementUrl : string
- $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
- getActive() : bool
- Get active
- getCategory() : int
- Get category
- getComponent() : string
- Get component
- getComponentController() : SystemComponent
- Returns the component controller for this component
- getCookieNames() : array<string|int, mixed>
- Get cookieNames
- getDescription() : string
- Get description
- getHost() : string
- Get host
- getId() : int
- Get id
- getIdentifier() : string
- Get identifier
- getKeyAsString() : string
- Returns this entity's key
- getName() : string
- Get name
- getOrd() : int
- Get ord
- getPrivacyStatementUrl() : string
- Get privacyStatementUrl
- getTranslatedFieldValue() : mixed
- Returns the value of a translatable field using fallback mechanisms
- initializeValidators() : mixed
- Set $this->validators
- isActive() : mixed
- isVirtual() : bool
- Returns the virtuality of the entity
- jsonSerialize() : mixed
- setActive() : Cookie
- Set active
- setCategory() : Cookie
- Set category
- setComponent() : Component
- Set component
- setCookieNames() : Cookie
- Set cookieNames
- setDescription() : Cookie
- Set description
- setHost() : Cookie
- Set host
- setIdentifier() : Cookie
- Set identifier
- setName() : Cookie
- Set name
- setOrd() : mixed
- Set ord
- setPrivacyStatementUrl() : Cookie
- Set privacyStatementUrl
- setTranslatableLocale() : mixed
- 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
$active
protected
bool
$active
$category
protected
int
$category
$component
protected
string
$component
$cookieNames
protected
array<string|int, mixed>
$cookieNames
$description
protected
string
$description
$host
protected
string
$host
$id
protected
int
$id
$identifier
protected
string
$identifier
$locale
protected
string
$locale
$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
$ord
protected
int
$ord
$privacyStatementUrl
protected
string
$privacyStatementUrl
$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
getActive()
Get active
public
getActive() : bool
Return values
boolgetCategory()
Get category
public
getCategory() : int
Return values
intgetComponent()
Get component
public
getComponent() : string
Tags
Return values
stringgetComponentController()
Returns the component controller for this component
public
getComponentController() : SystemComponent
Return values
SystemComponentgetCookieNames()
Get cookieNames
public
getCookieNames() : array<string|int, mixed>
Return values
array<string|int, mixed>getDescription()
Get description
public
getDescription() : string
Return values
stringgetHost()
Get host
public
getHost() : string
Return values
stringgetId()
Get id
public
getId() : int
Return values
intgetIdentifier()
Get identifier
public
getIdentifier() : string
Return values
stringgetKeyAsString()
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
getName()
Get name
public
getName() : string
Return values
stringgetOrd()
Get ord
public
getOrd() : int
Return values
intgetPrivacyStatementUrl()
Get privacyStatementUrl
public
getPrivacyStatementUrl() : string
Return values
stringgetTranslatedFieldValue()
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
isActive()
public
isActive() : mixed
Tags
isVirtual()
Returns the virtuality of the entity
public
isVirtual() : bool
Return values
bool —TRUE if the entity is virtual, otherwise FALSE
jsonSerialize()
public
jsonSerialize() : mixed
setActive()
Set active
public
setActive(bool $active) : Cookie
Parameters
- $active : bool
Return values
CookiesetCategory()
Set category
public
setCategory(int $category) : Cookie
Parameters
- $category : int
Return values
CookiesetComponent()
Set component
public
setComponent(string $component) : Component
Parameters
- $component : string
Tags
Return values
Component —name
setCookieNames()
Set cookieNames
public
setCookieNames(array<string|int, mixed> $cookieNames) : Cookie
Parameters
- $cookieNames : array<string|int, mixed>
Return values
CookiesetDescription()
Set description
public
setDescription(string $description) : Cookie
Parameters
- $description : string
Return values
CookiesetHost()
Set host
public
setHost(string $host) : Cookie
Parameters
- $host : string
Return values
CookiesetIdentifier()
Set identifier
public
setIdentifier(string $identifier) : Cookie
Parameters
- $identifier : string
Return values
CookiesetName()
Set name
public
setName(string $name) : Cookie
Parameters
- $name : string
Return values
CookiesetOrd()
Set ord
public
setOrd(int $ord) : mixed
Parameters
- $ord : int
setPrivacyStatementUrl()
Set privacyStatementUrl
public
setPrivacyStatementUrl(string $privacyStatementUrl) : Cookie
Parameters
- $privacyStatementUrl : string
Return values
CookiesetTranslatableLocale()
public
setTranslatableLocale(mixed $locale) : mixed
Parameters
- $locale : mixed
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