Public Member Functions | |
| addSubscriber (EventSubscriberInterface $subscriber) | |
| dispatch ($eventName, array $context=array()) | |
| getEventDispatcher () | |
| setEventDispatcher (EventDispatcherInterface $eventDispatcher) | |
Static Public Member Functions | |
| static | getAllEvents () |
Protected Attributes | |
| $eventDispatcher | |
Detailed Description
Class that holds an event dispatcher
Definition at line 12 of file AbstractHasDispatcher.php.
Member Function Documentation
◆ addSubscriber()
| Guzzle\Common\AbstractHasDispatcher::addSubscriber | ( | EventSubscriberInterface | $subscriber | ) |
Add an event subscriber to the dispatcher
- Parameters
-
EventSubscriberInterface $subscriber Event subscriber
- Returns
- self
Implements Guzzle\Common\HasDispatcherInterface.
Definition at line 46 of file AbstractHasDispatcher.php.
References Guzzle\Common\AbstractHasDispatcher\getEventDispatcher().
Referenced by Guzzle\Http\Client\__construct().
◆ dispatch()
| Guzzle\Common\AbstractHasDispatcher::dispatch | ( | $eventName, | |
| array | $context = array() |
||
| ) |
Helper to dispatch Guzzle events and set the event name on the event
- Parameters
-
string $eventName Name of the event to dispatch array $context Context of the event
- Returns
- Event Returns the created event object
Implements Guzzle\Common\HasDispatcherInterface.
Definition at line 41 of file AbstractHasDispatcher.php.
References Guzzle\Common\AbstractHasDispatcher\getEventDispatcher().
Referenced by Guzzle\Http\Curl\CurlMulti\add(), Guzzle\Service\Resource\ResourceIteratorApplyBatched\apply(), Guzzle\Plugin\Mock\MockPlugin\dequeue(), Guzzle\Service\Client\execute(), Guzzle\Service\Client\executeMultiple(), Guzzle\Service\Builder\ServiceBuilder\get(), Guzzle\Service\Client\getCommand(), Guzzle\Service\Resource\ResourceIterator\next(), Guzzle\Plugin\Backoff\BackoffPlugin\onRequestSent(), Guzzle\Service\Client\prepareCommand(), Guzzle\Http\Client\prepareRequest(), Guzzle\Http\Curl\CurlMulti\remove(), and Guzzle\Http\Curl\CurlMulti\removeErroredRequest().
◆ getAllEvents()
|
static |
Get a list of all of the events emitted from the class
- Returns
- array
Implements Guzzle\Common\HasDispatcherInterface.
Reimplemented in Guzzle\Http\Client, Guzzle\Service\Resource\ResourceIterator, Guzzle\Service\Builder\ServiceBuilder, Guzzle\Plugin\Mock\MockPlugin, Guzzle\Service\Client, Guzzle\Plugin\Backoff\BackoffPlugin, and Guzzle\Service\Resource\ResourceIteratorApplyBatched.
Definition at line 20 of file AbstractHasDispatcher.php.
Referenced by Guzzle\Tests\Common\AbstractHasAdapterTest\testDoesNotRequireRegisteredEvents().
◆ getEventDispatcher()
| Guzzle\Common\AbstractHasDispatcher::getEventDispatcher | ( | ) |
Get the EventDispatcher of the request
- Returns
- EventDispatcherInterface
Implements Guzzle\Common\HasDispatcherInterface.
Definition at line 32 of file AbstractHasDispatcher.php.
References Guzzle\Common\AbstractHasDispatcher\$eventDispatcher.
Referenced by Guzzle\Common\AbstractHasDispatcher\addSubscriber(), Guzzle\Common\AbstractHasDispatcher\dispatch(), Guzzle\Http\Curl\CurlMultiProxy\getAvailableHandle(), and Guzzle\Http\Client\prepareRequest().
◆ setEventDispatcher()
| Guzzle\Common\AbstractHasDispatcher::setEventDispatcher | ( | EventDispatcherInterface | $eventDispatcher | ) |
Set the EventDispatcher of the request
- Parameters
-
EventDispatcherInterface $eventDispatcher
- Returns
- self
Implements Guzzle\Common\HasDispatcherInterface.
Definition at line 25 of file AbstractHasDispatcher.php.
References Guzzle\Common\AbstractHasDispatcher\$eventDispatcher.
Field Documentation
◆ $eventDispatcher
|
protected |
Definition at line 18 of file AbstractHasDispatcher.php.
Referenced by Guzzle\Common\AbstractHasDispatcher\getEventDispatcher(), and Guzzle\Common\AbstractHasDispatcher\setEventDispatcher().
The documentation for this class was generated from the following file:
