Microsoft_Uri
[ class tree: Microsoft_Uri ] [ index: Microsoft_Uri ] [ all elements ]

Class: Microsoft_Uri

Source Location: /Uri.php

Class Overview


Abstract class for all Microsoft_Uri handlers


Author(s):

Copyright:

  • Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)

Variables

Methods


Child classes:

Microsoft_Uri_Http
HTTP(S) URI handler

Class Details

[line 35]
Abstract class for all Microsoft_Uri handlers



Tags:

copyright:  Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
abstract:  
usedby:  Microsoft_Uri_Http
license:  New BSD License


[ Top ]


Class Variables

static $_config = array(
        'allow_unwise' => false
    )

[line 49]

Global configuration array



Tags:

access:  protected

Type:   array


[ Top ]

$_scheme =  ''

[line 42]

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



Tags:

access:  protected

Type:   string


[ Top ]



Class Methods


static method check [line 72]

static boolean check( string $uri)

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.



Tags:

access:  public


Parameters:

string   $uri   The URI to check

[ Top ]

static method factory [line 94]

static Microsoft_Uri factory( [string $uri = 'http'])

Create a new Microsoft_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.



Tags:

link:  http://www.faqs.org/rfcs/rfc2396.html
throws:  Microsoft_Uri_Exception When an empty string was supplied for the scheme
throws:  Microsoft_Uri_Exception When the scheme is not supported
throws:  Microsoft_Uri_Exception When an illegal scheme is supplied
access:  public


Parameters:

string   $uri   The URI form which a Microsoft_Uri instance is created

[ Top ]

static method setConfig [line 158]

static void setConfig( Microsoft_Config|array $config)

Set global configuration options



Tags:

access:  public


Parameters:

Microsoft_Config|array   $config  

[ Top ]

constructor __construct [line 178]

Microsoft_Uri __construct( string $scheme, [string $schemeSpecific = ''])

Microsoft_Uri and its subclasses cannot be instantiated directly.

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




Tags:

abstract:  
access:  protected


Overridden in child classes as:

Microsoft_Uri_Http::__construct()
Constructor accepts a string $scheme (e.g., http, https) and a scheme-specific part of the URI (e.g., example.com/path/to/resource?query=param#fragment)

Parameters:

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

[ Top ]

method getScheme [line 144]

string|false getScheme( )

Get the URI's scheme



Tags:

return:  Scheme or false if no scheme is set.
access:  public


[ Top ]

method getUri [line 185]

string getUri( )

Return a string representation of this URI.



Tags:

abstract:  
access:  public


Overridden in child classes as:

Microsoft_Uri_Http::getUri()
Returns a URI based on current values of the instance variables. If any part of the URI does not pass validation, then an exception is thrown.

[ Top ]

method valid [line 192]

boolean valid( )

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



Tags:

abstract:  
access:  public


Overridden in child classes as:

Microsoft_Uri_Http::valid()
Validate the current URI from the instance variables. Returns true if and only if all parts pass validation.

[ Top ]

method __toString [line 59]

string __toString( )

Return a string representation of this URI.



Tags:

see:  Microsoft_Uri::getUri()
access:  public


[ Top ]


Documentation generated on Wed, 18 May 2011 12:07:01 +0200 by phpDocumentor 1.4.3