Inheritance diagram for Guzzle\Http\Message\Request:

Public Member Functions
	__clone ()

	__construct ($method, $url, $headers=array())

	__toString ()

	addCookie ($name, $value)

	addSubscriber (EventSubscriberInterface $subscriber)

	canCache ()

	dispatch ($eventName, array $context=array())

	getClient ()

	getCookie ($name)

	getCookies ()

	getCurlOptions ()

	getEventDispatcher ()

	getHost ()

	getMethod ()

	getPassword ()

	getPath ()

	getPort ()

	getProtocolVersion ()

	getQuery ($asString=false)

	getRawHeaders ()

	getResource ()

	getResponse ()

	getResponseBody ()

	getScheme ()

	getState ()

	getUrl ($asObject=false)

	getUsername ()

	isRedirect ()

	isResponseBodyRepeatable ()

	removeCookie ($name)

	send ()

	setAuth ($user, $password='', $scheme=CURLAUTH_BASIC)

	setClient (ClientInterface $client)

	setEventDispatcher (EventDispatcherInterface $eventDispatcher)

	setHost ($host)

	setIsRedirect ($isRedirect)

	setPath ($path)

	setPort ($port)

	setProtocolVersion ($protocol)

	setResponse (Response $response, $queued=false)

	setResponseBody ($body)

	setScheme ($scheme)

	setState ($state, array $context=array())

	setUrl ($url)

	startResponse (Response $response)

Public Member Functions inherited from Guzzle\Http\Message\AbstractMessage
	__construct ()

	addCacheControlDirective ($directive, $value=true)

	addHeader ($header, $value)

	addHeaders (array $headers)

	getCacheControlDirective ($directive)

	getHeader ($header)

	getHeaderLines ()

	getHeaders ()

	getParams ()

	getTokenizedHeader ($header, $token=';')

	hasCacheControlDirective ($directive)

	hasHeader ($header)

	removeCacheControlDirective ($directive)

	removeHeader ($header)

	setHeader ($header, $value)

	setHeaderFactory (HeaderFactoryInterface $factory)

	setHeaders (array $headers)

	setTokenizedHeader ($header, $data, $token=';')

Public Member Functions inherited from Guzzle\Http\Message\RequestInterface
	getQuery ()

Static Public Member Functions
static	getAllEvents ()

static	onRequestError (Event $event)

Protected Member Functions
	getEventArray ()

	processResponse (array $context=array())

Protected Attributes
	$client

	$curlOptions

	$eventDispatcher

	$isRedirect = false

	$method

	$password

	$response

	$responseBody

	$state

	$url

	$username

Protected Attributes inherited from Guzzle\Http\Message\AbstractMessage
	$headerFactory

	$headers

	$params

	$protocol = 'HTTP'

	$protocolVersion = '1.1'

Additional Inherited Members
Data Fields inherited from Guzzle\Http\Message\RequestInterface
const	CONNECT = 'CONNECT'

const	DELETE = 'DELETE'

const	GET = 'GET'

const	HEAD = 'HEAD'

const	OPTIONS = 'OPTIONS'

const	PATCH = 'PATCH'

const	POST = 'POST'

const	PUT = 'PUT'

const	STATE_COMPLETE = 'complete'

const	STATE_ERROR = 'error'

const	STATE_NEW = 'new'

const	STATE_TRANSFER = 'transfer'

const	TRACE = 'TRACE'

Detailed Description

HTTP request class to send requests

Definition at line 25 of file lib/vendor/guzzle/guzzle/src/Guzzle/Http/Message/Request.php.

Constructor & Destructor Documentation

◆ __construct()

Guzzle\Http\Message\Request::__construct	(	$method,
		$url,
		$headers = `array()`
	)

Parameters

string	$method	HTTP method
string \| Url	$url	HTTP URL to connect to. The URI scheme, host header, and URI are parsed from the full URL. If query string parameters are present they will be parsed as well.
array \| Collection	$headers	HTTP headers

Reimplemented in Guzzle\Http\Message\EntityEnclosingRequest.

Definition at line 119 of file lib/vendor/guzzle/guzzle/src/Guzzle/Http/Message/Request.php.

