core/model/modx/processors/system/console.class.php
Read from the registry to console
- Package
- modx
- $register
- string
The register to read from
- $topic
- string
The topic in the register to read from
- $format
- string
(optional) The format to output as. Defaults to json.
- $register_class
- string
(optional) If set, will load a custom registry class.
- $poll_limit
- integer
(optional) The number of polls to limit to. Defaults to 1.
- $poll_interval
- integer
(optional) The interval of polls to grab from. Defaults to 1.
- $time_limit
- integer
(optional) The time limit to sort by. Defaults to 10.
- $message_limit
- integer
(optional) The max amount of messages to grab. Defaults to 200.
- $remove_read
- boolean
(optional) If false, will not remove the message when read. Defaults to true.
- $show_filename
- boolean
(optional) If true, will show the filename in the message. Defaults to false.
- Subpackage
- processors.system.registry.register
\modConsoleProcessor
Read from the registry to console
{@inheritdoc}
- Parent(s)
- \modProcessor
- $register
- string
The register to read from
- $topic
- string
The topic in the register to read from
- $format
- string
(optional) The format to output as. Defaults to json.
- $register_class
- string
(optional) If set, will load a custom registry class.
- $poll_limit
- integer
(optional) The number of polls to limit to. Defaults to 1.
- $poll_interval
- integer
(optional) The interval of polls to grab from. Defaults to 1.
- $time_limit
- integer
(optional) The time limit to sort by. Defaults to 10.
- $message_limit
- integer
(optional) The max amount of messages to grab. Defaults to 200.
- $remove_read
- boolean
(optional) If false, will not remove the message when read. Defaults to true.
- $show_filename
- boolean
(optional) If true, will show the filename in the message. Defaults to false.
Properties
array
$properties= 'array()'
The array of properties being passed to this processor
Inherited from: \modProcessor::$$propertiesarray()
Details- Type
- array
- Inherited_from
- \modProcessor::$$properties
Methods
__construct(
\modX $modx, array $properties
=
array()
)
:
void
Name | Type | Description |
---|---|---|
$modx | \modX | A reference to the modX instance |
$properties | array | An array of properties |
_decodeLiterals(
string $string
)
:
string
Decodes strings encoded by _encodeLiterals to restore JavaScript literals.
Inherited from: \modProcessor::_decodeLiterals()Name | Type | Description |
---|---|---|
$string | string | The JSON-encoded string with encoded literals. |
Type | Description |
---|---|
string | The JSON-encoded string with literals restored. |
- Access
- protected
_encodeLiterals(
mixed $value, integer | string $key
)
:
void
Encodes certain JavaScript literal strings for later decoding.
Inherited from: \modProcessor::_encodeLiterals()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. |
- Access
- protected
addFieldError(
string $key, string $message
=
''
)
:
mixed
Name | Type | Description |
---|---|---|
$key | string | |
$message | string |
Type | Description |
---|---|
mixed |
checkPermissions(
)
:
boolean
Return true here to allow access to this processor.
Inherited from: \modProcessor::checkPermissions()Type | Description |
---|---|
boolean |
failure(
string $msg
=
'', mixed $object
=
null
)
:
array | string
Name | Type | Description |
---|---|---|
$msg | string | |
$object | mixed |
Type | Description |
---|---|
array | string |
getInstance(
\modX $modx, string $className, array $properties
=
array()
)
:
\The
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()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 |
Type | Description |
---|---|
\The | class specified by $className |
- Static
getLanguageTopics(
)
:
array
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.
Type | Description |
---|---|
array |
getProperties(
)
:
array
Get an array of properties for this processor
Inherited from: \modProcessor::getProperties()Type | Description |
---|---|
array |
getProperty(
string $k, mixed $default
=
null
)
:
mixed
Name | Type | Description |
---|---|---|
$k | string | |
$default | mixed |
Type | Description |
---|---|
mixed |
initialize(
)
:
boolean
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.
Type | Description |
---|---|
boolean |
outputArray(
array $array, mixed $count
=
false
)
:
string
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.
Name | Type | Description |
---|---|---|
$array | array | An array of data objects. |
$count | mixed | The total number of objects. Used for pagination. |
Type | Description |
---|---|
string | The JSON output. |
- 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.
Type | Description |
---|---|
mixed |
processEventResponse(
array | string $response, string $separator
=
"\n"
)
:
string
Processes a response from a Plugin Event invocation
Inherited from: \modProcessor::processEventResponse()Name | Type | Description |
---|---|---|
$response | array | string | The response generated by the invokeEvent call |
$separator | string | The separator for each event response |
Type | Description |
---|---|
string | The processed response. |
run(
)
:
\modProcessorResponse
Run the processor, returning a modProcessorResponse object.
Inherited from: \modProcessor::run()Type | Description |
---|---|
\modProcessorResponse |
setCheckbox(
string $k, boolean $force
=
false
)
:
int | null
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()Name | Type | Description |
---|---|---|
$k | string | |
$force | boolean |
Type | Description |
---|---|
int | null |
setDefaultProperties(
array $properties
=
array()
)
:
array
Sets default properties that only are set if they don't already exist in the request
Inherited from: \modProcessor::setDefaultProperties()Name | Type | Description |
---|---|---|
$properties | array |
Type | Description |
---|---|
array | The newly merged properties array |
setProperties(
array $properties
)
:
void
Set the runtime properties for the processor
Inherited from: \modProcessor::setProperties()Name | Type | Description |
---|---|---|
$properties | array | The properties, in array and key-value form, to run on this processor |
success(
string $msg
=
'', mixed $object
=
null
)
:
array | string
Name | Type | Description |
---|---|---|
$msg | string | |
$object | mixed |
Type | Description |
---|---|
array | string |
toJSON(
mixed $data
)
:
string
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.
Name | Type | Description |
---|---|---|
$data | mixed | The PHP data to be converted. |
Type | Description |
---|---|
string | The extended JSON-encoded string. |
- Access
- public
unsetProperty(
string $key
)
:
void
Completely unset a property from the properties array
Inherited from: \modProcessor::unsetProperty()Name | Type | Description |
---|---|---|
$key | string |