core/model/modx/sources/mysql/modfilemediasource.class.php

Show:

inherited

Classes
- \modFileMediaSource_mysql

Table of Contents

Package: modx
Subpackage: sources.mysql

\modFileMediaSource_mysql
jump to top

Package: modx\sources\mysql

Implements a file-system-based media source, allowing manipulation and management of files on the server's location. Supports basePath and baseUrl parameters, similar to Revolution 2.1 and prior's filemanager_* settings.

Of course, in your getContainerList method, you can define the context menu items for the tree, so not all of these methods might need to be implemented, depending on your situation. You can also provide custom actions for your source type, depending on the behavior you might need.

Parent(s): \modFileMediaSource < \modMediaSourceInterface < \modAccessibleSimpleObject < \modAccessibleObject < \xPDOObject

Properties

array
                 $_aggregates= 'array ()'

inherited

An array of aggregate foreign key relationships for the class.

Inherited from: \xPDOObject::$$_aggregates \modAccessibleObject::$$_aggregates \modAccessibleSimpleObject::$$_aggregates \modMediaSource::$$_aggregates \modFileMediaSource::$$_aggregates

Default valuearray ()Details

Type: array
Access: public
Inherited_from: \xPDOObject::$$_aggregates
Inherited_from: \modAccessibleObject::$$_aggregates
Inherited_from: \modAccessibleSimpleObject::$$_aggregates
Inherited_from: \modMediaSource::$$_aggregates
Inherited_from: \modFileMediaSource::$$_aggregates

string
                 $_alias= 'null'

inherited

An alias for this instance of the class.

Inherited from: \xPDOObject::$$_alias \modAccessibleObject::$$_alias \modAccessibleSimpleObject::$$_alias \modMediaSource::$$_alias \modFileMediaSource::$$_alias

Default valuenullDetails

Type: string
Inherited_from: \xPDOObject::$$_alias
Inherited_from: \modAccessibleObject::$$_alias
Inherited_from: \modAccessibleSimpleObject::$$_alias
Inherited_from: \modMediaSource::$$_alias
Inherited_from: \modFileMediaSource::$$_alias

boolean
                 $_cacheFlag= 'true'

inherited

Indicates the cacheability of the instance.

Inherited from: \xPDOObject::$$_cacheFlag \modAccessibleObject::$$_cacheFlag \modAccessibleSimpleObject::$$_cacheFlag \modMediaSource::$$_cacheFlag \modFileMediaSource::$$_cacheFlag

Default valuetrueDetails

Type: boolean
Inherited_from: \xPDOObject::$$_cacheFlag
Inherited_from: \modAccessibleObject::$$_cacheFlag
Inherited_from: \modAccessibleSimpleObject::$$_cacheFlag
Inherited_from: \modMediaSource::$$_cacheFlag
Inherited_from: \modFileMediaSource::$$_cacheFlag

string
                 $_class= 'null'

inherited

The actual class name of an instance.

Inherited from: \xPDOObject::$$_class \modAccessibleObject::$$_class \modAccessibleSimpleObject::$$_class \modMediaSource::$$_class \modFileMediaSource::$$_class

Default valuenullDetails

Type: string
Inherited_from: \xPDOObject::$$_class
Inherited_from: \modAccessibleObject::$$_class
Inherited_from: \modAccessibleSimpleObject::$$_class
Inherited_from: \modMediaSource::$$_class
Inherited_from: \modFileMediaSource::$$_class

array
                 $_composites= 'array ()'

inherited

An array of composite foreign key relationships for the class.

Inherited from: \xPDOObject::$$_composites \modAccessibleObject::$$_composites \modAccessibleSimpleObject::$$_composites \modMediaSource::$$_composites \modFileMediaSource::$$_composites

Default valuearray ()Details

Type: array
Access: public
Inherited_from: \xPDOObject::$$_composites
Inherited_from: \modAccessibleObject::$$_composites
Inherited_from: \modAccessibleSimpleObject::$$_composites
Inherited_from: \modMediaSource::$$_composites
Inherited_from: \modFileMediaSource::$$_composites

array
                 $_dirty= 'array ()'

inherited

An array of field names that have been modified.

Inherited from: \xPDOObject::$$_dirty \modAccessibleObject::$$_dirty \modAccessibleSimpleObject::$$_dirty \modMediaSource::$$_dirty \modFileMediaSource::$$_dirty

Default valuearray ()Details

Type: array
Access: public
Inherited_from: \xPDOObject::$$_dirty
Inherited_from: \modAccessibleObject::$$_dirty
Inherited_from: \modAccessibleSimpleObject::$$_dirty
Inherited_from: \modMediaSource::$$_dirty
Inherited_from: \modFileMediaSource::$$_dirty

array
                 $_fieldAliases= 'array()'

inherited

An optional array of field aliases.

Inherited from: \xPDOObject::$$_fieldAliases \modAccessibleObject::$$_fieldAliases \modAccessibleSimpleObject::$$_fieldAliases \modMediaSource::$$_fieldAliases \modFileMediaSource::$$_fieldAliases

Default valuearray()Details

Type: array
Inherited_from: \xPDOObject::$$_fieldAliases
Inherited_from: \modAccessibleObject::$$_fieldAliases
Inherited_from: \modAccessibleSimpleObject::$$_fieldAliases
Inherited_from: \modMediaSource::$$_fieldAliases
Inherited_from: \modFileMediaSource::$$_fieldAliases

array
                 $_fieldMeta= 'array ()'

inherited

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

Inherited from: \xPDOObject::$$_fieldMeta \modAccessibleObject::$$_fieldMeta \modAccessibleSimpleObject::$$_fieldMeta \modMediaSource::$$_fieldMeta \modFileMediaSource::$$_fieldMeta

Default valuearray ()Details

