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

  • AbstractEntityBodyDecorator
  • CachingEntityBody
  • Client
  • EntityBody
  • IoEmittingEntityBody
  • Mimetypes
  • QueryString
  • ReadLimitEntityBody
  • RedirectPlugin
  • StaticClient
  • Url

Interfaces

  • ClientInterface
  • EntityBodyInterface
NOTE: For Version 3 of the AWS SDK for PHP, please see the V3 User Guide and V3 API Reference.

Class Url

Parses and generates URLs based on URL parts. In favor of performance, URL parts are not validated.

Namespace: Guzzle\Http
Located at Guzzle/Http/Url.php

Methods summary

  • public static factory ( string $url )

    Factory method to create a new URL from a URL string

  • public static buildUrl ( array $parts )

    Build a URL from parse_url parts. The generated URL will be a relative URL if a scheme or host are not provided.

  • public __construct ( string $scheme, string $host, string $username = null, string $password = null, int $port = null, string $path = null, Guzzle\Http\QueryString $query = null, string $fragment = null )

    Create a new URL from URL parts

  • public __clone ( )

    Clone the URL

  • public __toString ( )

    Returns the URL as a URL string

  • public getParts ( )

    Get the parts of the URL as an array

  • public setHost ( string $host )

    Set the host of the request.

  • public getHost ( )

    Get the host part of the URL

  • public setScheme ( string $scheme )

    Set the scheme part of the URL (http, https, ftp, etc)

  • public getScheme ( )

    Get the scheme part of the URL

  • public setPort ( int $port )

    Set the port part of the URL

  • public getPort ( )

    Get the port part of the URl. Will return the default port for a given scheme if no port has been set.

  • public setPath ( array|string $path )

    Set the path part of the URL

  • public normalizePath ( )

    Normalize the URL so that double slashes and relative paths are removed

  • public addPath ( string $relativePath )

    Add a relative path to the currently set path.

  • public getPath ( )

    Get the path part of the URL

  • public getPathSegments ( )

    Get the path segments of the URL as an array

  • public setPassword ( string $password )

    Set the password part of the URL

  • public getPassword ( )

    Get the password part of the URL

  • public setUsername ( string $username )

    Set the username part of the URL

  • public getUsername ( )

    Get the username part of the URl

  • public getQuery ( )

    Get the query part of the URL as a QueryString object

  • public setQuery ( QueryString|string|array $query )

    Set the query part of the URL

  • public getFragment ( )

    Get the fragment part of the URL

  • public setFragment ( string $fragment )

    Set the fragment part of the URL

  • public isAbsolute ( )

    Check if this is an absolute URL

  • public combine ( string $url, bool $strictRfc3986 = false )

    Combine the URL with another URL. Follows the rules specific in RFC 3986 section 5.4.

Methods detail

# public static Guzzle\Http\Url
factory( string $url )

Factory method to create a new URL from a URL string

Parameters

$url
string
$url Full URL used to create a Url object

Returns

Guzzle\Http\Url

Throws

Guzzle\Common\Exception\InvalidArgumentException
# public static string
buildUrl( array $parts )

Build a URL from parse_url parts. The generated URL will be a relative URL if a scheme or host are not provided.

Parameters

$parts
array
$parts Array of parse_url parts

Returns

string
# public
__construct( string $scheme, string $host, string $username = null, string $password = null, integer $port = null, string $path = null, Guzzle\Http\QueryString $query = null, string $fragment = null )

Create a new URL from URL parts

Parameters

$scheme
string
$scheme Scheme of the URL
$host
string
$host Host of the URL
$username
string
$username Username of the URL
$password
string
$password Password of the URL
$port
integer
$port Port of the URL
$path
string
$path Path of the URL
$query
Guzzle\Http\QueryString|array|string
$query Query string of the URL
$fragment
string
$fragment Fragment of the URL
# public
__clone( )

Clone the URL

# public string
__toString( )

Returns the URL as a URL string

Returns

string
# public array
getParts( )

Get the parts of the URL as an array

Returns

