core/model/modx/processors/resource/search.class.php

Show: inherited
Table of Contents

Searches for specific resources and returns them in an array.

Package
modx  
$start
integer

The page to start on

$limit
integer

(optional) The number of results to limit by

$sort
string

The column to sort by

$dir
string

The direction to sort

array
Subpackage
processors.resource  

\modResourceSearchProcessor

Package: modx\processors\resource

Searches for specific resources and returns them in an array.

{@inheritdoc}

Parent(s)
\modObjectGetListProcessor < \modObjectProcessor < \modProcessor
$start
integer

The page to start on

$limit
integer

(optional) The number of results to limit by

$sort
string

The column to sort by

$dir
string

The direction to sort

array

Properties

Propertypublicarray  $actions= 'array()'

Default valuearray()Details
Type
array
Propertypublicboolean  $canEdit= 'false'

Default valuefalseDetails
Type
boolean
Propertypublicstring  $charset= ''UTF-8''

Default value'UTF-8'Details
Type
string
Propertypublicboolean  $checkListPermission= 'true'
inherited

If true and object is a modAccessibleObject, will check list permissionInherited from: \modObjectGetListProcessor::$$checkListPermission
Default valuetrueDetails
Type
boolean
Inherited_from
\modObjectGetListProcessor::$$checkListPermission  
Propertypublicstring  $classKey= ''modResource''

The class key of the Object to iterate
Default value'modResource'Details
Type
string
Propertypublicarray  $contextKeys= 'array()'

Default valuearray()Details
Type
array
Propertypublicint  $currentIndex= '0'
inherited

The current index of successful iterationInherited from: \modObjectGetListProcessor::$$currentIndex
Default value0Details
Type
int
Inherited_from
\modObjectGetListProcessor::$$currentIndex  
Propertypublicstring  $defaultSortDirection= ''ASC''
inherited

The default direction to sortInherited from: \modObjectGetListProcessor::$$defaultSortDirection
Default value'ASC'Details
Type
string
Inherited_from
\modObjectGetListProcessor::$$defaultSortDirection  
Propertypublicstring  $defaultSortField= ''pagetitle''

The default field to sort by
Default value'pagetitle'Details
Type
string
Propertypublicarray  $languageTopics= 'array('resource')'

An array of language topics to load
Default valuearray('resource')Details
Type
array
Propertypublic\modX  $modx= 'null'
inherited

A reference to the modX object.

Inherited from: \modProcessor::$$modx\modObjectProcessor::$$modx\modObjectGetListProcessor::$$modx
Default valuenullDetails
Type
\modX
Inherited_from
\modProcessor::$$modx  
Inherited_from
\modObjectProcessor::$$modx  
Inherited_from
\modObjectGetListProcessor::$$modx  
Propertypublic\xPDOObject|\modAccessibleObject  $object= ''
inherited

The object being grabbedInherited from: \modObjectProcessor::$$object\modObjectGetListProcessor::$$object
Propertypublicstring  $objectType= ''object''
inherited

The object "type", this will be used in various lexicon error stringsInherited from: \modObjectProcessor::$$objectType\modObjectGetListProcessor::$$objectType
Default value'object'Details
Type
string
Inherited_from
\modObjectProcessor::$$objectType  
Inherited_from
\modObjectGetListProcessor::$$objectType  
Propertypublicstring  $path= ''''
inherited

The absolute path to this processor

Inherited from: \modProcessor::$$path\modObjectProcessor::$$path\modObjectGetListProcessor::$$path
Default value''Details
Type
string
Inherited_from
\modProcessor::$$path  
Inherited_from
\modObjectProcessor::$$path  
Inherited_from
\modObjectGetListProcessor::$$path  
Propertypublicstring  $permission= ''search''

The Permission to use when checking against
Default value'search'Details
Type
string
Propertypublicstring  $primaryKeyField= ''id''
inherited

The primary key field to grab the object byInherited from: \modObjectProcessor::$$primaryKeyField\modObjectGetListProcessor::$$primaryKeyField
Default value'id'Details
Type
string
Inherited_from
\modObjectProcessor::$$primaryKeyField  
Inherited_from
\modObjectGetListProcessor::$$primaryKeyField  
Propertypublicarray  $properties= 'array()'
inherited

The array of properties being passed to this processor

Inherited from: \modProcessor::$$properties\modObjectProcessor::$$properties\modObjectGetListProcessor::$$properties
Default valuearray()Details
Type
array
Inherited_from
\modProcessor::$$properties  
Inherited_from
\modObjectProcessor::$$properties  
Inherited_from
\modObjectGetListProcessor::$$properties  

Methods

methodpublic__construct( \modX $modx, array $properties = array() ) : void
Parameters
Name Type Description
$modx \modX

A reference to the modX instance

$properties array

An array of properties

methodprotected_decodeLiterals( string $string ) : string
inherited

Decodes strings encoded by _encodeLiterals to restore JavaScript literals.

Inherited from: \modProcessor::_decodeLiterals()\modObjectProcessor::_decodeLiterals()\modObjectGetListProcessor::_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  
methodprotected_encodeLiterals( mixed $value, integer | string $key ) : void
inherited

Encodes certain JavaScript literal strings for later decoding.

Inherited from: \modProcessor::_encodeLiterals()\modObjectProcessor::_encodeLiterals()\modObjectGetListProcessor::_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  
methodpublicaddFieldError( string $key, string $message = '' ) : mixed
Parameters
Name Type Description
$key string
$message string
Returns
Type Description
mixed
methodpublicafterIteration( array $list ) : array
inherited

Can be used to insert a row after iteration

Inherited from: \modObjectGetListProcessor::afterIteration()
Parameters
Name Type Description
$list array
Returns
Type Description
array
methodpublicbeforeIteration( array $list ) : array

Can be used to insert a row before iteration

Parameters
Name Type Description
$list array
Returns
Type Description
array
methodpublicbeforeQuery( ) : boolean

Allow stoppage of process before the query

Returns
Type Description
boolean
methodpubliccheckPermissions( ) : boolean
inherited

Return true here to allow access to this processor.

Inherited from: \modObjectProcessor::checkPermissions()\modObjectGetListProcessor::checkPermissions()
Returns
Type Description
boolean
methodpublicfailure( string $msg = '', mixed $object = null ) : array | string
inherited

Return a failure message from the processor.

Inherited from: \modProcessor::failure()\modObjectProcessor::failure()\modObjectGetListProcessor::failure()
Parameters
Name Type Description
$msg string
$object mixed
Returns
Type Description
array | string
methodpublicgetContextKeys( ) : array

Get a collection of Context keys that the User can access for all the Resources

Returns
Type Description
array
methodpublicgetData( ) : array
inherited

Get the data of the query

Inherited from: \modObjectGetListProcessor::getData()
Returns
Type Description
array
methodpublicgetInstance( \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()
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
 
methodpublicgetLanguageTopics( ) : array
inherited

Load a collection of Language Topics for this processor.

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

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

Returns
Type Description
array
methodpublicgetProperties( ) : array
inherited

Get an array of properties for this processor

Inherited from: \modProcessor::getProperties()\modObjectProcessor::getProperties()\modObjectGetListProcessor::getProperties()
Returns
Type Description
array
methodpublicgetProperty( string $k, mixed $default = null ) : mixed
Parameters
Name Type Description
$k string
$default mixed
Returns
Type Description
mixed
methodpublicgetSortClassKey( ) : string
inherited

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

Inherited from: \modObjectGetListProcessor::getSortClassKey()
Returns
Type Description
string
methodpublichasErrors( ) : boolean
inherited

Return whether or not the processor has errors

Inherited from: \modProcessor::hasErrors()\modObjectProcessor::hasErrors()\modObjectGetListProcessor::hasErrors()
Returns
Type Description
boolean
methodpublicinitialize( ) : 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()
Returns
Type Description
boolean
methodpubliciterate( array $data ) : array
inherited

Iterate across the data

Inherited from: \modObjectGetListProcessor::iterate()
Parameters
Name Type Description
$data array
Returns
Type Description
array
methodpublicoutputArray( array $array, mixed $count = false ) : string
inherited

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

Inherited from: \modProcessor::outputArray()\modObjectProcessor::outputArray()\modObjectGetListProcessor::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  
methodpublicprepareQueryAfterCount( \xPDOQuery $c ) : \xPDOQuery
inherited

Can be used to prepare the query after the COUNT statement

Inherited from: \modObjectGetListProcessor::prepareQueryAfterCount()
Parameters
Name Type Description
$c \xPDOQuery
Returns
Type Description
\xPDOQuery
methodpublicprepareQueryBeforeCount( \xPDOQuery $c ) : \xPDOQuery

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

Parameters
Name Type Description
$c \xPDOQuery
Returns
Type Description
\xPDOQuery
methodpublicprepareRow( \xPDOObject $object ) : array

Prepare the row for iteration

Parameters
Name Type Description
$object \xPDOObject
Returns
Type Description
array
methodpublicprocess( ) : mixed
inherited

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

Inherited from: \modObjectGetListProcessor::process()

Used here for pre-2.2-style processors.

Returns
Type Description
mixed
methodpublicprocessEventResponse( array | string $response, string $separator = "\n" ) : string
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.
methodpublicrun( ) : \modProcessorResponse
inherited

Run the processor, returning a modProcessorResponse object.

Inherited from: \modProcessor::run()\modObjectProcessor::run()\modObjectGetListProcessor::run()
Returns
Type Description
\modProcessorResponse
methodpublicsetCheckbox( 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()
Parameters
Name Type Description
$k string
$force boolean
Returns
Type Description
int | null
methodpublicsetDefaultProperties( 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()
Parameters
Name Type Description
$properties array
Returns
Type Description
array The newly merged properties array
methodpublicsetPath( string $path ) : void
Parameters
Name Type Description
$path string

The absolute path

methodpublicsetProperties( array $properties ) : void
Parameters
Name Type Description
$properties array

The properties, in array and key-value form, to run on this processor

methodpublicsetProperty( string $k, mixed $v ) : void
Parameters
Name Type Description
$k string
$v mixed
methodpublicsuccess( string $msg = '', mixed $object = null ) : array | string
inherited

Return a success message from the processor.

Inherited from: \modProcessor::success()\modObjectProcessor::success()\modObjectGetListProcessor::success()
Parameters
Name Type Description
$msg string
$object mixed
Returns
Type Description
array | string
methodpublictoJSON( mixed $data ) : string
inherited

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

Inherited from: \modProcessor::toJSON()\modObjectProcessor::toJSON()\modObjectGetListProcessor::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  
methodpublicunsetProperty( string $key ) : void
inherited

Completely unset a property from the properties array

Inherited from: \modProcessor::unsetProperty()\modObjectProcessor::unsetProperty()\modObjectGetListProcessor::unsetProperty()
Parameters
Name Type Description
$key string
Documentation was generated by DocBlox 0.18.1.