Type: array
Access: public
Inherited_from: \xPDOObject::$$_fieldMeta
Inherited_from: \modAccessibleObject::$$_fieldMeta
Inherited_from: \modAccessibleSimpleObject::$$_fieldMeta
Inherited_from: \modMediaSource::$$_fieldMeta
Inherited_from: \modFileMediaSource::$$_fieldMeta

array
                 $_fields= 'array ()'

inherited

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

Inherited from: \xPDOObject::$$_fields \modAccessibleObject::$$_fields \modAccessibleSimpleObject::$$_fields \modMediaSource::$$_fields \modFileMediaSource::$$_fields

Default valuearray ()Details

Type: array
Access: public
Inherited_from: \xPDOObject::$$_fields
Inherited_from: \modAccessibleObject::$$_fields
Inherited_from: \modAccessibleSimpleObject::$$_fields
Inherited_from: \modMediaSource::$$_fields
Inherited_from: \modFileMediaSource::$$_fields

array
                 $_lazy= 'array ()'

inherited

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

Inherited from: \xPDOObject::$$_lazy \modAccessibleObject::$$_lazy \modAccessibleSimpleObject::$$_lazy \modMediaSource::$$_lazy \modFileMediaSource::$$_lazy

Default valuearray ()Details

Type: array
Access: public
Inherited_from: \xPDOObject::$$_lazy
Inherited_from: \modAccessibleObject::$$_lazy
Inherited_from: \modAccessibleSimpleObject::$$_lazy
Inherited_from: \modMediaSource::$$_lazy
Inherited_from: \modFileMediaSource::$$_lazy

boolean
                 $_new= 'true'

inherited

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

Inherited from: \xPDOObject::$$_new \modAccessibleObject::$$_new \modAccessibleSimpleObject::$$_new \modMediaSource::$$_new \modFileMediaSource::$$_new

Default valuetrueDetails

Type: boolean
Access: public
Inherited_from: \xPDOObject::$$_new
Inherited_from: \modAccessibleObject::$$_new
Inherited_from: \modAccessibleSimpleObject::$$_new
Inherited_from: \modMediaSource::$$_new
Inherited_from: \modFileMediaSource::$$_new

array
                 $_options= 'array()'

inherited

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

Inherited from: \xPDOObject::$$_options \modAccessibleObject::$$_options \modAccessibleSimpleObject::$$_options \modMediaSource::$$_options \modFileMediaSource::$$_options

Default valuearray()Details

Type: array
Inherited_from: \xPDOObject::$$_options
Inherited_from: \modAccessibleObject::$$_options
Inherited_from: \modAccessibleSimpleObject::$$_options
Inherited_from: \modMediaSource::$$_options
Inherited_from: \modFileMediaSource::$$_options

string
                 $_package= 'null'

inherited

The package the class is a part of.

Inherited from: \xPDOObject::$$_package \modAccessibleObject::$$_package \modAccessibleSimpleObject::$$_package \modMediaSource::$$_package \modFileMediaSource::$$_package

Default valuenullDetails

Type: string
Inherited_from: \xPDOObject::$$_package
Inherited_from: \modAccessibleObject::$$_package
Inherited_from: \modAccessibleSimpleObject::$$_package
Inherited_from: \modMediaSource::$$_package
Inherited_from: \modFileMediaSource::$$_package

string|array
                 $_pk= 'null'

inherited

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

Inherited from: \xPDOObject::$$_pk \modAccessibleObject::$$_pk \modAccessibleSimpleObject::$$_pk \modMediaSource::$$_pk \modFileMediaSource::$$_pk

Default valuenullDetails

Type: string | array
Access: public
Inherited_from: \xPDOObject::$$_pk
Inherited_from: \modAccessibleObject::$$_pk
Inherited_from: \modAccessibleSimpleObject::$$_pk
Inherited_from: \modMediaSource::$$_pk
Inherited_from: \modFileMediaSource::$$_pk

string|array
                 $_pktype= 'null'

inherited

The php native type of the primary key field.

Inherited from: \xPDOObject::$$_pktype \modAccessibleObject::$$_pktype \modAccessibleSimpleObject::$$_pktype \modMediaSource::$$_pktype \modFileMediaSource::$$_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: \modAccessibleObject::$$_pktype
Inherited_from: \modAccessibleSimpleObject::$$_pktype
Inherited_from: \modMediaSource::$$_pktype
Inherited_from: \modFileMediaSource::$$_pktype

array
                 $_policies= 'array()'

inherited

A local cache of access policies for the instance.

Inherited from: \modAccessibleObject::$$_policies \modAccessibleSimpleObject::$$_policies \modMediaSource::$$_policies \modFileMediaSource::$$_policies

Default valuearray()Details

Type: array
Inherited_from: \modAccessibleObject::$$_policies
Inherited_from: \modAccessibleSimpleObject::$$_policies
Inherited_from: \modMediaSource::$$_policies
Inherited_from: \modFileMediaSource::$$_policies

array
                 $_relatedObjects= 'array ()'

inherited

An array of object instances related to this object instance.

Inherited from: \xPDOObject::$$_relatedObjects \modAccessibleObject::$$_relatedObjects \modAccessibleSimpleObject::$$_relatedObjects \modMediaSource::$$_relatedObjects \modFileMediaSource::$$_relatedObjects

Default valuearray ()Details

Type: array
Access: public
Inherited_from: \xPDOObject::$$_relatedObjects
Inherited_from: \modAccessibleObject::$$_relatedObjects
Inherited_from: \modAccessibleSimpleObject::$$_relatedObjects
Inherited_from: \modMediaSource::$$_relatedObjects
Inherited_from: \modFileMediaSource::$$_relatedObjects

string
                 $_table= 'null'

inherited

Name of the actual table representing this class.

Inherited from: \xPDOObject::$$_table \modAccessibleObject::$$_table \modAccessibleSimpleObject::$$_table \modMediaSource::$$_table \modFileMediaSource::$$_table

