core/model/modx/sqlsrv/modprincipal.class.php

Show: inherited
Table of Contents

Package
modx  
Subpackage
sqlsrv  

\modPrincipal_sqlsrv

Package: modx\sqlsrv

Represents a person or system that will access modX.

{@internal Implement a derivative to define the behavior and attributes of an actual user or system that is intended to access modX or a modX service.}

Parent(s)
\modPrincipal < \xPDOSimpleObject < \xPDOObject

Properties

Propertypublicarray  $_aggregates= 'array ()'
inherited

An array of aggregate foreign key relationships for the class.

Inherited from: \xPDOObject::$$_aggregates\xPDOSimpleObject::$$_aggregates\modPrincipal::$$_aggregates
Default valuearray ()Details
Type
array
Access
public  
Inherited_from
\xPDOObject::$$_aggregates  
Inherited_from
\xPDOSimpleObject::$$_aggregates  
Inherited_from
\modPrincipal::$$_aggregates  
Propertypublicstring  $_alias= 'null'
inherited

An alias for this instance of the class.

Inherited from: \xPDOObject::$$_alias\xPDOSimpleObject::$$_alias\modPrincipal::$$_alias
Default valuenullDetails
Type
string
Inherited_from
\xPDOObject::$$_alias  
Inherited_from
\xPDOSimpleObject::$$_alias  
Inherited_from
\modPrincipal::$$_alias  
Propertyprotectedarray  $_attributes= 'null'
inherited

Stores a collection of key-value pairs identifying policy authority.

Inherited from: \modPrincipal::$$_attributes
Default valuenullDetails
Type
array
Access
protected  
Inherited_from
\modPrincipal::$$_attributes  
Propertypublicboolean  $_cacheFlag= 'true'
inherited

Indicates the cacheability of the instance.

Inherited from: \xPDOObject::$$_cacheFlag\xPDOSimpleObject::$$_cacheFlag\modPrincipal::$$_cacheFlag
Default valuetrueDetails
Type
boolean
Inherited_from
\xPDOObject::$$_cacheFlag  
Inherited_from
\xPDOSimpleObject::$$_cacheFlag  
Inherited_from
\modPrincipal::$$_cacheFlag  
Propertypublicstring  $_class= 'null'
inherited

The actual class name of an instance.

Inherited from: \xPDOObject::$$_class\xPDOSimpleObject::$$_class\modPrincipal::$$_class
Default valuenullDetails
Type
string
Inherited_from
\xPDOObject::$$_class  
Inherited_from
\xPDOSimpleObject::$$_class  
Inherited_from
\modPrincipal::$$_class  
Propertypublicarray  $_composites= 'array ()'
inherited

An array of composite foreign key relationships for the class.

Inherited from: \xPDOObject::$$_composites\xPDOSimpleObject::$$_composites\modPrincipal::$$_composites
Default valuearray ()Details
Type
array
Access
public  
Inherited_from
\xPDOObject::$$_composites  
Inherited_from
\xPDOSimpleObject::$$_composites  
Inherited_from
\modPrincipal::$$_composites  
Propertypublicarray  $_dirty= 'array ()'
inherited

An array of field names that have been modified.

Inherited from: \xPDOObject::$$_dirty\xPDOSimpleObject::$$_dirty\modPrincipal::$$_dirty
Default valuearray ()Details
Type
array
Access
public  
Inherited_from
\xPDOObject::$$_dirty  
Inherited_from
\xPDOSimpleObject::$$_dirty  
Inherited_from
\modPrincipal::$$_dirty  
Propertypublicarray  $_fieldAliases= 'array()'
inherited

An optional array of field aliases.

Inherited from: \xPDOObject::$$_fieldAliases\xPDOSimpleObject::$$_fieldAliases\modPrincipal::$$_fieldAliases
Default valuearray()Details
Type
array
Inherited_from
\xPDOObject::$$_fieldAliases  
Inherited_from
\xPDOSimpleObject::$$_fieldAliases  
Inherited_from
\modPrincipal::$$_fieldAliases  
Propertypublicarray  $_fieldMeta= 'array ()'
inherited

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

