Overview

Namespaces

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

Classes

  • ExecutionConfig
  • QueueHelper
  • SimpleDatabaseQueue

Interfaces

  • ArchivingQueueInterface
  • EventEmittingQueueInterface
  • ExecutionDeciderInterface
  • LoggingQueueInterface
  • MutableQueueInterface
  • QueueInterface
  • Overview
  • Namespace
  • Class
  • Tree
  • Deprecated
  • Todo
  • Download

Class QueueHelper

A collection of helper functions.

Namespace: Avisota\Queue
Package: avisota-core
Located at src/Avisota/Queue/QueueHelper.php
Methods summary
public
# setMessageTemplate( Avisota\Templating\MessageTemplateInterface $messageTemplate )

Parameters

$messageTemplate
Avisota\Templating\MessageTemplateInterface
$messageTemplate
public Avisota\Templating\MessageTemplateInterface
# getMessageTemplate( )

Returns

Avisota\Templating\MessageTemplateInterface
public
# setRecipientSource( Avisota\RecipientSource\RecipientSourceInterface $recipientSource )

Parameters

$recipientSource
Avisota\RecipientSource\RecipientSourceInterface
$recipientSource
public Avisota\RecipientSource\RecipientSourceInterface
# getRecipientSource( )

Returns

Avisota\RecipientSource\RecipientSourceInterface
public
# setQueue( Avisota\Queue\QueueInterface $queue )

Parameters

$queue
Avisota\Queue\QueueInterface
$queue
public Avisota\Queue\QueueInterface
# getQueue( )

Returns

Avisota\Queue\QueueInterface
public
# setLimit( integer $limit )

Parameters

$limit
integer
$limit
public integer
# getLimit( )

Returns

integer
public
# setOffset( integer $offset )

Parameters

$offset
integer
$offset
public integer
# getOffset( )

Returns

integer
public
# setNewsletterData( array $newsletterData )

Parameters

$newsletterData
array
$newsletterData
public array
# getNewsletterData( )

Returns

array
public
# setDeliveryDate( DateTime $deliveryDate )

Parameters

$deliveryDate
DateTime
$deliveryDate
public DateTime
# getDeliveryDate( )

Returns

DateTime
public
# setEventDispatcher( Symfony\Component\EventDispatcher\EventDispatcher $eventDispatcher = null )

Parameters

$eventDispatcher
Symfony\Component\EventDispatcher\EventDispatcher
$eventDispatcher
public Symfony\Component\EventDispatcher\EventDispatcher
# getEventDispatcher( )

Returns

Symfony\Component\EventDispatcher\EventDispatcher
public integer
# enqueue( )

Enqueue the message for all recipients into the queue.

Enqueue the message for all recipients into the queue.

Returns

integer
Complexity cannot easily reduced without a huge overhead :-(

SuppressWarnings(PHPMD.CyclomaticComplexity)

SuppressWarnings(PHPMD.NPathComplexity)

Properties summary
protected Avisota\Templating\MessageTemplateInterface $messageTemplate null
#
protected Avisota\RecipientSource\RecipientSourceInterface $recipientSource null
#
protected Avisota\Queue\QueueInterface $queue null
#
protected integer $limit null
#
protected integer $offset null
#
protected array $newsletterData null
#
protected DateTime $deliveryDate null
#
protected Symfony\Component\EventDispatcher\EventDispatcher $eventDispatcher null
#
avisota/core API documentation generated by ApiGen 2.8.0