class EntityEnclosingRequest

HTTP request that sends an entity-body in the request message (POST, PUT, PATCH, DELETE)

Hierarchy

Expanded class hierarchy of EntityEnclosingRequest

File

drupal/core/vendor/guzzle/http/Guzzle/Http/Message/EntityEnclosingRequest.php, line 14

Namespace

Guzzle\Http\Message
View source

Members

Namesort descending Modifiers Type Description Overrides
AbstractMessage::$cacheControl private property
AbstractMessage::$headers protected property
AbstractMessage::$params protected property
AbstractMessage::$protocolVersion protected property
AbstractMessage::addCacheControlDirective public function Add a Cache-Control directive on the message Overrides MessageInterface::addCacheControlDirective
AbstractMessage::addHeader public function Add a header to an existing collection of headers. Overrides MessageInterface::addHeader
AbstractMessage::addHeaders public function Add and merge in an array of HTTP headers. Overrides MessageInterface::addHeaders
AbstractMessage::getCacheControlDirective public function Get a Cache-Control directive from the message Overrides MessageInterface::getCacheControlDirective
AbstractMessage::getHeader public function Retrieve an HTTP header by name. Performs a case-insensitive search of all headers. Overrides MessageInterface::getHeader
AbstractMessage::getHeaderLines public function Get an array of message header lines Overrides MessageInterface::getHeaderLines
AbstractMessage::getHeaders public function Get all headers as a collection Overrides MessageInterface::getHeaders
AbstractMessage::getParams public function Get application and plugin specific parameters set on the message. Overrides MessageInterface::getParams
AbstractMessage::getTokenizedHeader public function Get a tokenized header as a Collection Overrides MessageInterface::getTokenizedHeader
AbstractMessage::hasCacheControlDirective public function Check if the message has a Cache-Control directive Overrides MessageInterface::hasCacheControlDirective
AbstractMessage::hasHeader public function Check if the specified header is present. Overrides MessageInterface::hasHeader
AbstractMessage::parseCacheControlDirective private function Parse the Cache-Control HTTP header into an array
AbstractMessage::rebuildCacheControlDirective private function Rebuild the Cache-Control HTTP header using the user-specified values
AbstractMessage::removeCacheControlDirective public function Remove a Cache-Control directive from the message Overrides MessageInterface::removeCacheControlDirective
AbstractMessage::removeHeader public function Remove a specific HTTP header. Overrides MessageInterface::removeHeader
AbstractMessage::setHeader public function Set an HTTP header Overrides MessageInterface::setHeader
AbstractMessage::setHeaders public function Overwrite all HTTP headers with the supplied array of headers Overrides MessageInterface::setHeaders
AbstractMessage::setTokenizedHeader public function Set a tokenized header on the request that implodes a Collection of data into a string separated by a token. Overrides MessageInterface::setTokenizedHeader
EntityEnclosingRequest::$body protected property
EntityEnclosingRequest::$expectCutoff protected property
EntityEnclosingRequest::$postFields protected property
EntityEnclosingRequest::$postFiles protected property
EntityEnclosingRequest::addPostFields public function Add POST fields to use in the request Overrides EntityEnclosingRequestInterface::addPostFields
EntityEnclosingRequest::addPostFile public function Add a POST file to the upload Overrides EntityEnclosingRequestInterface::addPostFile
EntityEnclosingRequest::addPostFiles public function Add POST files to use in the upload Overrides EntityEnclosingRequestInterface::addPostFiles
EntityEnclosingRequest::configureRedirects public function Configure how redirects are handled for the request Overrides EntityEnclosingRequestInterface::configureRedirects
EntityEnclosingRequest::getBody public function Get the body of the request if set Overrides EntityEnclosingRequestInterface::getBody
EntityEnclosingRequest::getPostField public function Get a POST field from the request Overrides EntityEnclosingRequestInterface::getPostField
EntityEnclosingRequest::getPostFields public function Get the post fields that will be used in the request Overrides EntityEnclosingRequestInterface::getPostFields
EntityEnclosingRequest::getPostFile public function Get a POST file from the request Overrides EntityEnclosingRequestInterface::getPostFile
EntityEnclosingRequest::getPostFiles public function Returns an associative array of POST field names to PostFileInterface objects Overrides EntityEnclosingRequestInterface::getPostFiles
EntityEnclosingRequest::processPostFields protected function Determine what type of request should be sent based on post fields
EntityEnclosingRequest::removePostField public function Remove a POST field or file by name Overrides EntityEnclosingRequestInterface::removePostField
EntityEnclosingRequest::removePostFile public function Remove a POST file from the request Overrides EntityEnclosingRequestInterface::removePostFile
EntityEnclosingRequest::setBody public function Set the body of the request Overrides EntityEnclosingRequestInterface::setBody
EntityEnclosingRequest::setExpectHeaderCutoff public function Set the size that the entity body of the request must exceed before adding the Expect: 100-Continue header.
EntityEnclosingRequest::setPostField public function Set a POST field value Overrides EntityEnclosingRequestInterface::setPostField
EntityEnclosingRequest::setState public function Set the state of the request Overrides Request::setState
EntityEnclosingRequest::__construct public function Create a new request Overrides Request::__construct
EntityEnclosingRequest::__toString public function Get the HTTP request as a string Overrides Request::__toString
EntityEnclosingRequestInterface::MULTIPART constant
EntityEnclosingRequestInterface::URL_ENCODED constant
Request::$client protected property
Request::$curlOptions protected property
Request::$eventDispatcher protected property
Request::$method protected property
Request::$password protected property
Request::$response protected property
Request::$responseBody protected property
Request::$state protected property
Request::$url protected property
Request::$username protected property
Request::addCookie public function Add a Cookie value by name to the Cookie header Overrides RequestInterface::addCookie
Request::addSubscriber public function @codeCoverageIgnore Overrides HasDispatcherInterface::addSubscriber
Request::canCache public function Returns whether or not the request can be cached Overrides RequestInterface::canCache
Request::changedHeader protected function Check to see if the modified headers need to reset any of the managed headers like cache-control Overrides AbstractMessage::changedHeader
Request::dispatch public function Helper to dispatch Guzzle events and set the event name on the event Overrides HasDispatcherInterface::dispatch
Request::getAllEvents public static function Get a list of all of the events emitted from the class Overrides HasDispatcherInterface::getAllEvents
Request::getClient public function Get the client used to transport the request Overrides RequestInterface::getClient
Request::getCookie public function Get a cookie value by name Overrides RequestInterface::getCookie
Request::getCookies public function Get an array of Cookies Overrides RequestInterface::getCookies
Request::getCurlOptions public function Get the cURL options that will be applied when the cURL handle is created Overrides RequestInterface::getCurlOptions
Request::getEventArray protected function Get an array containing the request and response for event notifications
Request::getEventDispatcher public function Get the EventDispatcher of the request Overrides HasDispatcherInterface::getEventDispatcher
Request::getHost public function Get the host of the request Overrides RequestInterface::getHost
Request::getMethod public function Get the HTTP method of the request Overrides RequestInterface::getMethod
Request::getPassword public function Get the password to pass in the URL if set Overrides RequestInterface::getPassword
Request::getPath public function Get the path of the request (e.g. '/', '/index.html') Overrides RequestInterface::getPath
Request::getPort public function Get the port that the request will be sent on if it has been set Overrides RequestInterface::getPort
Request::getProtocolVersion public function Get the HTTP protocol version of the request Overrides RequestInterface::getProtocolVersion
Request::getQuery public function Get the collection of key value pairs that will be used as the query string in the request Overrides RequestInterface::getQuery
Request::getRawHeaders public function Get the raw message headers as a string Overrides MessageInterface::getRawHeaders
Request::getResource public function Get the resource part of the the request, including the path, query string, and fragment Overrides RequestInterface::getResource
Request::getResponse public function Get the previously received {not been sent Overrides RequestInterface::getResponse
Request::getResponseBody protected function
Request::getScheme public function Get the URI scheme of the request (http, https, ftp, etc) Overrides RequestInterface::getScheme
Request::getState public function Get the state of the request. One of 'complete', 'sending', 'new' Overrides RequestInterface::getState
Request::getUrl public function Get the full URL of the request (e.g. 'http://www.guzzle-project.com/') scheme://username:password@domain:port/path?query_string#fragment Overrides RequestInterface::getUrl
Request::getUsername public function Get the username to pass in the URL if set Overrides RequestInterface::getUsername
Request::isResponseBodyRepeatable public function Determine if the response body is repeatable (readable + seekable) Overrides RequestInterface::isResponseBodyRepeatable
Request::onRequestError public static function Default method that will throw exceptions if an unsuccessful response is received.
Request::processResponse protected function Process a received response
Request::receiveResponseHeader public function Method to receive HTTP response headers as they are retrieved Overrides RequestInterface::receiveResponseHeader
Request::removeCookie public function Remove a specific cookie value by name Overrides RequestInterface::removeCookie
Request::send public function Send the request Overrides RequestInterface::send
Request::setAuth public function Set HTTP authorization parameters Overrides RequestInterface::setAuth
Request::setClient public function Set the client used to transport the request Overrides RequestInterface::setClient
Request::setEventDispatcher public function Set the EventDispatcher of the request Overrides HasDispatcherInterface::setEventDispatcher
Request::setHost public function Set the host of the request. Including a port in the host will modify the port of the request. Overrides RequestInterface::setHost
Request::setPath public function Set the path of the request (e.g. '/', '/index.html') Overrides RequestInterface::setPath
Request::setPort public function Set the port that the request will be sent on Overrides RequestInterface::setPort
Request::setProtocolVersion public function Set the HTTP protocol version of the request (e.g. 1.1 or 1.0) Overrides RequestInterface::setProtocolVersion
Request::setResponse public function Manually set a response for the request. Overrides RequestInterface::setResponse
Request::setResponseBody public function Set the EntityBody that will hold the response message's entity body. Overrides RequestInterface::setResponseBody
Request::setScheme public function Set the URI scheme of the request (http, https, ftp, etc) Overrides RequestInterface::setScheme
Request::setUrl public function Set the URL of the request Overrides RequestInterface::setUrl
Request::__clone public function Clone the request object, leaving off any response that was received
RequestInterface::CONNECT constant
RequestInterface::DELETE constant
RequestInterface::GET constant
RequestInterface::HEAD constant
RequestInterface::OPTIONS constant
RequestInterface::PATCH constant
RequestInterface::POST constant
RequestInterface::PUT constant
RequestInterface::STATE_COMPLETE constant
RequestInterface::STATE_ERROR constant
RequestInterface::STATE_NEW constant
RequestInterface::STATE_TRANSFER constant
RequestInterface::TRACE constant