array $fieldNames = null (line 73)

Names of the fields in the data table, fully-qualified with a table name.

NOTE: For use in table joins to qualify fields with the same name.

• access: public

array $_aggregates = array () (line 157)

An array of aggregate foreign key relationships for the class.

• access: public

boolean $_cacheFlag = true (line 212)

Indicates the cacheability of the instance.

• access: public

array $_composites = array () (line 164)

An array of composite foreign key relationships for the class.

• access: public

array $_fieldMeta = array () (line 150)

An array of metadata definitions for each field in the class.

• access: public

array $_lazy = array () (line 136)

An array of field names that have not been loaded from the source.

• access: public

array $_options = array() (line 218)

A collection of various options that can be used on the instance.

• access: public

string|array $_pk = null (line 98)

The primary key field (or an array of primary key fields) for this object.

• access: public

array $_relatedObjects = array () (line 171)

An array of object instances related to this object instance.

• access: public

string $_tableMeta = null (line 122)

An array of meta data for the table.

• access: public

boolean $_validationLoaded = false (line 199)

Indicates if the validation map has been loaded.

• access: public

xPDOValidator $_validator = null (line 178)

A validator object responsible for this object instance.

• access: public

static load (line 400)

Load an instance of an xPDOObject or derivative class.

• return: An instance of the requested class, or null if it could not be instantiated.
• access: public
• usedby: xPDO::getObject()

• xPDO &$xpdo: A valid xPDO instance.
• string $className: Name of the class.
• mixed $criteria: A valid primary key, criteria array, or xPDOCriteria instance.
• boolean|integer $cacheFlag: Indicates if the objects should be cached and optionally, by specifying an integer value, for how many seconds.

static loadCollectionGraph (line 511)

Load a collection of xPDOObject instances and a graph of related objects.

• return: An array of xPDOObject instances or an empty array if no instances are loaded.
• access: public

• xPDO &$xpdo: A valid xPDO instance.
• string $className: Name of the class.
• string|array $graph: 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.
• mixed $criteria: A valid primary key, criteria array, or xPDOCriteria instance.
• boolean|integer $cacheFlag: Indicates if the objects should be cached and optionally, by specifying an integer value, for how many seconds.

static _loadInstance (line 293)

Loads an instance from an associative array.

• return: A new xPDOObject derivative representing a data row.
• access: public

• xPDO &$xpdo: A valid xPDO instance.
• string $className: Name of the class.
• mixed $criteria: A valid xPDOQuery instance or relation alias.
• array $row: The associative array containing the instance data.

Constructor __construct (line 596)

Constructor

Do not call the constructor directly; see 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.

• access: public

• xPDO &$xpdo: A reference to a valid xPDO instance.

addOne (line 1068)

Adds an object related to this instance by a foreign key relationship.

• return: True if the related object was added to this object.
• see: xPDOObject::addMany()
• see: xPDOObject::getMany()
• see: xPDOObject::getOne()
• access: public

• mixed &$obj: A single object to be related to this instance.
• string $alias: The relation alias of the related object (only required if more than one relation exists to the same foreign class).

encode (line 1973)

Encodes a string using the specified algorithm.

NOTE: This implementation currently only implements md5. To implement additional algorithms, override this function in your xPDOObject derivative classes.

• return: The encoded string.
• access: public

• string $source: The string source to encode.
• string $type: The type of encoding algorithm to apply, md5 by default.

fromJSON (line 1954)

Sets the object fields from a JSON object string.

• access: public

• string $jsonSource: A JSON object string.
• string $keyPrefix: An optional prefix to strip from the keys.
• boolean $setPrimaryKeys: Indicates if primary key fields should be set.
• boolean $rawValues: Indicates if values should be set raw or via xPDOObject::set().
• boolean $adhocValues: Indicates if ad hoc fields should be added to the xPDOObject from the source object.

getFieldName (line 1625)

Gets a field name as represented in the database container.

This gets the name of the field, fully-qualified by either the object table name or a specified alias, and properly quoted.

• return: The name of the field, qualified with the table name or an optional table alias.
• access: public

• string $k: The simple name of the field.
• string $alias: An optional alias for the table in a specific query.

getFKDefinition (line 1610)

Get a foreign key definition for a specific classname.

This is generally used to lookup classes in a one-to-many relationship with the current object.

• return: A foreign key definition.
• access: public

• string $alias: Alias of the related class to lookup a foreign key definition from.

getOne (line 1013)

Gets an object related to this instance by a foreign key relationship.

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

• return: The related object or null if no instance exists.
• see: xPDOObject::addMany()
• see: xPDOObject::addOne()
• see: xPDOObject::getMany()
• access: public

• string $alias: Alias of the foreign class representing the related object.
• object $criteria: xPDOCriteria object to get the related objects
• boolean|integer $cacheFlag: Indicates if the object should be cached and optionally, by specifying an integer value, for how many seconds.

getPK (line 1545)

Gets the name (or names) of the primary key field(s) for the object.

• return: The string (or an array of strings) representing the name(s) of the primary key field(s) for this instance.
• access: public

getPrimaryKey (line 1507)

Gets the value (or values) of the primary key field(s) for the object.

• return: The string (or an array) representing the value(s) of the primary key field(s) for this instance.
• access: public

• boolean $validateCompound: 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

isDirty (line 1998)

Indicates if an object field has been modified (or never saved).

• return: True if the field exists and either has been modified or the object is new.
• access: public

• string $key: The field name to check.

isNew (line 2035)

Indicates if the instance is new, and has not yet been persisted.

• return: True if the object has not been saved or was loaded from the database.
• access: public

remove (line 1441)

Remove the persistent instance of an object permanently.

Deletes the persistent object isntance stored in the database when called, including any dependent objects defined by composite foreign key relationships.

• return: Returns true on success, false on failure.
• todo: Implement some way to reassign ownership of related composite objects when remove is called, perhaps by passing another object instance as an optional parameter, or creating a separate method.
• access: public

• array $ancestors: Keeps track of classes which have already been removed to prevent loop with circular references.

save (line 1181)

Persist new or changed objects to the database container.

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.

• return: Returns true on success, false on failure.
• access: public

• boolean|integer $cacheFlag: 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).

setDirty (line 2017)

Add the field to a collection of field keys that have been modified.

This function also clears any validation flag associated with the field.

• access: public

• string $key: The key of the field to set dirty.

toArray (line 1650)

Copies the object fields and corresponding values to an associative array.

• return: An array representation of the object fields/values.
• access: public

• string $keyPrefix: An optional prefix to prepend to the field values.
• boolean $rawValues: An optional flag indicating if you want the raw values instead of those returned by the xPDOObject::get() function.
• boolean $excludeLazy: 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.

validate (line 1824)

Validate the field values using an xPDOValidator.

• return: True if validation was successful.
• access: public

• array $options: An array of options to pass to the validator.

_getDataType (line 2046)

Gets the database data type for the specified field.

• return: The DB data type of the field.
• access: protected

• string $key: The field name to get the data type for.

_getRelatedObjectsByFK (line 1886)

Gets related objects by a foreign key and specified criteria.

• return: A collection of objects matching the criteria.
• access: protected

• string $alias: The alias representing the relationship.
• mixed $criteria: An optional xPDO criteria expression.
• boolean|integer $cacheFlag: 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.

_loadFieldData (line 2080)

Load persistent data from the source for the field(s) indicated.

• access: protected

• string|array $fields: A field name or array of field names to load from the data source.

_saveRelatedObject (line 1401)

Save a related object with pending changes.

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.

• return: True if a related object was dirty and saved successfully.
• access: protected
• usedby: xPDOObject::_saveRelatedObjects()

• xPDOObject &$obj: A reference to the related object.
• array $fkMeta: The meta data representing the relation.

_setRaw (line 2100)

Set a raw value on a field converted to the appropriate type.

• return: Returns true if the value was set, false otherwise.
• access: protected

• string $key: The key identifying the field to set.
• mixed $val: The value to set.