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

Show:

inherited

Classes
- \modResourceReloadProcessor

Table of Contents

\modResourceReloadProcessor
jump to top

Package: Default

save resource form data for reload

{@inheritdoc}

Parent(s): \modProcessor

Properties

\modX
                 $modx= 'null'

inherited

A reference to the modX object.

Inherited from: \modProcessor::$$modx

Default valuenullDetails

Type: \modX
Inherited_from: \modProcessor::$$modx

string
                 $path= ''''

inherited

The absolute path to this processor

Inherited from: \modProcessor::$$path

Default value''Details

Type: string
Inherited_from: \modProcessor::$$path

array
                 $properties= 'array()'

inherited

The array of properties being passed to this processor

Inherited from: \modProcessor::$$properties

Default valuearray()Details

Type: array
Inherited_from: \modProcessor::$$properties

\modRegister
                 $reg= ''

registry

Details

Type: \modRegister

Methods

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

inherited

Creates a modProcessor object.

Inherited from: \modProcessor::__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()

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

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

Parameters

Name	Type	Description
$key	string
$message	string

Returns

Type	Description
mixed

checkPermissions(
          
          )
        
        :
          boolean

inherited

Return true here to allow access to this processor.

Inherited from: \modProcessor::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()

Parameters

Name	Type	Description
$msg	string
$object	mixed

Returns

Type	Description
array \| string

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

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: \modProcessor::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()

Returns

Type	Description
array

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

inherited

Get a specific property.

Inherited from: \modProcessor::getProperty()

Parameters

Name	Type	Description
$k	string
$default	mixed

Returns

Type	Description
mixed

hasErrors(
          
          )
        
        :
          boolean

inherited

Return whether or not the processor has errors

Inherited from: \modProcessor::hasErrors()

Returns

Type	Description
boolean

initialize(
          
          )
        
        :
          bool | string

initialization tasks before processing

Returns

Type	Description
bool \| string	true to continue with processing, otherwise err msg

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

inherited

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

Inherited from: \modProcessor::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

process(
          
          )
        
        :
          mixed

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

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

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

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

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

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

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

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

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

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

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

Parameters

Name	Type	Description
$key	string

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

\modResourceReloadProcessorjump to top

Properties

Methods

\modResourceReloadProcessor
jump to top