References Guzzle\Http\Message\AbstractMessage\$headers, Guzzle\Http\Message\Request\$method, Guzzle\Http\Message\Request\$url, Guzzle\Http\Message\AbstractMessage\addHeader(), Guzzle\Http\Message\AbstractMessage\setHeader(), Guzzle\Http\Message\Request\setState(), and Guzzle\Http\Message\Request\setUrl().

Member Function Documentation

◆ __clone()

Guzzle\Http\Message\Request::__clone ( )

Definition at line 145 of file lib/vendor/guzzle/guzzle/src/Guzzle/Http/Message/Request.php.

References Guzzle\Http\Message\Request\$curlOptions, Guzzle\Http\Message\Request\$eventDispatcher, Guzzle\Http\Message\AbstractMessage\$headers, Guzzle\Http\Message\AbstractMessage\$params, Guzzle\Http\Message\Request\$url, Guzzle\Http\Message\Request\dispatch(), Guzzle\Http\Message\Request\setState(), and Guzzle\Http\Message\RequestInterface\STATE_NEW.

◆ __toString()

Guzzle\Http\Message\Request::__toString ( )

Get the HTTP request as a string

Returns: string

Implements Guzzle\Http\Message\RequestInterface.

Reimplemented in Guzzle\Http\Message\EntityEnclosingRequest.

Definition at line 165 of file lib/vendor/guzzle/guzzle/src/Guzzle/Http/Message/Request.php.

References Guzzle\Http\Message\Request\getRawHeaders().

◆ addCookie()

Guzzle\Http\Message\Request::addCookie	(	$name,
		$value
	)

Add a Cookie value by name to the Cookie header

Parameters

string	$name	Name of the cookie to add
string	$value	Value to set

Returns: self

Implements Guzzle\Http\Message\RequestInterface.

Definition at line 521 of file lib/vendor/guzzle/guzzle/src/Guzzle/Http/Message/Request.php.

References Guzzle\Http\Message\AbstractMessage\getHeader(), Guzzle\Http\Message\AbstractMessage\hasHeader(), and Guzzle\Http\Message\AbstractMessage\setHeader().

◆ addSubscriber()

Guzzle\Http\Message\Request::addSubscriber ( EventSubscriberInterface $subscriber )

Add an event subscriber to the dispatcher

Parameters

EventSubscriberInterface $subscriber Event subscriber

Returns: self

Implements Guzzle\Common\HasDispatcherInterface.

Definition at line 572 of file lib/vendor/guzzle/guzzle/src/Guzzle/Http/Message/Request.php.

References Guzzle\Http\Message\Request\getEventDispatcher().

◆ canCache()

Guzzle\Http\Message\Request::canCache ( )

Deprecated:: Use Guzzle\Plugin\Cache\DefaultCanCacheStrategy @codeCoverageIgnore

Definition at line 640 of file lib/vendor/guzzle/guzzle/src/Guzzle/Http/Message/Request.php.

References Guzzle\Common\Version\warn().

◆ dispatch()

Guzzle\Http\Message\Request::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 565 of file lib/vendor/guzzle/guzzle/src/Guzzle/Http/Message/Request.php.

References Guzzle\Http\Message\Request\getEventDispatcher().

Referenced by Guzzle\Http\Message\Request\__clone(), Guzzle\Http\Message\Request\processResponse(), and Guzzle\Http\Message\Request\setState().

◆ getAllEvents()

static Guzzle\Http\Message\Request::getAllEvents ( )

static

Get a list of all of the events emitted from the class

Returns: array

Implements Guzzle\Common\HasDispatcherInterface.

Definition at line 93 of file lib/vendor/guzzle/guzzle/src/Guzzle/Http/Message/Request.php.

Referenced by Guzzle\Tests\Http\Message\RequestTest\testDescribesEvents().

◆ getClient()

Guzzle\Http\Message\Request::getClient ( )

Get the client used to transport the request

Returns: ClientInterface $client

Implements Guzzle\Http\Message\RequestInterface.

Definition at line 190 of file lib/vendor/guzzle/guzzle/src/Guzzle/Http/Message/Request.php.

References Guzzle\Http\Message\Request\$client.

◆ getCookie()