Inherited from: \xPDOObject::$$_fieldMeta\xPDOSimpleObject::$$_fieldMeta\modPrincipal::$$_fieldMeta
Default valuearray ()Details
Type
array
Access
public  
Inherited_from
\xPDOObject::$$_fieldMeta  
Inherited_from
\xPDOSimpleObject::$$_fieldMeta  
Inherited_from
\modPrincipal::$$_fieldMeta  
Propertypublicarray  $_fields= 'array ()'
inherited

An array of key-value pairs representing the fields of the instance.

Inherited from: \xPDOObject::$$_fields\xPDOSimpleObject::$$_fields\modPrincipal::$$_fields
Default valuearray ()Details
Type
array
Access
public  
Inherited_from
\xPDOObject::$$_fields  
Inherited_from
\xPDOSimpleObject::$$_fields  
Inherited_from
\modPrincipal::$$_fields  
Propertypublicarray  $_lazy= 'array ()'
inherited

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

Inherited from: \xPDOObject::$$_lazy\xPDOSimpleObject::$$_lazy\modPrincipal::$$_lazy
Default valuearray ()Details
Type
array
Access
public  
Inherited_from
\xPDOObject::$$_lazy  
Inherited_from
\xPDOSimpleObject::$$_lazy  
Inherited_from
\modPrincipal::$$_lazy  
Propertypublicboolean  $_new= 'true'
inherited

Indicates if the instance is transient (and thus new).

Inherited from: \xPDOObject::$$_new\xPDOSimpleObject::$$_new\modPrincipal::$$_new
Default valuetrueDetails
Type
boolean
Access
public  
Inherited_from
\xPDOObject::$$_new  
Inherited_from
\xPDOSimpleObject::$$_new  
Inherited_from
\modPrincipal::$$_new  
Propertypublicarray  $_options= 'array()'
inherited

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

Inherited from: \xPDOObject::$$_options\xPDOSimpleObject::$$_options\modPrincipal::$$_options
Default valuearray()Details
Type
array
Inherited_from
\xPDOObject::$$_options  
Inherited_from
\xPDOSimpleObject::$$_options  
Inherited_from
\modPrincipal::$$_options  
Propertypublicstring  $_package= 'null'
inherited

The package the class is a part of.

Inherited from: \xPDOObject::$$_package\xPDOSimpleObject::$$_package\modPrincipal::$$_package
Default valuenullDetails
Type
string
Inherited_from
\xPDOObject::$$_package  
Inherited_from
\xPDOSimpleObject::$$_package  
Inherited_from
\modPrincipal::$$_package  
Propertypublicstring|array  $_pk= 'null'
inherited

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

Inherited from: \xPDOObject::$$_pk\xPDOSimpleObject::$$_pk\modPrincipal::$$_pk
Default valuenullDetails
Type
string | array
Access
public  
Inherited_from
\xPDOObject::$$_pk  
Inherited_from
\xPDOSimpleObject::$$_pk  
Inherited_from
\modPrincipal::$$_pk  
Propertypublicstring|array  $_pktype= 'null'
inherited

The php native type of the primary key field.

Inherited from: \xPDOObject::$$_pktype\xPDOSimpleObject::$$_pktype\modPrincipal::$$_pktype

NOTE: Will be an array if multiple primary keys are specified for the object.

Default valuenullDetails
Type
string | array
Access
public  
Inherited_from
\xPDOObject::$$_pktype  
Inherited_from
\xPDOSimpleObject::$$_pktype  
Inherited_from
\modPrincipal::$$_pktype  
Propertypublicarray  $_relatedObjects= 'array ()'
inherited

An array of object instances related to this object instance.

Inherited from: \xPDOObject::$$_relatedObjects\xPDOSimpleObject::$$_relatedObjects\modPrincipal::$$_relatedObjects
Default valuearray ()Details
Type
array
Access
public  
Inherited_from
\xPDOObject::$$_relatedObjects  
Inherited_from
\xPDOSimpleObject::$$_relatedObjects  
Inherited_from
\modPrincipal::$$_relatedObjects  
Propertypublicstring  $_table= 'null'
inherited

Name of the actual table representing this class.

