Open Journal Systems  3.3.0
Guzzle\Http\Message\RequestFactory Class Reference
Inheritance diagram for Guzzle\Http\Message\RequestFactory:
Guzzle\Http\Message\RequestFactoryInterface

Public Member Functions

 __construct ()
 
 applyOptions (RequestInterface $request, array $options=array(), $flags=self::OPTIONS_NONE)
 
 cloneRequestWithMethod (RequestInterface $request, $method)
 
 create ($method, $url, $headers=null, $body=null, array $options=array())
 
 fromMessage ($message)
 
 fromParts ( $method, array $urlParts, $headers=null, $body=null, $protocol='HTTP', $protocolVersion='1.1')
 

Static Public Member Functions

static getInstance ()
 

Protected Member Functions

 visit_allow_redirects (RequestInterface $request, $value, $flags)
 
 visit_auth (RequestInterface $request, $value, $flags)
 
 visit_body (RequestInterface $request, $value, $flags)
 
 visit_cert (RequestInterface $request, $value, $flags)
 
 visit_connect_timeout (RequestInterface $request, $value, $flags)
 
 visit_cookies (RequestInterface $request, $value, $flags)
 
 visit_debug (RequestInterface $request, $value, $flags)
 
 visit_events (RequestInterface $request, $value, $flags)
 
 visit_exceptions (RequestInterface $request, $value, $flags)
 
 visit_headers (RequestInterface $request, $value, $flags)
 
 visit_params (RequestInterface $request, $value, $flags)
 
 visit_plugins (RequestInterface $request, $value, $flags)
 
 visit_proxy (RequestInterface $request, $value, $flags)
 
 visit_query (RequestInterface $request, $value, $flags)
 
 visit_save_to (RequestInterface $request, $value, $flags)
 
 visit_ssl_key (RequestInterface $request, $value, $flags)
 
 visit_timeout (RequestInterface $request, $value, $flags)
 
 visit_verify (RequestInterface $request, $value, $flags)
 

Protected Attributes

 $entityEnclosingRequestClass = 'Guzzle\\Http\\Message\\EntityEnclosingRequest'
 
 $methods
 
 $requestClass = 'Guzzle\\Http\\Message\\Request'
 

Static Protected Attributes

static $instance
 

Additional Inherited Members

- Data Fields inherited from Guzzle\Http\Message\RequestFactoryInterface
const OPTIONS_AS_DEFAULTS = 1
 
const OPTIONS_NONE = 0
 

Detailed Description

Default HTTP request factory used to create the default {

See also
Request} and {
EntityEnclosingRequest} objects.

Definition at line 14 of file lib/vendor/guzzle/guzzle/src/Guzzle/Http/Message/RequestFactory.php.

Constructor & Destructor Documentation

◆ __construct()

Guzzle\Http\Message\RequestFactory::__construct ( )

Member Function Documentation

◆ applyOptions()

Guzzle\Http\Message\RequestFactory::applyOptions ( RequestInterface  $request,
array  $options = array(),
  $flags = self::OPTIONS_NONE 
)

Apply an associative array of options to the request

Parameters
RequestInterface$requestRequest to update
array$optionsOptions to use with the request. Available options are: "headers": Associative array of headers "query": Associative array of query string values to add to the request "body": Body of a request, including an EntityBody, string, or array when sending POST requests. "auth": Array of HTTP authentication parameters to use with the request. The array must contain the username in index [0], the password in index [2], and can optionally contain the authentication type in index [3]. The authentication types are: "Basic", "Digest", "NTLM", "Any" (defaults to "Basic"). "cookies": Associative array of cookies "allow_redirects": Set to false to disable redirects "save_to": String, fopen resource, or EntityBody object used to store the body of the response "events": Associative array mapping event names to a closure or array of (priority, closure) "plugins": Array of plugins to add to the request "exceptions": Set to false to disable throwing exceptions on an HTTP level error (e.g. 404, 500, etc) "params": Set custom request data parameters on a request. (Note: these are not query string parameters) "timeout": Float describing the timeout of the request in seconds "connect_timeout": Float describing the number of seconds to wait while trying to connect. Use 0 to wait indefinitely. "verify": Set to true to enable SSL cert validation (the default), false to disable, or supply the path to a CA bundle to enable verification using a custom certificate. "cert": Set to a string to specify the path to a file containing a PEM formatted certificate. If a password is required, then set an array containing the path to the PEM file followed by the the password required for the certificate. "ssl_key": Specify the path to a file containing a private SSL key in PEM format. If a password is required, then set an array containing the path to the SSL key followed by the password required for the certificate. "proxy": Specify an HTTP proxy (e.g. "http://username:password@192.168.16.1:10") "debug": Set to true to display all data sent over the wire
int$flagsBitwise flags to apply when applying the options to the request. Defaults to no special options. 1 (OPTIONS_AS_DEFAULTS): When specified, options will only update a request when the value does not already exist on the request. This is only supported by "query" and "headers". Other bitwise options may be added in the future.

