core/model/modx/modtemplatevar.class.php

&$xpdo A valid xPDO instance.

&$objCollection The collection to load the instance into.

Name of the class.

A valid primary key, criteria array, or xPDOCriteria instance.

Indicates if the objects should be cached and optionally, by specifying an integer value, for how many seconds.

A reference to the xPDO/modX object.

The name of the class by which to grab the instance from

A criteria to use when grabbing this instance

The row to select

&$xpdo A valid xPDO instance.

Name of the class.

A valid xPDOCriteria instance.

Indicates if the schema validation rules should be reloaded.

The field name to create a reference to.

The name of the reference.

&$obj A single object or collection of objects to be related to this instance via the intersection class.

An optional alias, required only for instances where you have more than one relation defined to the same class.

&$obj A single object to be related to this instance.

The relation alias of the related object (only required if more than one relation exists to the same foreign class).

A modPropertySet object or the name of a modPropertySet object to create a relationship with.

The field key to apply the rule to.

A name to identify the rule.

The type of rule.

The rule definition.

Any input parameters for the rule.

An associative array providing a key and value to search for within the matched policy attributes between policy and principal.

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.

The string source to encode.

The type of encoding algorithm to apply, md5 by default.

An associative array of key => values.

Specify an optional prefix to strip from all array keys in fldarray.

Optional param to set generated primary keys.

Optional way to set values without calling the {@link xPDOObject::set()} method.

Optional way to set adhoc values so that all the values of fldarray become object vars.

A JSON object string.

An optional prefix to strip from the keys.

Indicates if primary key fields should be set.

Indicates if values should be set raw or via {@link xPDOObject::set()}.

Indicates if ad hoc fields should be added to the xPDOObject from the source object.

A string (or an array of strings) representing the field key or name.

An optional variable (or an array of variables) to format the return value(s).

An additional optional variable that can be used in formatting the return value(s).

An array of options implementations can use to accept language, revision identifiers, or other information to alter the behavior of the method.

The field name or key to lookup a related class for.

Alias of the related class to lookup a foreign key definition from.

The field name or alias to translate to the actual field name.

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.

The simple name of the field.

An optional alias for the table in a specific query.

An array of options.

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).

A valid xPDO criteria representation.

Indicates if the objects should be cached and optionally, by specifying an integer value, for how many seconds.

The alias of the relation.

A valid xPDO criteria expression.

Indicates if the objects should be cached and optionally, by specifying an integer values, for how many seconds.

Alias of the foreign class representing the related object.

xPDOCriteria object to get the related objects

Indicates if the objects should be cached and optionally, by specifying an integer value, for how many seconds.

Alias of the foreign class representing the related object.

xPDOCriteria object to get the related objects

Indicates if the object should be cached and optionally, by specifying an integer value, for how many seconds.

The option key to retrieve a value for.

An optional array to search for a value in first.

A default value to return if no value is found; null is the default.

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

An array or string of properties to apply.

An explicit property set name to search for.

&$xpdo A reference to an initialized xPDO instance.

The class name to get columns from.

An optional alias for the table in the query.

An optional prefix to prepend to each column name.

An optional array of field names to include or exclude (include is default behavior).

Determines if any specified columns should be included or excluded from the set of results.

An array of options.

An array of options.

The field name to check.

Optional key to check for laziness.

Optional key to check for specific validation.

&$xpdo A valid xPDO instance.

Name of the class.

A valid primary key, criteria array, or xPDOCriteria instance.

Indicates if the objects should be cached and optionally, by specifying an integer value, for how many seconds.

&$xpdo A valid xPDO instance.

Name of the class.

A valid primary key, criteria array, or xPDOCriteria instance.

Indicates if the objects should be cached and optionally, by specifying an integer value, for how many seconds.

&$xpdo A valid xPDO instance.

Name of the class.

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.

A valid primary key, criteria array, or xPDOCriteria instance.

Indicates if the objects should be cached and optionally, by specifying an integer value, for how many seconds.

A modPropertySet object or the name of a modPropertySet object to dissociate from.

An optional field name to remove rules from. If not specified or null, all rules from all columns will be removed.

An optional array of rule names to remove if a single field is specified. If $field is null, this parameter is ignored.

The field key or name.

The value to set the field to.

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.

Indicates the value to set for cacheability of this element.

The source content; implementations can decide if it can only be a string, or some other source from which to retrieve it.

An array of options implementations can use to accept language, revision identifiers, or other information to alter the behavior of the method.

The key of the field to set dirty.

The content to set.

An array of options.

The option key to set a value for.

A value to assign to the option.

A property array or property string.

Indicates if properties should be merged with existing ones.

The source to use for this element.

The tag to use for this element.

The token to use for this element tag.

An optional prefix to prepend to the field values.

An optional flag indicating if you want the raw values instead of those returned by the {@link xPDOObject::get()} function.

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.

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.

An optional prefix to prepend to the field keys.

An optional flag indicating if the field values should be returned raw or via {@link xPDOObject::get()}.

An array of options to pass to the validator.