Inherited from: \xPDOObject::$$_table\xPDOSimpleObject::$$_table\modPrincipal::$$_table
Default valuenullDetails
Type
string
Access
public  
Inherited_from
\xPDOObject::$$_table  
Inherited_from
\xPDOSimpleObject::$$_table  
Inherited_from
\modPrincipal::$$_table  
Propertypublicstring  $_tableMeta= 'null'
inherited

An array of meta data for the table.

Inherited from: \xPDOObject::$$_tableMeta\xPDOSimpleObject::$$_tableMeta\modPrincipal::$$_tableMeta
Default valuenullDetails
Type
string
Access
public  
Inherited_from
\xPDOObject::$$_tableMeta  
Inherited_from
\xPDOSimpleObject::$$_tableMeta  
Inherited_from
\modPrincipal::$$_tableMeta  
Propertypublicarray  $_validated= 'array ()'
inherited

An array of field names that have been already validated.

Inherited from: \xPDOObject::$$_validated\xPDOSimpleObject::$$_validated\modPrincipal::$$_validated
Default valuearray ()Details
Type
array
Access
public  
Inherited_from
\xPDOObject::$$_validated  
Inherited_from
\xPDOSimpleObject::$$_validated  
Inherited_from
\modPrincipal::$$_validated  
Propertypublicboolean  $_validationLoaded= 'false'
inherited

Indicates if the validation map has been loaded.

Inherited from: \xPDOObject::$$_validationLoaded\xPDOSimpleObject::$$_validationLoaded\modPrincipal::$$_validationLoaded
Default valuefalseDetails
Type
boolean
Access
public  
Inherited_from
\xPDOObject::$$_validationLoaded  
Inherited_from
\xPDOSimpleObject::$$_validationLoaded  
Inherited_from
\modPrincipal::$$_validationLoaded  
Propertypublicarray  $_validationRules= 'array()'
inherited

An array of validation rules for this object instance.

Inherited from: \xPDOObject::$$_validationRules\xPDOSimpleObject::$$_validationRules\modPrincipal::$$_validationRules
Default valuearray()Details
Type
array
Access
public  
Inherited_from
\xPDOObject::$$_validationRules  
Inherited_from
\xPDOSimpleObject::$$_validationRules  
Inherited_from
\modPrincipal::$$_validationRules  
Propertypublic\xPDOValidator  $_validator= 'null'
inherited

A validator object responsible for this object instance.

Inherited from: \xPDOObject::$$_validator\xPDOSimpleObject::$$_validator\modPrincipal::$$_validator
Default valuenullDetails
Type
\xPDOValidator
Access
public  
Inherited_from
\xPDOObject::$$_validator  
Inherited_from
\xPDOSimpleObject::$$_validator  
Inherited_from
\modPrincipal::$$_validator  
Propertypublicstring  $container= 'null'
inherited

Name of the data source container the object belongs to.

Inherited from: \xPDOObject::$$container\xPDOSimpleObject::$$container\modPrincipal::$$container
Default valuenullDetails
Type
string
Access
public  
Inherited_from
\xPDOObject::$$container  
Inherited_from
\xPDOSimpleObject::$$container  
Inherited_from
\modPrincipal::$$container  
Propertypublicarray  $fieldNames= 'null'
inherited

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

Inherited from: \xPDOObject::$$fieldNames\xPDOSimpleObject::$$fieldNames\modPrincipal::$$fieldNames

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

Default valuenullDetails
Type
array
Access
public  
Inherited_from
\xPDOObject::$$fieldNames  
Inherited_from
\xPDOSimpleObject::$$fieldNames  
Inherited_from
\modPrincipal::$$fieldNames  
Propertypublic\xPDO  $xpdo= 'null'
inherited

A convenience reference to the xPDO object.

Inherited from: \xPDOObject::$$xpdo\xPDOSimpleObject::$$xpdo\modPrincipal::$$xpdo
Default valuenullDetails
Type
\xPDO
Access
public  
Inherited_from
\xPDOObject::$$xpdo  
Inherited_from
\xPDOSimpleObject::$$xpdo  
Inherited_from
\modPrincipal::$$xpdo  

Methods

methodpublic__construct( \xPDO $xpdo ) : \xPDOObject

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
}
Parameters
Name Type Description
$xpdo \xPDO

&$xpdo A reference to a valid xPDO instance.

