Zend_Uri Class Reference

Public Member Functions
	__toString ()
	getScheme ()
	getUri ()
	valid ()

Static Public Member Functions
static	check ($uri)
static	factory ($uri='http', $className=null)
static	setConfig ($config)

Protected Member Functions
	__construct ($scheme, $schemeSpecific='')

Protected Attributes
	$_scheme = ''

Static Protected Attributes
static	$_config

Detailed Description

Definition at line 30 of file Uri.php.

Constructor & Destructor Documentation

__construct()

__construct (   $scheme,   $schemeSpecific = ''  )

abstractprotected

Zend_Uri and its subclasses cannot be instantiated directly. Use Zend_Uri::factory() to return a new Zend_Uri object.

Parameters

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

Member Function Documentation

__toString()

__toString

(

)

Return a string representation of this URI.

See also

getUri()

Returns

string

Definition at line 54 of file Uri.php.

    {
        try {
            return $this->getUri();
        } catch (Exception $e) {
            trigger_error($e->getMessage(), E_USER_WARNING);
            return '';
        }
    }

check()

static check (   $uri )

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

string

$uri

The URI to check

Returns

boolean

Definition at line 72 of file Uri.php.

    {
        try {
            $uri = self::factory($uri);
        } catch (Exception $e) {
            return false;
        }

        return $uri->valid();
    }

factory()

static factory (   $uri = 'http',   $className = null  )

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

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

Exceptions

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

Returns

Zend_Uri http://www.faqs.org/rfcs/rfc2396.html

Create a new Zend_Uri object for the $uri. If a subclass of Zend_Uri exists for the scheme, return an instance of that class. Otherwise, a Zend_Uri_Exception is thrown.

Definition at line 96 of file Uri.php.

    {
        // Separate the scheme from the scheme-specific parts
        $uri            = explode(':', $uri, 2);
        $scheme         = strtolower($uri[0]);
        $schemeSpecific = isset($uri[1]) === true ? $uri[1] : '';

        if (strlen($scheme) === 0) {
            #require_once 'Zend/Uri/Exception.php';
            throw new Zend_Uri_Exception('An empty string was supplied for the scheme');
        }

        // Security check: $scheme is used to load a class file, so only alphanumerics are allowed.
        if (ctype_alnum($scheme) === false) {
            #require_once 'Zend/Uri/Exception.php';
            throw new Zend_Uri_Exception('Illegal scheme supplied, only alphanumeric characters are permitted');
        }

        if ($className === null) {
            switch ($scheme) {
                case 'http':
                    // Break intentionally omitted
                case 'https':
                    $className = 'Zend_Uri_Http';
                    break;

                case 'mailto':
                    // TODO
                default:
                    #require_once 'Zend/Uri/Exception.php';
                    throw new Zend_Uri_Exception("Scheme \"$scheme\" is not supported");
                    break;
            }
        }

        #require_once 'Zend/Loader.php';
        try {
            Zend_Loader::loadClass($className);
        } catch (Exception $e) {
            #require_once 'Zend/Uri/Exception.php';
            throw new Zend_Uri_Exception("\"$className\" not found");
        }

        $schemeHandler = new $className($scheme, $schemeSpecific);

        if (! $schemeHandler instanceof Zend_Uri) {
            #require_once 'Zend/Uri/Exception.php';
            throw new Zend_Uri_Exception("\"$className\" is not an instance of Zend_Uri");
        }

        return $schemeHandler;
    }

getScheme()

getScheme

(

)

Get the URI's scheme

Returns

string|false Scheme or false if no scheme is set.

Definition at line 158 of file Uri.php.

    {
        if (empty($this->_scheme) === false) {
            return $this->_scheme;
        } else {
            return false;
        }
    }

getUri()

getUri ( )

abstract

Return a string representation of this URI.

Returns

string

setConfig()

static setConfig (   $config )

static

Set global configuration options

Parameters

Zend_Config | array

$config

Definition at line 172 of file Uri.php.

    {
        if ($config instanceof Zend_Config) {
            $config = $config->toArray();
        } elseif (!is_array($config)) {
            throw new Zend_Uri_Exception("Config must be an array or an instance of Zend_Config.");
        }

        foreach ($config as $k => $v) {
            self::$_config[$k] = $v;
        }
    }

valid()

valid ( )

abstract

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

Returns

boolean

Field Documentation

$_config

$_config

staticprotected

Initial value:

= array(
        'allow_unwise' => false
    )

Definition at line 44 of file Uri.php.

$_scheme

$_scheme = ''

protected

Definition at line 37 of file Uri.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/zendframework1/library/Zend/Uri.php