AMQPExchange

class AMQPExchange (View source)

stub class representing AMQPExchange from pecl-amqp

Methods

__construct(AMQPChannel $channel)

Create an instance of AMQPExchange.

void
bind(string $exchangeName, string $routingKey = '', array $arguments = [])

Bind to another exchange.

void
unbind(string $exchangeName, string $routingKey = '', array $arguments = [])

Remove binding to another exchange.

void
declareExchange()

Declare a new exchange on the broker.

void
declare()

Declare a new exchange on the broker.

void
delete(string $exchangeName = null, int $flags = AMQP_NOPARAM)

Delete the exchange from the broker.

bool|int|float|string|null
getArgument(string $argumentName)

Get the argument associated with the given key.

bool
hasArgument(string $argumentName)

Check whether argument associated with the given key exists.

array
getArguments()

Get all arguments set on the given exchange.

int
getFlags()

Get all the flags currently set on the given exchange.

string|null
getName()

Get the configured name.

string|null
getType()

Get the configured type.

void
publish(string $message, string|null $routingKey = null, int|null $flags = null, array $headers = [])

Publish a message to an exchange.

void
setArgument(string $argumentName, string|int $argumentValue)

Set the value for the given key.

void
removeArgument(string $argumentName)

Set the value for the given key.

bool
setArguments(array $arguments)

Set all arguments on the exchange.

void
setFlags(int|null $flags)

Set the flags on an exchange.

void
setName(string $exchangeName)

Set the name of the exchange.

void
setType(string $exchangeType)

Set the type of the exchange.

AMQPChannel
getChannel()

Get the AMQPChannel object in use

AMQPConnection
getConnection()

Get the AMQPConnection object in use

Details

at line 1157
__construct(AMQPChannel $channel)

Create an instance of AMQPExchange.

Returns a new instance of an AMQPExchange object, associated with the given AMQPChannel object.

Parameters

AMQPChannel $channel

A valid AMQPChannel object, connected to a broker.

Exceptions

AMQPExchangeException
AMQPConnectionException

at line 1174
void bind(string $exchangeName, string $routingKey = '', array $arguments = [])

Bind to another exchange.

Bind an exchange to another exchange using the specified routing key.

Parameters

string $exchangeName

Name of the exchange to bind.
string $routingKey

The routing key to use for binding.
array $arguments

Additional binding arguments.

Return Value

void

Exceptions

AMQPExchangeException
AMQPChannelException
AMQPConnectionException

at line 1191
void unbind(string $exchangeName, string $routingKey = '', array $arguments = [])

Remove binding to another exchange.

Remove a routing key binding on an another exchange from the given exchange.

Parameters

string $exchangeName

Name of the exchange to bind.
string $routingKey

The routing key to use for binding.
array $arguments

Additional binding arguments.

Return Value

void

Exceptions

AMQPExchangeException
AMQPChannelException
AMQPConnectionException

at line 1202
void declareExchange()

Declare a new exchange on the broker.

Return Value

void

Exceptions

AMQPExchangeException
AMQPChannelException
AMQPConnectionException

at line 1213
void declare()

Declare a new exchange on the broker.

Return Value

void

Exceptions

AMQPExchangeException
AMQPChannelException
AMQPConnectionException

at line 1230
void delete(string $exchangeName = null, int $flags = AMQP_NOPARAM)

Delete the exchange from the broker.

Parameters

string $exchangeName

Optional name of exchange to delete.
int $flags

Optionally AMQP_IFUNUSED can be specified to indicate the exchange should not be deleted until no clients are connected to it.

Return Value

void

Exceptions

AMQPExchangeException
AMQPChannelException
AMQPConnectionException

at line 1242
bool|int|float|string|null getArgument(string $argumentName)

Get the argument associated with the given key.

Get the argument associated with the given key.

Parameters

string $argumentName

The key to look up.

Return Value

bool|int|float|string|null

Exceptions

AMQPExchangeException

at line 1251
bool hasArgument(string $argumentName)

Check whether argument associated with the given key exists.

Parameters

string $argumentName

The key to look up.

Return Value

bool

at line 1258
array getArguments()

Get all arguments set on the given exchange.

Return Value

array

An array containing all of the set key/value pairs.

at line 1266
int getFlags()

Get all the flags currently set on the given exchange.

Return Value

int

An integer bitmask of all the flags currently set on this exchange object.

at line 1273
string|null getName()

Get the configured name.

Return Value

string|null

The configured name as a string.

at line 1280
string|null getType()

Get the configured type.

Return Value

string|null

The configured type as a string.

at line 1303
void publish(string $message, string|null $routingKey = null, int|null $flags = null, array $headers = [])

Publish a message to an exchange.

Publish a message to the exchange represented by the AMQPExchange object.

Parameters

string $message

The message to publish.
string|null $routingKey

The optional routing key to which to publish to.
int|null $flags

One or more of AMQP_MANDATORY and AMQP_IMMEDIATE.
array $headers

One of content_type, content_encoding, message_id, user_id, app_id, delivery_mode, priority, timestamp, expiration, type or reply_to, headers.

Return Value

void

Exceptions

AMQPExchangeException
AMQPChannelException
AMQPConnectionException

at line 1318
void setArgument(string $argumentName, string|int $argumentValue)

Set the value for the given key.

Parameters

string $argumentName

Name of the argument to set.
string|int $argumentValue

Value of the argument to set.

Return Value

void

at line 1325
void removeArgument(string $argumentName)

Set the value for the given key.

Parameters

string $argumentName

Name of the argument to remove.

Return Value

void

at line 1334
bool setArguments(array $arguments)

Set all arguments on the exchange.

Parameters

array $arguments

An array of key/value pairs of arguments.

Return Value

bool

TRUE on success or FALSE on failure.

at line 1346
void setFlags(int|null $flags)

Set the flags on an exchange.

Parameters

int|null $flags

A bitmask of flags. This call currently only considers the following flags: AMQP_DURABLE, AMQP_PASSIVE (and AMQP_DURABLE, if librabbitmq version >= 0.5.3)

Return Value

void

at line 1355
void setName(string $exchangeName)

Set the name of the exchange.

Parameters

string $exchangeName

The name of the exchange to set as string.

Return Value

void

at line 1367
void setType(string $exchangeType)

Set the type of the exchange.

Set the type of the exchange. This can be any of AMQP_EX_TYPE_DIRECT, AMQP_EX_TYPE_FANOUT, AMQP_EX_TYPE_HEADERS or AMQP_EX_TYPE_TOPIC.

Parameters

string $exchangeType

The type of exchange as a string.

Return Value

void

at line 1374
AMQPChannel getChannel()

Get the AMQPChannel object in use

Return Value

AMQPChannel

at line 1381
AMQPConnection getConnection()

Get the AMQPConnection object in use

Return Value

AMQPConnection