Implements Guzzle\Http\Message\RequestFactoryInterface.

Definition at line 170 of file lib/vendor/guzzle/guzzle/src/Guzzle/Http/Message/RequestFactory.php.

Referenced by Guzzle\Http\Message\RequestFactory\create().

◆ cloneRequestWithMethod()

Guzzle\Http\Message\RequestFactory::cloneRequestWithMethod ( RequestInterface  $request,
  $method 
)

◆ create()

Guzzle\Http\Message\RequestFactory::create (   $method,
  $url,
  $headers = null,
  $body = null,
array  $options = array() 
)

Create a new request based on the HTTP method

Parameters
string$methodHTTP method (GET, POST, PUT, PATCH, HEAD, DELETE, ...)
string | Url$urlHTTP URL to connect to
array | Collection$headersHTTP headers
string | resource | array | EntityBodyInterface$bodyBody to send in the request
array$optionsArray of options to apply to the request
Returns
RequestInterface

Implements Guzzle\Http\Message\RequestFactoryInterface.

Definition at line 92 of file lib/vendor/guzzle/guzzle/src/Guzzle/Http/Message/RequestFactory.php.

References Guzzle\Http\Message\RequestFactory\applyOptions().

Referenced by Guzzle\Http\Message\RequestFactory\cloneRequestWithMethod(), and Guzzle\Http\Message\RequestFactory\fromParts().

◆ fromMessage()

Guzzle\Http\Message\RequestFactory::fromMessage (   $message)

Create a new request based on an HTTP message

Parameters
string$messageHTTP message as a string
Returns
RequestInterface

Implements Guzzle\Http\Message\RequestFactoryInterface.

Definition at line 58 of file lib/vendor/guzzle/guzzle/src/Guzzle/Http/Message/RequestFactory.php.

References Guzzle\Http\Message\RequestFactory\fromParts(), and Guzzle\Parser\ParserRegistry\getInstance().

◆ fromParts()

Guzzle\Http\Message\RequestFactory::fromParts (   $method,
array  $urlParts,
  $headers = null,
  $body = null,
  $protocol = 'HTTP',
  $protocolVersion = '1.1' 
)

Create a request from URL parts as returned from parse_url()

Parameters
string$methodHTTP method (GET, POST, PUT, HEAD, DELETE, etc)
array$urlPartsURL parts containing the same keys as parse_url()
  • scheme: e.g. http
  • host: e.g. www.guzzle-project.com
  • port: e.g. 80
  • user: e.g. michael
  • pass: e.g. rocks
  • path: e.g. / OR /index.html
  • query: after the question mark ?
array | Collection$headersHTTP headers
string | resource | array | EntityBodyInterface$bodyBody to send in the request
string$protocolProtocol (HTTP, SPYDY, etc)
string$protocolVersion1.0, 1.1, etc
Returns
RequestInterface

Implements Guzzle\Http\Message\RequestFactoryInterface.

Definition at line 80 of file lib/vendor/guzzle/guzzle/src/Guzzle/Http/Message/RequestFactory.php.

References Guzzle\Http\Url\buildUrl(), and Guzzle\Http\Message\RequestFactory\create().

Referenced by Guzzle\Http\Message\RequestFactory\fromMessage().

◆ getInstance()

static Guzzle\Http\Message\RequestFactory::getInstance ( )
static