Returns
Type Description
\xPDOObject
Details
Access
public  
methodprotected_getAliases( string $class, int $limit = 0 ) : array
inherited

Find aliases for any defined object relations of the specified class.

Inherited from: \xPDOObject::_getAliases()\xPDOSimpleObject::_getAliases()\modPrincipal::_getAliases()
Parameters
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.

Returns
Type Description
array An array of aliases or an empty array if none are found.
Details
Access
protected  
methodprotected_getDataType( string $key ) : string
inherited

Gets the database data type for the specified field.

Inherited from: \xPDOObject::_getDataType()\xPDOSimpleObject::_getDataType()\modPrincipal::_getDataType()
Parameters
Name Type Description
$key string

The field name to get the data type for.

Returns
Type Description
string The DB data type of the field.
Details
Access
protected  
methodprotected_getPHPType( string $key ) : string
inherited

Gets the php data type for the specified field.

Inherited from: \xPDOObject::_getPHPType()\xPDOSimpleObject::_getPHPType()\modPrincipal::_getPHPType()
Parameters
Name Type Description
$key string

The field name to get the data type for.

Returns
Type Description
string The PHP data type of the field.
Details
Access
protected  
methodprotected_getRelatedObjectsByFK( string $alias, mixed $criteria = null, boolean | integer $cacheFlag = true ) : array
inherited

Gets related objects by a foreign key and specified criteria.

Inherited from: \xPDOObject::_getRelatedObjectsByFK()\xPDOSimpleObject::_getRelatedObjectsByFK()\modPrincipal::_getRelatedObjectsByFK()
Parameters
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.

Returns
Type Description
array A collection of objects matching the criteria.
Details
Access
protected  
methodprotected_initFields( ) : void
inherited

Initializes the field names with the qualified table name.

Inherited from: \xPDOObject::_initFields()\xPDOSimpleObject::_initFields()\modPrincipal::_initFields()

Once this is called, you can lookup the qualified name by the field name itself in {@link xPDOObject::$fieldNames}.

Details
Access
protected  
methodpublic_loadCollectionInstance( \xPDO $xpdo, array $objCollection, string $className, mixed $criteria,  $row,  $fromCache, boolean | integer $cacheFlag = true ) : void
staticinherited

Responsible for loading an instance into a collection.

Inherited from: \xPDOObject::_loadCollectionInstance()\xPDOSimpleObject::_loadCollectionInstance()\modPrincipal::_loadCollectionInstance()
Parameters
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.

Details
Static
 
methodprotected_loadFieldData( string | array $fields ) : void
inherited

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

Inherited from: \xPDOObject::_loadFieldData()\xPDOSimpleObject::_loadFieldData()\modPrincipal::_loadFieldData()
Parameters
Name Type Description
$fields string | array

A field name or array of field names to load from the data source.

Details
Access
protected  
methodpublic_loadInstance( \xPDO $xpdo, string $className, \xPDOQuery | string $criteria, array $row ) : \xPDOObject
staticinherited

Loads an instance from an associative array.

Inherited from: \xPDOObject::_loadInstance()\xPDOSimpleObject::_loadInstance()\modPrincipal::_loadInstance()
Parameters
Name Type Description
$xpdo \xPDO

&$xpdo A valid xPDO instance.

$className string

Name of the class.

$criteria \xPDOQuery | string

A valid xPDOQuery instance or relation alias.

$row array

The associative array containing the instance data.

Returns
Type Description
\xPDOObject A new xPDOObject derivative representing a data row.
Details
Static
 
methodpublic_loadRows( \xPDO $xpdo, string $className, \xPDOCriteria $criteria ) : \PDOStatement
staticinherited

Responsible for loading a result set from the database.

Inherited from: \xPDOObject::_loadRows()\xPDOSimpleObject::_loadRows()\modPrincipal::_loadRows()
Parameters
Name Type Description
$xpdo \xPDO

&$xpdo A valid xPDO instance.

$className string

Name of the class.

$criteria \xPDOCriteria

A valid xPDOCriteria instance.

Returns
Type Description
\PDOStatement A reference to a PDOStatement representing the result set.
Details
Static
 
methodpublic_loadValidation( boolean $reload = false ) : void
inherited

Used to load validation from the object map.

