Uri.php

Show: PublicProtectedPrivateinherited
Table of Contents
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-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Uri  
Version
$Id: Uri.php 24593 2012-01-05 20:35:02Z matthew $  

\Zend_Uri

Package: Zend\Uri
Abstract class for all Zend_Uri handlers
Children
\Zend_Uri_Http
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

>VPropertyprotectedarray $_config = array('allow_unwise' => false)
static
Global configuration array
Default valuearray('allow_unwise' => false)Details
Type
array
>VPropertyprotectedstring $_scheme = ''
Scheme of this URI (http, ftp, etc.)
Default value''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
NameTypeDescription
$schemestring

The scheme of the URI

$schemeSpecificstring

The scheme-specific part of the URI

methodpublic__toString() : string

Return a string representation of this URI.

Returns
TypeDescription
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
NameTypeDescription
$uristring

The URI to check

Returns
TypeDescription
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
NameTypeDescription
$uristring

The URI form which a Zend_Uri instance is created

$classNamestring

The name of the class to use in order to manipulate URI

Returns
TypeDescription
\Zend_Uri
Throws
ExceptionDescription
\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
\Zend_Uri_ExceptionWhen $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
TypeDescription
string | falseScheme or false if no scheme is set.
methodpublicgetUri() : string
abstract

Return a string representation of this URI.

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

Set global configuration options

Parameters
NameTypeDescription
$config\Zend_Config | array
methodpublicvalid() : boolean
abstract

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

Returns
TypeDescription
boolean
Documentation was generated by phpDocumentor 2.0.0a12.