Get a cached instance of the default request factory

Returns
RequestFactory

Definition at line 42 of file lib/vendor/guzzle/guzzle/src/Guzzle/Http/Message/RequestFactory.php.

Referenced by Guzzle\Http\Client\__construct(), Guzzle\Http\RedirectPlugin\createRedirectRequest(), Guzzle\Tests\Plugin\Backoff\BackoffLoggerTest\getMocks(), Guzzle\Tests\Http\Server\getReceivedRequests(), Guzzle\Tests\Plugin\Oauth\OauthPluginTest\getRequest(), Guzzle\Tests\Http\Curl\CurlHandleTest\testAddsCustomCurlOptions(), Guzzle\Tests\Http\Message\EntityEnclosingRequestTest\testAddsPostFieldsAndSetsContentLength(), Guzzle\Tests\Http\Message\EntityEnclosingRequestTest\testAddsPostFilesAndSetsContentType(), Guzzle\Tests\Plugin\Async\AsyncPluginTest\testAddsTimesOutAfterSending(), Guzzle\Tests\Http\Message\EntityEnclosingRequestTest\testAllowsContentDispositionFieldsInPostUploadsWhenSettingInBulk(), Guzzle\Tests\Http\Message\EntityEnclosingRequestTest\testAllowsContentTypeInPostUploads(), Guzzle\Tests\Http\Curl\CurlHandleTest\testAllowsWireTransferInfoToBeEnabled(), Guzzle\Tests\Http\Message\HttpRequestFactoryTest\testBugPathIncorrectlyHandled(), Guzzle\Tests\Http\Message\HttpRequestFactoryTest\testCachesSingletonInstance(), Guzzle\Tests\Http\Message\HttpRequestFactoryTest\testCanAddBasicAuth(), Guzzle\Tests\Http\Message\HttpRequestFactoryTest\testCanAddDigestAuth(), Guzzle\Tests\Http\Message\HttpRequestFactoryTest\testCanAddQueryString(), Guzzle\Tests\Http\Message\EntityEnclosingRequestTest\testCanSendMultipleRequestsUsingASingleRequestObject(), Guzzle\Tests\Http\Message\HttpRequestFactoryTest\testCanSetDefaultHeadersOptions(), Guzzle\Tests\Http\Message\HttpRequestFactoryTest\testCanSetDefaultQueryString(), Guzzle\Tests\Http\Message\HttpRequestFactoryTest\testClonesRequestsWithMethodWithClient(), Guzzle\Tests\Http\Message\HttpRequestFactoryTest\testClonesRequestsWithMethodWithClientWithEntityEnclosingChange(), Guzzle\Tests\Http\Message\HttpRequestFactoryTest\testClonesRequestsWithMethodWithoutClient(), Guzzle\Tests\Http\Message\HttpRequestFactoryTest\testCreatesBodyWithoutZeroString(), Guzzle\Tests\Http\Message\HttpRequestFactoryTest\testCreatesFromMessage(), Guzzle\Tests\Http\Message\HttpRequestFactoryTest\testCreatesFromParts(), Guzzle\Tests\Http\Message\HttpRequestFactoryTest\testCreatesHeadAndDeleteRequests(), Guzzle\Tests\Http\Message\HttpRequestFactoryTest\testCreatesHttpMessagesWithBodiesAndNormalizesLineEndings(), Guzzle\Tests\Http\Message\HttpRequestFactoryTest\testCreatesNewGetRequests(), Guzzle\Tests\Http\Message\HttpRequestFactoryTest\testCreatesNewPostRequestWithFields(), Guzzle\Tests\Http\Message\HttpRequestFactoryTest\testCreatesNewPutRequestWithBody(), Guzzle\Tests\Http\Message\HttpRequestFactoryTest\testCreatesNewTraceRequest(), Guzzle\Tests\Http\Message\HttpRequestFactoryTest\testCreatesOptionsRequests(), Guzzle\Tests\Http\Message\HttpRequestFactoryTest\testCreatesProperTransferEncodingRequests(), Guzzle\Tests\Http\Message\HttpRequestFactoryTest\testCreatesPutRequests(), Guzzle\Tests\Http\Curl\CurlHandleTest\testCurlConfigurationOptionsAreSet(), Guzzle\Tests\Http\Curl\CurlMultiTest\testCurlErrorsAreCaught(), Guzzle\Tests\Plugin\Async\AsyncPluginTest\testEnablesProgressCallbacks(), Guzzle\Tests\Http\Curl\CurlHandleTest\testEnsuresRequestsHaveResponsesWhenUpdatingFromTransfer(), Guzzle\Tests\Service\Command\ClosureCommandTest\testExecutesClosure(), Guzzle\Tests\Http\Curl\CurlHandleTest\testFactoryUsesSpecifiedProtocol(), Guzzle\Tests\Http\Message\EntityEnclosingRequestTest\testGuessesContentTypeOfPostUpload(), Guzzle\Tests\Http\Message\HttpRequestFactoryTest\testHandlesChunkedTransferEncoding(), Guzzle\Tests\Plugin\Async\AsyncPluginTest\testMasksCurlExceptions(), Guzzle\Tests\Http\Message\EntityEnclosingRequestTest\testPostRequestsUseApplicationXwwwForUrlEncodedForArrays(), Guzzle\Tests\Http\Message\EntityEnclosingRequestTest\testPostRequestsUseMultipartFormDataWithFiles(), Guzzle\Tests\Http\Message\EntityEnclosingRequestTest\testProcessMethodAddsContentType(), Guzzle\Tests\Http\Message\HttpRequestFactoryTest\testProperlyDealsWithDuplicateHeaders(), Guzzle\Tests\Plugin\Md5\Md5ValidatorPluginTest\testProperlyValidatesWhenUsingContentEncoding(), Guzzle\Tests\Plugin\Cache\DefaultCacheStorageTest\testPurgeRemovesAllMethodCaches(), Guzzle\Tests\Http\Curl\CurlMultiTest\testRemovesQueuedRequests(), Guzzle\Tests\Http\Message\EntityEnclosingRequestTest\testRequestBodyAddsContentLength(), Guzzle\Tests\Http\Message\EntityEnclosingRequestTest\testRequestBodyContainsPostFiles(), Guzzle\Tests\Http\Message\EntityEnclosingRequestTest\testRequestBodyDoesNotUseContentLengthWhenChunked(), Guzzle\Tests\Http\Message\RequestTest\testRequestCanBeSentUsingCurl(), Guzzle\Tests\Http\Message\RequestTest\testRequestCanHaveManuallySetResponseBody(), Guzzle\Tests\Http\Message\EntityEnclosingRequestTest\testRequestHasMutableBody(), Guzzle\Tests\Http\Message\EntityEnclosingRequestTest\testRequestIncludesBodyInMessage(), Guzzle\Tests\Http\Message\EntityEnclosingRequestTest\testRequestIncludesPostBodyInMessageOnlyWhenNoPostFiles(), Guzzle\Tests\Http\Message\RequestTest\testRequestsCanBeConvertedToRawMessageStrings(), Guzzle\Tests\Http\Message\RequestTest\testRequestStringsIncludeAuth(), Guzzle\Tests\Plugin\Cache\DefaultRevalidationTest\testRevalidatesResponsesAgainstOriginServer(), Guzzle\Tests\Http\Curl\CurlHandleTest\testSendsPostRequestsWithFields(), Guzzle\Tests\Http\Curl\CurlHandleTest\testSendsPostRequestsWithFiles(), Guzzle\Tests\Http\Message\EntityEnclosingRequestTest\testSetPostFields(), Guzzle\Tests\Http\Message\EntityEnclosingRequestTest\testSetPostFiles(), Guzzle\Tests\Http\Message\EntityEnclosingRequestTest\testSetPostFilesThrowsExceptionWhenFileIsNotFound(), Guzzle\Tests\Plugin\Md5\Md5ValidatorPluginTest\testSkipsWhenContentLengthIsTooLarge(), Guzzle\Tests\Http\Curl\CurlHandleTest\testStoresStdErr(), Guzzle\Tests\Plugin\Md5\Md5ValidatorPluginTest\testThrowsExceptionOnInvalidMd5(), Guzzle\Tests\Http\Message\EntityEnclosingRequestTest\testThrowsExceptionWhenNonStringsAreAddedToPost(), and Guzzle\Tests\Plugin\Md5\Md5ValidatorPluginTest\testValidatesMd5().

