Class RequestFactory

Default HTTP request factory used to create the default Guzzle\Http\Message\Request and Guzzle\Http\Message\EntityEnclosingRequest objects.

Guzzle\Http\Message\RequestFactory implements Guzzle\Http\Message\RequestFactoryInterface

Namespace: Guzzle\Http\Message
Located at src/Guzzle/Http/Message/RequestFactory.php

Methods summary
`public static Guzzle\Http\Message\RequestFactory`	# `getInstance( )` Get a cached instance of the default request factory Get a cached instance of the default request factory Returns `Guzzle\Http\Message\RequestFactory`
`public`	# `__construct( )`
`public Guzzle\Http\Message\RequestInterface`	# `fromMessage( string $message )` Create a new request based on an HTTP message Create a new request based on an HTTP message Parameters `$message` HTTP message as a string Returns `Guzzle\Http\Message\RequestInterface` Implementation of `Guzzle\Http\Message\RequestFactoryInterface::fromMessage()`
`public Guzzle\Http\Message\RequestInterface`	# `fromParts( string $method, array $urlParts, array\|Guzzle\Common\Collection $headers = null, string\|resource\|array\|EntityBodyInterface $body = null, string $protocol = 'HTTP', string $protocolVersion = '1.1' )` Create a request from URL parts as returned from parse_url() Create a request from URL parts as returned from parse_url() Parameters `$method` HTTP method (GET, POST, PUT, HEAD, DELETE, etc) `$urlParts` URL 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 ? `$headers` HTTP headers `$body` Body to send in the request `$protocol` Protocol (HTTP, SPYDY, etc) `$protocolVersion` 1.0, 1.1, etc Returns `Guzzle\Http\Message\RequestInterface` Implementation of `Guzzle\Http\Message\RequestFactoryInterface::fromParts()`
`public Guzzle\Http\Message\RequestInterface`	# `create( string $method, string\|Guzzle\Http\Url $url, array\|Guzzle\Common\Collection $headers = null, string\|resource\|array\|EntityBodyInterface $body = null, array $options = array() )` Create a new request based on the HTTP method Create a new request based on the HTTP method Parameters `$method` HTTP method (GET, POST, PUT, PATCH, HEAD, DELETE, ...) `$url` HTTP URL to connect to `$headers` HTTP headers `$body` Body to send in the request `$options` Array of options to apply to the request Returns `Guzzle\Http\Message\RequestInterface` Implementation of `Guzzle\Http\Message\RequestFactoryInterface::create()`
`public Guzzle\Http\Message\RequestInterface`	# `cloneRequestWithMethod( Guzzle\Http\Message\RequestInterface $request, string $method )` Clone a request while changing the method. Emulates the behavior of Guzzle\Http\Message\Request::clone, but can change the HTTP method. Clone a request while changing the method. Emulates the behavior of Guzzle\Http\Message\Request::clone, but can change the HTTP method. Parameters `$request` Request to clone `$method` Method to set Returns `Guzzle\Http\Message\RequestInterface`
`public`	# `applyOptions( Guzzle\Http\Message\RequestInterface $request, array $options = array(), integer $flags = self::OPTIONS_NONE )` Apply an associative array of options to the request Apply an associative array of options to the request Parameters `$request` Request to update `$options` Options 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 `$flags` Bitwise 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. Implementation of `Guzzle\Http\Message\RequestFactoryInterface::applyOptions()`
`protected`	# `visit_headers( Guzzle\Http\Message\RequestInterface $request, $value, $flags )`
`protected`	# `visit_body( Guzzle\Http\Message\RequestInterface $request, $value, $flags )`
`protected`	# `visit_allow_redirects( Guzzle\Http\Message\RequestInterface $request, $value, $flags )`
`protected`	# `visit_auth( Guzzle\Http\Message\RequestInterface $request, $value, $flags )`
`protected`	# `visit_query( Guzzle\Http\Message\RequestInterface $request, $value, $flags )`
`protected`	# `visit_cookies( Guzzle\Http\Message\RequestInterface $request, $value, $flags )`
`protected`	# `visit_events( Guzzle\Http\Message\RequestInterface $request, $value, $flags )`
`protected`	# `visit_plugins( Guzzle\Http\Message\RequestInterface $request, $value, $flags )`
`protected`	# `visit_exceptions( Guzzle\Http\Message\RequestInterface $request, $value, $flags )`
`protected`	# `visit_save_to( Guzzle\Http\Message\RequestInterface $request, $value, $flags )`
`protected`	# `visit_params( Guzzle\Http\Message\RequestInterface $request, $value, $flags )`
`protected`	# `visit_timeout( Guzzle\Http\Message\RequestInterface $request, $value, $flags )`
`protected`	# `visit_connect_timeout( Guzzle\Http\Message\RequestInterface $request, $value, $flags )`
`protected`	# `visit_debug( Guzzle\Http\Message\RequestInterface $request, $value, $flags )`
`protected`	# `visit_verify( Guzzle\Http\Message\RequestInterface $request, $value, $flags )`
`protected`	# `visit_proxy( Guzzle\Http\Message\RequestInterface $request, $value, $flags )`
`protected`	# `visit_cert( Guzzle\Http\Message\RequestInterface $request, $value, $flags )`
`protected`	# `visit_ssl_key( Guzzle\Http\Message\RequestInterface $request, $value, $flags )`

Constants inherited from Guzzle\Http\Message\RequestFactoryInterface
`OPTIONS_AS_DEFAULTS, OPTIONS_NONE`

Properties summary
`protected static Guzzle\Http\Message\RequestFactory`	`$instance` Singleton instance of the default request factory Singleton instance of the default request factory	#
`protected array`	`$methods` Hash of methods available to the class (provides fast isset() lookups) Hash of methods available to the class (provides fast isset() lookups)	#
`protected string`	`$requestClass` Class to instantiate for requests with no body Class to instantiate for requests with no body	# `'Guzzle\\Http\\Message\\Request'`
`protected string`	`$entityEnclosingRequestClass` Class to instantiate for requests with a body Class to instantiate for requests with a body	# `'Guzzle\\Http\\Message\\EntityEnclosingRequest'`

Namespaces

Classes

Interfaces

Class RequestFactory

Returns

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Parameters

Implementation of