core/model/modx/modaction.class.php
- Package
- modx
\modAction
Represents an action to a controller or connector.
This is the basis for the entire xPDO object model, and can also be used by a class generator {@link xPDOGenerator}, ultimately allowing custom classes to be user-defined in a web interface and framework-generated at runtime.
- Parent(s)
- \modAccessibleSimpleObject < \modAccessibleObject < \xPDOObject
- Children
- \modAction_mysql
- \modAction_sqlsrv
- See
- \modManagerController
Properties
array
$_aggregates= 'array ()'
An array of aggregate foreign key relationships for the class.
Inherited from: \xPDOObject::$$_aggregates\modAccessibleObject::$$_aggregates\modAccessibleSimpleObject::$$_aggregatesarray ()
Details- Type
- array
- Access
- public
- Inherited_from
- \xPDOObject::$$_aggregates
- Inherited_from
- \modAccessibleObject::$$_aggregates
- Inherited_from
- \modAccessibleSimpleObject::$$_aggregates
string
$_alias= 'null'
An alias for this instance of the class.
Inherited from: \xPDOObject::$$_alias\modAccessibleObject::$$_alias\modAccessibleSimpleObject::$$_aliasnull
Details- Type
- string
- Inherited_from
- \xPDOObject::$$_alias
- Inherited_from
- \modAccessibleObject::$$_alias
- Inherited_from
- \modAccessibleSimpleObject::$$_alias
boolean
$_cacheFlag= 'true'
Indicates the cacheability of the instance.
Inherited from: \xPDOObject::$$_cacheFlag\modAccessibleObject::$$_cacheFlag\modAccessibleSimpleObject::$$_cacheFlagtrue
Details- Type
- boolean
- Inherited_from
- \xPDOObject::$$_cacheFlag
- Inherited_from
- \modAccessibleObject::$$_cacheFlag
- Inherited_from
- \modAccessibleSimpleObject::$$_cacheFlag
string
$_class= 'null'
The actual class name of an instance.
Inherited from: \xPDOObject::$$_class\modAccessibleObject::$$_class\modAccessibleSimpleObject::$$_classnull
Details- Type
- string
- Inherited_from
- \xPDOObject::$$_class
- Inherited_from
- \modAccessibleObject::$$_class
- Inherited_from
- \modAccessibleSimpleObject::$$_class
array
$_composites= 'array ()'
An array of composite foreign key relationships for the class.
Inherited from: \xPDOObject::$$_composites\modAccessibleObject::$$_composites\modAccessibleSimpleObject::$$_compositesarray ()
Details- Type
- array
- Access
- public
- Inherited_from
- \xPDOObject::$$_composites
- Inherited_from
- \modAccessibleObject::$$_composites
- Inherited_from
- \modAccessibleSimpleObject::$$_composites
array
$_dirty= 'array ()'
An array of field names that have been modified.
Inherited from: \xPDOObject::$$_dirty\modAccessibleObject::$$_dirty\modAccessibleSimpleObject::$$_dirtyarray ()
Details- Type
- array
- Access
- public
- Inherited_from
- \xPDOObject::$$_dirty
- Inherited_from
- \modAccessibleObject::$$_dirty
- Inherited_from
- \modAccessibleSimpleObject::$$_dirty
array
$_fieldAliases= 'array()'
An optional array of field aliases.
Inherited from: \xPDOObject::$$_fieldAliases\modAccessibleObject::$$_fieldAliases\modAccessibleSimpleObject::$$_fieldAliasesarray()
Details- Type
- array
- Inherited_from
- \xPDOObject::$$_fieldAliases
- Inherited_from
- \modAccessibleObject::$$_fieldAliases
- Inherited_from
- \modAccessibleSimpleObject::$$_fieldAliases
array
$_fieldMeta= 'array ()'
An array of metadata definitions for each field in the class.
Inherited from: \xPDOObject::$$_fieldMeta\modAccessibleObject::$$_fieldMeta\modAccessibleSimpleObject::$$_fieldMetaarray ()
Details- Type
- array
- Access
- public
- Inherited_from
- \xPDOObject::$$_fieldMeta
- Inherited_from
- \modAccessibleObject::$$_fieldMeta
- Inherited_from
- \modAccessibleSimpleObject::$$_fieldMeta
array
$_fields= 'array ()'
An array of key-value pairs representing the fields of the instance.
Inherited from: \xPDOObject::$$_fields\modAccessibleObject::$$_fields\modAccessibleSimpleObject::$$_fieldsarray ()
Details- Type
- array
- Access
- public
- Inherited_from
- \xPDOObject::$$_fields
- Inherited_from
- \modAccessibleObject::$$_fields
- Inherited_from
- \modAccessibleSimpleObject::$$_fields
array
$_lazy= 'array ()'
An array of field names that have not been loaded from the source.
Inherited from: \xPDOObject::$$_lazy\modAccessibleObject::$$_lazy\modAccessibleSimpleObject::$$_lazyarray ()
Details- Type
- array
- Access
- public
- Inherited_from
- \xPDOObject::$$_lazy
- Inherited_from
- \modAccessibleObject::$$_lazy
- Inherited_from
- \modAccessibleSimpleObject::$$_lazy
boolean
$_new= 'true'
Indicates if the instance is transient (and thus new).
Inherited from: \xPDOObject::$$_new\modAccessibleObject::$$_new\modAccessibleSimpleObject::$$_newtrue
Details- Type
- boolean
- Access
- public
- Inherited_from
- \xPDOObject::$$_new
- Inherited_from
- \modAccessibleObject::$$_new
- Inherited_from
- \modAccessibleSimpleObject::$$_new
array
$_options= 'array()'
A collection of various options that can be used on the instance.
Inherited from: \xPDOObject::$$_options\modAccessibleObject::$$_options\modAccessibleSimpleObject::$$_optionsarray()
Details- Type
- array
- Inherited_from
- \xPDOObject::$$_options
- Inherited_from
- \modAccessibleObject::$$_options
- Inherited_from
- \modAccessibleSimpleObject::$$_options
string
$_package= 'null'
The package the class is a part of.
Inherited from: \xPDOObject::$$_package\modAccessibleObject::$$_package\modAccessibleSimpleObject::$$_packagenull
Details- Type
- string
- Inherited_from
- \xPDOObject::$$_package
- Inherited_from
- \modAccessibleObject::$$_package
- Inherited_from
- \modAccessibleSimpleObject::$$_package
string|array
$_pk= 'null'
The primary key field (or an array of primary key fields) for this object.
Inherited from: \xPDOObject::$$_pk\modAccessibleObject::$$_pk\modAccessibleSimpleObject::$$_pknull
Details- Type
- string | array
- Access
- public
- Inherited_from
- \xPDOObject::$$_pk
- Inherited_from
- \modAccessibleObject::$$_pk
- Inherited_from
- \modAccessibleSimpleObject::$$_pk
string|array
$_pktype= 'null'
The php native type of the primary key field.
Inherited from: \xPDOObject::$$_pktype\modAccessibleObject::$$_pktype\modAccessibleSimpleObject::$$_pktypeNOTE: Will be an array if multiple primary keys are specified for the object.
null
Details- Type
- string | array
- Access
- public
- Inherited_from
- \xPDOObject::$$_pktype
- Inherited_from
- \modAccessibleObject::$$_pktype
- Inherited_from
- \modAccessibleSimpleObject::$$_pktype
array
$_policies= 'array()'
A local cache of access policies for the instance.
Inherited from: \modAccessibleObject::$$_policies\modAccessibleSimpleObject::$$_policiesarray()
Details- Type
- array
- Inherited_from
- \modAccessibleObject::$$_policies
- Inherited_from
- \modAccessibleSimpleObject::$$_policies
array
$_relatedObjects= 'array ()'
An array of object instances related to this object instance.
Inherited from: \xPDOObject::$$_relatedObjects\modAccessibleObject::$$_relatedObjects\modAccessibleSimpleObject::$$_relatedObjectsarray ()
Details- Type
- array
- Access
- public
- Inherited_from
- \xPDOObject::$$_relatedObjects
- Inherited_from
- \modAccessibleObject::$$_relatedObjects
- Inherited_from
- \modAccessibleSimpleObject::$$_relatedObjects
string
$_table= 'null'
Name of the actual table representing this class.
Inherited from: \xPDOObject::$$_table\modAccessibleObject::$$_table\modAccessibleSimpleObject::$$_tablenull
Details- Type
- string
- Access
- public
- Inherited_from
- \xPDOObject::$$_table
- Inherited_from
- \modAccessibleObject::$$_table
- Inherited_from
- \modAccessibleSimpleObject::$$_table
string
$_tableMeta= 'null'
An array of meta data for the table.
Inherited from: \xPDOObject::$$_tableMeta\modAccessibleObject::$$_tableMeta\modAccessibleSimpleObject::$$_tableMetanull
Details- Type
- string
- Access
- public
- Inherited_from
- \xPDOObject::$$_tableMeta
- Inherited_from
- \modAccessibleObject::$$_tableMeta
- Inherited_from
- \modAccessibleSimpleObject::$$_tableMeta
array
$_validated= 'array ()'
An array of field names that have been already validated.
Inherited from: \xPDOObject::$$_validated\modAccessibleObject::$$_validated\modAccessibleSimpleObject::$$_validatedarray ()
Details- Type
- array
- Access
- public
- Inherited_from
- \xPDOObject::$$_validated
- Inherited_from
- \modAccessibleObject::$$_validated
- Inherited_from
- \modAccessibleSimpleObject::$$_validated
boolean
$_validationLoaded= 'false'
Indicates if the validation map has been loaded.
Inherited from: \xPDOObject::$$_validationLoaded\modAccessibleObject::$$_validationLoaded\modAccessibleSimpleObject::$$_validationLoadedfalse
Details- Type
- boolean
- Access
- public
- Inherited_from
- \xPDOObject::$$_validationLoaded
- Inherited_from
- \modAccessibleObject::$$_validationLoaded
- Inherited_from
- \modAccessibleSimpleObject::$$_validationLoaded
array
$_validationRules= 'array()'
An array of validation rules for this object instance.
Inherited from: \xPDOObject::$$_validationRules\modAccessibleObject::$$_validationRules\modAccessibleSimpleObject::$$_validationRulesarray()
Details- Type
- array
- Access
- public
- Inherited_from
- \xPDOObject::$$_validationRules
- Inherited_from
- \modAccessibleObject::$$_validationRules
- Inherited_from
- \modAccessibleSimpleObject::$$_validationRules
\xPDOValidator
$_validator= 'null'
A validator object responsible for this object instance.
Inherited from: \xPDOObject::$$_validator\modAccessibleObject::$$_validator\modAccessibleSimpleObject::$$_validatornull
Details- Type
- \xPDOValidator
- Access
- public
- Inherited_from
- \xPDOObject::$$_validator
- Inherited_from
- \modAccessibleObject::$$_validator
- Inherited_from
- \modAccessibleSimpleObject::$$_validator
string
$assets= ''
Any action-specific assets. Not used.
Any action-specific assets. Not used.- Type
- string
- Magic
- Property
- Any action-specific assets. Not used.
string
$container= 'null'
Name of the data source container the object belongs to.
Inherited from: \xPDOObject::$$container\modAccessibleObject::$$container\modAccessibleSimpleObject::$$containernull
Details- Type
- string
- Access
- public
- Inherited_from
- \xPDOObject::$$container
- Inherited_from
- \modAccessibleObject::$$container
- Inherited_from
- \modAccessibleSimpleObject::$$container
string
$controller= ''
The name of the controller to use
The name of the controller to use- Type
- string
- Magic
- Property
- The name of the controller to use
array
$fieldNames= 'null'
Names of the fields in the data table, fully-qualified with a table name.
Inherited from: \xPDOObject::$$fieldNames\modAccessibleObject::$$fieldNames\modAccessibleSimpleObject::$$fieldNamesNOTE: For use in table joins to qualify fields with the same name.
null
Details- Type
- array
- Access
- public
- Inherited_from
- \xPDOObject::$$fieldNames
- Inherited_from
- \modAccessibleObject::$$fieldNames
- Inherited_from
- \modAccessibleSimpleObject::$$fieldNames
boolean
$haslayout= ''
Whether or not to load the header/footer of the action. Deprecated (use modManagerController class properties instead).
Whether or not to load the header/footer of the action. Deprecated (use modManagerController class properties instead).- Type
- boolean
- Magic
- Property
- Whether or not to load the header/footer of the action. Deprecated (use modManagerController class properties instead).
string
$help_url= ''
An absolute URL that this Action can use for displaying a Help box
An absolute URL that this Action can use for displaying a Help box- Type
- string
- Magic
- Property
- An absolute URL that this Action can use for displaying a Help box
string
$lang_topics= ''
Any lexicon topics to load in conjunction with the specified controller. Deprecated (use modManagerController class method instead)
Any lexicon topics to load in conjunction with the specified controller. Deprecated (use modManagerController class method instead)- Type
- string
- Magic
- Property
- Any lexicon topics to load in conjunction with the specified controller. Deprecated (use modManagerController class method instead)
string
$namespace= ''
The key of the Namespace this action belongs to.
The key of the Namespace this action belongs to.- Type
- string
- Magic
- Property
- The key of the Namespace this action belongs to.
int
$parent= ''
The ID of the parent action of this action.
The ID of the parent action of this action.- Type
- int
- Magic
- Property
- The ID of the parent action of this action.
\xPDO
$xpdo= 'null'
A convenience reference to the xPDO object.
Inherited from: \xPDOObject::$$xpdo\modAccessibleObject::$$xpdo\modAccessibleSimpleObject::$$xpdonull
Details- Type
- \xPDO
- Access
- public
- Inherited_from
- \xPDOObject::$$xpdo
- Inherited_from
- \modAccessibleObject::$$xpdo
- Inherited_from
- \modAccessibleSimpleObject::$$xpdo
Methods
__construct(
\xPDO $xpdo
)
:
\xPDOObject
Constructor
Inherited from: \xPDOObject::__construct()\modAccessibleObject::__construct()\modAccessibleSimpleObject::__construct()Do not call the constructor directly; see {@link xPDO::newObject()}.
All derivatives of xPDOObject must redeclare this method, and must call the parent method explicitly before any additional logic is executed, e.g.
public function __construct(xPDO & $xpdo) {
parent :: __construct($xpdo);
// Any additional constructor tasks here
}
Name | Type | Description |
---|---|---|
$xpdo | \xPDO | &$xpdo A reference to a valid xPDO instance. |
Type | Description |
---|---|
\xPDOObject |
- Access
- public
_getAliases(
string $class, int $limit
=
0
)
:
array
Find aliases for any defined object relations of the specified class.
Inherited from: \xPDOObject::_getAliases()\modAccessibleObject::_getAliases()\modAccessibleSimpleObject::_getAliases()Name | Type | Description |
---|---|---|
$class | string | The name of the class to find aliases from. |
$limit | int | An optional limit on the number of aliases to return; default is 0, i.e. no limit. |
Type | Description |
---|---|
array | An array of aliases or an empty array if none are found. |
- Access
- protected
_getDataType(
string $key
)
:
string
Gets the database data type for the specified field.
Inherited from: \xPDOObject::_getDataType()\modAccessibleObject::_getDataType()\modAccessibleSimpleObject::_getDataType()Name | Type | Description |
---|---|---|
$key | string | The field name to get the data type for. |
Type | Description |
---|---|
string | The DB data type of the field. |
- Access
- protected
_getPHPType(
string $key
)
:
string
Gets the php data type for the specified field.
Inherited from: \xPDOObject::_getPHPType()\modAccessibleObject::_getPHPType()\modAccessibleSimpleObject::_getPHPType()Name | Type | Description |
---|---|---|
$key | string | The field name to get the data type for. |
Type | Description |
---|---|
string | The PHP data type of the field. |
- Access
- protected
_getRelatedObjectsByFK(
string $alias, mixed $criteria
=
null, boolean | integer $cacheFlag
=
true
)
:
array
Gets related objects by a foreign key and specified criteria.
Inherited from: \xPDOObject::_getRelatedObjectsByFK()\modAccessibleObject::_getRelatedObjectsByFK()\modAccessibleSimpleObject::_getRelatedObjectsByFK()Name | Type | Description |
---|---|---|
$alias | string | The alias representing the relationship. |
$criteria | mixed | An optional xPDO criteria expression. |
$cacheFlag | boolean | integer | Indicates if the saved object(s) should be cached and optionally, by specifying an integer value, for how many seconds before expiring. Overrides the cacheFlag for the object. |
Type | Description |
---|---|
array | A collection of objects matching the criteria. |
- Access
- protected
_initFields(
)
:
void
Initializes the field names with the qualified table name.
Inherited from: \xPDOObject::_initFields()\modAccessibleObject::_initFields()\modAccessibleSimpleObject::_initFields()Once this is called, you can lookup the qualified name by the field name itself in {@link xPDOObject::$fieldNames}.
- Access
- protected
_loadCollectionInstance(
\xPDO $xpdo, array $objCollection, string $className, mixed $criteria, $row, $fromCache, boolean | integer $cacheFlag
=
true
)
:
void
Custom instance loader for collections that respects policy checking.
Inherited from: \modAccessibleObject::_loadCollectionInstance()\modAccessibleSimpleObject::_loadCollectionInstance()Name | Type | Description |
---|---|---|
$xpdo | \xPDO | &$xpdo A valid xPDO instance. |
$objCollection | array | &$objCollection The collection to load the instance into. |
$className | string | Name of the class. |
$criteria | mixed | A valid primary key, criteria array, or xPDOCriteria instance. |
$row | ||
$fromCache | ||
$cacheFlag | boolean | integer | Indicates if the objects should be cached and optionally, by specifying an integer value, for how many seconds. |
_loadFieldData(
string | array $fields
)
:
void
Load persistent data from the source for the field(s) indicated.
Inherited from: \xPDOObject::_loadFieldData()\modAccessibleObject::_loadFieldData()\modAccessibleSimpleObject::_loadFieldData()Name | Type | Description |
---|---|---|
$fields | string | array | A field name or array of field names to load from the data source. |
- Access
- protected
_loadInstance(
\xPDO | \modX $xpdo, string $className, mixed $criteria, int $row
)
:
\modAccessibleObject | null
Custom instance from row loader that respects policy checking
Inherited from: \modAccessibleObject::_loadInstance()\modAccessibleSimpleObject::_loadInstance()Name | Type | Description |
---|---|---|
$xpdo | \xPDO | \modX | A reference to the xPDO/modX object. |
$className | string | The name of the class by which to grab the instance from |
$criteria | mixed | A criteria to use when grabbing this instance |
$row | int | The row to select |
Type | Description |
---|---|
\modAccessibleObject | null | An instance of the object |
_loadRows(
\xPDO $xpdo, string $className, \xPDOCriteria $criteria
)
:
\PDOStatement
Responsible for loading a result set from the database.
Inherited from: \xPDOObject::_loadRows()\modAccessibleObject::_loadRows()\modAccessibleSimpleObject::_loadRows()Name | Type | Description |
---|---|---|
$xpdo | \xPDO | &$xpdo A valid xPDO instance. |
$className | string | Name of the class. |
$criteria | \xPDOCriteria | A valid xPDOCriteria instance. |
Type | Description |
---|---|
\PDOStatement | A reference to a PDOStatement representing the result set. |
- Static
_loadValidation(
boolean $reload
=
false
)
:
void
Used to load validation from the object map.
Inherited from: \xPDOObject::_loadValidation()\modAccessibleObject::_loadValidation()\modAccessibleSimpleObject::_loadValidation()Name | Type | Description |
---|---|---|
$reload | boolean | Indicates if the schema validation rules should be reloaded. |
- Access
- public
_saveRelatedObject(
\xPDOObject $obj, array $fkMeta
)
:
boolean
Save a related object with pending changes.
Inherited from: \xPDOObject::_saveRelatedObject()\modAccessibleObject::_saveRelatedObject()\modAccessibleSimpleObject::_saveRelatedObject()This function is also responsible for setting foreign keys when new related objects are being saved, as well as local keys when the host object is new and needs the foreign key.
Name | Type | Description |
---|---|---|
$obj | \xPDOObject | &$obj A reference to the related object. |
$fkMeta | array | The meta data representing the relation. |
Type | Description |
---|---|
boolean | True if a related object was dirty and saved successfully. |
- Access
- protected
_saveRelatedObjects(
)
:
integer
Searches for any related objects with pending changes to save.
Inherited from: \xPDOObject::_saveRelatedObjects()\modAccessibleObject::_saveRelatedObjects()\modAccessibleSimpleObject::_saveRelatedObjects()Type | Description |
---|---|
integer | The number of related objects processed. |
- Access
- protected
- Uses
- \xPDOObject::_saveRelatedObject()
_setRaw(
string $key, mixed $val
)
:
boolean
Set a raw value on a field converted to the appropriate type.
Inherited from: \xPDOObject::_setRaw()\modAccessibleObject::_setRaw()\modAccessibleSimpleObject::_setRaw()Name | Type | Description |
---|---|---|
$key | string | The key identifying the field to set. |
$val | mixed | The value to set. |
Type | Description |
---|---|
boolean | Returns true if the value was set, false otherwise. |
- Access
- protected
addFieldAlias(
string $field, string $alias
)
:
bool
Add an alias as a reference to an actual field of the object.
Inherited from: \xPDOObject::addFieldAlias()\modAccessibleObject::addFieldAlias()\modAccessibleSimpleObject::addFieldAlias()Name | Type | Description |
---|---|---|
$field | string | The field name to create a reference to. |
$alias | string | The name of the reference. |
Type | Description |
---|---|
bool | True if the reference is added successfully. |
addMany(
mixed $obj, string $alias
=
''
)
:
boolean
Adds an object or collection of objects related to this class.
Inherited from: \xPDOObject::addMany()\modAccessibleObject::addMany()\modAccessibleSimpleObject::addMany()This method adds an object or collection of objects in a one-to- many foreign key relationship with this object to the internal list of related objects. By adding these related objects, you can cascade {@link xPDOObject::save()}, {@link xPDOObject::remove()}, and other operations based on the type of relationships defined.
Name | Type | Description |
---|---|---|
$obj | mixed | &$obj A single object or collection of objects to be related to this instance via the intersection class. |
$alias | string | An optional alias, required only for instances where you have more than one relation defined to the same class. |
Type | Description |
---|---|
boolean | Indicates if the addMany was successful. |
addOne(
mixed $obj, string $alias
=
''
)
:
boolean
Adds an object related to this instance by a foreign key relationship.
Inherited from: \xPDOObject::addOne()\modAccessibleObject::addOne()\modAccessibleSimpleObject::addOne()Name | Type | Description |
---|---|---|
$obj | mixed | &$obj A single object to be related to this instance. |
$alias | string | The relation alias of the related object (only required if more than one relation exists to the same foreign class). |
Type | Description |
---|---|
boolean | True if the related object was added to this object. |
addValidationRule(
string $field, string $name, string $type, string $rule, array $parameters
=
array()
)
:
void
Add a validation rule to an object field for this instance.
Inherited from: \xPDOObject::addValidationRule()\modAccessibleObject::addValidationRule()\modAccessibleSimpleObject::addValidationRule()Name | Type | Description |
---|---|---|
$field | string | The field key to apply the rule to. |
$name | string | A name to identify the rule. |
$type | string | The type of rule. |
$rule | string | The rule definition. |
$parameters | array | Any input parameters for the rule. |
checkPolicy(
array $criteria, string | array $targets
=
null
)
:
boolean
Determine if the current user attributes satisfy the object policy.
Inherited from: \modAccessibleObject::checkPolicy()\modAccessibleSimpleObject::checkPolicy()Name | Type | Description |
---|---|---|
$criteria | array | An associative array providing a key and value to search for within the matched policy attributes between policy and principal. |
$targets | string | array | A target modAccess class name or an array of class names to limit the check. In most cases, this does not need to be set; derivatives should typically determine what targets to include in the findPolicy() implementation. |
Type | Description |
---|---|
boolean | Returns true if the policy is satisfied or no policy exists. |
encode(
string $source, string $type
=
'md5'
)
:
string
Encodes a string using the specified algorithm.
Inherited from: \xPDOObject::encode()\modAccessibleObject::encode()\modAccessibleSimpleObject::encode()NOTE: This implementation currently only implements md5. To implement additional algorithms, override this function in your xPDOObject derivative classes.
Name | Type | Description |
---|---|---|
$source | string | The string source to encode. |
$type | string | The type of encoding algorithm to apply, md5 by default. |
Type | Description |
---|---|
string | The encoded string. |
findPolicy(
string $context
=
''
)
:
array
Find access policies applicable to this object in a specific context.
Inherited from: \modAccessibleObject::findPolicy()\modAccessibleSimpleObject::findPolicy()Name | Type | Description |
---|---|---|
$context | string | A key identifying a specific context to use when searching for the applicable policies. If not provided, the current context is used. |
Type | Description |
---|---|
array | An array of access policies for this object; an empty array is returned if no policies are assigned to the object. |
- Access
- protected
fromArray(
array $fldarray, string $keyPrefix
=
'', boolean $setPrimaryKeys
=
false, boolean $rawValues
=
false, boolean $adhocValues
=
false
)
:
void
Sets object fields from an associative array of key => value pairs.
Inherited from: \xPDOObject::fromArray()\modAccessibleObject::fromArray()\modAccessibleSimpleObject::fromArray()Name | Type | Description |
---|---|---|
$fldarray | array | An associative array of key => values. |
$keyPrefix | string | Specify an optional prefix to strip from all array keys in fldarray. |
$setPrimaryKeys | boolean | Optional param to set generated primary keys. |
$rawValues | boolean | Optional way to set values without calling the {@link xPDOObject::set()} method. |
$adhocValues | boolean | Optional way to set adhoc values so that all the values of fldarray become object vars. |
fromJSON(
string $jsonSource, string $keyPrefix
=
'', boolean $setPrimaryKeys
=
false, boolean $rawValues
=
false, boolean $adhocValues
=
false
)
:
void
Sets the object fields from a JSON object string.
Inherited from: \xPDOObject::fromJSON()\modAccessibleObject::fromJSON()\modAccessibleSimpleObject::fromJSON()Name | Type | Description |
---|---|---|
$jsonSource | string | A JSON object string. |
$keyPrefix | string | An optional prefix to strip from the keys. |
$setPrimaryKeys | boolean | Indicates if primary key fields should be set. |
$rawValues | boolean | Indicates if values should be set raw or via {@link xPDOObject::set()}. |
$adhocValues | boolean | Indicates if ad hoc fields should be added to the xPDOObject from the source object. |
get(
string | array $k, string | array $format
=
null, mixed $formatTemplate
=
null
)
:
mixed
Get a field value (or a set of values) by the field key(s) or name(s).
Inherited from: \xPDOObject::get()\modAccessibleObject::get()\modAccessibleSimpleObject::get()Warning: do not use the $format parameter if retrieving multiple values of different types, as the format string will be applied to all types, most likely with unpredicatable results. Optionally, you can supply an associate array of format strings with the field key as the key for the format array.
Name | Type | Description |
---|---|---|
$k | string | array | A string (or an array of strings) representing the field key or name. |
$format | string | array | An optional variable (or an array of variables) to format the return value(s). |
$formatTemplate | mixed | An additional optional variable that can be used in formatting the return value(s). |
Type | Description |
---|---|
mixed | The value(s) of the field(s) requested. |
getFKClass(
string $k
)
:
void
Get the name of a class related by foreign key to a specified field key.
Inherited from: \xPDOObject::getFKClass()\modAccessibleObject::getFKClass()\modAccessibleSimpleObject::getFKClass()This is generally used to lookup classes involved in one-to-one relationships with the current object.
Name | Type | Description |
---|---|---|
$k | string | The field name or key to lookup a related class for. |
getFKDefinition(
string $alias
)
:
array
Get a foreign key definition for a specific classname.
Inherited from: \xPDOObject::getFKDefinition()\modAccessibleObject::getFKDefinition()\modAccessibleSimpleObject::getFKDefinition()This is generally used to lookup classes in a one-to-many relationship with the current object.
Name | Type | Description |
---|---|---|
$alias | string | Alias of the related class to lookup a foreign key definition from. |
Type | Description |
---|---|
array | A foreign key definition. |
getField(
string $key, bool $validate
=
false
)
:
string | bool
Get a field name, looking up any by alias if not an actual field.
Inherited from: \xPDOObject::getField()\modAccessibleObject::getField()\modAccessibleSimpleObject::getField()Name | Type | Description |
---|---|---|
$key | string | The field name or alias to translate to the actual field name. |
$validate | bool | If true, the method will return false if the field or an alias of it is not found. Otherwise, the key is returned as passed. |
Type | Description |
---|---|
string | bool | The actual field name, the key as passed, or false if not a field or alias and validate is true. |
getFieldName(
string $k, string $alias
=
null
)
:
string
Gets a field name as represented in the database container.
Inherited from: \xPDOObject::getFieldName()\modAccessibleObject::getFieldName()\modAccessibleSimpleObject::getFieldName()This gets the name of the field, fully-qualified by either the object table name or a specified alias, and properly quoted.
Name | Type | Description |
---|---|---|
$k | string | The simple name of the field. |
$alias | string | An optional alias for the table in a specific query. |
Type | Description |
---|---|
string | The name of the field, qualified with the table name or an optional table alias. |
getGraph(
boolean | string | array | integer $graph
=
true, \xPDOCriteria | array | string | integer $criteria
=
null, boolean | integer $cacheFlag
=
true
)
:
array | boolean
Load a graph of related objects to the current object.
Inherited from: \xPDOObject::getGraph()\modAccessibleObject::getGraph()\modAccessibleSimpleObject::getGraph()Name | Type | Description |
---|---|---|
$graph | boolean | string | array | integer | An option to tell how to deal with related objects. If integer, will traverse related objects up to a $graph level of depth and load them to the object. If an array, will traverse required related object and load them to the object. If true, will traverse the entire graph and append all related objects to the object (default behavior). |
$criteria | \xPDOCriteria | array | string | integer | A valid xPDO criteria representation. |
$cacheFlag | boolean | integer | Indicates if the objects should be cached and optionally, by specifying an integer value, for how many seconds. |
Type | Description |
---|---|
array | boolean | The graph that was loaded or false if nothing was loaded. |
getIterator(
string $alias, null | array | \xPDOCriteria $criteria
=
null, bool | int $cacheFlag
=
true
)
:
bool | \xPDOIterator
Get an xPDOIterator for a collection of objects related by aggregate or composite relations.
Inherited from: \xPDOObject::getIterator()\modAccessibleObject::getIterator()\modAccessibleSimpleObject::getIterator()Name | Type | Description |
---|---|---|
$alias | string | The alias of the relation. |
$criteria | null | array | \xPDOCriteria | A valid xPDO criteria expression. |
$cacheFlag | bool | int | Indicates if the objects should be cached and optionally, by specifying an integer values, for how many seconds. |
Type | Description |
---|---|
bool | \xPDOIterator | An iterator for the collection or false if no relation is found. |
getMany(
string $alias, object $criteria
=
null, boolean | integer $cacheFlag
=
true
)
:
array
Gets a collection of objects related by aggregate or composite relations.
Inherited from: \xPDOObject::getMany()\modAccessibleObject::getMany()\modAccessibleSimpleObject::getMany()Name | Type | Description |
---|---|---|
$alias | string | Alias of the foreign class representing the related object. |
$criteria | object | xPDOCriteria object to get the related objects |
$cacheFlag | boolean | integer | Indicates if the objects should be cached and optionally, by specifying an integer value, for how many seconds. |
Type | Description |
---|---|
array | A collection of related objects or an empty array. |
getOne(
string $alias, object $criteria
=
null, boolean | integer $cacheFlag
=
true
)
:
\xPDOObject | null
Gets an object related to this instance by a foreign key relationship.
Inherited from: \xPDOObject::getOne()\modAccessibleObject::getOne()\modAccessibleSimpleObject::getOne()Use this for 1:? (one:zero-or-one) or 1:1 relationships, which you can distinguish by setting the nullability of the field representing the foreign key.
For all 1:* relationships for this instance, see {@link getMany()}.
Name | Type | Description |
---|---|---|
$alias | string | Alias of the foreign class representing the related object. |
$criteria | object | xPDOCriteria object to get the related objects |
$cacheFlag | boolean | integer | Indicates if the object should be cached and optionally, by specifying an integer value, for how many seconds. |
Type | Description |
---|---|
\xPDOObject | null | The related object or null if no instance exists. |
getOption(
string $key, array | null $options
=
null, mixed $default
=
null
)
:
mixed
Get an option value for this instance.
Inherited from: \xPDOObject::getOption()\modAccessibleObject::getOption()\modAccessibleSimpleObject::getOption()Name | Type | Description |
---|---|---|
$key | string | The option key to retrieve a value for. |
$options | array | null | An optional array to search for a value in first. |
$default | mixed | A default value to return if no value is found; null is the default. |
Type | Description |
---|---|
mixed | The value of the option or the provided default if it is not set. |
getPK(
)
:
mixed
Gets the name (or names) of the primary key field(s) for the object.
Inherited from: \xPDOObject::getPK()\modAccessibleObject::getPK()\modAccessibleSimpleObject::getPK()Type | Description |
---|---|
mixed | The string (or an array of strings) representing the name(s) of the primary key field(s) for this instance. |
getPKType(
)
:
string
Gets the type of the primary key field for the object.
Inherited from: \xPDOObject::getPKType()\modAccessibleObject::getPKType()\modAccessibleSimpleObject::getPKType()Type | Description |
---|---|
string | The type of the primary key field for this instance. |
getPolicies(
)
:
array
Return the currently loaded array of policies.
Inherited from: \modAccessibleObject::getPolicies()\modAccessibleSimpleObject::getPolicies()Type | Description |
---|---|
array |
getPrimaryKey(
boolean $validateCompound
=
true
)
:
mixed
Gets the value (or values) of the primary key field(s) for the object.
Inherited from: \xPDOObject::getPrimaryKey()\modAccessibleObject::getPrimaryKey()\modAccessibleSimpleObject::getPrimaryKey()Name | Type | Description |
---|---|---|
$validateCompound | boolean | If any of the keys in a compound primary key are empty or null, and the default value is not allowed to be null, do not return an array, instead return null; the default is true |
Type | Description |
---|---|
mixed | The string (or an array) representing the value(s) of the primary key field(s) for this instance. |
getSelectColumns(
\xPDO $xpdo, string $className, string $tableAlias
=
'', string $columnPrefix
=
'', array $columns
=
array (), boolean $exclude
=
false
)
:
string
Get a set of column names from an xPDOObject for use in SQL queries.
Inherited from: \xPDOObject::getSelectColumns()\modAccessibleObject::getSelectColumns()\modAccessibleSimpleObject::getSelectColumns()Name | Type | Description |
---|---|---|
$xpdo | \xPDO | &$xpdo A reference to an initialized xPDO instance. |
$className | string | The class name to get columns from. |
$tableAlias | string | An optional alias for the table in the query. |
$columnPrefix | string | An optional prefix to prepend to each column name. |
$columns | array | An optional array of field names to include or exclude (include is default behavior). |
$exclude | boolean | Determines if any specified columns should be included or excluded from the set of results. |
Type | Description |
---|---|
string | A comma-delimited list of the field names for use in a SELECT clause. |
- Static
getValidator(
)
:
string | boolean
Get the xPDOValidator class configured for this instance.
Inherited from: \xPDOObject::getValidator()\modAccessibleObject::getValidator()\modAccessibleSimpleObject::getValidator()Type | Description |
---|---|
string | boolean | The xPDOValidator instance or false if it could not be loaded. |
isDirty(
string $key
)
:
boolean
Indicates if an object field has been modified (or never saved).
Inherited from: \xPDOObject::isDirty()\modAccessibleObject::isDirty()\modAccessibleSimpleObject::isDirty()Name | Type | Description |
---|---|---|
$key | string | The field name to check. |
Type | Description |
---|---|
boolean | True if the field exists and either has been modified or the object is new. |
- Access
- public
isLazy(
string $key
=
''
)
:
boolean
Indicates if the object or specified field is lazy.
Inherited from: \xPDOObject::isLazy()\modAccessibleObject::isLazy()\modAccessibleSimpleObject::isLazy()Name | Type | Description |
---|---|---|
$key | string | Optional key to check for laziness. |
Type | Description |
---|---|
boolean | True if the field specified or if any field is lazy if no field is specified. |
isNew(
)
:
boolean
Indicates if the instance is new, and has not yet been persisted.
Inherited from: \xPDOObject::isNew()\modAccessibleObject::isNew()\modAccessibleSimpleObject::isNew()Type | Description |
---|---|
boolean | True if the object has not been saved or was loaded from the database. |
isValidated(
string $key
=
''
)
:
boolean
Indicates if the object or specified field has been validated.
Inherited from: \xPDOObject::isValidated()\modAccessibleObject::isValidated()\modAccessibleSimpleObject::isValidated()Name | Type | Description |
---|---|---|
$key | string | Optional key to check for specific validation. |
Type | Description |
---|---|
boolean | True if the object or specified field has been fully validated successfully. |
load(
\xPDO $xpdo, string $className, mixed $criteria, boolean | integer $cacheFlag
=
true
)
:
object | null
Custom instance loader that forces access policy checking.
Inherited from: \modAccessibleObject::load()\modAccessibleSimpleObject::load()Name | Type | Description |
---|---|---|
$xpdo | \xPDO | &$xpdo A valid xPDO instance. |
$className | string | Name of the class. |
$criteria | mixed | A valid primary key, criteria array, or xPDOCriteria instance. |
$cacheFlag | boolean | integer | Indicates if the objects should be cached and optionally, by specifying an integer value, for how many seconds. |
Type | Description |
---|---|
object | null | An instance of the requested class, or null if it could not be instantiated. |
loadCollection(
\xPDO $xpdo, string $className, mixed $criteria
=
null, boolean | integer $cacheFlag
=
true
)
:
array
Custom collection loader that forces access policy checking.
Inherited from: \modAccessibleObject::loadCollection()\modAccessibleSimpleObject::loadCollection()Name | Type | Description |
---|---|---|
$xpdo | \xPDO | &$xpdo A valid xPDO instance. |
$className | string | Name of the class. |
$criteria | mixed | A valid primary key, criteria array, or xPDOCriteria instance. |
$cacheFlag | boolean | integer | Indicates if the objects should be cached and optionally, by specifying an integer value, for how many seconds. |
Type | Description |
---|---|
array | An array of xPDOObject instances or an empty array if no instances are loaded. |
loadCollectionGraph(
\xPDO $xpdo, string $className, string | array $graph, mixed $criteria, boolean | integer $cacheFlag
)
:
array
Load a collection of xPDOObject instances and a graph of related objects.
Inherited from: \xPDOObject::loadCollectionGraph()\modAccessibleObject::loadCollectionGraph()\modAccessibleSimpleObject::loadCollectionGraph()Name | Type | Description |
---|---|---|
$xpdo | \xPDO | &$xpdo A valid xPDO instance. |
$className | string | Name of the class. |
$graph | string | array | A related object graph in array or JSON format, e.g. array('relationAlias'=>array('subRelationAlias'=>array())) or {"relationAlias":{"subRelationAlias":{}}}. Note that the empty arrays are necessary in order for the relation to be recognized. |
$criteria | mixed | A valid primary key, criteria array, or xPDOCriteria instance. |
$cacheFlag | boolean | integer | Indicates if the objects should be cached and optionally, by specifying an integer value, for how many seconds. |
Type | Description |
---|---|
array | An array of xPDOObject instances or an empty array if no instances are loaded. |
- Static
rebuildCache(
array $options
=
array()
)
:
boolean
Rebuilds the action map cache.
Name | Type | Description |
---|---|---|
$options | array | An array of options to pass to the cacheManager->generateActionMap method |
Type | Description |
---|---|
boolean | True if successful. |
- Access
- public
- See
- \modCacheManager::generateActionMap
remove(
array $ancestors
=
array()
)
:
boolean
Overrides xPDOObject::save to cache the actionMap.
Deletes the persistent object isntance stored in the database when called, including any dependent objects defined by composite foreign key relationships.
Name | Type | Description |
---|---|---|
$ancestors | array | Keeps track of classes which have already been removed to prevent loop with circular references. |
Type | Description |
---|---|
boolean | Returns true on success, false on failure. |
removeValidationRules(
string $field
=
null, array $rules
=
array()
)
:
void
Remove one or more validation rules from this instance.
Inherited from: \xPDOObject::removeValidationRules()\modAccessibleObject::removeValidationRules()\modAccessibleSimpleObject::removeValidationRules()Name | Type | Description |
---|---|---|
$field | string | An optional field name to remove rules from. If not specified or null, all rules from all columns will be removed. |
$rules | array | An optional array of rule names to remove if a single field is specified. If $field is null, this parameter is ignored. |
save(
boolean | integer $cacheFlag
=
null
)
:
boolean
Overrides xPDOObject::save to cache the actionMap.
Inserts or updates the database record representing this object and any new or changed related object records. Both aggregate and composite related objects will be saved as appropriate, before or following the save operation on the controlling instance.
Name | Type | Description |
---|---|---|
$cacheFlag | boolean | integer | Indicates if the saved object(s) should be cached and optionally, by specifying an integer value, for how many seconds before expiring. Overrides the cacheFlag for the object(s). |
Type | Description |
---|---|
boolean | Returns true on success, false on failure. |
set(
string $k, mixed $v
=
null, string | \callable $vType
=
''
)
:
boolean
Set a field value by the field key or name.
Inherited from: \xPDOObject::set()\modAccessibleObject::set()\modAccessibleSimpleObject::set()Name | Type | Description |
---|---|---|
$k | string | The field key or name. |
$v | mixed | The value to set the field to. |
$vType | string | \callable | A string indicating the format of the provided value parameter, or a callable function that should be used to set the field value, overriding the default behavior. |
Type | Description |
---|---|
boolean | Determines whether the value was set successfully and was determined to be dirty (i.e. different from the previous value). |
setDirty(
string $key
=
''
)
:
void
Add the field to a collection of field keys that have been modified.
Inherited from: \xPDOObject::setDirty()\modAccessibleObject::setDirty()\modAccessibleSimpleObject::setDirty()This function also clears any validation flag associated with the field.
Name | Type | Description |
---|---|---|
$key | string | The key of the field to set dirty. |
setOption(
string $key, mixed $value
)
:
void
Set an option value for this instance.
Inherited from: \xPDOObject::setOption()\modAccessibleObject::setOption()\modAccessibleSimpleObject::setOption()Name | Type | Description |
---|---|---|
$key | string | The option key to set a value for. |
$value | mixed | A value to assign to the option. |
setPolicies(
array $policies
=
array()
)
:
void
Set the current object's policies.
Inherited from: \modAccessibleObject::setPolicies()\modAccessibleSimpleObject::setPolicies()Name | Type | Description |
---|---|---|
$policies | array |
toArray(
string $keyPrefix
=
'', boolean $rawValues
=
false, boolean $excludeLazy
=
false, boolean | integer | string | array $includeRelated
=
false
)
:
array
Copies the object fields and corresponding values to an associative array.
Inherited from: \xPDOObject::toArray()\modAccessibleObject::toArray()\modAccessibleSimpleObject::toArray()Name | Type | Description |
---|---|---|
$keyPrefix | string | An optional prefix to prepend to the field values. |
$rawValues | boolean | An optional flag indicating if you want the raw values instead of those returned by the {@link xPDOObject::get()} function. |
$excludeLazy | boolean | An option flag indicating if you want to exclude lazy fields from the resulting array; the default behavior is to include them which means the object will query the database for the lazy fields before providing the value. |
$includeRelated | boolean | integer | string | array | Describes if and how to include loaded related object fields. As an integer all loaded related objects in the graph up to that level of depth will be included. As a string, only loaded related objects matching the JSON graph representation will be included. As an array, only loaded related objects matching the graph array will be included. As boolean true, all currently loaded related objects will be included. |
Type | Description |
---|---|
array | An array representation of the object fields/values. |
toJSON(
string $keyPrefix
=
'', boolean $rawValues
=
false
)
:
string
Returns a JSON representation of the object.
Inherited from: \xPDOObject::toJSON()\modAccessibleObject::toJSON()\modAccessibleSimpleObject::toJSON()Name | Type | Description |
---|---|---|
$keyPrefix | string | An optional prefix to prepend to the field keys. |
$rawValues | boolean | An optional flag indicating if the field values should be returned raw or via {@link xPDOObject::get()}. |
Type | Description |
---|---|
string | A JSON string representing the object. |
validate(
array $options
=
array()
)
:
boolean
Validate the field values using an xPDOValidator.
Inherited from: \xPDOObject::validate()\modAccessibleObject::validate()\modAccessibleSimpleObject::validate()Name | Type | Description |
---|---|---|
$options | array | An array of options to pass to the validator. |
Type | Description |
---|---|
boolean | True if validation was successful. |