Uri/Http.php

+ Show: +

inherited

+ Classes +
- \Zend_Uri_Http

+ Table of Contents +

Zend Framework

LICENSE

+ +

This source file is subject to the new BSD license that is bundled +with this package in the file LICENSE.txt. +It is also available through the world-wide-web at this URL: +http://framework.zend.com/license/new-bsd +If you did not receive a copy of the license and are unable to +obtain it through the world-wide-web, please send an email +to license@zend.com so we can send you a copy immediately.

Category: Zend + +
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com) + +
License: New BSD License + +
Package: Zend_Uri + +
Version: $Id: Http.php 24593 2012-01-05 20:35:02Z matthew $ + +

\Zend_Uri_Http
jump to top

Package: Zend\Uri

HTTP(S) URI handler

Parent(s): \Zend_Uri
Category: Zend + +
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com) + +
License: New BSD License + +
Uses: \global\Zend_Uri + +

Constants

 
+                CHAR_ALNUM
+                = 'A-Za-z0-9'

Character classes for validation regular expressions

 
+                CHAR_MARK
+                = '-_.!~*\'()\[\]'

 
+                CHAR_RESERVED
+                = ';\/?:@&=+$,'

 
+                CHAR_SEGMENT
+                = ':@&=+$,;'

 
+                CHAR_UNWISE
+                = '{}|\\\\^`'

Properties

array $_config = array('allow_unwise' => false)

staticinherited

Global configuration array

Inherited from: + \Zend_Uri::$$_config

Default valuearray('allow_unwise' => false)Details

Type: array
Inherited_from: \Zend_Uri::$$_config + +

string $_fragment = ''

HTTP fragment

Default value''Details

Type: string

string $_host = ''

HTTP host

Default value''Details

Type: string

string $_password = ''

HTTP password

Default value''Details

Type: string

string $_path = ''

HTTP part

Default value''Details

Type: string

string $_port = ''

HTTP post

Default value''Details

Type: string

string $_query = ''

HTTP query

Default value''Details

Type: string

array $_regex = array()

Regular expression grammar rules for validation; values added by constructor

Default valuearray()Details

Type: array

string $_scheme = ''

inherited

Scheme of this URI (http, ftp, etc.)

Inherited from: + \Zend_Uri::$$_scheme

Default value''Details

Type: string
Inherited_from: \Zend_Uri::$$_scheme + +

string $_username = ''

HTTP username

Default value''Details

Type: string

Methods

__construct(string $scheme, string $schemeSpecific = '') : void

Constructor accepts a string $scheme (e.g., http, https) and a scheme-specific part of the URI +(e.g., example.com/path/to/resource?query=param#fragment)

Use Zend_Uri::factory() to return a new Zend_Uri object.

Parameters

Name	Type	Description
$scheme	string	The scheme of the URI
$schemeSpecific	string	The scheme-specific part of the URI +

Throws

Exception	Description
\Zend_Uri_Exception	When the URI is not valid

__toString() : string

inherited

Return a string representation of this URI.

Inherited from: + \Zend_Uri::__toString()

Returns

Type	Description
string

Details

See: \getUri() + +

_parseUri(string $schemeSpecific) : void

Parse the scheme-specific portion of the URI and place its parts into instance variables.

Parameters

Name	Type	Description
$schemeSpecific	string	The scheme-specific portion to parse +

Throws

Exception	Description
\Zend_Uri_Exception	When scheme-specific decoposition fails
\Zend_Uri_Exception	When authority decomposition fails

addReplaceQueryParameters(array $queryParams) : string

Add or replace params in the query string for the current URI, and +return the old query.

Parameters

Name	Type	Description
$queryParams	array

Returns

Type	Description
string	Old query string

check(string $uri) : boolean

staticinherited

Convenience function, checks that a $uri string is well-formed +by validating it but not returning an object.

Inherited from: + \Zend_Uri::check()

Returns TRUE if +$uri is a well-formed URI, or FALSE otherwise.

Parameters

Name	Type	Description
$uri	string	The URI to check

Returns

Type	Description
boolean

factory(string $uri = 'http', string $className = null) : \Zend_Uri

staticinherited

Create a new Zend_Uri object for a URI.

Inherited from: + \Zend_Uri::factory()

If building a new URI, then $uri should contain +only the scheme (http, ftp, etc). Otherwise, supply $uri with the complete URI.

Parameters

Name	Type	Description
$uri	string	The URI form which a Zend_Uri instance is created
$className	string	The name of the class to use in order to manipulate URI

Returns

Type	Description
\Zend_Uri

Throws

Exception	Description
\Zend_Uri_Exception	When an empty string was supplied for the scheme
\Zend_Uri_Exception	When an illegal scheme is supplied
\Zend_Uri_Exception	When the scheme is not supported
\Zend_Uri_Exception	When $className doesn't exist or doesn't implements Zend_Uri

Details

Link: http://www.faqs.org/rfcs/rfc2396.html + +

fromString(string $uri) : \Zend_Uri_Http

static

Creates a Zend_Uri_Http from the given string

Parameters

Name	Type	Description
$uri	string	String to create URI from, must start with + 'http://' or 'https://' +

Returns

Type	Description
\Zend_Uri_Http

Throws

Exception	Description
\InvalidArgumentException	When the given $uri is not a string or + does not start with http:// or https://
\Zend_Uri_Exception	When the given $uri is invalid

getFragment() : string | false

Returns the fragment portion of the URL (after #), or FALSE if none.

Returns

Type	Description
string \| false

getHost() : string

Returns the domain or host IP portion of the URL, or FALSE if none.

Returns

Type	Description
string

getPassword() : string

Returns the password portion of the URL, or FALSE if none.

Returns

Type	Description
string

getPath() : string

Returns the path and filename portion of the URL.

Returns

Type	Description
string

getPort() : string

Returns the TCP port, or FALSE if none.

Returns

Type	Description
string

getQuery() : string

Returns the query portion of the URL (after ?), or FALSE if none.

Returns

Type	Description
string

getQueryAsArray() : array

Returns the query portion of the URL (after ?) as a +key-value-array.

If the query is empty an empty array +is returned

Returns

Type	Description
array

getScheme() : string | false

inherited

Get the URI's scheme

Inherited from: + \Zend_Uri::getScheme()

Returns

Type	Description
string \| false	Scheme or false if no scheme is set.

getUri() : string

Returns a URI based on current values of the instance variables.

If any +part of the URI does not pass validation, then an exception is thrown.

Returns

Type	Description
string

Throws

Exception	Description
\Zend_Uri_Exception	When one or more parts of the URI are invalid

getUsername() : string

Returns the username portion of the URL, or FALSE if none.

Returns

Type	Description
string

removeQueryParameters(array $queryParamKeys) : string

Remove params in the query string for the current URI, and +return the old query.

Parameters

Name	Type	Description
$queryParamKeys	array

Returns

Type	Description
string	Old query string

setConfig(\Zend_Config | array $config) : void

staticinherited

Set global configuration options

Inherited from: + \Zend_Uri::setConfig()

Parameters

Name	Type	Description
$config	\Zend_Config \| array

setFragment(string $fragment) : string

Sets the fragment for the current URI, and returns the old fragment

Parameters

Name	Type	Description
$fragment	string	Fragment of the current URI

Returns

Type	Description
string

Throws

Exception	Description
\Zend_Uri_Exception	When $fragment is not a valid HTTP fragment

setHost(string $host) : string

Sets the host for the current URI, and returns the old host

Parameters

Name	Type	Description
$host	string	The HTTP host

Returns

Type	Description
string

Throws

Exception	Description
\Zend_Uri_Exception	When $host is nota valid HTTP host

setPassword(string $password) : string

Sets the password for the current URI, and returns the old password

Parameters

Name	Type	Description
$password	string	The HTTP password

Returns

Type	Description
string

Throws

Exception	Description
\Zend_Uri_Exception	When $password is not a valid HTTP password

setPath(string $path) : string

Sets the path for the current URI, and returns the old path

Parameters

Name	Type	Description
$path	string	The HTTP path

Returns

Type	Description
string

Throws

Exception	Description
\Zend_Uri_Exception	When $path is not a valid HTTP path

setPort(string $port) : string

Sets the port for the current URI, and returns the old port

Parameters

Name	Type	Description
$port	string	The HTTP port

Returns

Type	Description
string

Throws

Exception	Description
\Zend_Uri_Exception	When $port is not a valid HTTP port

setQuery(string | array $query) : string

Set the query string for the current URI, and return the old query +string This method accepts both strings and arrays.

Parameters

Name	Type	Description
$query	string \| array	The query string or array

Returns

Type	Description
string	Old query string

Throws

Exception	Description
\Zend_Uri_Exception	When $query is not a valid query string

setUsername(string $username) : string

Sets the username for the current URI, and returns the old username

Parameters

Name	Type	Description
$username	string	The HTTP username

Returns

Type	Description
string

Throws

Exception	Description
\Zend_Uri_Exception	When $username is not a valid HTTP username

valid() : boolean

Validate the current URI from the instance variables.

Returns true if and only if all +parts pass validation.

Returns

Type	Description
boolean

validateFragment(string $fragment = null) : boolean

Returns true if and only if the fragment passes validation.

If no fragment is passed, +then the fragment contained in the instance variable is used.

Parameters

Name	Type	Description
$fragment	string	Fragment of an URI

Returns

Type	Description
boolean

Throws

Exception	Description
\Zend_Uri_Exception	When fragment validation fails

Details

Link: http://www.faqs.org/rfcs/rfc2396.html + +

validateHost(string $host = null) : boolean

Returns true if and only if the host string passes validation.

If no host is passed, +then the host contained in the instance variable is used.

Parameters

Name	Type	Description
$host	string	The HTTP host

Returns

Type	Description
boolean

Details

Uses: \Zend_Filter + +

validatePassword(string $password = null) : boolean

Returns true if and only if the password passes validation.

If no password is passed, +then the password contained in the instance variable is used.

Parameters

Name	Type	Description
$password	string	The HTTP password

Returns

Type	Description
boolean

Throws

Exception	Description
\Zend_Uri_Exception	When password validation fails

Details

Link: http://www.faqs.org/rfcs/rfc2396.html + +

validatePath(string $path = null) : boolean

Returns true if and only if the path string passes validation.

If no path is passed, +then the path contained in the instance variable is used.

Parameters

Name	Type	Description
$path	string	The HTTP path

Returns

Type	Description
boolean

Throws

Exception	Description
\Zend_Uri_Exception	When path validation fails

validatePort(string $port = null) : boolean

Returns true if and only if the TCP port string passes validation.

If no port is passed, +then the port contained in the instance variable is used.

Parameters

Name	Type	Description
$port	string	The HTTP port

Returns

Type	Description
boolean

validateQuery(string $query = null) : boolean

Returns true if and only if the query string passes validation.

If no query is passed, +then the query string contained in the instance variable is used.

Parameters

Name	Type	Description
$query	string	The query to validate

Returns

Type	Description
boolean

Throws

Exception	Description
\Zend_Uri_Exception	When query validation fails

Details

Link: http://www.faqs.org/rfcs/rfc2396.html + +

validateUsername(string $username = null) : boolean

Returns true if and only if the username passes validation.

If no username is passed, +then the username contained in the instance variable is used.

Parameters

Name	Type	Description
$username	string	The HTTP username

Returns

Type	Description
boolean

Throws

Exception	Description
\Zend_Uri_Exception	When username validation fails

Details

Link: http://www.faqs.org/rfcs/rfc2396.html + +

Uri/Http.php

\Zend_Uri_Httpjump to top

Constants

Properties

Methods

\Zend_Uri_Http
jump to top