model/modx/registry/modregister.class.php

Classes 
abstract
Implement a derivative of this class to provide the behavior for the abstract methods, or override other public or protected methods at your discretion.
package
modx
subpackage
registry
Classes
modRegister

Description

Represents a container used for producing and consuming messages.

\modRegister
jump to top

abstract
Implement a derivative of this class to provide the behavior for the abstract methods, or override other public or protected methods at your discretion.
package
modx
subpackage
registry
Properties
$__kill
$_currentTopic
$_key
$modx
$options
$subscriptions
Methods
__construct
abort
acknowledge
begin
close
commit
connect
getKey
read
send
setCurrentTopic
subscribe
unsubscribe

Description

Represents a container used for producing and consuming messages.

Properties

$__kill
jump to class

boolean $__kill = 'false'

A polling flag that will terminate additional polling when true.

Details

boolean
visibility
public
default
false
final
false
static
false

$_currentTopic
jump to class

string $_currentTopic = '/'

An optional current topic to allow writes to relative paths.

Details

string
visibility
protected
default
/
final
false
static
false
access
protected

$_key
jump to class

string $_key = 'null'

The key identifying this register in a registry.

Details

string
visibility
protected
default
null
final
false
static
false
access
protected

$modx
jump to class

\modX $modx = 'null'

A reference to the modX instance the register is loaded by.

Details

\modX
visibility
public
default
null
final
false
static
false
access
public

$options
jump to class

array $options = 'null'

An array of global options applied to the registry.

Details

array
visibility
public
default
null
final
false
static
false
access
public

$subscriptions
jump to class

array $subscriptions = 'array'

An array of topics and/or messages the register is subscribed to.

Details

array
visibility
public
default
array
final
false
static
false
access
public

Methods

__construct
jump to class

__construct( \modX $modx, string $key, array $options = array ) :

Construct a new modRegister.

Arguments
$modx
\modX
&$modx A reference to a modX instance.
$key
string
A valid PHP variable which will be set on the modRegistry instance.
$options
array
Optional array of registry options.
Details
visibility
public
final
false
static
false

abort
jump to class

abort(  $transactionKey ) : void

Arguments
$transactionKey
Details
visibility
public
final
false
static
false

acknowledge
jump to class

acknowledge( string $messageKey, string $transactionKey ) : void

Acknowledge the registry was read

Arguments
$messageKey
string
The key of the message being read
$transactionKey
string
The secure key of the transaction that is reading
Details
visibility
public
final
false
static
false

begin
jump to class

begin( \$transactionKey $transactionKey ) : void

Begin the reading of the message

Arguments
$transactionKey
\$transactionKey
The key of the message
Details
visibility
public
final
false
static
false

close
jump to class

close( ) : boolean

Close the connection to the register service implementation.

Output
boolean
Indicates if the connection was closed successfully.
Details
visibility
public
final
false
static
false
abstract
Implement this only if necessary for the implementation.

commit
jump to class

commit( string $transactionKey ) : void

Commit the transaction and finish

Arguments
$transactionKey
string
The key of the transaction
Details
visibility
public
final
false
static
false

connect
jump to class

connect( array $attributes = array ) : boolean

Connect to the register service implementation.

Arguments
$attributes
array
A collection of attributes required for connection to the register.
Output
boolean
Indicates if the connection was successful.
Details
visibility
public
final
false
static
false
abstract
Implement this only if necessary for the implementation.

getKey
jump to class

getKey( ) : string

Get the key of this registry

Output
string
The key of the current registry
Details
visibility
public
final
false
static
false

read
jump to class

read( array $options = array ) : mixed

Reads any undigested messages from subscribed topics.

Arguments
$options
array
An array of general or protocol specific options.
Output
mixed
The resulting message from the register.
Details
visibility
public
final
false
static
false

send
jump to class

send( string $topic, mixed $message, array $options = array ) : boolean

Send a message to the register.

Arguments
$topic
string
A topic container in which to broadcast the message.
$message
mixed
A message, or collection of messages to be sent to the register.
$options
array
An optional array of general or protocol specific message properties.
Output
boolean
Indicates if the message was recorded.
Details
visibility
public
final
false
static
false
abstract
Implement this function in derivatives to send a message to a specific register (e.g. modFileRegister for file-based registers, modStompRegister for ActiveMQ, etc.).

setCurrentTopic
jump to class

setCurrentTopic( string $topic ) : void

Set the current topic to be read

Arguments
$topic
string
The key of the topic
Details
visibility
public
final
false
static
false

subscribe
jump to class

subscribe( string $topic ) : boolean

Subscribe to a topic (or specific message) in the register.

Arguments
$topic
string
The path representing the topic or message.
Output
boolean
Indicates if the subscription was successful.
Details
visibility
public
final
false
static
false

unsubscribe
jump to class

unsubscribe( string $topic ) : boolean

Unsubscribe from a topic (or specific message) in the register.

Arguments
$topic
string
The path representing the topic or message.
Output
boolean
Indicates if the subscription was removed successfully.
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox 0.11.2.