AWS SDK for PHP
  • Namespace
  • Class
  • Tree
  • Download

Namespaces

  • Aws
    • AutoScaling
      • Enum
      • Exception
    • CloudFormation
      • Enum
      • Exception
    • CloudFront
      • Enum
      • Exception
    • CloudFront_2012_05_05
    • CloudHsm
      • Exception
    • CloudSearch
      • Enum
      • Exception
    • CloudSearch_2011_02_01
    • CloudSearchDomain
      • Exception
    • CloudTrail
      • Exception
    • CloudWatch
      • Enum
      • Exception
    • CloudWatchLogs
      • Exception
    • CodeCommit
      • Exception
    • CodeDeploy
      • Exception
    • CodePipeline
      • Exception
    • CognitoIdentity
      • Exception
    • CognitoSync
      • Exception
    • Common
      • Client
      • Command
      • Credentials
      • Enum
      • Exception
        • Parser
      • Hash
      • InstanceMetadata
        • Waiter
      • Iterator
      • Model
        • MultipartUpload
      • Signature
      • Waiter
    • ConfigService
      • Exception
    • DataPipeline
      • Enum
      • Exception
    • DeviceFarm
      • Exception
    • DirectConnect
      • Enum
      • Exception
    • DirectoryService
      • Exception
    • DynamoDb
      • Enum
      • Exception
      • Model
        • BatchRequest
      • Session
        • LockingStrategy
    • DynamoDb_2011_12_05
    • DynamoDbStreams
      • Exception
    • Ec2
      • Enum
      • Exception
      • Iterator
    • Ecs
      • Exception
    • Efs
      • Exception
    • ElastiCache
      • Enum
      • Exception
    • ElasticBeanstalk
      • Enum
      • Exception
    • ElasticFileSystem
    • ElasticLoadBalancing
      • Exception
    • ElasticTranscoder
      • Exception
    • Emr
      • Enum
      • Exception
    • Glacier
      • Enum
      • Exception
      • Model
        • MultipartUpload
    • Iam
      • Enum
      • Exception
    • ImportExport
      • Enum
      • Exception
    • Kinesis
      • Enum
      • Exception
    • Kms
      • Exception
    • Lambda
      • Exception
    • MachineLearning
      • Exception
    • OpsWorks
      • Enum
      • Exception
    • Rds
      • Enum
      • Exception
    • Redshift
      • Enum
      • Exception
    • Route53
      • Enum
      • Exception
    • Route53Domains
      • Exception
    • S3
      • Command
      • Enum
      • Exception
        • Parser
      • Iterator
      • Model
        • MultipartUpload
      • Sync
    • Ses
      • Enum
      • Exception
    • SimpleDb
      • Exception
    • Sns
      • Exception
      • MessageValidator
        • Exception
    • Sqs
      • Enum
      • Exception
    • Ssm
      • Exception
    • StorageGateway
      • Enum
      • Exception
    • Sts
      • Exception
    • Support
      • Exception
    • Swf
      • Enum
      • Exception
    • WorkSpaces
      • Exception
  • Guzzle
    • Batch
      • Exception
    • Cache
    • Common
      • Exception
    • Http
      • Curl
      • Exception
      • Message
        • Header
      • QueryAggregator
    • Inflection
    • Iterator
    • Log
    • Parser
      • Cookie
      • Message
      • UriTemplate
      • Url
    • Plugin
      • Async
      • Backoff
      • Cache
      • Cookie
        • CookieJar
        • Exception
      • ErrorResponse
        • Exception
      • History
      • Log
      • Md5
      • Mock
      • Oauth
    • Service
      • Builder
      • Command
        • Factory
        • LocationVisitor
          • Request
          • Response
      • Description
      • Exception
      • Resource
    • Stream
  • PHP

Classes

  • AbstractMessage
  • EntityEnclosingRequest
  • Header
  • PostFile
  • Request
  • RequestFactory
  • Response

Interfaces

  • EntityEnclosingRequestInterface
  • MessageInterface
  • PostFileInterface
  • RequestFactoryInterface
  • RequestInterface
NOTE: For Version 3 of the AWS SDK for PHP, please see the V3 User Guide and V3 API Reference.

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 Guzzle/Http/Message/RequestFactory.php

Methods summary

  • public static getInstance ( )

    Get a cached instance of the default request factory

  • public __construct ( )
  • public fromMessage ( string $message )

    Create a new request based on an HTTP message

  • public fromParts ( string $method, array $urlParts, array|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()

  • public create ( string $method, string|Url $url, array|Collection $headers = null, string|resource|array|EntityBodyInterface $body = null, array $options = array() )

    Create a new request based on the HTTP method

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

  • public applyOptions ( Guzzle\Http\Message\RequestInterface $request, array $options = array(), int $flags = Guzzle\Http\Message\RequestFactoryInterface::OPTIONS_NONE )

    Apply an associative array of options to the request

  • protected visit_headers ( Guzzle\Http\Message\RequestInterface $request, mixed $value, mixed $flags )
  • protected visit_body ( Guzzle\Http\Message\RequestInterface $request, mixed $value, mixed $flags )
  • protected visit_allow_redirects ( Guzzle\Http\Message\RequestInterface $request, mixed $value, mixed $flags )
  • protected visit_auth ( Guzzle\Http\Message\RequestInterface $request, mixed $value, mixed $flags )
  • protected visit_query ( Guzzle\Http\Message\RequestInterface $request, mixed $value, mixed $flags )
  • protected visit_cookies ( Guzzle\Http\Message\RequestInterface $request, mixed $value, mixed $flags )
  • protected visit_events ( Guzzle\Http\Message\RequestInterface $request, mixed $value, mixed $flags )
  • protected visit_plugins ( Guzzle\Http\Message\RequestInterface $request, mixed $value, mixed $flags )
  • protected visit_exceptions ( Guzzle\Http\Message\RequestInterface $request, mixed $value, mixed $flags )
  • protected visit_save_to ( Guzzle\Http\Message\RequestInterface $request, mixed $value, mixed $flags )
  • protected visit_params ( Guzzle\Http\Message\RequestInterface $request, mixed $value, mixed $flags )
  • protected visit_timeout ( Guzzle\Http\Message\RequestInterface $request, mixed $value, mixed $flags )
  • protected visit_connect_timeout ( Guzzle\Http\Message\RequestInterface $request, mixed $value, mixed $flags )
  • protected visit_debug ( Guzzle\Http\Message\RequestInterface $request, mixed $value, mixed $flags )
  • protected visit_verify ( Guzzle\Http\Message\RequestInterface $request, mixed $value, mixed $flags )
  • protected visit_proxy ( Guzzle\Http\Message\RequestInterface $request, mixed $value, mixed $flags )
  • protected visit_cert ( Guzzle\Http\Message\RequestInterface $request, mixed $value, mixed $flags )
  • protected visit_ssl_key ( Guzzle\Http\Message\RequestInterface $request, mixed $value, mixed $flags )

Methods detail

# public static Guzzle\Http\Message\RequestFactory
getInstance( )

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

Parameters

$message
string
$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()

Parameters

$method
string
$method HTTP method (GET, POST, PUT, HEAD, DELETE, etc)
$urlParts
array
$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
array|Guzzle\Common\Collection
$headers HTTP headers
$body
string|resource|array|EntityBodyInterface
$body Body to send in the request
$protocol
string
$protocol Protocol (HTTP, SPYDY, etc)
$protocolVersion
string
$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

Parameters

$method
string
$method HTTP method (GET, POST, PUT, PATCH, HEAD, DELETE, ...)
$url
string|Guzzle\Http\Url
$url HTTP URL to connect to
$headers
array|Guzzle\Common\Collection
$headers HTTP headers
$body
string|resource|array|EntityBodyInterface
$body Body to send in the request
$options
array
$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.

Parameters

$request
Guzzle\Http\Message\RequestInterface
$request Request to clone
$method
string
$method Method to set

Returns

Guzzle\Http\Message\RequestInterface
# public
applyOptions( Guzzle\Http\Message\RequestInterface $request, array $options = array(), integer $flags = Guzzle\Http\Message\RequestFactoryInterface::OPTIONS_NONE )

Apply an associative array of options to the request

Parameters

$request
Guzzle\Http\Message\RequestInterface
$request Request to update
$options
array
$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
integer
$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, mixed $value, mixed $flags )
# protected
visit_body( Guzzle\Http\Message\RequestInterface $request, mixed $value, mixed $flags )
# protected
visit_allow_redirects( Guzzle\Http\Message\RequestInterface $request, mixed $value, mixed $flags )
# protected
visit_auth( Guzzle\Http\Message\RequestInterface $request, mixed $value, mixed $flags )
# protected
visit_query( Guzzle\Http\Message\RequestInterface $request, mixed $value, mixed $flags )
# protected
visit_cookies( Guzzle\Http\Message\RequestInterface $request, mixed $value, mixed $flags )
# protected
visit_events( Guzzle\Http\Message\RequestInterface $request, mixed $value, mixed $flags )
# protected
visit_plugins( Guzzle\Http\Message\RequestInterface $request, mixed $value, mixed $flags )
# protected
visit_exceptions( Guzzle\Http\Message\RequestInterface $request, mixed $value, mixed $flags )
# protected
visit_save_to( Guzzle\Http\Message\RequestInterface $request, mixed $value, mixed $flags )
# protected
visit_params( Guzzle\Http\Message\RequestInterface $request, mixed $value, mixed $flags )
# protected
visit_timeout( Guzzle\Http\Message\RequestInterface $request, mixed $value, mixed $flags )
# protected
visit_connect_timeout( Guzzle\Http\Message\RequestInterface $request, mixed $value, mixed $flags )
# protected
visit_debug( Guzzle\Http\Message\RequestInterface $request, mixed $value, mixed $flags )
# protected
visit_verify( Guzzle\Http\Message\RequestInterface $request, mixed $value, mixed $flags )
# protected
visit_proxy( Guzzle\Http\Message\RequestInterface $request, mixed $value, mixed $flags )
# protected
visit_cert( Guzzle\Http\Message\RequestInterface $request, mixed $value, mixed $flags )
# protected
visit_ssl_key( Guzzle\Http\Message\RequestInterface $request, mixed $value, mixed $flags )

Magic methods summary

Constants summary

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
protected array $methods
#

Hash of methods available to the class (provides fast isset() lookups)
protected string $requestClass
#

Class to instantiate for requests with no body
protected string $entityEnclosingRequestClass
#

Class to instantiate for requests with a body
AWS SDK for PHP API documentation generated by ApiGen 2.8.0