Interface RequestInterface
Generic HTTP request interface
- Guzzle\Http\Message\RequestInterface implements Guzzle\Http\Message\MessageInterface, Guzzle\Common\HasDispatcherInterface
Direct known implementers
Guzzle\Http\Message\EntityEnclosingRequestInterface,
Guzzle\Http\Message\Request
Indirect known implementers
Methods summary
-
public__toString ( ) -
publicsend ( )Send the request
-
publicsetClient ( Guzzle\Http\ClientInterface $client )Set the client used to transport the request
-
publicgetClient ( )Get the client used to transport the request
-
publicsetUrl ( string $url )Set the URL of the request
-
publicgetUrl ( bool $asObject = false )Get the full URL of the request (e.g. 'http://www.guzzle-project.com/')
-
publicgetResource ( )Get the resource part of the the request, including the path, query string, and fragment
-
publicgetQuery ( )Get the collection of key value pairs that will be used as the query string in the request
-
publicgetMethod ( )Get the HTTP method of the request
-
publicgetScheme ( )Get the URI scheme of the request (http, https, ftp, etc)
-
publicsetScheme ( string $scheme )Set the URI scheme of the request (http, https, ftp, etc)
-
publicgetHost ( )Get the host of the request
-
publicsetHost ( string $host )Set the host of the request. Including a port in the host will modify the port of the request.
-
publicgetPath ( )Get the path of the request (e.g. '/', '/index.html')
-
publicsetPath ( string|array $path )Set the path of the request (e.g. '/', '/index.html')
-
publicgetPort ( )Get the port that the request will be sent on if it has been set
-
publicsetPort ( int $port )Set the port that the request will be sent on
-
publicgetUsername ( )Get the username to pass in the URL if set
-
publicgetPassword ( )Get the password to pass in the URL if set
-
publicsetAuth ( string|bool $user, string $password = '', string $scheme = 'Basic' )Set HTTP authorization parameters
-
publicgetProtocolVersion ( )Get the HTTP protocol version of the request
-
publicsetProtocolVersion ( string $protocol )Set the HTTP protocol version of the request (e.g. 1.1 or 1.0)
-
publicgetResponse ( )Get the previously received
Guzzle\Http\Message\Responseor NULL if the request has not been sent -
publicsetResponse ( Guzzle\Http\Message\Response $response, bool $queued = false )Manually set a response for the request.
-
publicstartResponse ( Guzzle\Http\Message\Response $response )The start of a response has been received for a request and the request is still in progress
-
publicsetResponseBody ( EntityBodyInterface|string|resource $body )Set the EntityBody that will hold a successful response message's entity body.
-
publicgetResponseBody ( )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.
-
publicgetState ( )Get the state of the request. One of 'complete', 'transfer', 'new', 'error'
-
publicsetState ( string $state, array $context = array() )Set the state of the request
-
publicgetCurlOptions ( )Get the cURL options that will be applied when the cURL handle is created
-
publicgetCookies ( )Get an array of Cookies
-
publicgetCookie ( string $name )Get a cookie value by name
-
publicaddCookie ( string $name, string $value )Add a Cookie value by name to the Cookie header
-
publicremoveCookie ( string $name )Remove a specific cookie value by name
Methods detail
Returns
stringSend the request
Returns
Throws
Set the client used to transport the request
Parameters
- $client
Guzzle\Http\ClientInterface
$client
Returns
Set the URL of the request
Parameters
- $url
string
$url|Url Full URL to set including query string
Returns
Get the full URL of the request (e.g. 'http://www.guzzle-project.com/')
Parameters
- $asObject
boolean
$asObject Set to TRUE to retrieve the URL as a clone of the URL object owned by the request.
Returns
string|Guzzle\Http\UrlGet the resource part of the the request, including the path, query string, and fragment
Returns
stringGet the collection of key value pairs that will be used as the query string in the request
Returns
Get the HTTP method of the request
Returns
stringGet the URI scheme of the request (http, https, ftp, etc)
Returns
stringSet the URI scheme of the request (http, https, ftp, etc)
Parameters
- $scheme
string
$scheme Scheme to set
Returns
Get the host of the request
Returns
stringSet the host of the request. Including a port in the host will modify the port of the request.
Parameters
- $host
string
$host Host to set (e.g. www.yahoo.com, www.yahoo.com:80)
Returns
Get the path of the request (e.g. '/', '/index.html')
Returns
stringSet the path of the request (e.g. '/', '/index.html')
Parameters
- $path
string|array
$path Path to set or array of segments to implode
Returns
Get the port that the request will be sent on if it has been set
Returns
integer|nullSet the port that the request will be sent on
Parameters
- $port
integer
$port Port number to set
Returns
Get the username to pass in the URL if set
Returns
string|nullGet the password to pass in the URL if set
Returns
string|null
public
Guzzle\Http\Message\RequestInterface
setAuth( string|boolean $user, string $password = '', string $scheme = 'Basic' )
Set HTTP authorization parameters
Parameters
- $user
string|boolean
$user User name or false disable authentication- $password
string
$password Password- $scheme
string
$scheme Authentication scheme ('Basic', 'Digest', or a CURLAUTH_* constant (deprecated))
Returns
Throws
Link
Get the HTTP protocol version of the request
Returns
stringSet the HTTP protocol version of the request (e.g. 1.1 or 1.0)
Parameters
- $protocol
string
$protocol HTTP protocol version to use with the request
Returns
Get the previously received Guzzle\Http\Message\Response or NULL if the request has not
been sent
Returns
public
Guzzle\Http\Message\RequestInterface
setResponse( Guzzle\Http\Message\Response $response, boolean $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
Guzzle\Http\Message\Response
$response Response object to set- $queued
boolean
$queued Set to TRUE to keep the request in a state of not having been sent, but queue the response for send()
Returns
public
Guzzle\Http\Message\RequestInterface
startResponse( Guzzle\Http\Message\Response $response )
The start of a response has been received for a request and the request is still in progress
Parameters
- $response
Guzzle\Http\Message\Response
$response Response that has been received so far
Returns
public
Guzzle\Http\Message\Request
setResponseBody( Guzzle\Http\EntityBodyInterface|string|resource $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
- $body
Guzzle\Http\EntityBodyInterface|string|resource
$body Response body object. Pass a string to attempt to store the response body in a local file.
Returns
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
Get the state of the request. One of 'complete', 'transfer', 'new', 'error'
Returns
stringSet the state of the request
Parameters
- $state
string
$state State of the request ('complete', 'transfer', 'new', 'error')- $context
array
$context Contextual information about the state change
Returns
stringReturns the current state of the request (which may have changed due to events being fired)
Get the cURL options that will be applied when the cURL handle is created
Returns
Get an array of Cookies
Returns
arrayGet a cookie value by name
Parameters
- $name
string
$name Cookie to retrieve
Returns
null|stringAdd a Cookie value by name to the Cookie header
Parameters
- $name
string
$name Name of the cookie to add- $value
string
$value Value to set
Returns
Remove a specific cookie value by name
Parameters
- $name
string
$name Cookie to remove by name
Returns
Methods inherited from Guzzle\Http\Message\MessageInterface
addHeader(),
addHeaders(),
getHeader(),
getHeaderLines(),
getHeaders(),
getParams(),
getRawHeaders(),
hasHeader(),
removeHeader(),
setHeader(),
setHeaders()
Methods inherited from Guzzle\Common\HasDispatcherInterface
addSubscriber(),
dispatch(),
getAllEvents(),
getEventDispatcher(),
setEventDispatcher()
Magic methods summary
Constants summary
string |
STATE_NEW |
'new' |
|
string |
STATE_COMPLETE |
'complete' |
|
string |
STATE_TRANSFER |
'transfer' |
|
string |
STATE_ERROR |
'error' |
|
string |
GET |
'GET' |
|
string |
PUT |
'PUT' |
|
string |
POST |
'POST' |
|
string |
DELETE |
'DELETE' |
|
string |
HEAD |
'HEAD' |
|
string |
CONNECT |
'CONNECT' |
|
string |
OPTIONS |
'OPTIONS' |
|
string |
TRACE |
'TRACE' |
|
string |
PATCH |
'PATCH' |