array
# public Guzzle\Http\Url
setHost( string $host )

Set the host of the request.

Parameters

$host
string
$host Host to set (e.g. www.yahoo.com, yahoo.com)

Returns

Guzzle\Http\Url
# public string
getHost( )

Get the host part of the URL

Returns

string
# public Guzzle\Http\Url
setScheme( string $scheme )

Set the scheme part of the URL (http, https, ftp, etc)

Parameters

$scheme
string
$scheme Scheme to set

Returns

Guzzle\Http\Url
# public string
getScheme( )

Get the scheme part of the URL

Returns

string
# public Guzzle\Http\Url
setPort( integer $port )

Set the port part of the URL

Parameters

$port
integer
$port Port to set

Returns

Guzzle\Http\Url
# public integer|null
getPort( )

Get the port part of the URl. Will return the default port for a given scheme if no port has been set.

Returns

integer|null
# public Guzzle\Http\Url
setPath( array|string $path )

Set the path part of the URL

Parameters

$path
array|string
$path Path string or array of path segments

Returns

Guzzle\Http\Url
# public Guzzle\Http\Url
normalizePath( )

Normalize the URL so that double slashes and relative paths are removed

Returns

Guzzle\Http\Url
# public Guzzle\Http\Url
addPath( string $relativePath )

Add a relative path to the currently set path.

Parameters

$relativePath
string
$relativePath Relative path to add

Returns

Guzzle\Http\Url
# public string
getPath( )

Get the path part of the URL

Returns

string
# public array
getPathSegments( )

Get the path segments of the URL as an array

Returns

array
# public Guzzle\Http\Url
setPassword( string $password )

Set the password part of the URL

Parameters

$password
string
$password Password to set

Returns

Guzzle\Http\Url
# public null|string
getPassword( )

Get the password part of the URL

Returns

null|string
# public Guzzle\Http\Url
setUsername( string $username )

Set the username part of the URL

Parameters

$username
string
$username Username to set

Returns

Guzzle\Http\Url
# public null|string
getUsername( )

Get the username part of the URl

Returns

null|string
# public Guzzle\Http\QueryString
getQuery( )

Get the query part of the URL as a QueryString object

Returns

Guzzle\Http\QueryString
# public Guzzle\Http\Url
setQuery( Guzzle\Http\QueryString|string|array $query )

Set the query part of the URL

Parameters

$query
Guzzle\Http\QueryString|string|array
$query Query to set

Returns

Guzzle\Http\Url
# public null|string
getFragment( )

Get the fragment part of the URL

Returns

null|string
# public Guzzle\Http\Url
setFragment( string $fragment )

Set the fragment part of the URL

Parameters

$fragment
string
$fragment Fragment to set

Returns

Guzzle\Http\Url
# public boolean
isAbsolute( )

Check if this is an absolute URL

Returns

boolean
# public Guzzle\Http\Url
combine( string $url, boolean $strictRfc3986 = false )

Combine the URL with another URL. Follows the rules specific in RFC 3986 section 5.4.

Parameters

$url
string
$url Relative URL to combine with
$strictRfc3986
boolean
$strictRfc3986 Set to true to use strict RFC 3986 compliance when merging paths. When first released, Guzzle used an incorrect algorithm for combining relative URL paths. In order to not break users, we introduced this flag to allow the merging of URLs based on strict RFC 3986 section 5.4.1. This means that "http://a.com/foo/baz" merged with "bar" would become "http://a.com/foo/bar". When this value is set to false, it would become "http://a.com/foo/baz/bar".

Returns

Guzzle\Http\Url

Throws

Guzzle\Common\Exception\InvalidArgumentException

Link

http://tools.ietf.org/html/rfc3986#section-5.4

Magic methods summary

Properties summary

protected mixed $scheme
#
protected mixed $host
#
protected mixed $port
#
protected mixed $username
#
protected mixed $password
#
protected string $path
#
protected mixed $fragment
#
protected Guzzle\Http\QueryString $query
#

Query part of the URL
AWS SDK for PHP API documentation generated by ApiGen 2.8.0