Docs For Class Zend

Description

Abstract class for all Zend_Uri handlers

copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
abstract:
usedby: Zend_Uri_Http
license: New BSD License

Located in /Uri.php (line 30)

Direct descendents

Class	Description
Zend_Uri_Http	HTTP(S) URI handler

Variable Summary

static array $_config

string $_scheme

Method Summary

static boolean check (string $uri)

static Zend_Uri factory ([string $uri = 'http'], [string $className = null])

static void setConfig (Zend_Config|array $config)

Zend_Uri __construct (string $scheme, [string $schemeSpecific = ''])

string|false getScheme ()

string getUri ()

boolean valid ()

string __toString ()

Variables

static array $_config = array(
'allow_unwise' => false
) (line 44)

Global configuration array

access: protected

string $_scheme = '' (line 37)

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

access: protected

Methods

static check (line 67)

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.

access: public

static boolean check (string $uri)

string $uri: The URI to check

static factory (line 91)

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.

link: http://www.faqs.org/rfcs/rfc2396.html
throws: Zend_Uri_Exception When $className doesn't exist or doesn't implements Zend_Uri
throws: Zend_Uri_Exception When an empty string was supplied for the scheme
throws: Zend_Uri_Exception When an illegal scheme is supplied
throws: Zend_Uri_Exception When the scheme is not supported
access: public

static Zend_Uri factory ([string $uri = 'http'], [string $className = null])

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

static setConfig (line 167)

Set global configuration options

access: public

static void setConfig (Zend_Config|array $config)

Zend_Config|array $config

Constructor __construct (line 187)

Zend_Uri and its subclasses cannot be instantiated directly.

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

abstract:
access: protected

Zend_Uri __construct (string $scheme, [string $schemeSpecific = ''])

string $scheme: The scheme of the URI
string $schemeSpecific: The scheme-specific part of the URI

Redefined in descendants as:

Zend_Uri_Http::__construct() : 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)

getScheme (line 153)

Get the URI's scheme

return: Scheme or false if no scheme is set.
access: public

string|false getScheme ()

getUri (line 194)

Return a string representation of this URI.

abstract:
access: public

string getUri ()

Redefined in descendants as:

Zend_Uri_Http::getUri() : 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.

valid (line 201)

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

abstract:
access: public

boolean valid ()

Redefined in descendants as:

Zend_Uri_Http::valid() : Validate the current URI from the instance variables. Returns true if and only if all parts pass validation.

__toString (line 54)

Return a string representation of this URI.

see: Zend_Uri::getUri()
access: public

string __toString ()