Guzzle\Http\Message\Request::getCookie ( $name )

Get a cookie value by name

Parameters

string $name Cookie to retrieve

Returns: null|string

Implements Guzzle\Http\Message\RequestInterface.

Definition at line 514 of file lib/vendor/guzzle/guzzle/src/Guzzle/Http/Message/Request.php.

References Guzzle\Http\Message\Request\getCookies().

◆ getCookies()

Guzzle\Http\Message\Request::getCookies ( )

Get an array of Cookies

Returns: array

Implements Guzzle\Http\Message\RequestInterface.

Definition at line 504 of file lib/vendor/guzzle/guzzle/src/Guzzle/Http/Message/Request.php.

References Guzzle\Http\Message\AbstractMessage\getHeader(), and Guzzle\Parser\ParserRegistry\getInstance().

Referenced by Guzzle\Http\Message\Request\getCookie().

◆ getCurlOptions()

Guzzle\Http\Message\Request::getCurlOptions ( )

Get the cURL options that will be applied when the cURL handle is created

Returns: Collection

Implements Guzzle\Http\Message\RequestInterface.

Definition at line 428 of file lib/vendor/guzzle/guzzle/src/Guzzle/Http/Message/Request.php.

References Guzzle\Http\Message\Request\$curlOptions.

Referenced by Guzzle\Http\Message\Request\setAuth().

◆ getEventArray()

Guzzle\Http\Message\Request::getEventArray ( )

protected

Get an array containing the request and response for event notifications

Returns: array

Definition at line 584 of file lib/vendor/guzzle/guzzle/src/Guzzle/Http/Message/Request.php.

Referenced by Guzzle\Http\Message\Request\processResponse().

◆ getEventDispatcher()

Guzzle\Http\Message\Request::getEventDispatcher ( )

Get the EventDispatcher of the request

Returns: EventDispatcherInterface

Implements Guzzle\Common\HasDispatcherInterface.

Definition at line 556 of file lib/vendor/guzzle/guzzle/src/Guzzle/Http/Message/Request.php.

References Guzzle\Http\Message\Request\$eventDispatcher, and Guzzle\Http\Message\Request\setEventDispatcher().

Referenced by Guzzle\Http\Message\Request\addSubscriber(), Guzzle\Http\Message\Request\dispatch(), Guzzle\Http\Message\Request\processResponse(), and Guzzle\Http\Message\Request\setResponse().

◆ getHost()

Guzzle\Http\Message\Request::getHost ( )

Get the host of the request

Returns: string

Implements Guzzle\Http\Message\RequestInterface.

Definition at line 263 of file lib/vendor/guzzle/guzzle/src/Guzzle/Http/Message/Request.php.

◆ getMethod()

Guzzle\Http\Message\Request::getMethod ( )

Get the HTTP method of the request

Returns: string

Implements Guzzle\Http\Message\RequestInterface.

Definition at line 246 of file lib/vendor/guzzle/guzzle/src/Guzzle/Http/Message/Request.php.

References Guzzle\Http\Message\Request\$method.

◆ getPassword()

Guzzle\Http\Message\Request::getPassword ( )

Get the password to pass in the URL if set

Returns: string|null

Implements Guzzle\Http\Message\RequestInterface.

Definition at line 325 of file lib/vendor/guzzle/guzzle/src/Guzzle/Http/Message/Request.php.

References Guzzle\Http\Message\Request\$password.

◆ getPath()

Guzzle\Http\Message\Request::getPath ( )

Get the path of the request (e.g. '/', '/index.html')

Returns: string

Implements Guzzle\Http\Message\RequestInterface.

Definition at line 288 of file lib/vendor/guzzle/guzzle/src/Guzzle/Http/Message/Request.php.

Referenced by Guzzle\Http\Message\Request\getResource().

◆ getPort()

Guzzle\Http\Message\Request::getPort ( )

Get the port that the request will be sent on if it has been set

Returns: int|null

Implements Guzzle\Http\Message\RequestInterface.

Definition at line 300 of file lib/vendor/guzzle/guzzle/src/Guzzle/Http/Message/Request.php.

◆ getProtocolVersion()

Guzzle\Http\Message\Request::getProtocolVersion ( )

Get the HTTP protocol version of the request

Returns: string

Implements Guzzle\Http\Message\RequestInterface.

Definition at line 276 of file lib/vendor/guzzle/guzzle/src/Guzzle/Http/Message/Request.php.

References Guzzle\Http\Message\AbstractMessage\$protocolVersion.

◆ getQuery()

Guzzle\Http\Message\Request::getQuery ( $asString = false )

Definition at line 239 of file lib/vendor/guzzle/guzzle/src/Guzzle/Http/Message/Request.php.

◆ getRawHeaders()

Guzzle\Http\Message\Request::getRawHeaders ( )

Get the raw message headers as a string

Returns: string

Implements Guzzle\Http\Message\MessageInterface.

Definition at line 195 of file lib/vendor/guzzle/guzzle/src/Guzzle/Http/Message/Request.php.

References Guzzle\Http\Message\AbstractMessage\$protocolVersion, Guzzle\Http\Message\AbstractMessage\getHeaderLines(), and Guzzle\Http\Message\Request\getResource().

Referenced by Guzzle\Http\Message\Request\__toString().

◆ getResource()

Guzzle\Http\Message\Request::getResource ( )

Get the resource part of the the request, including the path, query string, and fragment

Returns: string

Implements Guzzle\Http\Message\RequestInterface.

Definition at line 371 of file lib/vendor/guzzle/guzzle/src/Guzzle/Http/Message/Request.php.

References Guzzle\Http\Message\Request\getPath().

Referenced by Guzzle\Http\Message\Request\getRawHeaders().

◆ getResponse()

Guzzle\Http\Message\Request::getResponse ( )

Get the previously received {

See also: Response} or NULL if the request has not been sent

Returns: Response|null

Implements Guzzle\Http\Message\RequestInterface.

Definition at line 234 of file lib/vendor/guzzle/guzzle/src/Guzzle/Http/Message/Request.php.

References Guzzle\Http\Message\Request\$response.

◆ getResponseBody()

Guzzle\Http\Message\Request::getResponseBody ( )

Get the EntityBody that will hold the resulting response message's entity body. This response body will only be used for successful responses. Intermediate responses (e.g. redirects) will not use the targeted response body.

Returns: EntityBodyInterface

Implements Guzzle\Http\Message\RequestInterface.

Definition at line 482 of file lib/vendor/guzzle/guzzle/src/Guzzle/Http/Message/Request.php.

References Guzzle\Http\Message\Request\$responseBody, and Guzzle\Http\EntityBody\factory().

Referenced by Guzzle\Http\Message\Request\setResponse().

◆ getScheme()

Guzzle\Http\Message\Request::getScheme ( )

Get the URI scheme of the request (http, https, ftp, etc)

Returns: string

Implements Guzzle\Http\Message\RequestInterface.

Definition at line 251 of file lib/vendor/guzzle/guzzle/src/Guzzle/Http/Message/Request.php.

◆ getState()

Guzzle\Http\Message\Request::getState ( )

Get the state of the request. One of 'complete', 'transfer', 'new', 'error'

Returns: string

Implements Guzzle\Http\Message\RequestInterface.

Definition at line 386 of file lib/vendor/guzzle/guzzle/src/Guzzle/Http/Message/Request.php.

References Guzzle\Http\Message\Request\$state.

◆ getUrl()

Guzzle\Http\Message\Request::getUrl ( $asObject = false )

Get the full URL of the request (e.g. 'http://www.guzzle-project.com/')

Parameters

bool $asObject Set to TRUE to retrieve the URL as a clone of the URL object owned by the request.

Returns: string|Url

Implements Guzzle\Http\Message\RequestInterface.

Definition at line 381 of file lib/vendor/guzzle/guzzle/src/Guzzle/Http/Message/Request.php.

Referenced by Guzzle\Http\Message\Request\startResponse().

◆ getUsername()

Guzzle\Http\Message\Request::getUsername ( )

Get the username to pass in the URL if set

Returns: string|null

Implements Guzzle\Http\Message\RequestInterface.

Definition at line 320 of file lib/vendor/guzzle/guzzle/src/Guzzle/Http/Message/Request.php.