◆ visit_allow_redirects()

Guzzle\Http\Message\RequestFactory::visit_allow_redirects ( RequestInterface  $request,
  $value,
  $flags 
)
protected

◆ visit_auth()

Guzzle\Http\Message\RequestFactory::visit_auth ( RequestInterface  $request,
  $value,
  $flags 
)
protected

◆ visit_body()

Guzzle\Http\Message\RequestFactory::visit_body ( RequestInterface  $request,
  $value,
  $flags 
)
protected

◆ visit_cert()

Guzzle\Http\Message\RequestFactory::visit_cert ( RequestInterface  $request,
  $value,
  $flags 
)
protected

◆ visit_connect_timeout()

Guzzle\Http\Message\RequestFactory::visit_connect_timeout ( RequestInterface  $request,
  $value,
  $flags 
)
protected

◆ visit_cookies()

Guzzle\Http\Message\RequestFactory::visit_cookies ( RequestInterface  $request,
  $value,
  $flags 
)
protected

◆ visit_debug()

Guzzle\Http\Message\RequestFactory::visit_debug ( RequestInterface  $request,
  $value,
  $flags 
)
protected

◆ visit_events()

Guzzle\Http\Message\RequestFactory::visit_events ( RequestInterface  $request,
  $value,
  $flags 
)
protected

