core/model/modx/processors/system/registry/register/read.php

Show: inherited

Table of Contents

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