Class EntityEnclosingRequest
HTTP request that sends an entity-body in the request message (POST, PUT, PATCH, DELETE)
- Guzzle\Http\Message\AbstractMessage implements Guzzle\Http\Message\MessageInterface
-
Guzzle\Http\Message\Request
implements
Guzzle\Http\Message\RequestInterface
-
Guzzle\Http\Message\EntityEnclosingRequest
implements
Guzzle\Http\Message\EntityEnclosingRequestInterface
Methods summary
-
public__construct ( string $method, string|Url $url, array|Collection $headers = array() ) -
public__toString ( ) -
publicsetState ( string $state, array $context = array() )Set the state of the request
-
publicsetBody ( string|resource|EntityBodyInterface $body, string $contentType = null )Set the body of the request
-
publicgetBody ( )Get the body of the request if set
-
publicsetExpectHeaderCutoff ( int|bool $size )Set the size that the entity body of the request must exceed before adding the Expect: 100-Continue header.
-
publicconfigureRedirects ( bool $strict = false, int $maxRedirects = 5 )Configure how redirects are handled for the request
-
publicgetPostField ( string $field )Get a POST field from the request
-
publicgetPostFields ( )Get the post fields that will be used in the request
-
publicsetPostField ( string $key, string $value )Set a POST field value
-
publicaddPostFields ( QueryString|array $fields )Add POST fields to use in the request
-
publicremovePostField ( string $field )Remove a POST field or file by name
-
publicgetPostFiles ( )Returns an associative array of POST field names to PostFileInterface objects
-
publicgetPostFile ( string $fieldName )Get a POST file from the request
-
publicremovePostFile ( string $fieldName )Remove a POST file from the request
-
publicaddPostFile ( string $field, string $filename = null, string $contentType = null, string $postname = null )Add a POST file to the upload
-
publicaddPostFiles ( array $files )Add POST files to use in the upload
-
protectedprocessPostFields ( )Determine what type of request should be sent based on post fields
Methods detail
Parameters
- $method
string
$method HTTP method- $url
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.- $headers
array|Collection
$headers HTTP headers
Overrides
Returns
stringOverrides
Implementation of
Set 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)
Overrides
Implementation of
public
Guzzle\Http\Message\EntityEnclosingRequest
setBody( string|resource|Guzzle\Http\EntityBodyInterface $body, string $contentType = null )
Set the body of the request
Parameters
- $body
string|resource|Guzzle\Http\EntityBodyInterface
$body Body to use in the entity body of the request- $contentType
string
$contentType Content-Type to set. Leave null to use an existing Content-Type or to guess the Content-Type
Returns
Throws
Guzzle\Http\Exception\RequestExceptionif the protocol is < 1.1 and Content-Length can not be determined
Implementation of
Get the body of the request if set
Returns
Implementation of
Set the size that the entity body of the request must exceed before adding the Expect: 100-Continue header.
Parameters
- $size
integer|boolean
$size Cutoff in bytes. Set to false to never send the expect header (even with non-seekable data)
Returns
public
Guzzle\Http\Message\EntityEnclosingRequest
configureRedirects( boolean $strict = false, integer $maxRedirects = 5 )
Configure how redirects are handled for the request
Parameters
- $strict
boolean
$strict Set to true to follow strict RFC compliance when redirecting POST requests. Most browsers with follow a 301-302 redirect for a POST request with a GET request. This is the default behavior of Guzzle. Enable strict redirects to redirect these responses with a POST rather than a GET request.- $maxRedirects
integer
$maxRedirects Specify the maximum number of allowed redirects. Set to 0 to disable redirects.
Returns
Implementation of
Get a POST field from the request
Parameters
- $field
string
$field Field to retrieve
Returns
mixed|nullImplementation of
Get the post fields that will be used in the request
Returns
Implementation of
Set a POST field value
Parameters
- $key
string
$key Key to set- $value
string
$value Value to set
Returns
Implementation of
public
Guzzle\Http\Message\EntityEnclosingRequest
addPostFields( Guzzle\Http\QueryString|array $fields )
Add POST fields to use in the request
Parameters
- $fields
Guzzle\Http\QueryString|array
$fields POST fields
Returns
Implementation of
Remove a POST field or file by name
Parameters
- $field
string
$field Name of the POST field or file to remove
Returns
Implementation of
Returns an associative array of POST field names to PostFileInterface objects
Returns
arrayImplementation of
Get a POST file from the request
Parameters
- $fieldName
string
$fieldName POST fields to retrieve
Returns
array|nullReturns an array wrapping an array of PostFileInterface objects
Implementation of
Remove a POST file from the request
Parameters
- $fieldName
string
$fieldName POST file field name to remove
Returns
Implementation of
public
Guzzle\Http\Message\EntityEnclosingRequest
addPostFile( string $field, string $filename = null, string $contentType = null, string $postname = null )
Add a POST file to the upload
Parameters
- $field
string
$field POST field to use (e.g. file). Used to reference content from the server.- $filename
string
$filename Full path to the file. Do not include the @ symbol.- $contentType
string
$contentType Optional Content-Type to add to the Content-Disposition. Default behavior is to guess. Set to false to not specify.- $postname
string
$postname The name of the file, when posted. (e.g. rename the file)
Returns
Implementation of
Add POST files to use in the upload
Parameters
- $files
array
$files An array of POST fields => filenames where filename can be a string or PostFileInterface
Returns
Implementation of
Determine what type of request should be sent based on post fields
Methods inherited from Guzzle\Http\Message\Request
__clone(),
addCookie(),
addSubscriber(),
dispatch(),
getAllEvents(),
getClient(),
getCookie(),
getCookies(),
getCurlOptions(),
getEventArray(),
getEventDispatcher(),
getHost(),
getMethod(),
getPassword(),
getPath(),
getPort(),
getProtocolVersion(),
getQuery(),
getRawHeaders(),
getResource(),
getResponse(),
getResponseBody(),
getScheme(),
getState(),
getUrl(),
getUsername(),
onRequestError(),
processResponse(),
removeCookie(),
send(),
setAuth(),
setClient(),
setEventDispatcher(),
setHost(),
setPath(),
setPort(),
setProtocolVersion(),
setResponse(),
setResponseBody(),
setScheme(),
setUrl(),
startResponse()
Methods inherited from Guzzle\Http\Message\AbstractMessage
addHeader(),
addHeaders(),
getHeader(),
getHeaderLines(),
getHeaders(),
getParams(),
hasHeader(),
removeHeader(),
setHeader(),
setHeaderFactory(),
setHeaders()
Magic methods summary
Constants summary
Constants inherited from Guzzle\Http\Message\RequestInterface
CONNECT,
DELETE,
GET,
HEAD,
OPTIONS,
PATCH,
POST,
PUT,
STATE_COMPLETE,
STATE_ERROR,
STATE_NEW,
STATE_TRANSFER,
TRACE
Constants inherited from Guzzle\Http\Message\EntityEnclosingRequestInterface
Properties summary
protected
integer
|
$expectCutoff |
#
When the size of the body is greater than 1MB, then send Expect: 100-Continue |
protected
|
$body |
#
$body Body of the request |
protected
|
$postFields |
#
POST fields to use in the EntityBody |
protected
array
|
$postFiles |
#
POST files to send with the request |
Properties inherited from Guzzle\Http\Message\Request
$client,
$curlOptions,
$eventDispatcher,
$isRedirect,
$method,
$password,
$response,
$responseBody,
$state,
$url,
$username
Properties inherited from Guzzle\Http\Message\AbstractMessage
$headerFactory,
$headers,
$params,
$protocol,
$protocolVersion