DataAccess
extends EntityBase
in package
DataAccess
Tags
Table of Contents
Properties
- $accessCondition : array<string|int, mixed>
- $allowedOutputMethods : array<string|int, mixed>
- $dataAccessApiKeys : Collection
- $dataSource : DataSource
- $fieldList : array<string|int, mixed>
- $id : 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()
- $readPermission : Permission
- $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.
- $writePermission : Permission
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
- addDataAccessApiKey() : DataAccess
- Add dataAccessApiKeys
- addDataAccessApiKeys() : mixed
- Add dataAccessApiKeys
- getAccessCondition() : array<string|int, mixed>
- Get accessCondition
- getAllowedOutputMethods() : array<string|int, mixed>
- Get allowedOutputMethods
- getComponentController() : SystemComponent
- Returns the component controller for this component
- getDataAccessApiKeys() : Collection
- Get dataAccessApiKeys
- getDataSource() : string
- Get dataSource
- getFieldList() : array<string|int, mixed>
- Get fieldList
- getId() : int
- Get id
- getKeyAsString() : string
- Returns this entity's key
- getName() : string
- Get name
- getReadPermission() : Permission
- Get read permission
- getTranslatedFieldValue() : mixed
- Returns the value of a translatable field using fallback mechanisms
- getWritePermission() : Permission
- Get write permission
- initializeValidators() : mixed
- Set $this->validators
- isVirtual() : bool
- Returns the virtuality of the entity
- removeDataAccessApiKey() : mixed
- Remove dataAccessApiKeys
- setAccessCondition() : mixed
- Set accessCondition
- setAllowedOutputMethods() : mixed
- Set allowedOutputMethods
- setDataSource() : mixed
- Set dataSource
- setFieldList() : mixed
- Set fieldList
- setName() : mixed
- Set name
- setReadPermission() : mixed
- Set read permission
- setVirtual() : mixed
- Set the virtuality of the entity
- setWritePermission() : mixed
- Set write permission
- 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
$accessCondition
protected
array<string|int, mixed>
$accessCondition
$allowedOutputMethods
protected
array<string|int, mixed>
$allowedOutputMethods
$dataAccessApiKeys
protected
Collection
$dataAccessApiKeys
$dataSource
protected
DataSource
$dataSource
$fieldList
protected
array<string|int, mixed>
$fieldList
$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
$name
protected
string
$name
$nestingCount
Counts the nesting level of __call()
protected
static int
$nestingCount
= 0
$readPermission
protected
Permission
$readPermission
$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.
$writePermission
protected
Permission
$writePermission
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
Attributes
- #[ReturnTypeWillChange]
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
Attributes
- #[ReturnTypeWillChange]
__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
addDataAccessApiKey()
Add dataAccessApiKeys
public
addDataAccessApiKey(DataAccessApiKey $dataAccessApiKeys) : DataAccess
Parameters
- $dataAccessApiKeys : DataAccessApiKey
Return values
DataAccessaddDataAccessApiKeys()
Add dataAccessApiKeys
public
addDataAccessApiKeys(DataAccessApiKey $dataAccessApiKeys) : mixed
Parameters
- $dataAccessApiKeys : DataAccessApiKey
getAccessCondition()
Get accessCondition
public
getAccessCondition() : array<string|int, mixed>
Return values
array<string|int, mixed> —$accessCondition
getAllowedOutputMethods()
Get allowedOutputMethods
public
getAllowedOutputMethods() : array<string|int, mixed>
Return values
array<string|int, mixed> —$allowedOutputMethods
getComponentController()
Returns the component controller for this component
public
getComponentController() : SystemComponent
Return values
SystemComponentgetDataAccessApiKeys()
Get dataAccessApiKeys
public
getDataAccessApiKeys() : Collection
Return values
Collection —$dataAccessApiKeys
getDataSource()
Get dataSource
public
getDataSource() : string
Return values
string —$dataSource
getFieldList()
Get fieldList
public
getFieldList() : array<string|int, mixed>
Return values
array<string|int, mixed> —$fieldList
getId()
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
getName()
Get name
public
getName() : string
Return values
string —$name
getReadPermission()
Get read permission
public
getReadPermission() : Permission
Return values
Permission —$readPermission
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
getWritePermission()
Get write permission
public
getWritePermission() : Permission
Return values
Permission —$writePermission
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
removeDataAccessApiKey()
Remove dataAccessApiKeys
public
removeDataAccessApiKey(DataAccessApiKey $dataAccessApiKeys) : mixed
Parameters
- $dataAccessApiKeys : DataAccessApiKey
setAccessCondition()
Set accessCondition
public
setAccessCondition(array<string|int, mixed> $accessCondition) : mixed
Parameters
- $accessCondition : array<string|int, mixed>
setAllowedOutputMethods()
Set allowedOutputMethods
public
setAllowedOutputMethods(array<string|int, mixed> $allowedOutputMethods) : mixed
Parameters
- $allowedOutputMethods : array<string|int, mixed>
setDataSource()
Set dataSource
public
setDataSource(string $dataSource) : mixed
Parameters
- $dataSource : string
setFieldList()
Set fieldList
public
setFieldList(array<string|int, mixed> $fieldList) : mixed
Parameters
- $fieldList : array<string|int, mixed>
setName()
Set name
public
setName(string $name) : mixed
Parameters
- $name : string
setReadPermission()
Set read permission
public
setReadPermission(Permission $readPermission) : mixed
Parameters
- $readPermission : Permission
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
setWritePermission()
Set write permission
public
setWritePermission(Permission $writePermission) : mixed
Parameters
- $writePermission : Permission
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