References Guzzle\Http\Message\Request\$username.

◆ isRedirect()

Guzzle\Http\Message\Request::isRedirect ( )

Deprecated:: Use the history plugin @codeCoverageIgnore

Definition at line 666 of file lib/vendor/guzzle/guzzle/src/Guzzle/Http/Message/Request.php.

References Guzzle\Http\Message\Request\$isRedirect, and Guzzle\Common\Version\warn().

Referenced by Guzzle\Http\Message\Request\setIsRedirect().

◆ isResponseBodyRepeatable()

Guzzle\Http\Message\Request::isResponseBodyRepeatable ( )

Determine if the response body is repeatable (readable + seekable)

Returns: bool

Deprecated:: Use getResponseBody()->isSeekable() @codeCoverageIgnore

Definition at line 498 of file lib/vendor/guzzle/guzzle/src/Guzzle/Http/Message/Request.php.

References Guzzle\Common\Version\warn().

◆ onRequestError()

static Guzzle\Http\Message\Request::onRequestError ( Event $event )

static

Default method that will throw exceptions if an unsuccessful response is received.

Parameters

Event $event Received

Exceptions

BadResponseException if the response is not successful

Definition at line 176 of file lib/vendor/guzzle/guzzle/src/Guzzle/Http/Message/Request.php.

References Guzzle\Http\Exception\BadResponseException\factory(), and Guzzle\Common\Event\toArray().

◆ processResponse()

Guzzle\Http\Message\Request::processResponse ( array $context = array() )

protected

Process a received response

Parameters

array $context Contextual information

Exceptions

RequestException|BadResponseException on unsuccessful responses

Definition at line 598 of file lib/vendor/guzzle/guzzle/src/Guzzle/Http/Message/Request.php.

References Guzzle\Http\Message\Request\dispatch(), Guzzle\Http\Message\Request\getEventArray(), Guzzle\Http\Message\Request\getEventDispatcher(), and Guzzle\Http\Message\RequestInterface\STATE_COMPLETE.

Referenced by Guzzle\Http\Message\Request\setState().

◆ removeCookie()

Guzzle\Http\Message\Request::removeCookie ( $name )

Remove a specific cookie value by name

Parameters

string $name Cookie to remove by name

Returns: self

Implements Guzzle\Http\Message\RequestInterface.

Definition at line 535 of file lib/vendor/guzzle/guzzle/src/Guzzle/Http/Message/Request.php.

References Guzzle\Http\Message\AbstractMessage\getHeader().

◆ send()

Guzzle\Http\Message\Request::send ( )

Send the request

Returns: Response

Exceptions

RequestException on a request error

Implements Guzzle\Http\Message\RequestInterface.

Definition at line 225 of file lib/vendor/guzzle/guzzle/src/Guzzle/Http/Message/Request.php.

◆ setAuth()

Guzzle\Http\Message\Request::setAuth	(	$user,
		$password = `''`,
		$scheme = `CURLAUTH_BASIC`
	)

Set HTTP authorization parameters

Parameters

string \| bool	$user	User name or false disable authentication
string	$password	Password
string	$scheme	Authentication scheme ('Basic', 'Digest', or a CURLAUTH_* constant (deprecated))

Returns: self http://php.net/manual/en/function.curl-setopt.php See the available options for CURLOPT_HTTPAUTH RequestException

Implements Guzzle\Http\Message\RequestInterface.

Definition at line 330 of file lib/vendor/guzzle/guzzle/src/Guzzle/Http/Message/Request.php.

References Guzzle\Http\Message\Request\$password, Guzzle\Http\Message\Request\getCurlOptions(), Guzzle\Http\Message\AbstractMessage\removeHeader(), and Guzzle\Http\Message\AbstractMessage\setHeader().

Referenced by Guzzle\Http\Message\Request\setUrl().

◆ setClient()

Guzzle\Http\Message\Request::setClient ( ClientInterface $client )

Set the client used to transport the request

Parameters

ClientInterface $client

Returns: self

Implements Guzzle\Http\Message\RequestInterface.

Definition at line 183 of file lib/vendor/guzzle/guzzle/src/Guzzle/Http/Message/Request.php.

References Guzzle\Http\Message\Request\$client.

