DoctrineTransport
in package
implements
TransportInterface, SetupableTransportInterface, MessageCountAwareInterface, ListableReceiverInterface
Tags
Table of Contents
Interfaces
- TransportInterface
- SetupableTransportInterface
- MessageCountAwareInterface
- ListableReceiverInterface
- Used when a receiver has the ability to list messages and find specific messages.
Properties
- $connection : mixed
- $receiver : mixed
- $sender : mixed
- $serializer : mixed
Methods
- __construct() : mixed
- ack() : void
- {@inheritdoc}
- all() : array<string|int, Envelope>|iterable<string|int, mixed>
- Returns all the messages (up to the limit) in this receiver.
- configureSchema() : void
- Adds the Table to the Schema if this transport uses this connection.
- find() : Envelope|null
- Returns the Envelope by id or none.
- get() : iterable<string|int, mixed>
- {@inheritdoc}
- getExtraSetupSqlForTable() : array<string|int, string>
- Adds extra SQL if the given table was created by the Connection.
- getMessageCount() : int
- Returns the number of messages waiting to be handled.
- reject() : void
- {@inheritdoc}
- send() : Envelope
- {@inheritdoc}
- setup() : void
- Setup the transport.
- getReceiver() : DoctrineReceiver
- getSender() : DoctrineSender
Properties
$connection
private
mixed
$connection
$receiver
private
mixed
$receiver
$sender
private
mixed
$sender
$serializer
private
mixed
$serializer
Methods
__construct()
public
__construct(Connection $connection, SerializerInterface $serializer) : mixed
Parameters
- $connection : Connection
- $serializer : SerializerInterface
ack()
{@inheritdoc}
public
ack(Envelope $envelope) : void
Parameters
- $envelope : Envelope
all()
Returns all the messages (up to the limit) in this receiver.
public
all([int $limit = null ]) : array<string|int, Envelope>|iterable<string|int, mixed>
Parameters
- $limit : int = null
Return values
array<string|int, Envelope>|iterable<string|int, mixed>configureSchema()
Adds the Table to the Schema if this transport uses this connection.
public
configureSchema(Schema $schema, Connection $forConnection) : void
Parameters
- $schema : Schema
- $forConnection : Connection
find()
Returns the Envelope by id or none.
public
find(mixed $id) : Envelope|null
Parameters
- $id : mixed
Return values
Envelope|nullget()
{@inheritdoc}
public
get() : iterable<string|int, mixed>
Return values
iterable<string|int, mixed>getExtraSetupSqlForTable()
Adds extra SQL if the given table was created by the Connection.
public
getExtraSetupSqlForTable(Table $createdTable) : array<string|int, string>
Parameters
- $createdTable : Table
Return values
array<string|int, string>getMessageCount()
Returns the number of messages waiting to be handled.
public
getMessageCount() : int
Return values
intreject()
{@inheritdoc}
public
reject(Envelope $envelope) : void
Parameters
- $envelope : Envelope
send()
{@inheritdoc}
public
send(Envelope $envelope) : Envelope
Parameters
- $envelope : Envelope
Return values
Envelopesetup()
Setup the transport.
public
setup() : void
getReceiver()
private
getReceiver() : DoctrineReceiver
Return values
DoctrineReceivergetSender()
private
getSender() : DoctrineSender