Default valuenullDetails

Type: string
Access: public
Inherited_from: \xPDOObject::$$_table
Inherited_from: \modAccessibleObject::$$_table
Inherited_from: \modAccessibleSimpleObject::$$_table
Inherited_from: \modMediaSource::$$_table
Inherited_from: \modFileMediaSource::$$_table

string
                 $_tableMeta= 'null'

inherited

An array of meta data for the table.

Inherited from: \xPDOObject::$$_tableMeta \modAccessibleObject::$$_tableMeta \modAccessibleSimpleObject::$$_tableMeta \modMediaSource::$$_tableMeta \modFileMediaSource::$$_tableMeta

Default valuenullDetails

Type: string
Access: public
Inherited_from: \xPDOObject::$$_tableMeta
Inherited_from: \modAccessibleObject::$$_tableMeta
Inherited_from: \modAccessibleSimpleObject::$$_tableMeta
Inherited_from: \modMediaSource::$$_tableMeta
Inherited_from: \modFileMediaSource::$$_tableMeta

array
                 $_validated= 'array ()'

inherited

An array of field names that have been already validated.

Inherited from: \xPDOObject::$$_validated \modAccessibleObject::$$_validated \modAccessibleSimpleObject::$$_validated \modMediaSource::$$_validated \modFileMediaSource::$$_validated

Default valuearray ()Details

Type: array
Access: public
Inherited_from: \xPDOObject::$$_validated
Inherited_from: \modAccessibleObject::$$_validated
Inherited_from: \modAccessibleSimpleObject::$$_validated
Inherited_from: \modMediaSource::$$_validated
Inherited_from: \modFileMediaSource::$$_validated

boolean
                 $_validationLoaded= 'false'

inherited

Indicates if the validation map has been loaded.

Inherited from: \xPDOObject::$$_validationLoaded \modAccessibleObject::$$_validationLoaded \modAccessibleSimpleObject::$$_validationLoaded \modMediaSource::$$_validationLoaded \modFileMediaSource::$$_validationLoaded

Default valuefalseDetails

Type: boolean
Access: public
Inherited_from: \xPDOObject::$$_validationLoaded
Inherited_from: \modAccessibleObject::$$_validationLoaded
Inherited_from: \modAccessibleSimpleObject::$$_validationLoaded
Inherited_from: \modMediaSource::$$_validationLoaded
Inherited_from: \modFileMediaSource::$$_validationLoaded

array
                 $_validationRules= 'array()'

inherited

An array of validation rules for this object instance.

Inherited from: \xPDOObject::$$_validationRules \modAccessibleObject::$$_validationRules \modAccessibleSimpleObject::$$_validationRules \modMediaSource::$$_validationRules \modFileMediaSource::$$_validationRules

Default valuearray()Details

Type: array
Access: public
Inherited_from: \xPDOObject::$$_validationRules
Inherited_from: \modAccessibleObject::$$_validationRules
Inherited_from: \modAccessibleSimpleObject::$$_validationRules
Inherited_from: \modMediaSource::$$_validationRules
Inherited_from: \modFileMediaSource::$$_validationRules

\xPDOValidator
                 $_validator= 'null'

inherited

A validator object responsible for this object instance.

Inherited from: \xPDOObject::$$_validator \modAccessibleObject::$$_validator \modAccessibleSimpleObject::$$_validator \modMediaSource::$$_validator \modFileMediaSource::$$_validator

Default valuenullDetails

Type: \xPDOValidator
Access: public
Inherited_from: \xPDOObject::$$_validator
Inherited_from: \modAccessibleObject::$$_validator
Inherited_from: \modAccessibleSimpleObject::$$_validator
Inherited_from: \modMediaSource::$$_validator
Inherited_from: \modFileMediaSource::$$_validator

string
                 $container= 'null'

inherited

Name of the data source container the object belongs to.

Inherited from: \xPDOObject::$$container \modAccessibleObject::$$container \modAccessibleSimpleObject::$$container \modMediaSource::$$container \modFileMediaSource::$$container

Default valuenullDetails

Type: string
Access: public
Inherited_from: \xPDOObject::$$container
Inherited_from: \modAccessibleObject::$$container
Inherited_from: \modAccessibleSimpleObject::$$container
Inherited_from: \modMediaSource::$$container
Inherited_from: \modFileMediaSource::$$container

\modContext
                 $ctx= ''

inherited

Inherited from: \modMediaSource::$$ctx \modFileMediaSource::$$ctx

Details

Type: \modContext
Inherited_from: \modMediaSource::$$ctx
Inherited_from: \modFileMediaSource::$$ctx

array
                 $errors= 'array()'

inherited

Inherited from: \modMediaSource::$$errors \modFileMediaSource::$$errors

Default valuearray()Details

Type: array
Inherited_from: \modMediaSource::$$errors
Inherited_from: \modFileMediaSource::$$errors

array
                 $fieldNames= 'null'

inherited

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

Inherited from: \xPDOObject::$$fieldNames \modAccessibleObject::$$fieldNames \modAccessibleSimpleObject::$$fieldNames \modMediaSource::$$fieldNames \modFileMediaSource::$$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: \modAccessibleObject::$$fieldNames
Inherited_from: \modAccessibleSimpleObject::$$fieldNames
Inherited_from: \modMediaSource::$$fieldNames
Inherited_from: \modFileMediaSource::$$fieldNames

\modFileHandler
                 $fileHandler= ''

inherited

Inherited from: \modFileMediaSource::$$fileHandler

Details

Type: \modFileHandler
Inherited_from: \modFileMediaSource::$$fileHandler

array
                 $permissions= 'array()'

inherited

Inherited from: \modMediaSource::$$permissions \modFileMediaSource::$$permissions

Default valuearray()Details

Type: array
Inherited_from: \modMediaSource::$$permissions
Inherited_from: \modFileMediaSource::$$permissions

array
                 $properties= 'array()'

inherited

Inherited from: \modMediaSource::$$properties \modFileMediaSource::$$properties

Default valuearray()Details

Type: array
Inherited_from: \modMediaSource::$$properties
Inherited_from: \modFileMediaSource::$$properties

\modX|\xPDO
                 $xpdo= ''

inherited

A convenience reference to the xPDO object.

Inherited from: \modMediaSource::$$xpdo \modFileMediaSource::$$xpdo

Details

Type: \modX | \xPDO
Inherited_from: \modMediaSource::$$xpdo
Inherited_from: \modFileMediaSource::$$xpdo

Methods

__construct(
          \xPDO $xpdo
          )
        
        :
          \xPDOObject

inherited

Constructor

Inherited from: \xPDOObject::__construct()\modAccessibleObject::__construct()\modAccessibleSimpleObject::__construct()\modMediaSource::__construct()\modFileMediaSource::__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
}

Parameters

Name	Type	Description
$xpdo	\xPDO	&$xpdo A reference to a valid xPDO instance.

Returns

Type	Description
\xPDOObject

Details

Access: public

_getAliases(
          string $class, int $limit
              =
              0
          )
        
        :
          array

inherited

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

Inherited from: \xPDOObject::_getAliases()\modAccessibleObject::_getAliases()\modAccessibleSimpleObject::_getAliases()\modMediaSource::_getAliases()\modFileMediaSource::_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

_getDataType(
          string $key
          )
        
        :
          string

inherited

Gets the database data type for the specified field.

Inherited from: \xPDOObject::_getDataType()\modAccessibleObject::_getDataType()\modAccessibleSimpleObject::_getDataType()\modMediaSource::_getDataType()\modFileMediaSource::_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

_getPHPType(
          string $key
          )
        
        :
          string

inherited

Gets the php data type for the specified field.

Inherited from: \xPDOObject::_getPHPType()\modAccessibleObject::_getPHPType()\modAccessibleSimpleObject::_getPHPType()\modMediaSource::_getPHPType()\modFileMediaSource::_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

_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()\modAccessibleObject::_getRelatedObjectsByFK()\modAccessibleSimpleObject::_getRelatedObjectsByFK()\modMediaSource::_getRelatedObjectsByFK()\modFileMediaSource::_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

_initFields(
          
          )
        
        :
          void

inherited

Initializes the field names with the qualified table name.

Inherited from: \xPDOObject::_initFields()\modAccessibleObject::_initFields()\modAccessibleSimpleObject::_initFields()\modMediaSource::_initFields()\modFileMediaSource::_initFields()

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

Details

Access: protected

_loadCollectionInstance(
          \xPDO $xpdo, array $objCollection, string $className, mixed $criteria,  $row,  $fromCache, boolean | integer $cacheFlag
              =
              true
          )
        
        :
          void

staticinherited

Custom instance loader for collections that respects policy checking.

Inherited from: \modAccessibleObject::_loadCollectionInstance()\modAccessibleSimpleObject::_loadCollectionInstance()\modMediaSource::_loadCollectionInstance()\modFileMediaSource::_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.

_loadFieldData(
          string | array $fields
          )
        
        :
          void

inherited

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

Inherited from: \xPDOObject::_loadFieldData()\modAccessibleObject::_loadFieldData()\modAccessibleSimpleObject::_loadFieldData()\modMediaSource::_loadFieldData()\modFileMediaSource::_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

_loadInstance(
          \xPDO | \modX $xpdo, string $className, mixed $criteria, int $row
          )
        
        :
          \modAccessibleObject | null

staticinherited

Custom instance from row loader that respects policy checking

Inherited from: \modAccessibleObject::_loadInstance()\modAccessibleSimpleObject::_loadInstance()\modMediaSource::_loadInstance()\modFileMediaSource::_loadInstance()

Parameters

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

Returns

Type	Description
\modAccessibleObject \| null	An instance of the object

_loadRows(
          \xPDO $xpdo, string $className, \xPDOCriteria $criteria
          )
        
        :
          \PDOStatement

staticinherited

Responsible for loading a result set from the database.

Inherited from: \xPDOObject::_loadRows()\modAccessibleObject::_loadRows()\modAccessibleSimpleObject::_loadRows()\modMediaSource::_loadRows()\modFileMediaSource::_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

_loadValidation(
          boolean $reload
              =
              false
          )
        
        :
          void

inherited

Used to load validation from the object map.

Inherited from: \xPDOObject::_loadValidation()\modAccessibleObject::_loadValidation()\modAccessibleSimpleObject::_loadValidation()\modMediaSource::_loadValidation()\modFileMediaSource::_loadValidation()

Parameters

Name	Type	Description
$reload	boolean	Indicates if the schema validation rules should be reloaded.

Details

Access: public

_saveRelatedObject(
          \xPDOObject $obj, array $fkMeta
          )
        
        :
          boolean

inherited

Save a related object with pending changes.

Inherited from: \xPDOObject::_saveRelatedObject()\modAccessibleObject::_saveRelatedObject()\modAccessibleSimpleObject::_saveRelatedObject()\modMediaSource::_saveRelatedObject()\modFileMediaSource::_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.

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

_saveRelatedObjects(
          
          )
        
        :
          integer

inherited

Searches for any related objects with pending changes to save.

Inherited from: \xPDOObject::_saveRelatedObjects()\modAccessibleObject::_saveRelatedObjects()\modAccessibleSimpleObject::_saveRelatedObjects()\modMediaSource::_saveRelatedObjects()\modFileMediaSource::_saveRelatedObjects()

Returns

Type	Description
integer	The number of related objects processed.

Details

Access: protected
Uses: \xPDOObject::_saveRelatedObject()

_setRaw(
          string $key, mixed $val
          )
        
        :
          boolean

