core/model/modx/registry/modregister.class.php

Show:

inherited

Classes
- \modRegister

Table of Contents

Represents a container used for producing and consuming messages.

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

\modRegister
jump to top

Package: modx\registry

Represents a container used for producing and consuming messages.

Children: \modFileRegister; \modDbRegister
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.

Properties

boolean
                 $__kill= 'false'

A polling flag that will terminate additional polling when true.

Default valuefalseDetails

Type: boolean

string
                 $_currentTopic= ''/''

An optional current topic to allow writes to relative paths.

Default value'/'Details

Type: string
Access: protected

string
                 $_key= 'null'

The key identifying this register in a registry.

Default valuenullDetails

Type: string
Access: protected

\modX
                 $modx= 'null'

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

Default valuenullDetails

Type: \modX
Access: public

array
                 $options= 'null'

An array of global options applied to the registry.

Default valuenullDetails

Type: array
Access: public

array
                 $subscriptions= 'array()'

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

Default valuearray()Details

Type: array
Access: public

Methods

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

Construct a new modRegister.

Parameters

Name	Type	Description
$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.

abort(
           $transactionKey
          )
        
        :
          void

Parameters

Name	Type	Description
$transactionKey

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

Acknowledge the registry was read

Parameters

Name	Type	Description
$messageKey	string	The key of the message being read
$transactionKey	string	The secure key of the transaction that is reading

begin(
          \$transactionKey $transactionKey
          )
        
        :
          void

Begin the reading of the message

Parameters

Name	Type	Description
$transactionKey	\$transactionKey	The key of the message

close(
          
          )
        
        :
          boolean

abstract

Close the connection to the register service implementation.

Returns

Type	Description
boolean	Indicates if the connection was closed successfully.

Details

Abstract: Implement this only if necessary for the implementation.

commit(
          string $transactionKey
          )
        
        :
          void

Commit the transaction and finish

Parameters

Name	Type	Description
$transactionKey	string	The key of the transaction

connect(
          array $attributes
              =
              array()
          )
        
        :
          boolean

abstract

Connect to the register service implementation.

Parameters

Name	Type	Description
$attributes	array	A collection of attributes required for connection to the register.

Returns

Type	Description
boolean	Indicates if the connection was successful.

Details

Abstract: Implement this only if necessary for the implementation.

getCurrentTopic(
          
          )
        
        :
          string

Get the current topic of the register.

Returns

Type	Description
string	The current topic set for the register.

getKey(
          
          )
        
        :
          string

Get the key of this registry

Returns

Type	Description
string	The key of the current registry

read(
          array $options
              =
              array()
          )
        
        :
          mixed

abstract

Reads any undigested messages from subscribed topics.

Parameters

Name	Type	Description
$options	array	An array of general or protocol specific options.

Returns

Type	Description
mixed	The resulting message from the register.

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

abstract

Send a message to the register.

Parameters

Name	Type	Description
$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.

Returns

Type	Description
boolean	Indicates if the message was recorded.

Details

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(
          string $topic
          )
        
        :
          void

Set the current topic to be read

Parameters

Name	Type	Description
$topic	string	The key of the topic

subscribe(
          string $topic
          )
        
        :
          boolean

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

Parameters

Name	Type	Description
$topic	string	The path representing the topic or message.

Returns

Type	Description
boolean	Indicates if the subscription was successful.

unsubscribe(
          string $topic
          )
        
        :
          boolean

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

Parameters

Name	Type	Description
$topic	string	The path representing the topic or message.

Returns

Type	Description
boolean	Indicates if the subscription was removed successfully.

core/model/modx/registry/modregister.class.php

\modRegisterjump to top

Properties

Methods

\modRegister
jump to top