Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes

Zend_Uri Class Reference

Public Member Functions

 __toString ()
 getScheme ()
 getUri ()
 valid ()

Static Public Member Functions

static check ($uri)
static factory ($uri= 'http')
static setConfig (array $config)

Protected Member Functions

 __construct ($scheme, $schemeSpecific= '')

Protected Attributes

 $_scheme = ''

Static Protected Attributes

static $_config

Detailed Description

Definition at line 30 of file Uri.php.


Constructor & Destructor Documentation

__construct ( scheme,
schemeSpecific = '' 
) [abstract, protected]

Zend_Uri and its subclasses cannot be instantiated directly. Use Zend_Uri::factory() to return a new Zend_Uri object.

Parameters:
string$schemeThe scheme of the URI
string$schemeSpecificThe scheme-specific part of the URI

Member Function Documentation

__toString (  )

Return a string representation of this URI.

See also:
getUri()
Returns:
string

Definition at line 54 of file Uri.php.

static check ( uri ) [static]

Convenience function, checks that a $uri string is well-formed by validating it but not returning an object. Returns TRUE if $uri is a well-formed URI, or FALSE otherwise.

Parameters:
string$uriThe URI to check
Returns:
boolean

Definition at line 67 of file Uri.php.

static factory ( uri = 'http' ) [static]

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

Parameters:
string$uriThe URI form which a Zend_Uri instance is created
Exceptions:
Zend_Uri_ExceptionWhen an empty string was supplied for the scheme
Zend_Uri_ExceptionWhen an illegal scheme is supplied
Zend_Uri_ExceptionWhen the scheme is not supported
Returns:
Zend_Uri http://www.faqs.org/rfcs/rfc2396.html

Create a new Zend_Uri object for the $uri. If a subclass of Zend_Uri exists for the scheme, return an instance of that class. Otherwise, a Zend_Uri_Exception is thrown.

Definition at line 89 of file Uri.php.

getScheme (  )

Get the URI's scheme

Returns:
string|false Scheme or false if no scheme is set.

Definition at line 140 of file Uri.php.

getUri (  ) [abstract]

Return a string representation of this URI.

Returns:
string
static setConfig ( array $  config ) [static]

Set global configuration options

Parameters:
array$config

Definition at line 154 of file Uri.php.

valid (  ) [abstract]

Returns TRUE if this URI is valid, or FALSE otherwise.

Returns:
boolean

Field Documentation

$_config [static, protected]
Initial value:
 array(
        'allow_unwise' => false
    )

Definition at line 44 of file Uri.php.


The documentation for this class was generated from the following file: