core/model/modx/processors/element/chunk/getlist.class.php

Show:

inherited

Classes
- \modChunkGetListProcessor

Table of Contents

Grabs a list of chunks.

Package: modx
$start: integer
(optional) The record to start at. Defaults to 0.
$limit: integer
(optional) The number of records to limit to. Defaults to 10.
$sort: string
(optional) The column to sort by. Defaults to name.
$dir: string
(optional) The direction of the sort. Defaults to ASC.
Subpackage: processors.element.chunk

\modChunkGetListProcessor
jump to top

Package: modx\processors\element\chunk

Grabs a list of chunks.

{@inheritdoc}

Parent(s): \modElementGetListProcessor < \modObjectGetListProcessor < \modObjectProcessor < \modProcessor
$start: integer
(optional) The record to start at. Defaults to 0.
$limit: integer
(optional) The number of records to limit to. Defaults to 10.
$sort: string
(optional) The column to sort by. Defaults to name.
$dir: string
(optional) The direction of the sort. Defaults to ASC.

Properties

boolean
                 $checkListPermission= 'true'

inherited

If true and object is a modAccessibleObject, will check list permissionInherited from: \modObjectGetListProcessor::$$checkListPermission \modElementGetListProcessor::$$checkListPermission

Default valuetrueDetails

Type: boolean
Inherited_from: \modObjectGetListProcessor::$$checkListPermission
Inherited_from: \modElementGetListProcessor::$$checkListPermission

string
                 $classKey= ''modChunk''

The class key of the Object to iterate

Default value'modChunk'Details

Type: string

int
                 $currentIndex= '0'

inherited

The current index of successful iterationInherited from: \modObjectGetListProcessor::$$currentIndex \modElementGetListProcessor::$$currentIndex

Default value0Details

Type: int
Inherited_from: \modObjectGetListProcessor::$$currentIndex
Inherited_from: \modElementGetListProcessor::$$currentIndex

string
                 $defaultSortDirection= ''ASC''

inherited

The default direction to sortInherited from: \modObjectGetListProcessor::$$defaultSortDirection \modElementGetListProcessor::$$defaultSortDirection

Default value'ASC'Details

Type: string
Inherited_from: \modObjectGetListProcessor::$$defaultSortDirection
Inherited_from: \modElementGetListProcessor::$$defaultSortDirection

string
                 $defaultSortField= ''name''

inherited

The default field to sort byInherited from: \modObjectGetListProcessor::$$defaultSortField \modElementGetListProcessor::$$defaultSortField

Default value'name'Details

Type: string
Inherited_from: \modObjectGetListProcessor::$$defaultSortField
Inherited_from: \modElementGetListProcessor::$$defaultSortField

array
                 $languageTopics= 'array('chunk','category')'

An array of language topics to load

Default valuearray('chunk','category')Details

Type: array

\modX
                 $modx= 'null'

inherited

A reference to the modX object.

Inherited from: \modProcessor::$$modx \modObjectProcessor::$$modx \modObjectGetListProcessor::$$modx \modElementGetListProcessor::$$modx

Default valuenullDetails

Type: \modX
Inherited_from: \modProcessor::$$modx
Inherited_from: \modObjectProcessor::$$modx
Inherited_from: \modObjectGetListProcessor::$$modx
Inherited_from: \modElementGetListProcessor::$$modx

\xPDOObject|\modAccessibleObject
                 $object= ''

inherited

The object being grabbedInherited from: \modObjectProcessor::$$object \modObjectGetListProcessor::$$object \modElementGetListProcessor::$$object

Details

Type: \xPDOObject | \modAccessibleObject
Inherited_from: \modObjectProcessor::$$object
Inherited_from: \modObjectGetListProcessor::$$object
Inherited_from: \modElementGetListProcessor::$$object

string
                 $objectType= ''object''

inherited

The object "type", this will be used in various lexicon error stringsInherited from: \modObjectProcessor::$$objectType \modObjectGetListProcessor::$$objectType \modElementGetListProcessor::$$objectType

Default value'object'Details

Type: string
Inherited_from: \modObjectProcessor::$$objectType
Inherited_from: \modObjectGetListProcessor::$$objectType
Inherited_from: \modElementGetListProcessor::$$objectType

string
                 $path= ''''

inherited

The absolute path to this processor

Inherited from: \modProcessor::$$path \modObjectProcessor::$$path \modObjectGetListProcessor::$$path \modElementGetListProcessor::$$path

Default value''Details

Type: string
Inherited_from: \modProcessor::$$path
Inherited_from: \modObjectProcessor::$$path
Inherited_from: \modObjectGetListProcessor::$$path
Inherited_from: \modElementGetListProcessor::$$path

string
                 $permission= ''''

inherited

The Permission to use when checking againstInherited from: \modObjectProcessor::$$permission \modObjectGetListProcessor::$$permission \modElementGetListProcessor::$$permission

Default value''Details

Type: string
Inherited_from: \modObjectProcessor::$$permission
Inherited_from: \modObjectGetListProcessor::$$permission
Inherited_from: \modElementGetListProcessor::$$permission

string
                 $primaryKeyField= ''id''

inherited

The primary key field to grab the object byInherited from: \modObjectProcessor::$$primaryKeyField \modObjectGetListProcessor::$$primaryKeyField \modElementGetListProcessor::$$primaryKeyField

Default value'id'Details

Type: string
Inherited_from: \modObjectProcessor::$$primaryKeyField
Inherited_from: \modObjectGetListProcessor::$$primaryKeyField
Inherited_from: \modElementGetListProcessor::$$primaryKeyField

array
                 $properties= 'array()'

inherited

The array of properties being passed to this processor

Inherited from: \modProcessor::$$properties \modObjectProcessor::$$properties \modObjectGetListProcessor::$$properties \modElementGetListProcessor::$$properties

Default valuearray()Details

Type: array
Inherited_from: \modProcessor::$$properties
Inherited_from: \modObjectProcessor::$$properties
Inherited_from: \modObjectGetListProcessor::$$properties
Inherited_from: \modElementGetListProcessor::$$properties

Methods

__construct(
          \modX $modx, array $properties
              =
              array()
          )
        
        :
          void

inherited

Creates a modProcessor object.

Inherited from: \modProcessor::__construct()\modObjectProcessor::__construct()\modObjectGetListProcessor::__construct()\modElementGetListProcessor::__construct()

Parameters

Name	Type	Description
$modx	\modX	A reference to the modX instance
$properties	array	An array of properties

_decodeLiterals(
          string $string
          )
        
        :
          string

inherited

Decodes strings encoded by _encodeLiterals to restore JavaScript literals.

Inherited from: \modProcessor::_decodeLiterals()\modObjectProcessor::_decodeLiterals()\modObjectGetListProcessor::_decodeLiterals()\modElementGetListProcessor::_decodeLiterals()

Parameters

Name	Type	Description
$string	string	The JSON-encoded string with encoded literals.

Returns

Type	Description
string	The JSON-encoded string with literals restored.

Details

Access: protected

_encodeLiterals(
          mixed $value, integer | string $key
          )
        
        :
          void

inherited

Encodes certain JavaScript literal strings for later decoding.

Inherited from: \modProcessor::_encodeLiterals()\modObjectProcessor::_encodeLiterals()\modObjectGetListProcessor::_encodeLiterals()\modElementGetListProcessor::_encodeLiterals()

Parameters

Name	Type	Description
$value	mixed	&$value A reference to the value to be encoded if it is identified as a literal.
$key	integer \| string	The array key corresponding to the value.

Details

Access: protected

addFieldError(
          string $key, string $message
              =
              ''
          )
        
        :
          mixed

inherited

Add an error to the field

Inherited from: \modProcessor::addFieldError()\modObjectProcessor::addFieldError()\modObjectGetListProcessor::addFieldError()\modElementGetListProcessor::addFieldError()

Parameters

Name	Type	Description
$key	string
$message	string

Returns

Type	Description
mixed

afterIteration(
          array $list
          )
        
        :
          array

inherited

Can be used to insert a row after iteration

Inherited from: \modObjectGetListProcessor::afterIteration()\modElementGetListProcessor::afterIteration()

Parameters

Name	Type	Description
$list	array

Returns

Type	Description
array

beforeIteration(
          array $list
          )
        
        :
          array

inherited

Can be used to insert a row before iteration

Inherited from: \modObjectGetListProcessor::beforeIteration()\modElementGetListProcessor::beforeIteration()

Parameters

Name	Type	Description
$list	array

Returns

Type	Description
array

beforeQuery(
          
          )
        
        :
          boolean

inherited

Allow stoppage of process before the query

Inherited from: \modObjectGetListProcessor::beforeQuery()\modElementGetListProcessor::beforeQuery()

Returns

Type	Description
boolean

checkPermissions(
          
          )
        
        :
          boolean

inherited

Return true here to allow access to this processor.

Inherited from: \modObjectProcessor::checkPermissions()\modObjectGetListProcessor::checkPermissions()\modElementGetListProcessor::checkPermissions()

Returns

Type	Description
boolean

failure(
          string $msg
              =
              '', mixed $object
              =
              null
          )
        
        :
          array | string

inherited

Return a failure message from the processor.

Inherited from: \modProcessor::failure()\modObjectProcessor::failure()\modObjectGetListProcessor::failure()\modElementGetListProcessor::failure()

Parameters

Name	Type	Description
$msg	string
$object	mixed

Returns

Type	Description
array \| string

getData(
          
          )
        
        :
          array

inherited

Get the data of the query

Inherited from: \modObjectGetListProcessor::getData()\modElementGetListProcessor::getData()

Returns

Type	Description
array

getInstance(
          \modX $modx, string $className, array $properties
              =
              array()
          )
        
        :
          \The

staticinherited

Return the proper instance of the derived class. This can be used to override how MODX loads a processor class; for example, when handling derivative classes with class_key settings.

Inherited from: \modProcessor::getInstance()\modObjectProcessor::getInstance()\modObjectGetListProcessor::getInstance()\modElementGetListProcessor::getInstance()

Parameters

Name	Type	Description
$modx	\modX	A reference to the modX object.
$className	string	The name of the class that is being requested.
$properties	array	An array of properties being run with the processor

Returns

Type	Description
\The	class specified by $className

Details

Static

getLanguageTopics(
          
          )
        
        :
          array

inherited

Load a collection of Language Topics for this processor.

Inherited from: \modObjectProcessor::getLanguageTopics()\modObjectGetListProcessor::getLanguageTopics()\modElementGetListProcessor::getLanguageTopics()

Override this in your derivative class to provide the array of topics to load.

Returns

Type	Description
array

getProperties(
          
          )
        
        :
          array

inherited

Get an array of properties for this processor

Inherited from: \modProcessor::getProperties()\modObjectProcessor::getProperties()\modObjectGetListProcessor::getProperties()\modElementGetListProcessor::getProperties()

Returns

Type	Description
array

getProperty(
          string $k, mixed $default
              =
              null
          )
        
        :
          mixed

inherited

Get a specific property.

Inherited from: \modProcessor::getProperty()\modObjectProcessor::getProperty()\modObjectGetListProcessor::getProperty()\modElementGetListProcessor::getProperty()

Parameters

Name	Type	Description
$k	string
$default	mixed

Returns

Type	Description
mixed

getSortClassKey(
          
          )
        
        :
          string

inherited

Can be used to provide a custom sorting class key for the default sorting columns

Inherited from: \modObjectGetListProcessor::getSortClassKey()\modElementGetListProcessor::getSortClassKey()

Returns

Type	Description
string

hasErrors(
          
          )
        
        :
          boolean

inherited

Return whether or not the processor has errors

Inherited from: \modProcessor::hasErrors()\modObjectProcessor::hasErrors()\modObjectGetListProcessor::hasErrors()\modElementGetListProcessor::hasErrors()

Returns

Type	Description
boolean

initialize(
          
          )
        
        :
          boolean

inherited

Can be used to provide custom methods prior to processing. Return true to tell MODX that the Processor initialized successfully. If you return anything else, MODX will output that return value as an error message.

Inherited from: \modObjectGetListProcessor::initialize()\modElementGetListProcessor::initialize()

Returns

Type	Description
boolean

iterate(
          array $data
          )
        
        :
          array

inherited

Iterate across the data

Inherited from: \modObjectGetListProcessor::iterate()\modElementGetListProcessor::iterate()

Parameters

Name	Type	Description
$data	array

Returns

Type	Description
array

outputArray(
          array $array, mixed $count
              =
              false
          )
        
        :
          string

inherited

Return arrays of objects (with count) converted to JSON.

Inherited from: \modProcessor::outputArray()\modObjectProcessor::outputArray()\modObjectGetListProcessor::outputArray()\modElementGetListProcessor::outputArray()

The JSON result includes two main elements, total and results. This format is used for list results.

Parameters

Name	Type	Description
$array	array	An array of data objects.
$count	mixed	The total number of objects. Used for pagination.

Returns

Type	Description
string	The JSON output.

Details

Access: public

prepareQueryAfterCount(
          \xPDOQuery $c
          )
        
        :
          \xPDOQuery

inherited

Can be used to prepare the query after the COUNT statement

Inherited from: \modElementGetListProcessor::prepareQueryAfterCount()

Parameters

Name	Type	Description
$c	\xPDOQuery

Returns

Type	Description
\xPDOQuery

prepareQueryBeforeCount(
          \xPDOQuery $c
          )
        
        :
          \xPDOQuery

inherited

Can be used to adjust the query prior to the COUNT statement

Inherited from: \modElementGetListProcessor::prepareQueryBeforeCount()

Parameters

Name	Type	Description
$c	\xPDOQuery

Returns

Type	Description
\xPDOQuery

prepareRow(
          \xPDOObject $object
          )
        
        :
          array

inherited

Prepare the row for iteration

Inherited from: \modObjectGetListProcessor::prepareRow()\modElementGetListProcessor::prepareRow()

Parameters

Name	Type	Description
$object	\xPDOObject

Returns

Type	Description
array

process(
          
          )
        
        :
          mixed

inherited

Run the processor and return the result. Override this in your derivative class to provide custom functionality.

Inherited from: \modObjectGetListProcessor::process()\modElementGetListProcessor::process()

Used here for pre-2.2-style processors.

Returns

Type	Description
mixed

processEventResponse(
          array | string $response, string $separator
              =
              "\n"
          )
        
        :
          string

inherited

Processes a response from a Plugin Event invocation

Inherited from: \modProcessor::processEventResponse()\modObjectProcessor::processEventResponse()\modObjectGetListProcessor::processEventResponse()\modElementGetListProcessor::processEventResponse()

Parameters

Name	Type	Description
$response	array \| string	The response generated by the invokeEvent call
$separator	string	The separator for each event response

Returns

Type	Description
string	The processed response.

run(
          
          )
        
        :
          \modProcessorResponse

inherited

Run the processor, returning a modProcessorResponse object.

Inherited from: \modProcessor::run()\modObjectProcessor::run()\modObjectGetListProcessor::run()\modElementGetListProcessor::run()

Returns

Type	Description
\modProcessorResponse

setCheckbox(
          string $k, boolean $force
              =
              false
          )
        
        :
          int | null

inherited

Special helper method for handling checkboxes. Only set value if passed or $force is true, and check for a not empty value or string 'false'.

Inherited from: \modProcessor::setCheckbox()\modObjectProcessor::setCheckbox()\modObjectGetListProcessor::setCheckbox()\modElementGetListProcessor::setCheckbox()

Parameters

Name	Type	Description
$k	string
$force	boolean

Returns

Type	Description
int \| null

setDefaultProperties(
          array $properties
              =
              array()
          )
        
        :
          array

inherited

Sets default properties that only are set if they don't already exist in the request

Inherited from: \modProcessor::setDefaultProperties()\modObjectProcessor::setDefaultProperties()\modObjectGetListProcessor::setDefaultProperties()\modElementGetListProcessor::setDefaultProperties()

Parameters

Name	Type	Description
$properties	array

Returns

Type	Description
array	The newly merged properties array

setPath(
          string $path
          )
        
        :
          void

inherited

Set the path of the processor

Inherited from: \modProcessor::setPath()\modObjectProcessor::setPath()\modObjectGetListProcessor::setPath()\modElementGetListProcessor::setPath()

Parameters

Name	Type	Description
$path	string	The absolute path

setProperties(
          array $properties
          )
        
        :
          void

inherited

Set the runtime properties for the processor

Inherited from: \modProcessor::setProperties()\modObjectProcessor::setProperties()\modObjectGetListProcessor::setProperties()\modElementGetListProcessor::setProperties()

Parameters

Name	Type	Description
$properties	array	The properties, in array and key-value form, to run on this processor

setProperty(
          string $k, mixed $v
          )
        
        :
          void

inherited

Set a property value

Inherited from: \modProcessor::setProperty()\modObjectProcessor::setProperty()\modObjectGetListProcessor::setProperty()\modElementGetListProcessor::setProperty()

Parameters

Name	Type	Description
$k	string
$v	mixed

success(
          string $msg
              =
              '', mixed $object
              =
              null
          )
        
        :
          array | string

inherited

Return a success message from the processor.

Inherited from: \modProcessor::success()\modObjectProcessor::success()\modObjectGetListProcessor::success()\modElementGetListProcessor::success()

Parameters

Name	Type	Description
$msg	string
$object	mixed

Returns

Type	Description
array \| string

toJSON(
          mixed $data
          )
        
        :
          string

inherited

Converts PHP to JSON with JavaScript literals left in-tact.

Inherited from: \modProcessor::toJSON()\modObjectProcessor::toJSON()\modObjectGetListProcessor::toJSON()\modElementGetListProcessor::toJSON()

JSON does not allow JavaScript literals, but this function encodes certain identifiable literals and decodes them back into literals after modX::toJSON() formats the data.

Parameters

Name	Type	Description
$data	mixed	The PHP data to be converted.

Returns

Type	Description
string	The extended JSON-encoded string.

Details

Access: public

unsetProperty(
          string $key
          )
        
        :
          void

inherited

Completely unset a property from the properties array

Inherited from: \modProcessor::unsetProperty()\modObjectProcessor::unsetProperty()\modObjectGetListProcessor::unsetProperty()\modElementGetListProcessor::unsetProperty()

Parameters

Name	Type	Description
$key	string

core/model/modx/processors/element/chunk/getlist.class.php

\modChunkGetListProcessorjump to top

Properties

Methods

\modChunkGetListProcessor
jump to top