Class MockPlugin

Queues mock responses or exceptions and delivers mock responses or exceptions in a fifo order.

Guzzle\Common\AbstractHasDispatcher implements Guzzle\Common\HasDispatcherInterface

Guzzle\Plugin\Mock\MockPlugin implements Symfony\Component\EventDispatcher\EventSubscriberInterface, Countable

Namespace: Guzzle\Plugin\Mock
Located at src/Guzzle/Plugin/Mock/MockPlugin.php

Methods summary
`public`	# `__construct( array $items = null, boolean $temporary = false, boolean $readBodies = false )` Parameters `$items` Array of responses or exceptions to queue `$temporary` Set to TRUE to remove the plugin when the queue is empty `$readBodies` Set to TRUE to consume the entity body when a mock is served
`public static`	# `getSubscribedEvents( )`
`public static array`	# `getAllEvents( )` Get a list of all of the events emitted from the class Get a list of all of the events emitted from the class Returns array Overrides `Guzzle\Common\AbstractHasDispatcher::getAllEvents()`
`public static Guzzle\Http\Message\Response`	# `getMockFile( string $path )` Get a mock response from a file Get a mock response from a file Parameters `$path` File to retrieve a mock response from Returns `Guzzle\Http\Message\Response` Throws `InvalidArgumentException` if the file is not found
`public Guzzle\Plugin\Mock\MockPlugin`	# `readBodies( boolean $readBodies )` Set whether or not to consume the entity body of a request when a mock response is used Set whether or not to consume the entity body of a request when a mock response is used Parameters `$readBodies` Set to true to read and consume entity bodies Returns `Guzzle\Plugin\Mock\MockPlugin`
`public integer`	# `count( )` Returns the number of remaining mock responses Returns the number of remaining mock responses Returns integer Implementation of `Countable::count()`
`public Guzzle\Plugin\Mock\MockPlugin`	# `addResponse( string\|Guzzle\Http\Message\Response $response )` Add a response to the end of the queue Add a response to the end of the queue Parameters `$response` Response object or path to response file Returns `Guzzle\Plugin\Mock\MockPlugin` Throws `InvalidArgumentException` if a string or Response is not passed
`public Guzzle\Plugin\Mock\MockPlugin`	# `addException( Guzzle\Http\Exception\CurlException $e )` Add an exception to the end of the queue Add an exception to the end of the queue Parameters `$e` Exception to throw when the request is executed Returns `Guzzle\Plugin\Mock\MockPlugin`
`public Guzzle\Plugin\Mock\MockPlugin`	# `clearQueue( )` Clear the queue Clear the queue Returns `Guzzle\Plugin\Mock\MockPlugin`
`public array`	# `getQueue( )` Returns an array of mock responses remaining in the queue Returns an array of mock responses remaining in the queue Returns array
`public boolean`	# `isTemporary( )` Check if this is a temporary plugin Check if this is a temporary plugin Returns boolean
`public Guzzle\Plugin\Mock\MockPlugin`	# `dequeue( Guzzle\Http\Message\RequestInterface $request )` Get a response from the front of the list and add it to a request Get a response from the front of the list and add it to a request Parameters `$request` Request to mock Returns `Guzzle\Plugin\Mock\MockPlugin` Throws `Guzzle\Http\Exception\CurlException` When request.send is called and an exception is queued
`public`	# `flush( )` Clear the array of received requests Clear the array of received requests
`public array`	# `getReceivedRequests( )` Get an array of requests that were mocked by this plugin Get an array of requests that were mocked by this plugin Returns array
`public`	# `onRequestBeforeSend( Guzzle\Common\Event $event )` Called when a request is about to be sent Called when a request is about to be sent Parameters `$event` Throws `OutOfBoundsException` When queue is empty

Methods inherited from Guzzle\Common\AbstractHasDispatcher
`addSubscriber(), dispatch(), getEventDispatcher(), setEventDispatcher()`

Properties summary
`protected array`	`$queue` Array of mock responses / exceptions Array of mock responses / exceptions	# `array()`
`protected boolean`	`$temporary` Whether or not to remove the plugin when the queue is empty Whether or not to remove the plugin when the queue is empty	# `false`
`protected array`	`$received` Array of requests that were mocked Array of requests that were mocked	# `array()`
`protected boolean`	`$readBodies` Whether or not to consume an entity body when a mock response is served Whether or not to consume an entity body when a mock response is served	#

Properties inherited from Guzzle\Common\AbstractHasDispatcher
`$eventDispatcher`

Namespaces

Classes

Class MockPlugin

Parameters

Returns

Overrides

Parameters

Returns

Throws

Parameters

Returns

Returns

Implementation of

Parameters

Returns

Throws

Parameters

Returns

Returns

Returns

Returns

Parameters

Returns

Throws

Returns

Parameters

Throws