Class Zend_Uri_Http

Description

Located in /Zend/Uri/Http.php (line 37)

Zend_Uri
   |
   --Zend_Uri_Http
Variable Summary
 mixed $_fragment
 mixed $_host
 mixed $_password
 mixed $_path
 mixed $_port
 mixed $_query
 mixed $_regex
 mixed $_username
Method Summary
 void __construct (string $scheme, [string $schemeSpecific = ''])
 unknown getFragment ()
 string getHost ()
 string getPassword ()
 string getPath ()
 string getPort ()
 string getQuery ()
 string getUri ()
 string getUsername ()
 string setFragment (string $fragment)
 string setHost (string $host)
 string setPassword (string $password)
 string setPath (string $path)
 string setPort (string $port)
 string setQueryArray ([array $array = array()])
 string setQueryString (string $query)
 string setUsername (string $username)
 boolean valid ()
 boolean validateFragment ([string $fragment = null])
 boolean validateHost ([string $host = null])
 boolean validatePassword ([string $password = null])
 boolean validatePath ([string $path = null])
 boolean validatePort ([string $port = null])
 boolean validateQuery ([string $query = null])
 boolean validateUsername ([string $username = null])
 void _parseUri (string $schemeSpecific)
 void _queryArrayRecurse ([array $array = array()], [string $key = null], [array &$queryVars = array()])
Variables
mixed $_fragment = '' (line 50)
  • access: protected
mixed $_host = '' (line 46)
  • access: protected
mixed $_password = '' (line 45)
  • access: protected
mixed $_path = '' (line 48)
  • access: protected
mixed $_port = '' (line 47)
  • access: protected
mixed $_query = '' (line 49)
  • access: protected
mixed $_regex = array() (line 56)

Regular expression grammar rules for validation; values added by constructor

  • access: protected
mixed $_username = '' (line 44)

URI parts are divided among these instance variables

  • access: protected

Inherited Variables

Inherited from Zend_Uri

Zend_Uri::$_scheme
Methods
Constructor __construct (line 68)

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)

  • access: protected
  • throws: Zend_Uri_Exception
void __construct (string $scheme, [string $schemeSpecific = ''])
  • string $scheme
  • string $schemeSpecific

Redefinition of:
Zend_Uri::__construct()
Zend_Uri and its subclasses cannot be instantiated directly.
getFragment (line 633)

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

  • access: public
unknown getFragment ()
getHost (line 340)

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

  • access: public
string getHost ()
getPassword (line 272)

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

  • access: public
string getPassword ()
getPath (line 454)

Returns the path and filename portion of the URL, or FALSE if none.

  • access: public
string getPath ()
getPort (line 399)

Returns the TCP port, or FALSE if none.

  • access: public
string getPort ()
getQuery (line 513)

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

  • access: public
string getQuery ()
getUri (line 170)

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.

  • access: public
  • throws: Zend_Uri_Exception
string getUri ()

Redefinition of:
Zend_Uri::getUri()
Return a string representation of this URI.
getUsername (line 210)

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

  • access: public
string getUsername ()
setFragment (line 678)

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

  • access: public
  • throws: Zend_Uri_Exception
string setFragment (string $fragment)
  • string $fragment
setHost (line 383)

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

  • access: public
  • throws: Zend_Uri_Exception
string setHost (string $host)
  • string $host
setPassword (line 324)

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

  • access: public
  • throws: Zend_Uri_Exception
string setPassword (string $password)
  • string $password
setPath (line 498)

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

  • access: public
  • throws: Zend_Uri_Exception
string setPath (string $path)
  • string $path
setPort (line 438)

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

  • access: public
  • throws: Zend_Uri_Exception
string setPort (string $port)
  • string $port
setQueryArray (line 558)

Sets given associative array to query string for the current URI, and returns the old query string

  • access: public
  • throws: Zend_Uri_Exception
string setQueryArray ([array $array = array()])
  • array $array
setQueryString (line 617)

Sets the query string for the current URI, and returns the old query string

  • access: public
  • throws: Zend_Uri_Exception
string setQueryString (string $query)
  • string $query
setUsername (line 256)

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

  • access: public
  • throws: Zend_Uri_Exception
string setUsername (string $username)
  • string $username
valid (line 190)

Validate the current URI from the instance variables. Returns true if and only if all parts pass validation.

  • access: public
boolean valid ()

Redefinition of:
Zend_Uri::valid()
Returns TRUE if this URI is valid, or FALSE otherwise.
validateFragment (line 646)

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.

  • access: public
  • throws: Zend_Uri_Exception
boolean validateFragment ([string $fragment = null])
  • string $fragment
validateHost (line 354)

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.

boolean validateHost ([string $host = null])
  • string $host
validatePassword (line 286)

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.

  • access: public
  • throws: Zend_Uri_Exception
boolean validatePassword ([string $password = null])
  • string $password
validatePath (line 468)

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.

  • access: public
  • throws: Zend_Uri_Exception
boolean validatePath ([string $path = null])
  • string $path
validatePort (line 412)

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.

  • access: public
boolean validatePort ([string $port = null])
  • string $port
validateQuery (line 527)

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.

  • access: public
  • throws: Zend_Uri_Exception
boolean validateQuery ([string $query = null])
  • string $query
validateUsername (line 224)

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.

  • access: public
  • throws: Zend_Uri_Exception
boolean validateUsername ([string $username = null])
  • string $username
_parseUri (line 121)

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

  • access: protected
  • throws: Zend_Uri_Exception
void _parseUri (string $schemeSpecific)
  • string $schemeSpecific
_queryArrayRecurse (line 583)

Used by queryArray(). Goes through array recursively and compiles array content

  • access: private
  • throws: Zend_Uri_Exception
void _queryArrayRecurse ([array $array = array()], [string $key = null], [array &$queryVars = array()])
  • array $array
  • string $key
  • array $queryVars

Inherited Methods

Inherited From Zend_Uri

 Zend_Uri::__construct()
 Zend_Uri::check()
 Zend_Uri::factory()
 Zend_Uri::getScheme()
 Zend_Uri::getUri()
 Zend_Uri::valid()
 Zend_Uri::__toString()

Documentation generated on Tue, 18 Apr 2006 11:55:09 -0700 by phpDocumentor 1.3.0RC3