inherited

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

Inherited from: \xPDOObject::_setRaw()\modAccessibleObject::_setRaw()\modAccessibleSimpleObject::_setRaw()\modMediaSource::_setRaw()\modFileMediaSource::_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

addError(
          string $field, string $message
          )
        
        :
          string

inherited

Add an error for an action occurring in the source

Inherited from: \modMediaSource::addError()\modFileMediaSource::addError()

Parameters

Name	Type	Description
$field	string	The field corresponding to the error
$message	string	The message to add

Returns

Type	Description
string	The added error

addFieldAlias(
          string $field, string $alias
          )
        
        :
          bool

inherited

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

Inherited from: \xPDOObject::addFieldAlias()\modAccessibleObject::addFieldAlias()\modAccessibleSimpleObject::addFieldAlias()\modMediaSource::addFieldAlias()\modFileMediaSource::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.

addMany(
          mixed $obj, string $alias
              =
              ''
          )
        
        :
          boolean

inherited

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

Inherited from: \xPDOObject::addMany()\modAccessibleObject::addMany()\modAccessibleSimpleObject::addMany()\modMediaSource::addMany()\modFileMediaSource::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()

addOne(
          mixed $obj, string $alias
              =
              ''
          )
        
        :
          boolean

inherited

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

Inherited from: \xPDOObject::addOne()\modAccessibleObject::addOne()\modAccessibleSimpleObject::addOne()\modMediaSource::addOne()\modFileMediaSource::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()

