Overview

Namespaces

  • Avisota
    • Event
    • Message
    • Queue
    • Recipient
    • RecipientSource
    • Renderer
    • Templating
    • Test
      • Database
      • Imap
      • Message
      • Queue
      • Renderer
      • Transport
    • Transport

Classes

  • AbstractTransportMessageEvent
  • PostEnqueueEvent
  • PostTransportMessageEvent
  • PreEnqueueEvent
  • PreTransportMessageEvent
  • Overview
  • Namespace
  • Class
  • Tree
  • Deprecated
  • Todo
  • Download

Class PreEnqueueEvent

Abstract event triggered by an event emitting queue.

Symfony\Component\EventDispatcher\Event
Extended by Avisota\Event\PreEnqueueEvent
Namespace: Avisota\Event
Package: avisota-core
Located at src/Avisota/Event/PreEnqueueEvent.php
Methods summary
public
# __construct( Avisota\Message\MessageInterface $message, Avisota\Queue\QueueInterface $queue )
public Avisota\Message\MessageInterface
# getMessage( )

Get the message to be transported.

Get the message to be transported.

Returns

Avisota\Message\MessageInterface
public Avisota\Queue\QueueInterface
# getQueue( )

Get the transporting queue.

Get the transporting queue.

Returns

Avisota\Queue\QueueInterface
public
# setSkip( boolean $skip )

Set if the message should be skipped.

Set if the message should be skipped.

Parameters

$skip
boolean
$skip
public boolean
# isSkip( )

Determines if the message should be skipped.

Determines if the message should be skipped.

Returns

boolean
Constants summary
string NAME 'avisota.queue.pre-enqueue'
#
Properties summary
protected Avisota\Message\MessageInterface $message
#

The message to be transported.

The message to be transported.

protected Avisota\Queue\QueueInterface $queue
#

The queue that send the message.

The queue that send the message.

protected boolean $skip false
#

Skip the message and do not enqueue.

Skip the message and do not enqueue.

avisota/core API documentation generated by ApiGen 2.8.0