◆ visit_exceptions()

Guzzle\Http\Message\RequestFactory::visit_exceptions ( RequestInterface  $request,
  $value,
  $flags 
)
protected

◆ visit_headers()

◆ visit_params()

Guzzle\Http\Message\RequestFactory::visit_params ( RequestInterface  $request,
  $value,
  $flags 
)
protected

◆ visit_plugins()

Guzzle\Http\Message\RequestFactory::visit_plugins ( RequestInterface  $request,
  $value,
  $flags 
)
protected

◆ visit_proxy()

Guzzle\Http\Message\RequestFactory::visit_proxy ( RequestInterface  $request,
  $value,
  $flags 
)
protected

◆ visit_query()

Guzzle\Http\Message\RequestFactory::visit_query ( RequestInterface  $request,
  $value,
  $flags 
)
protected

◆ visit_save_to()

Guzzle\Http\Message\RequestFactory::visit_save_to ( RequestInterface  $request,
  $value,
  $flags 
)
protected

◆ visit_ssl_key()

Guzzle\Http\Message\RequestFactory::visit_ssl_key ( RequestInterface  $request,
  $value,
  $flags 
)
protected

◆ visit_timeout()

Guzzle\Http\Message\RequestFactory::visit_timeout ( RequestInterface  $request,
  $value,
  $flags 
)
protected

◆ visit_verify()

Guzzle\Http\Message\RequestFactory::visit_verify ( RequestInterface  $request,
  $value,
  $flags 
)
protected

Field Documentation

◆ $entityEnclosingRequestClass

string Guzzle\Http\Message\RequestFactory::$entityEnclosingRequestClass = 'Guzzle\\Http\\Message\\EntityEnclosingRequest'
protected

Class to instantiate for requests with a body

Definition at line 35 of file lib/vendor/guzzle/guzzle/src/Guzzle/Http/Message/RequestFactory.php.

◆ $instance

Guzzle\Http\Message\RequestFactory::$instance
staticprotected

Singleton instance of the default request factory

Definition at line 18 of file lib/vendor/guzzle/guzzle/src/Guzzle/Http/Message/RequestFactory.php.

◆ $methods

RequestFactory Guzzle\Http\Message\RequestFactory::$methods
protected

◆ $requestClass

string Guzzle\Http\Message\RequestFactory::$requestClass = 'Guzzle\\Http\\Message\\Request'
protected

Class to instantiate for requests with no body

Definition at line 29 of file lib/vendor/guzzle/guzzle/src/Guzzle/Http/Message/RequestFactory.php.


The documentation for this class was generated from the following file: