API Documentation

Uri.php

Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Uri
version
$Id: Uri.php 22539 2010-07-08 12:47:44Z shahar $
Classes
Zend_Uri

Description

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.

Zend_Uri
jump to top

category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Uri
Properties
$_scheme
$_config
Methods
__toString
check
factory
getScheme
setConfig
__construct
getUri
valid

Description

Abstract class for all Zend_Uri handlers

Properties

$_config
jump to class

array $_config = 'array'

Global configuration array

Details

$_config
array
visibility
protected
default
array
final
false
static
true

$_scheme
jump to class

string $_scheme = ''

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

Details

$_scheme
string
visibility
protected
default
final
false
static
false

Methods

__construct
jump to class

__construct( string $scheme, string $schemeSpecific ) :

Zend_Uri and its subclasses cannot be instantiated directly.

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

Arguments
$scheme
string
The scheme of the URI
$schemeSpecific
string
The scheme-specific part of the URI
Details
visibility
protected
final
false
static
false

__toString
jump to class

__toString( ) : string

Return a string representation of this URI.

Output
string
Details
visibility
public
final
false
static
false
see
getUri()

check
jump to class

check( string $uri ) : boolean

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.

Arguments
$uri
string
The URI to check
Output
boolean
Details
visibility
public
final
false
static
true

factory
jump to class

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

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.

Arguments
$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
Output
Zend_Uri
Details
visibility
public
final
false
static
true
link
http://www.faqs.org/rfcs/rfc2396.html
throws
When an empty string was supplied for the scheme
throws
When an illegal scheme is supplied
throws
When the scheme is not supported
throws
When $className doesn't exist or doesn't implements Zend_Uri

getScheme
jump to class

getScheme( ) : string|false

Get the URI's scheme

Output
string|false
Scheme or false if no scheme is set.
Details
visibility
public
final
false
static
false

getUri
jump to class

getUri( ) : string

Return a string representation of this URI.

Output
string
Details
visibility
public
final
false
static
false

setConfig
jump to class

setConfig( Zend_Config|array $config ) :

Set global configuration options

Arguments
$config
Zend_Configarray
Details
visibility
public
final
false
static
true

valid
jump to class

valid( ) : boolean

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

Output
boolean
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.