addValidationRule(
          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()\modAccessibleObject::addValidationRule()\modAccessibleSimpleObject::addValidationRule()\modMediaSource::addValidationRule()\modFileMediaSource::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.

checkPolicy(
          string | array $criteria, array $targets
              =
              null
          )
        
        :
          bool

inherited

Allow overriding of checkPolicy to always allow media sources to be loaded

Inherited from: \modMediaSource::checkPolicy()\modFileMediaSource::checkPolicy()

Parameters

Name	Type	Description
$criteria	string \| array
$targets	array

Returns

Type	Description
bool

chmodContainer(
          string $directoryPath, string $mode
          )
        
        :
          boolean

inherited

Chmod a specific folder

Inherited from: \modFileMediaSource::chmodContainer()

Parameters

Name	Type	Description
$directoryPath	string
$mode	string

Returns

Type	Description
boolean

clearCache(
          array $options
              =
              array()
          )
        
        :
          void

inherited

Clear the caches of all sources

Inherited from: \modMediaSource::clearCache()\modFileMediaSource::clearCache()

Parameters

Name	Type	Description
$options	array

createContainer(
          string $name, string $parentContainer
          )
        
        :
          boolean

inherited

Create a filesystem folder

Inherited from: \modFileMediaSource::createContainer()

Parameters

Name	Type	Description
$name	string
$parentContainer	string

Returns

Type	Description
boolean

createObject(
          string $objectPath, string $name, string $content
          )
        
        :
          boolean | string

inherited

Create a file

Inherited from: \modFileMediaSource::createObject()

Parameters

Name	Type	Description
$objectPath	string
$name	string
$content	string

Returns

Type	Description
boolean \| string

encode(
          string $source, string $type
              =
              'md5'
          )
        
        :
          string

inherited

Encodes a string using the specified algorithm.

Inherited from: \xPDOObject::encode()\modAccessibleObject::encode()\modAccessibleSimpleObject::encode()\modMediaSource::encode()\modFileMediaSource::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.

findPolicy(
          string $context
              =
              ''
          )
        
        :
          array

inherited

Find all policies for this object

Inherited from: \modMediaSource::findPolicy()\modFileMediaSource::findPolicy()

Parameters

Name	Type	Description
$context	string

Returns

Type	Description
array

fromArray(
          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()\modAccessibleObject::fromArray()\modAccessibleSimpleObject::fromArray()\modMediaSource::fromArray()\modFileMediaSource::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.

fromJSON(
          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()\modAccessibleObject::fromJSON()\modAccessibleSimpleObject::fromJSON()\modMediaSource::fromJSON()\modFileMediaSource::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.

get(
          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()\modAccessibleObject::get()\modAccessibleSimpleObject::get()\modMediaSource::get()\modFileMediaSource::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.

getBasePath(
          string $object
              =
              ''
          )
        
        :
          string

inherited

Get the base path for this source. Only applicable to sources that are streams.

Inherited from: \modFileMediaSource::getBasePath()

Parameters

Name	Type	Description
$object	string	An optional file to find the base path of

Returns

Type	Description
string

getBaseUrl(
          string $object
              =
              ''
          )
        
        :
          string

inherited

Get the base URL for this source. Only applicable to sources that are streams.

Inherited from: \modFileMediaSource::getBaseUrl()

Parameters

Name	Type	Description
$object	string	An optional object to find the base url of

Returns

Type	Description
string

getBases(
          string $path
          )
        
        :
          array

inherited

Get base paths/urls and sanitize incoming paths

Inherited from: \modFileMediaSource::getBases()

Parameters

Name	Type	Description
$path	string	A path to the active directory

Returns

Type	Description
array

getContainerList(
          string $path
          )
        
        :
          array

inherited

Return an array of files and folders at this current level in the directory structure

Inherited from: \modFileMediaSource::getContainerList()

Parameters

Name	Type	Description
$path	string

Returns

Type	Description
array

getDefaultProperties(
          
          )
        
        :
          array

inherited

Get the default properties for the filesystem media source type.

Inherited from: \modFileMediaSource::getDefaultProperties()

Returns

Type	Description
array

getDefaultSource(
          \xPDO | \modX $xpdo, int $defaultSourceId
              =
              null, boolean $fallbackToDefault
              =
              true
          )
        
        :
          \modMediaSource | null

staticinherited

Get the default MODX filesystem source

Inherited from: \modMediaSource::getDefaultSource()\modFileMediaSource::getDefaultSource()

Parameters

Name	Type	Description
$xpdo	\xPDO \| \modX	A reference to an xPDO instance
$defaultSourceId	int
$fallbackToDefault	boolean

Returns

Type	Description
\modMediaSource \| null

Details

Static

getEditActionId(
          
          )
        
        :
          boolean | int

inherited

Get the ID of the edit file action

Inherited from: \modFileMediaSource::getEditActionId()

Returns

Type	Description
boolean \| int

getErrors(
          
          )
        
        :
          array

inherited

Get all errors that have occurred for this source

Inherited from: \modMediaSource::getErrors()\modFileMediaSource::getErrors()

Returns

Type	Description
array

getFKClass(
          string $k
          )
        
        :
          void

inherited

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

Inherited from: \xPDOObject::getFKClass()\modAccessibleObject::getFKClass()\modAccessibleSimpleObject::getFKClass()\modMediaSource::getFKClass()\modFileMediaSource::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.

getFKDefinition(
          string $alias
          )
        
        :
          array

inherited

Get a foreign key definition for a specific classname.

Inherited from: \xPDOObject::getFKDefinition()\modAccessibleObject::getFKDefinition()\modAccessibleSimpleObject::getFKDefinition()\modMediaSource::getFKDefinition()\modFileMediaSource::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.

getField(
          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()\modAccessibleObject::getField()\modAccessibleSimpleObject::getField()\modMediaSource::getField()\modFileMediaSource::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.

getFieldName(
          string $k, string $alias
              =
              null
          )
        
        :
          string

inherited

Gets a field name as represented in the database container.

Inherited from: \xPDOObject::getFieldName()\modAccessibleObject::getFieldName()\modAccessibleSimpleObject::getFieldName()\modMediaSource::getFieldName()\modFileMediaSource::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.

getGraph(
          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()\modAccessibleObject::getGraph()\modAccessibleSimpleObject::getGraph()\modMediaSource::getGraph()\modFileMediaSource::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.

getIterator(
          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()\modAccessibleObject::getIterator()\modAccessibleSimpleObject::getIterator()\modMediaSource::getIterator()\modFileMediaSource::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.

getListContextMenu(
          \DirectoryIterator $file, array $fileArray
          )
        
        :
          array

inherited

Get the context menu items for a specific object in the list view

Inherited from: \modFileMediaSource::getListContextMenu()

Parameters

Name	Type	Description
$file	\DirectoryIterator
$fileArray	array

Returns

Type	Description
array

getMany(
          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()\modAccessibleObject::getMany()\modAccessibleSimpleObject::getMany()\modMediaSource::getMany()\modFileMediaSource::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()

getObjectContents(
          string $objectPath
          )
        
        :
          array

inherited

Get the contents of a specified file

Inherited from: \modFileMediaSource::getObjectContents()

Parameters

Name	Type	Description
$objectPath	string

Returns

Type	Description
array

getObjectUrl(
          string $object
              =
              ''
          )
        
        :
          string

inherited

Get the absolute URL for a specified object. Only applicable to sources that are streams.

Inherited from: \modFileMediaSource::getObjectUrl()

Parameters

Name	Type	Description
$object	string

Returns

Type	Description
string

getObjectsInContainer(
          string $path
          )
        
        :
          array

inherited

Get a list of files in a specific directory.

Inherited from: \modFileMediaSource::getObjectsInContainer()

Parameters

Name	Type	Description
$path	string

Returns

Type	Description
array

getOne(
          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()\modAccessibleObject::getOne()\modAccessibleSimpleObject::getOne()\modMediaSource::getOne()\modFileMediaSource::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()

getOpenTo(
          string $value, array $parameters
              =
              array()
          )
        
        :
          string

inherited

Get the openTo directory for this source, used with TV input types

Inherited from: \modMediaSource::getOpenTo()\modFileMediaSource::getOpenTo()

Parameters

Name	Type	Description
$value	string
$parameters	array

Returns

Type	Description
string

getOption(
          string $key, array | null $options
              =
              null, mixed $default
              =
              null
          )
        
        :
          mixed

inherited

Get an option value for this instance.

Inherited from: \xPDOObject::getOption()\modAccessibleObject::getOption()\modAccessibleSimpleObject::getOption()\modMediaSource::getOption()\modFileMediaSource::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.

getPK(
          
          )
        
        :
          mixed

inherited

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

Inherited from: \xPDOObject::getPK()\modAccessibleObject::getPK()\modAccessibleSimpleObject::getPK()\modMediaSource::getPK()\modFileMediaSource::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.

getPKType(
          
          )
        
        :
          string

inherited

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

Inherited from: \xPDOObject::getPKType()\modAccessibleObject::getPKType()\modAccessibleSimpleObject::getPKType()\modMediaSource::getPKType()\modFileMediaSource::getPKType()

Returns

Type	Description
string	The type of the primary key field for this instance.

getPermissions(
          
          )
        
        :
          array

inherited

Get a list of permissions for browsing and utilizing the source. May be overridden to provide a custom list of permissions.

Inherited from: \modMediaSource::getPermissions()\modFileMediaSource::getPermissions()

Returns

Type	Description
array

getPolicies(
          
          )
        
        :
          array

inherited

Return the currently loaded array of policies.

Inherited from: \modAccessibleObject::getPolicies()\modAccessibleSimpleObject::getPolicies()\modMediaSource::getPolicies()\modFileMediaSource::getPolicies()

Returns

Type	Description
array

getPrimaryKey(
          boolean $validateCompound
              =
              true
          )
        
        :
          mixed

inherited

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

Inherited from: \xPDOObject::getPrimaryKey()\modAccessibleObject::getPrimaryKey()\modAccessibleSimpleObject::getPrimaryKey()\modMediaSource::getPrimaryKey()\modFileMediaSource::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.

getProperties(
          boolean $parsed
              =
              false
          )
        
        :
          array

inherited

Get the properties on this source

Inherited from: \modMediaSource::getProperties()\modFileMediaSource::getProperties()

Parameters

Name	Type	Description
$parsed	boolean

Returns

Type	Description
array

getPropertyList(
          
          )
        
        :
          array

inherited

Get all properties in key => value format

Inherited from: \modMediaSource::getPropertyList()\modFileMediaSource::getPropertyList()

Returns

Type	Description
array

getSelectColumns(
          \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()\modAccessibleObject::getSelectColumns()\modAccessibleSimpleObject::getSelectColumns()\modMediaSource::getSelectColumns()\modFileMediaSource::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

getTypeDescription(
          
          )
        
        :
          string

inherited

Get the description of this source type

Inherited from: \modFileMediaSource::getTypeDescription()

Returns

Type	Description
string

getTypeName(
          
          )
        
        :
          string

inherited

Get the name of this source type

Inherited from: \modFileMediaSource::getTypeName()

Returns

Type	Description
string

getValidator(
          
          )
        
        :
          string | boolean

inherited

Get the xPDOValidator class configured for this instance.

Inherited from: \xPDOObject::getValidator()\modAccessibleObject::getValidator()\modAccessibleSimpleObject::getValidator()\modMediaSource::getValidator()\modFileMediaSource::getValidator()

Returns

Type	Description
string \| boolean	The xPDOValidator instance or false if it could not be loaded.

getWorkingContext(
          
          )
        
        :
          bool | \modContext

inherited

Get the current working context for the processor

Inherited from: \modMediaSource::getWorkingContext()\modFileMediaSource::getWorkingContext()

Returns

Type	Description
bool \| \modContext

hasErrors(
          
          )
        
        :
          bool

inherited

See if the source has any errors

Inherited from: \modMediaSource::hasErrors()\modFileMediaSource::hasErrors()

Returns

Type	Description
bool

hasPermission(
          string $key
          )
        
        :
          bool

inherited

See if the source is allowing a certain permission.

Inherited from: \modMediaSource::hasPermission()\modFileMediaSource::hasPermission()

Parameters

Name	Type	Description
$key	string

Returns

Type	Description
bool

initialize(
          
          )
        
        :
          boolean

inherited

Initialize the source

Inherited from: \modFileMediaSource::initialize()

Returns

Type	Description
boolean

isDirty(
          string $key
          )
        
        :
          boolean

inherited

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

Inherited from: \xPDOObject::isDirty()\modAccessibleObject::isDirty()\modAccessibleSimpleObject::isDirty()\modMediaSource::isDirty()\modFileMediaSource::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

isLazy(
          string $key
              =
              ''
          )
        
        :
          boolean

inherited

Indicates if the object or specified field is lazy.

Inherited from: \xPDOObject::isLazy()\modAccessibleObject::isLazy()\modAccessibleSimpleObject::isLazy()\modMediaSource::isLazy()\modFileMediaSource::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.

isNew(
          
          )
        
        :
          boolean

inherited

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

Inherited from: \xPDOObject::isNew()\modAccessibleObject::isNew()\modAccessibleSimpleObject::isNew()\modMediaSource::isNew()\modFileMediaSource::isNew()

Returns

Type	Description
boolean	True if the object has not been saved or was loaded from the database.

isValidated(
          string $key
              =
              ''
          )
        
        :
          boolean

inherited

Indicates if the object or specified field has been validated.

Inherited from: \xPDOObject::isValidated()\modAccessibleObject::isValidated()\modAccessibleSimpleObject::isValidated()\modMediaSource::isValidated()\modFileMediaSource::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.

load(
          \xPDO $xpdo, string $className, mixed $criteria, boolean | integer $cacheFlag
              =
              true
          )
        
        :
          object | null

staticinherited

Custom instance loader that forces access policy checking.

Inherited from: \modAccessibleObject::load()\modAccessibleSimpleObject::load()\modMediaSource::load()\modFileMediaSource::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.

loadCollection(
          \xPDO $xpdo, string $className, mixed $criteria
              =
              null, boolean | integer $cacheFlag
              =
              true
          )
        
        :
          array

staticinherited

Custom collection loader that forces access policy checking.

Inherited from: \modAccessibleObject::loadCollection()\modAccessibleSimpleObject::loadCollection()\modMediaSource::loadCollection()\modFileMediaSource::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.

loadCollectionGraph(
          \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()\modAccessibleObject::loadCollectionGraph()\modAccessibleSimpleObject::loadCollectionGraph()\modMediaSource::loadCollectionGraph()\modFileMediaSource::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

moveObject(
          string $from, string $to, string $point
              =
              'append'
          )
        
        :
          boolean

inherited

Move a file or folder to a specific location

Inherited from: \modFileMediaSource::moveObject()

Parameters

Name	Type	Description
$from	string	The location to move from
$to	string	The location to move to
$point	string

Returns

Type	Description
boolean

parseProperties(
          array $properties
          )
        
        :
          array

inherited

Parse any tags in the properties

Inherited from: \modMediaSource::parseProperties()\modFileMediaSource::parseProperties()

Parameters

Name	Type	Description
$properties	array

Returns

Type	Description
array

prepareOutputUrl(
          string $value
          )
        
        :
          string

inherited

Prepare the output values for image/file TVs by prefixing the baseUrl property to them

Inherited from: \modFileMediaSource::prepareOutputUrl()

Parameters

Name	Type	Description
$value	string

Returns

Type	Description
string

prepareProperties(
          array $properties
              =
              array()
          )
        
        :
          array

inherited

Translate any needed properties

Inherited from: \modMediaSource::prepareProperties()\modFileMediaSource::prepareProperties()

Parameters

Name	Type	Description
$properties	array

Returns

Type	Description
array

prepareSrcForThumb(
          string $src
          )
        
        :
          string

inherited

Prepare the source path for phpThumb

Inherited from: \modMediaSource::prepareSrcForThumb()\modFileMediaSource::prepareSrcForThumb()

Parameters

Name	Type	Description
$src	string

Returns

Type	Description
string

remove(
          array $ancestors
              =
              array ()
          )
        
        :
          boolean

inherited

Custom remove that respects access policies.

Inherited from: \modAccessibleObject::remove()\modAccessibleSimpleObject::remove()\modMediaSource::remove()\modFileMediaSource::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.

removeContainer(
          string $path
          )
        
        :
          boolean

inherited

Remove a folder at the specified location

Inherited from: \modFileMediaSource::removeContainer()

Parameters

Name	Type	Description
$path	string

Returns

Type	Description
boolean

removeObject(
          string $objectPath
          )
        
        :
          boolean

inherited

Remove a file

Inherited from: \modFileMediaSource::removeObject()

Parameters

Name	Type	Description
$objectPath	string

Returns

Type	Description
boolean

removeValidationRules(
          string $field
              =
              null, array $rules
              =
              array()
          )
        
        :
          void

inherited

Remove one or more validation rules from this instance.

Inherited from: \xPDOObject::removeValidationRules()\modAccessibleObject::removeValidationRules()\modAccessibleSimpleObject::removeValidationRules()\modMediaSource::removeValidationRules()\modFileMediaSource::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.

renameContainer(
          string $oldPath, string $newName
          )
        
        :
          bool

inherited

Inherited from: \modFileMediaSource::renameContainer()

Parameters

Name	Type	Description
$oldPath	string
$newName	string

Returns

Type	Description
bool

renameObject(
          string $oldPath, string $newName
          )
        
        :
          bool

inherited

Inherited from: \modFileMediaSource::renameObject()

Parameters

Name	Type	Description
$oldPath	string
$newName	string

Returns

Type	Description
bool

save(
          boolean $cacheFlag
              =
              null
          )
        
        :
          boolean

inherited

Override xPDOObject::save to clear the sources cache on save

Inherited from: \modMediaSource::save()\modFileMediaSource::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

Returns

Type	Description
boolean

set(
          string $k, mixed $v
              =
              null, string | \callable $vType
              =
              ''
          )
        
        :
          boolean

inherited

Set a field value by the field key or name.

Inherited from: \xPDOObject::set()\modAccessibleObject::set()\modAccessibleSimpleObject::set()\modMediaSource::set()\modFileMediaSource::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).

setDirty(
          string $key
              =
              ''
          )
        
        :
          void

inherited

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

Inherited from: \xPDOObject::setDirty()\modAccessibleObject::setDirty()\modAccessibleSimpleObject::setDirty()\modMediaSource::setDirty()\modFileMediaSource::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.

setOption(
          string $key, mixed $value
          )
        
        :
          void

inherited

Set an option value for this instance.

Inherited from: \xPDOObject::setOption()\modAccessibleObject::setOption()\modAccessibleSimpleObject::setOption()\modMediaSource::setOption()\modFileMediaSource::setOption()

Parameters

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

inherited

Set the current object's policies.

Inherited from: \modAccessibleObject::setPolicies()\modAccessibleSimpleObject::setPolicies()\modMediaSource::setPolicies()\modFileMediaSource::setPolicies()

Parameters

Name	Type	Description
$policies	array

setProperties(
          array $properties, boolean $merge
              =
              false
          )
        
        :
          bool

inherited

Set the properties for this Source

Inherited from: \modMediaSource::setProperties()\modFileMediaSource::setProperties()

Parameters

Name	Type	Description
$properties	array
$merge	boolean

Returns

Type	Description
bool

setRequestProperties(
          array $scriptProperties
              =
              array()
          )
        
        :
          array

inherited

Setup the request properties for the source, determining any request-specific actions

Inherited from: \modMediaSource::setRequestProperties()\modFileMediaSource::setRequestProperties()

Parameters

Name	Type	Description
$scriptProperties	array

Returns

Type	Description
array

toArray(
          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()\modAccessibleObject::toArray()\modAccessibleSimpleObject::toArray()\modMediaSource::toArray()\modFileMediaSource::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.

toJSON(
          string $keyPrefix
              =
              '', boolean $rawValues
              =
              false
          )
        
        :
          string

inherited

Returns a JSON representation of the object.

Inherited from: \xPDOObject::toJSON()\modAccessibleObject::toJSON()\modAccessibleSimpleObject::toJSON()\modMediaSource::toJSON()\modFileMediaSource::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.

updateContainer(
          
          )
        
        :
          void

inherited

Inherited from: \modMediaSource::updateContainer()\modFileMediaSource::updateContainer()

updateObject(
          string $objectPath, string $content
          )
        
        :
          boolean | string

inherited

Update the contents of a file

Inherited from: \modFileMediaSource::updateObject()

Parameters

Name	Type	Description
$objectPath	string
$content	string

Returns

Type	Description
boolean \| string

uploadObjectsToContainer(
          string $container, array $objects
              =
              array()
          )
        
        :
          boolean

inherited

Upload files to a specific folder on the file system

Inherited from: \modFileMediaSource::uploadObjectsToContainer()

Parameters

Name	Type	Description
$container	string
$objects	array

Returns

Type	Description
boolean

validate(
          array $options
              =
              array()
          )
        
        :
          boolean

inherited

Validate the field values using an xPDOValidator.

Inherited from: \xPDOObject::validate()\modAccessibleObject::validate()\modAccessibleSimpleObject::validate()\modMediaSource::validate()\modFileMediaSource::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.

core/model/modx/sources/mysql/modfilemediasource.class.php

\modFileMediaSource_mysqljump to top

Properties

Methods

\modFileMediaSource_mysql
jump to top