Documentation

Horde_PubSub_Handle
in package

Publish-Subscribe handler: unique handle subscribed to a given topic.

Tags
category

Horde

Table of Contents

$_callback  : string|array<string|int, mixed>
PHP callback to invoke
$_topic  : string
Topic to which this handle is subscribed
__construct()  : mixed
Constructor
call()  : void
Invoke handler
getCallback()  : string|array<string|int, mixed>
Retrieve registered callback
getTopic()  : string
Get topic to which handle is subscribed

Properties

$_callback

PHP callback to invoke

protected string|array<string|int, mixed> $_callback

$_topic

Topic to which this handle is subscribed

protected string $_topic

Methods

__construct()

Constructor

public __construct(string $topic, string|object $context[, string|null $handler = null ]) : mixed
Parameters
$topic : string

Topic to which handle is subscribed

$context : string|object

Function name, class name, or object instance

$handler : string|null = null

Method name, if $context is a class or object

Return values
mixed

call()

Invoke handler

public call(array<string|int, mixed> $args) : void
Parameters
$args : array<string|int, mixed>

Arguments to pass to callback

Return values
void

getCallback()

Retrieve registered callback

public getCallback() : string|array<string|int, mixed>
Return values
string|array<string|int, mixed>

getTopic()

Get topic to which handle is subscribed

public getTopic() : string
Return values
string

Search results