◆ setEventDispatcher()

Guzzle\Http\Message\Request::setEventDispatcher ( EventDispatcherInterface $eventDispatcher )

Set the EventDispatcher of the request

Parameters

EventDispatcherInterface $eventDispatcher

Returns: self

Implements Guzzle\Common\HasDispatcherInterface.

Definition at line 548 of file lib/vendor/guzzle/guzzle/src/Guzzle/Http/Message/Request.php.

References Guzzle\Http\Message\Request\$eventDispatcher.

Referenced by Guzzle\Http\Message\Request\getEventDispatcher().

◆ setHost()

Guzzle\Http\Message\Request::setHost ( $host )

Set the host of the request. Including a port in the host will modify the port of the request.

Parameters

string $host Host to set (e.g. www.yahoo.com, www.yahoo.com:80)

Returns: self

Implements Guzzle\Http\Message\RequestInterface.

Definition at line 268 of file lib/vendor/guzzle/guzzle/src/Guzzle/Http/Message/Request.php.

References Guzzle\Http\Message\Request\setPort().

◆ setIsRedirect()

Guzzle\Http\Message\Request::setIsRedirect ( $isRedirect )

Deprecated:: Use the history plugin (not emitting a warning as this is built-into the RedirectPlugin for now) @codeCoverageIgnore

Definition at line 655 of file lib/vendor/guzzle/guzzle/src/Guzzle/Http/Message/Request.php.

References Guzzle\Http\Message\Request\$isRedirect, and Guzzle\Http\Message\Request\isRedirect().

◆ setPath()

Guzzle\Http\Message\Request::setPath ( $path )

Set the path of the request (e.g. '/', '/index.html')

Parameters

string | array $path Path to set or array of segments to implode

Returns: self

Implements Guzzle\Http\Message\RequestInterface.

Definition at line 293 of file lib/vendor/guzzle/guzzle/src/Guzzle/Http/Message/Request.php.

◆ setPort()

Guzzle\Http\Message\Request::setPort ( $port )

Set the port that the request will be sent on

Parameters

int $port Port number to set

Returns: self

Implements Guzzle\Http\Message\RequestInterface.

Definition at line 305 of file lib/vendor/guzzle/guzzle/src/Guzzle/Http/Message/Request.php.

Referenced by Guzzle\Http\Message\Request\setHost(), and Guzzle\Http\Message\Request\setUrl().

◆ setProtocolVersion()

Guzzle\Http\Message\Request::setProtocolVersion ( $protocol )

Set the HTTP protocol version of the request (e.g. 1.1 or 1.0)

Parameters

string $protocol HTTP protocol version to use with the request

Returns: self

Implements Guzzle\Http\Message\RequestInterface.

Definition at line 281 of file lib/vendor/guzzle/guzzle/src/Guzzle/Http/Message/Request.php.

References Guzzle\Http\Message\AbstractMessage\$protocol.

◆ setResponse()

Guzzle\Http\Message\Request::setResponse	(	Response	$response,
			$queued = `false`
	)

Manually set a response for the request.

This method is useful for specifying a mock response for the request or setting the response using a cache. Manually setting a response will bypass the actual sending of a request.

Parameters

Response	$response	Response object to set
bool	$queued	Set to TRUE to keep the request in a state of not having been sent, but queue the response for send()

Returns: self Returns a reference to the object.

Implements Guzzle\Http\Message\RequestInterface.

Definition at line 442 of file lib/vendor/guzzle/guzzle/src/Guzzle/Http/Message/Request.php.

References Guzzle\Http\Message\Request\$response, Guzzle\Http\Message\Request\getEventDispatcher(), Guzzle\Http\Message\Request\getResponseBody(), and Guzzle\Http\Message\Request\setState().

◆ setResponseBody()

Guzzle\Http\Message\Request::setResponseBody ( $body )

Set the EntityBody that will hold a successful response message's entity body.

This method should be invoked when you need to send the response's entity body somewhere other than the normal php://temp buffer. For example, you can send the entity body to a socket, file, or some other custom stream.

Parameters

EntityBodyInterface | string | resource $body Response body object. Pass a string to attempt to store the response body in a local file.