Public Member Functions | |
| addSubscriber (EventSubscriberInterface $subscriber) | |
| dispatch ($eventName, array $context=array()) | |
| getEventDispatcher () | |
| setEventDispatcher (EventDispatcherInterface $eventDispatcher) | |
Static Public Member Functions | |
| static | getAllEvents () |
Detailed Description
Holds an event dispatcher
Definition at line 11 of file HasDispatcherInterface.php.
Member Function Documentation
◆ addSubscriber()
| Guzzle\Common\HasDispatcherInterface::addSubscriber | ( | EventSubscriberInterface | $subscriber | ) |
Add an event subscriber to the dispatcher
- Parameters
-
EventSubscriberInterface $subscriber Event subscriber
- Returns
- self
Implemented in Guzzle\Http\Message\Request, Guzzle\Http\IoEmittingEntityBody, and Guzzle\Common\AbstractHasDispatcher.
Referenced by Guzzle\Http\Message\RequestFactory\visit_plugins().
◆ dispatch()
| Guzzle\Common\HasDispatcherInterface::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
Implemented in Guzzle\Http\Message\Request, Guzzle\Http\IoEmittingEntityBody, and Guzzle\Common\AbstractHasDispatcher.
Referenced by Guzzle\Stream\PhpStreamRequestFactory\fromRequest().
◆ getAllEvents()
|
static |
Get a list of all of the events emitted from the class
- Returns
- array
Implemented in Guzzle\Http\Message\Request, Guzzle\Http\Client, Guzzle\Service\Resource\ResourceIterator, Guzzle\Service\Builder\ServiceBuilder, Guzzle\Plugin\Mock\MockPlugin, Guzzle\Service\Client, Guzzle\Plugin\Backoff\BackoffPlugin, Guzzle\Service\Resource\ResourceIteratorApplyBatched, Guzzle\Http\IoEmittingEntityBody, and Guzzle\Common\AbstractHasDispatcher.
◆ getEventDispatcher()
| Guzzle\Common\HasDispatcherInterface::getEventDispatcher | ( | ) |
Get the EventDispatcher of the request
- Returns
- EventDispatcherInterface
Implemented in Guzzle\Http\Message\Request, Guzzle\Http\IoEmittingEntityBody, and Guzzle\Common\AbstractHasDispatcher.
Referenced by Guzzle\Http\Message\RequestFactory\cloneRequestWithMethod(), Guzzle\Plugin\Mock\MockPlugin\dequeue(), Guzzle\Tests\GuzzleTestCase\getWildcardObserver(), Guzzle\Tests\GuzzleTestCase\hasSubscriber(), Guzzle\Http\RedirectPlugin\throwTooManyRedirectsException(), Guzzle\Tests\Http\Curl\CurlHandleTest\updateForHandle(), Guzzle\Http\Message\RequestFactory\visit_events(), and Guzzle\Http\Message\RequestFactory\visit_exceptions().
◆ setEventDispatcher()
| Guzzle\Common\HasDispatcherInterface::setEventDispatcher | ( | EventDispatcherInterface | $eventDispatcher | ) |
Set the EventDispatcher of the request
- Parameters
-
EventDispatcherInterface $eventDispatcher
- Returns
- self
Implemented in Guzzle\Http\Message\Request, Guzzle\Http\IoEmittingEntityBody, and Guzzle\Common\AbstractHasDispatcher.
The documentation for this interface was generated from the following file:
