API Documentation

Uri.php

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-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Uri  
version
$Id: Uri.php 23775 2011-03-01 17:25:24Z ralph $  

\Zend_Uri

Abstract class for all Zend_Uri handlers

category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Uri  

Properties

Propertyprotectedarray  $_config= 'array'
static

Global configuration array

Default valuearrayDetails
Type
array
Propertyprotectedstring  $_scheme= ''

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

Details
Type
string

Methods

methodprotected__construct( string $scheme, string $schemeSpecific ) : void
abstract

Zend_Uri and its subclasses cannot be instantiated directly.

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

methodpublic__toString( ) : string

Return a string representation of this URI.

Returns
Type Description
string
Details
see
\getUri()  
methodpubliccheck( string $uri ) : boolean
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
Name Type Description
$uri string The URI to check
Returns
Type Description
boolean
methodpublicfactory( string $uri = http, string $className = null ) : \Zend_Uri
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
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  
methodpublicgetScheme( ) : string|false

Get the URI's scheme

Returns
Type Description
stringfalse Scheme or false if no scheme is set.
methodpublicgetUri( ) : string
abstract

Return a string representation of this URI.

Returns
Type Description
string
methodpublicsetConfig( \Zend_Config|array $config ) : void
static

Set global configuration options

Parameters
Name Type Description
$config \Zend_Config|array
methodpublicvalid( ) : boolean
abstract

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

Returns
Type Description
boolean
Documentation was generated by DocBlox 0.13.3.