Inherited from: \xPDOObject::_loadValidation()\xPDOSimpleObject::_loadValidation()\modPrincipal::_loadValidation()
Parameters
Name Type Description
$reload boolean

Indicates if the schema validation rules should be reloaded.

Details
Access
public  
methodprotected_saveRelatedObject( \xPDOObject $obj, array $fkMeta ) : boolean

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.

Parameters
Name Type Description
$obj \xPDOObject

&$obj A reference to the related object.

$fkMeta array

The meta data representing the relation.

Returns
Type Description
boolean True if a related object was dirty and saved successfully.
Details
Access
protected  
methodprotected_saveRelatedObjects( ) : integer
inherited

Searches for any related objects with pending changes to save.

Inherited from: \xPDOObject::_saveRelatedObjects()\xPDOSimpleObject::_saveRelatedObjects()\modPrincipal::_saveRelatedObjects()
Returns
Type Description
integer The number of related objects processed.
Details
Access
protected  
Uses
\xPDOObject::_saveRelatedObject()  
methodprotected_setRaw( string $key, mixed $val ) : boolean
inherited

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

Inherited from: \xPDOObject::_setRaw()\xPDOSimpleObject::_setRaw()\modPrincipal::_setRaw()
Parameters
Name Type Description
$key string

The key identifying the field to set.

$val mixed

The value to set.

Returns
Type Description
boolean Returns true if the value was set, false otherwise.
Details
Access
protected  
methodpublicaddFieldAlias( string $field, string $alias ) : bool
inherited

Add an alias as a reference to an actual field of the object.

Inherited from: \xPDOObject::addFieldAlias()\xPDOSimpleObject::addFieldAlias()\modPrincipal::addFieldAlias()
Parameters
Name Type Description
$field string

The field name to create a reference to.

$alias string

The name of the reference.

Returns
Type Description
bool True if the reference is added successfully.
methodpublicaddMany( mixed $obj, string $alias = '' ) : boolean
inherited

Adds an object or collection of objects related to this class.

Inherited from: \xPDOObject::addMany()\xPDOSimpleObject::addMany()\modPrincipal::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.

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

Returns
Type Description
boolean Indicates if the addMany was successful.
Details
See
\xPDOObject::addOne()  
See
\xPDOObject::getOne()  
See
\xPDOObject::getMany()  
methodpublicaddOne( mixed $obj, string $alias = '' ) : boolean
inherited

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

Inherited from: \xPDOObject::addOne()\xPDOSimpleObject::addOne()\modPrincipal::addOne()
Parameters
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).

Returns
Type Description
boolean True if the related object was added to this object.
Details
See
\xPDOObject::getOne()  
See
\xPDOObject::getMany()  
See
\xPDOObject::addMany()  
methodpublicaddValidationRule( string $field, string $name, string $type, string $rule, array $parameters = array() ) : void
inherited

Add a validation rule to an object field for this instance.

Inherited from: \xPDOObject::addValidationRule()\xPDOSimpleObject::addValidationRule()\modPrincipal::addValidationRule()
Parameters
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.

methodpublicencode( string $source, string $type = 'md5' ) : string
inherited

Encodes a string using the specified algorithm.

Inherited from: \xPDOObject::encode()\xPDOSimpleObject::encode()\modPrincipal::encode()

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

Parameters
Name Type Description
$source string

The string source to encode.

$type string

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

Returns
Type Description
string The encoded string.
methodpublicfromArray( array $fldarray, string $keyPrefix = '', boolean $setPrimaryKeys = false, boolean $rawValues = false, boolean $adhocValues = false ) : void
inherited

Sets object fields from an associative array of key => value pairs.

Inherited from: \xPDOObject::fromArray()\xPDOSimpleObject::fromArray()\modPrincipal::fromArray()
Parameters
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.

methodpublicfromJSON( string $jsonSource, string $keyPrefix = '', boolean $setPrimaryKeys = false, boolean $rawValues = false, boolean $adhocValues = false ) : void
inherited

Sets the object fields from a JSON object string.

Inherited from: \xPDOObject::fromJSON()\xPDOSimpleObject::fromJSON()\modPrincipal::fromJSON()
Parameters
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.

methodpublicget( string | array $k, string | array $format = null, mixed $formatTemplate = null ) : mixed
inherited

