Interface RequestInterface

Guzzle\Http\Message\RequestInterface implements Guzzle\Http\Message\MessageInterface, Guzzle\Common\HasDispatcherInterface

Methods summary

• public __toString ( )
• public send ( )

  Send the request

• public setClient ( Guzzle\Http\ClientInterface $client )

  Set the client used to transport the request

• public getClient ( )

  Get the client used to transport the request

• public setUrl ( string $url )

  Set the URL of the request

• public getUrl ( bool $asObject = false )

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

• public getResource ( )

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

• public getQuery ( )

  Get the collection of key value pairs that will be used as the query string in the request

• public getMethod ( )

  Get the HTTP method of the request

• public getScheme ( )

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

• public setScheme ( string $scheme )

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

• public getHost ( )

  Get the host of the request

• public setHost ( string $host )

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

• public getPath ( )

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

• public setPath ( string|array $path )

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

• public getPort ( )

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

• public setPort ( int $port )

  Set the port that the request will be sent on

• public getUsername ( )

  Get the username to pass in the URL if set

• public getPassword ( )

  Get the password to pass in the URL if set

• public setAuth ( string|bool $user, string $password = '', string $scheme = 'Basic' )

  Set HTTP authorization parameters

• public getProtocolVersion ( )

  Get the HTTP protocol version of the request

• public setProtocolVersion ( string $protocol )

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

• public getResponse ( )

  Get the previously received Guzzle\Http\Message\Response or NULL if the request has not been sent

• public setResponse ( Guzzle\Http\Message\Response $response, bool $queued = false )

  Manually set a response for the request.

• public startResponse ( Guzzle\Http\Message\Response $response )

  The start of a response has been received for a request and the request is still in progress

• public setResponseBody ( EntityBodyInterface|string|resource $body )

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

• public 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.

• public getState ( )

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

• public setState ( string $state, array $context = array() )

  Set the state of the request

• public getCurlOptions ( )

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

• public getCookies ( )

  Get an array of Cookies

• public getCookie ( string $name )

  Get a cookie value by name

• public addCookie ( string $name, string $value )

  Add a Cookie value by name to the Cookie header

• public removeCookie ( string $name )

  Remove a specific cookie value by name

Methods detail

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