Zend/Uri.php
Classes
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
Default value
Default value
Parameters
Returns
Details
Parameters
Returns
Parameters
Returns
Throws
Details
Returns
Returns
Parameters
Returns
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
- Used_by
- \Zend_Uri_Http
Properties
array
$_config= 'array(
'allow_unwise' => false
)'
static
Global configuration array
array(
'allow_unwise' => false
)Details- Type
- array
string
$_scheme= ''''
Scheme of this URI (http, ftp, etc.)
''Details- Type
- string
Methods
__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.
| Name | Type | Description |
|---|---|---|
| $scheme | string | The scheme of the URI |
| $schemeSpecific | string | The scheme-specific part of the URI |
__toString(
)
:
stringReturn a string representation of this URI.
| Type | Description |
|---|---|
| string |
- See
- \getUri()
check(
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.
| Name | Type | Description |
|---|---|---|
| $uri | string | The URI to check |
| Type | Description |
|---|---|
| boolean |
factory(
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.
| 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 |
| Type | Description |
|---|---|
| \Zend_Uri |
| 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 |
getScheme(
)
:
string|falseGet the URI's scheme
| Type | Description |
|---|---|
| string|false | Scheme or false if no scheme is set. |
getUri(
)
:
string
abstract
Return a string representation of this URI.
| Type | Description |
|---|---|
| string |
setConfig(
\Zend_Config|array $config
)
:
void
static
Set global configuration options
| Name | Type | Description |
|---|---|---|
| $config | \Zend_Config|array |
valid(
)
:
boolean
abstract
Returns TRUE if this URI is valid, or FALSE otherwise.
| Type | Description |
|---|---|
| boolean |