Documentation

Manager
in package
implements ArrayAccess, Countable, IteratorAggregate

Queue manager class

Tags
category

Pop

author

Nick Sagona, III dev@nolainteractive.com

copyright

Copyright (c) 2009-2023 NOLA Interactive, LLC. (http://www.nolainteractive.com)

license

http://www.popphp.org/license New BSD License

version
1.2.0

Interfaces, Classes, Traits and Enums

ArrayAccess
Countable
IteratorAggregate

Table of Contents

$queues  : array<string|int, Queue>
Queues
__construct()  : mixed
Constructor
__get()  : Queue
Get a queue
__isset()  : bool
Determine if a queue is registered with the manager object
__set()  : Manager
Register a queue with the manager
__unset()  : Manager
Unset a queue with the manager
addQueue()  : Manager
Add queue
addQueues()  : Manager
Add queues
count()  : int
Return count
getIterator()  : ArrayIterator
Get iterator
getQueue()  : Queue
Get queue
getQueues()  : array<string|int, mixed>
Get queues
hasQueue()  : bool
Has queue
offsetExists()  : bool
Determine if a queue is registered with the manager object
offsetGet()  : Queue
Get a queue
offsetSet()  : Manager
Set a queue with the manager
offsetUnset()  : Manager
Unset a queue from the manager

Properties

$queues

Queues

protected array<string|int, Queue> $queues = []

Methods

__construct()

Constructor

public __construct([mixed $queues = null ]) : mixed

Instantiate the queue manager object.

Parameters
$queues : mixed = null
Return values
mixed

__get()

Get a queue

public __get(string $name) : Queue
Parameters
$name : string
Return values
Queue

__isset()

Determine if a queue is registered with the manager object

public __isset(string $name) : bool
Parameters
$name : string
Return values
bool

__set()

Register a queue with the manager

public __set(string $name, mixed $value) : Manager
Parameters
$name : string
$value : mixed
Return values
Manager

__unset()

Unset a queue with the manager

public __unset(string $name) : Manager
Parameters
$name : string
Return values
Manager

addQueues()

Add queues

public addQueues(array<string|int, mixed> $queues) : Manager
Parameters
$queues : array<string|int, mixed>
Return values
Manager

count()

Return count

public count() : int
Return values
int

getIterator()

Get iterator

public getIterator() : ArrayIterator
Return values
ArrayIterator

getQueue()

Get queue

public getQueue(string $queue) : Queue
Parameters
$queue : string
Return values
Queue

getQueues()

Get queues

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

hasQueue()

Has queue

public hasQueue(string $queue) : bool
Parameters
$queue : string
Return values
bool

offsetExists()

Determine if a queue is registered with the manager object

public offsetExists(string $offset) : bool
Parameters
$offset : string
Return values
bool

offsetGet()

Get a queue

public offsetGet(string $offset) : Queue
Parameters
$offset : string
Return values
Queue

offsetSet()

Set a queue with the manager

public offsetSet(string $offset, mixed $value) : Manager
Parameters
$offset : string
$value : mixed
Return values
Manager

offsetUnset()

Unset a queue from the manager

public offsetUnset(string $offset) : Manager
Parameters
$offset : string
Return values
Manager

Search results