PHP Class Uecode\Bundle\QPushBundle\Provider\AbstractProvider

Author: Keith Kirk ([email protected])
Inheritance: implements Uecode\Bundle\QPushBundle\Provider\ProviderInterface
Show file Open project: uecode/qpush-bundle

Protected Properties

Property Type Description
$cache Doctrine\Common\Cache\Cache Doctrine APC Cache Driver
$logger Monolog\Logger Monolog Logger
$name string QPush Queue Name
$options array QPush Queue Options

Public Methods

Method Description
create ( )
delete ( $id )
destroy ( )
getCache ( ) {@inheritDoc}
getName ( ) {@inheritDoc}
getNameWithPrefix ( ) {@inheritDoc}
getOptions ( ) {@inheritDoc}
getProvider ( )
getlogger ( ) {@inheritDoc}
log ( $level, $message, array $context = [] ) {@inheritDoc}
mergeOptions ( array $options = [] ) : array Merge override options while restricting what keys are allowed
onMessageReceived ( Uecode\Bundle\QPushBundle\Event\MessageEvent $event ) : boolean
onNotification ( Uecode\Bundle\QPushBundle\Event\NotificationEvent $event, string $eventName, Symfony\Component\EventDispatcher\EventDispatcherInterface $dispatcher ) : boolean
publish ( array $message, array $options = [] )
receive ( array $options = [] )

Method Details

create() abstract public method

abstract public create ( )

delete() abstract public method

abstract public delete ( $id )

destroy() abstract public method

abstract public destroy ( )

getCache() public method

{@inheritDoc}
public getCache ( )

getName() public method

{@inheritDoc}
public getName ( )

getNameWithPrefix() public method

{@inheritDoc}
public getNameWithPrefix ( )

getOptions() public method

{@inheritDoc}
public getOptions ( )

getProvider() abstract public method

abstract public getProvider ( )

getlogger() public method

{@inheritDoc}
public getlogger ( )

log() public method

{@inheritDoc}
public log ( $level, $message, array $context = [] )
$context array

mergeOptions() public method

Merge override options while restricting what keys are allowed
public mergeOptions ( array $options = [] ) : array
$options array An array of options that override the queue defaults
return array

onMessageReceived() public method

public onMessageReceived ( Uecode\Bundle\QPushBundle\Event\MessageEvent $event ) : boolean
$event Uecode\Bundle\QPushBundle\Event\MessageEvent
return boolean

onNotification() public method

public onNotification ( Uecode\Bundle\QPushBundle\Event\NotificationEvent $event, string $eventName, Symfony\Component\EventDispatcher\EventDispatcherInterface $dispatcher ) : boolean
$event Uecode\Bundle\QPushBundle\Event\NotificationEvent
$eventName string Name of the event
$dispatcher Symfony\Component\EventDispatcher\EventDispatcherInterface
return boolean

publish() abstract public method

abstract public publish ( array $message, array $options = [] )
$message array
$options array

receive() abstract public method

abstract public receive ( array $options = [] )
$options array

Property Details

$cache protected property

Doctrine APC Cache Driver
protected Cache,Doctrine\Common\Cache $cache
return Doctrine\Common\Cache\Cache

$logger protected property

Monolog Logger
protected Logger,Monolog $logger
return Monolog\Logger

$name protected property

QPush Queue Name
protected string $name
return string

$options protected property

QPush Queue Options
protected array $options
return array