Get a field value (or a set of values) by the field key(s) or name(s).

Inherited from: \xPDOObject::get()\xPDOSimpleObject::get()\modPrincipal::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.

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

Returns
Type Description
mixed The value(s) of the field(s) requested.
methodpublicgetAttributes( array $targets = array(), string $context = '', boolean $reload = false ) : array
inherited

Get the attributes for this principal.

Inherited from: \modPrincipal::getAttributes()
Parameters
Name Type Description
$targets array

An array of target modAccess classes to load.

$context string

The context to check within. Defaults to active context.

$reload boolean

If true, the attributes will be reloaded and the session updated.

Returns
Type Description
array An array of attributes on the principal
methodpublicgetFKClass( string $k ) : void
inherited

Get the name of a class related by foreign key to a specified field key.

Inherited from: \xPDOObject::getFKClass()\xPDOSimpleObject::getFKClass()\modPrincipal::getFKClass()

This is generally used to lookup classes involved in one-to-one relationships with the current object.

Parameters
Name Type Description
$k string

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

methodpublicgetFKDefinition( string $alias ) : array
inherited

Get a foreign key definition for a specific classname.

Inherited from: \xPDOObject::getFKDefinition()\xPDOSimpleObject::getFKDefinition()\modPrincipal::getFKDefinition()

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

Parameters
Name Type Description
$alias string

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

Returns
Type Description
array A foreign key definition.
methodpublicgetField( string $key, bool $validate = false ) : string | bool
inherited

Get a field name, looking up any by alias if not an actual field.

Inherited from: \xPDOObject::getField()\xPDOSimpleObject::getField()\modPrincipal::getField()
Parameters
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.

Returns
Type Description
string | bool The actual field name, the key as passed, or false if not a field or alias and validate is true.
methodpublicgetFieldName( string $k, string $alias = null ) : string
inherited

Gets a field name as represented in the database container.

Inherited from: \xPDOObject::getFieldName()\xPDOSimpleObject::getFieldName()\modPrincipal::getFieldName()

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

Parameters
Name Type Description
$k string

The simple name of the field.

$alias string

An optional alias for the table in a specific query.

Returns
Type Description
string The name of the field, qualified with the table name or an optional table alias.
methodpublicgetGraph( boolean | string | array | integer $graph = true, \xPDOCriteria | array | string | integer $criteria = null, boolean | integer $cacheFlag = true ) : array | boolean
inherited

Load a graph of related objects to the current object.

Inherited from: \xPDOObject::getGraph()\xPDOSimpleObject::getGraph()\modPrincipal::getGraph()
Parameters
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.

Returns
Type Description
array | boolean The graph that was loaded or false if nothing was loaded.
methodpublicgetIterator( string $alias, null | array | \xPDOCriteria $criteria = null, bool | int $cacheFlag = true ) : bool | \xPDOIterator
inherited

Get an xPDOIterator for a collection of objects related by aggregate or composite relations.

Inherited from: \xPDOObject::getIterator()\xPDOSimpleObject::getIterator()\modPrincipal::getIterator()
Parameters
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.

Returns
Type Description
bool | \xPDOIterator An iterator for the collection or false if no relation is found.
methodpublicgetMany( string $alias, object $criteria = null, boolean | integer $cacheFlag = true ) : array
inherited

Gets a collection of objects related by aggregate or composite relations.

Inherited from: \xPDOObject::getMany()\xPDOSimpleObject::getMany()\modPrincipal::getMany()
Parameters
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.

Returns
Type Description
array A collection of related objects or an empty array.
Details
See
\xPDOObject::getOne()  
See
\xPDOObject::addOne()  
See
\xPDOObject::addMany()  
methodpublicgetOne( string $alias, object $criteria = null, boolean | integer $cacheFlag = true ) : \xPDOObject | null
inherited

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

Inherited from: \xPDOObject::getOne()\xPDOSimpleObject::getOne()\modPrincipal::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()}.

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

Returns
Type Description
\xPDOObject | null The related object or null if no instance exists.
Details
See
\xPDOObject::getMany()  
See
\xPDOObject::addOne()  
See
\xPDOObject::addMany()  
methodpublicgetOption( string $key, array | null $options = null, mixed $default = null ) : mixed
inherited

Get an option value for this instance.

Inherited from: \xPDOObject::getOption()\xPDOSimpleObject::getOption()\modPrincipal::getOption()
Parameters
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.

Returns
Type Description
mixed The value of the option or the provided default if it is not set.
methodpublicgetPK( ) : mixed
inherited

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

Inherited from: \xPDOObject::getPK()\xPDOSimpleObject::getPK()\modPrincipal::getPK()
Returns
Type Description
mixed The string (or an array of strings) representing the name(s) of the primary key field(s) for this instance.
methodpublicgetPKType( ) : string
inherited

Gets the type of the primary key field for the object.

Inherited from: \xPDOObject::getPKType()\xPDOSimpleObject::getPKType()\modPrincipal::getPKType()
Returns
Type Description
string The type of the primary key field for this instance.
methodpublicgetPrimaryKey( boolean $validateCompound = true ) : mixed
inherited

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

Inherited from: \xPDOObject::getPrimaryKey()\xPDOSimpleObject::getPrimaryKey()\modPrincipal::getPrimaryKey()
Parameters
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

Returns
Type Description
mixed The string (or an array) representing the value(s) of the primary key field(s) for this instance.
methodpublicgetSelectColumns( \xPDO $xpdo, string $className, string $tableAlias = '', string $columnPrefix = '', array $columns = array (), boolean $exclude = false ) : string
staticinherited

Get a set of column names from an xPDOObject for use in SQL queries.

Inherited from: \xPDOObject::getSelectColumns()\xPDOSimpleObject::getSelectColumns()\modPrincipal::getSelectColumns()
Parameters
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.

Returns
Type Description
string A comma-delimited list of the field names for use in a SELECT clause.
Details
Static
 
methodpublicgetValidator( ) : string | boolean
inherited

Get the xPDOValidator class configured for this instance.

Inherited from: \xPDOObject::getValidator()\xPDOSimpleObject::getValidator()\modPrincipal::getValidator()
Returns
Type Description
string | boolean The xPDOValidator instance or false if it could not be loaded.
methodpublicisDirty( string $key ) : boolean
inherited

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

Inherited from: \xPDOObject::isDirty()\xPDOSimpleObject::isDirty()\modPrincipal::isDirty()
Parameters
Name Type Description
$key string

The field name to check.

Returns
Type Description
boolean True if the field exists and either has been modified or the object is new.
Details
Access
public  
methodpublicisLazy( string $key = '' ) : boolean
inherited

Indicates if the object or specified field is lazy.

Inherited from: \xPDOObject::isLazy()\xPDOSimpleObject::isLazy()\modPrincipal::isLazy()
Parameters
Name Type Description
$key string

Optional key to check for laziness.

Returns
Type Description
boolean True if the field specified or if any field is lazy if no field is specified.
methodpublicisNew( ) : boolean
inherited

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

Inherited from: \xPDOObject::isNew()\xPDOSimpleObject::isNew()\modPrincipal::isNew()
Returns
Type Description
boolean True if the object has not been saved or was loaded from the database.
methodpublicisValidated( string $key = '' ) : boolean
inherited

Indicates if the object or specified field has been validated.

Inherited from: \xPDOObject::isValidated()\xPDOSimpleObject::isValidated()\modPrincipal::isValidated()
Parameters
Name Type Description
$key string

Optional key to check for specific validation.

Returns
Type Description
boolean True if the object or specified field has been fully validated successfully.
methodpublicload( \xPDO $xpdo, string $className, mixed $criteria, boolean | integer $cacheFlag = true ) : object | null
staticinherited

Load an instance of an xPDOObject or derivative class.

Inherited from: \xPDOObject::load()\xPDOSimpleObject::load()\modPrincipal::load()
Parameters
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.

Returns
Type Description
object | null An instance of the requested class, or null if it could not be instantiated.
Details
Static
 
methodpublicloadAttributes( string $target, string $context = '', boolean $reload = false ) : void
inherited

Load attributes of the principal that define access to secured objects.

Inherited from: \modPrincipal::loadAttributes()

{@internal Implement this function in derivatives to control how your user class uses the MODX ABAC (Attribute-Based Access Control) security model}

Parameters
Name Type Description
$target string

The target modAccess classes to load attributes from.

$context string

Context to check within, defaults to current context.

$reload boolean

If true, the attributes will be reloaded and the session updated.

Details
Abstract
 
Access
protected  
methodpublicloadCollection( \xPDO $xpdo, string $className, mixed $criteria = null, boolean | integer $cacheFlag = true ) : array
staticinherited

Load a collection of xPDOObject instances.

Inherited from: \xPDOObject::loadCollection()\xPDOSimpleObject::loadCollection()\modPrincipal::loadCollection()
Parameters
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.

Returns
Type Description
array An array of xPDOObject instances or an empty array if no instances are loaded.
Details
Static
 
methodpublicloadCollectionGraph( \xPDO $xpdo, string $className, string | array $graph, mixed $criteria, boolean | integer $cacheFlag ) : array
staticinherited

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

Inherited from: \xPDOObject::loadCollectionGraph()\xPDOSimpleObject::loadCollectionGraph()\modPrincipal::loadCollectionGraph()
Parameters
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.

Returns
Type Description
array An array of xPDOObject instances or an empty array if no instances are loaded.
Details
Static
 
methodpublicremove( array $ancestors = array () ) : boolean
inherited

Remove the persistent instance of an object permanently.

Inherited from: \xPDOObject::remove()\xPDOSimpleObject::remove()\modPrincipal::remove()

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

Parameters
Name Type Description
$ancestors array

Keeps track of classes which have already been removed to prevent loop with circular references.

Returns
Type Description
boolean Returns true on success, false on failure.
methodpublicremoveValidationRules( string $field = null, array $rules = array() ) : void
inherited

Remove one or more validation rules from this instance.

Inherited from: \xPDOObject::removeValidationRules()\xPDOSimpleObject::removeValidationRules()\modPrincipal::removeValidationRules()
Parameters
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.

methodpublicsave( boolean | integer $cacheFlag = null ) : boolean
inherited

Persist new or changed objects to the database container.

Inherited from: \xPDOObject::save()\xPDOSimpleObject::save()\modPrincipal::save()

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.

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

Returns
Type Description
boolean Returns true on success, false on failure.
methodpublicset( string $k, mixed $v = null, string | \callable $vType = '' ) : boolean
inherited

Set a field value by the field key or name.

Inherited from: \xPDOObject::set()\xPDOSimpleObject::set()\modPrincipal::set()
Parameters
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.

Returns
Type Description
boolean Determines whether the value was set successfully and was determined to be dirty (i.e. different from the previous value).
methodpublicsetDirty( string $key = '' ) : void
inherited

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

Inherited from: \xPDOObject::setDirty()\xPDOSimpleObject::setDirty()\modPrincipal::setDirty()

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

Parameters
Name Type Description
$key string

The key of the field to set dirty.

methodpublicsetOption( string $key, mixed $value ) : void
inherited

Set an option value for this instance.

Inherited from: \xPDOObject::setOption()\xPDOSimpleObject::setOption()\modPrincipal::setOption()
Parameters
Name Type Description
$key string

The option key to set a value for.

$value mixed

A value to assign to the option.

methodpublictoArray( string $keyPrefix = '', boolean $rawValues = false, boolean $excludeLazy = false, boolean | integer | string | array $includeRelated = false ) : array
inherited

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

Inherited from: \xPDOObject::toArray()\xPDOSimpleObject::toArray()\modPrincipal::toArray()
Parameters
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.

Returns
Type Description
array An array representation of the object fields/values.
methodpublictoJSON( string $keyPrefix = '', boolean $rawValues = false ) : string
inherited

Returns a JSON representation of the object.

Inherited from: \xPDOObject::toJSON()\xPDOSimpleObject::toJSON()\modPrincipal::toJSON()
Parameters
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()}.

Returns
Type Description
string A JSON string representing the object.
methodpublicvalidate( array $options = array() ) : boolean
inherited

Validate the field values using an xPDOValidator.

Inherited from: \xPDOObject::validate()\xPDOSimpleObject::validate()\modPrincipal::validate()
Parameters
Name Type Description
$options array

An array of options to pass to the validator.

Returns
Type Description
boolean True if validation was successful.
Documentation was generated by DocBlox 0.18.1.