GenericUri Class Reference
[Internet standarts implementations]

See also:
http://tools.ietf.org/html/rfc3986
More...

Inheritance diagram for GenericUri:

Inheritance graph
[legend]

List of all members.

Public Member Functions

 parse ($uri, $guessClass=false)
 
Returns:
GenericUri

 transform (GenericUri $reference, $strict=true)
 
See also:
http://tools.ietf.org/html/rfc3986#section-5.2.2

 getKnownSubSchemes ()
 setScheme ($scheme)
 
Returns:
GenericUri

 getScheme ()
 setUserInfo ($userInfo)
 
Returns:
GenericUri

 getUserInfo ()
 setHost ($host)
 
Returns:
GenericUri

 getHost ()
 setPort ($port)
 
Returns:
GenericUri

 getPort ()
 setPath ($path)
 
Returns:
GenericUri

 getPath ()
 setQuery ($query)
 
Returns:
GenericUri

 appendQuery ($string, $separator= '&')
 
Returns:
GenericUri

 getQuery ()
 setFragment ($fragment)
 
Returns:
GenericUri

 getFragment ()
 setAuthority ($authority)
 
Returns:
GenericUri

 getAuthority ()
 setSchemeSpecificPart ($schemeSpecificPart)
 getSchemeSpecificPart ()
 toString ()
 toStringFromRoot ()
 isValid ()
 isValidScheme ()
 isValidUserInfo ()
 isValidHost ()
 isValidPort ()
 isValidPath ()
 isValidQuery ()
 isValidFragment ()
 isAbsolute ()
 isRelative ()
 normalize ()
 
See also:
http://tools.ietf.org/html/rfc3986#section-6


Static Public Member Functions

static create ()
 
Returns:
GenericUri


Public Attributes

const CHARS_UNRESERVED = 'a-z0-9-._~'
const CHARS_SUBDELIMS = '!$&\'()*+,;='
const PATTERN_PCTENCODED = '%[0-9a-f][0-9a-f]'

Protected Member Functions

 isValidHostName ()
 charPattern ($extraChars=null, $pctEncodedPattern=true)
 userInfoCharPattern ($pctEncoded=true)
 hostNameCharPattern ($pctEncoded=true)
 segmentCharPattern ($pctEncoded=true)
 fragmentOrQueryCharPattern ($pctEncoded=true)

Protected Attributes

 $scheme = null
 $userInfo = null
 $host = null
 $port = null
 $path = null
 $query = null
 $fragment = null

Private Member Functions

 isValidFragmentOrQuery ($string)
 mergePath ($path)
 normalizePercentEncoded ($string, $unreservedPartChars)

Static Private Member Functions

static removeDotSegments ($path)


Detailed Description

See also:
http://tools.ietf.org/html/rfc3986

Todo:
comparsion

Definition at line 18 of file GenericUri.class.php.


Member Function Documentation

static GenericUri::create (  )  [static]

Returns:
GenericUri

Reimplemented in HttpUrl, Url, and Urn.

Definition at line 37 of file GenericUri.class.php.

Referenced by TextUtils::normalizeUri().

GenericUri::parse ( uri,
guessClass = false 
) [final]

Returns:
GenericUri

Definition at line 45 of file GenericUri.class.php.

References getKnownSubSchemes().

Referenced by setSchemeSpecificPart().

Here is the call graph for this function:

GenericUri::transform ( GenericUri reference,
strict = true 
) [final]

See also:
http://tools.ietf.org/html/rfc3986#section-5.2.2

Returns:
GenericUri

Definition at line 107 of file GenericUri.class.php.

References $path, getAuthority(), getFragment(), getHost(), getPath(), getPort(), getQuery(), getScheme(), getUserInfo(), setHost(), setPath(), setPort(), setQuery(), setScheme(), and setUserInfo().

Here is the call graph for this function:

GenericUri::getKnownSubSchemes (  ) 

Reimplemented in Url, and Urn.

Definition at line 175 of file GenericUri.class.php.

References Url::create(), and Urn::create().

Referenced by parse().

Here is the call graph for this function:

GenericUri::setScheme ( scheme  ) 

Returns:
GenericUri

Definition at line 186 of file GenericUri.class.php.

References $scheme.

Referenced by Url::fixMistakenPath(), normalize(), and transform().

GenericUri::getScheme (  ) 

Definition at line 193 of file GenericUri.class.php.

Referenced by HttpUrl::normalize(), normalize(), and transform().

GenericUri::setUserInfo ( userInfo  ) 

Returns:
GenericUri

Definition at line 201 of file GenericUri.class.php.

References $userInfo.

Referenced by normalize(), setAuthority(), and transform().

GenericUri::getUserInfo (  ) 

Definition at line 208 of file GenericUri.class.php.

Referenced by normalize(), and transform().

GenericUri::setHost ( host  ) 

Returns:
GenericUri

Definition at line 216 of file GenericUri.class.php.

References $host.

Referenced by normalize(), setAuthority(), and transform().

GenericUri::getHost (  ) 

Definition at line 223 of file GenericUri.class.php.

Referenced by normalize(), and transform().

GenericUri::setPort ( port  ) 

Returns:
GenericUri

Definition at line 231 of file GenericUri.class.php.

References $port.

Referenced by Url::normalize(), HttpUrl::normalize(), setAuthority(), and transform().

GenericUri::getPort (  ) 

Definition at line 238 of file GenericUri.class.php.

Referenced by Url::normalize(), HttpUrl::normalize(), and transform().

GenericUri::setPath ( path  ) 

Returns:
GenericUri

Definition at line 246 of file GenericUri.class.php.

References $path.

Referenced by HttpUrl::ensureAbsolute(), Url::fixAuthorityFromPath(), Url::fixMistakenPath(), HttpUrl::normalize(), normalize(), and transform().

GenericUri::getPath (  ) 

Definition at line 253 of file GenericUri.class.php.

Referenced by mergePath(), HttpUrl::normalize(), normalize(), and transform().

GenericUri::setQuery ( query  ) 

Returns:
GenericUri

Definition at line 261 of file GenericUri.class.php.

References $query.

Referenced by appendQuery(), normalize(), and transform().

GenericUri::appendQuery ( string,
separator = '&' 
)

Returns:
GenericUri

Definition at line 271 of file GenericUri.class.php.

References $query, and setQuery().

Here is the call graph for this function:

GenericUri::getQuery (  ) 

Definition at line 285 of file GenericUri.class.php.

Referenced by normalize(), and transform().

GenericUri::setFragment ( fragment  ) 

Returns:
GenericUri

Definition at line 293 of file GenericUri.class.php.

References $fragment.

Referenced by normalize().

GenericUri::getFragment (  ) 

Definition at line 300 of file GenericUri.class.php.

Referenced by normalize(), and transform().

GenericUri::setAuthority ( authority  ) 

Returns:
GenericUri

Definition at line 308 of file GenericUri.class.php.

References setHost(), setPort(), and setUserInfo().

Referenced by HttpUrl::ensureAbsolute(), and Url::fixAuthorityFromPath().

Here is the call graph for this function:

GenericUri::getAuthority (  ) 

Definition at line 333 of file GenericUri.class.php.

Referenced by HttpUrl::ensureAbsolute(), Url::fixAuthorityFromPath(), Url::fixMistakenPath(), getSchemeSpecificPart(), Urn::isValid(), Url::isValid(), isValidPath(), mergePath(), Url::toSmallString(), and transform().

GenericUri::setSchemeSpecificPart ( schemeSpecificPart  ) 

Definition at line 349 of file GenericUri.class.php.

References parse().

Here is the call graph for this function:

GenericUri::getSchemeSpecificPart (  ) 

Definition at line 354 of file GenericUri.class.php.

References getAuthority().

Referenced by toString().

Here is the call graph for this function:

GenericUri::toString (  ) 

Implements Stringable.

Definition at line 374 of file GenericUri.class.php.

References getSchemeSpecificPart().

Referenced by OpenIdConsumer::makeCheckIdRequest().

Here is the call graph for this function:

GenericUri::toStringFromRoot (  ) 

Definition at line 386 of file GenericUri.class.php.

GenericUri::isValid (  ) 

Reimplemented in Url, and Urn.

Definition at line 399 of file GenericUri.class.php.

References isValidFragment(), isValidHost(), isValidPath(), isValidPort(), isValidQuery(), isValidScheme(), and isValidUserInfo().

Here is the call graph for this function:

GenericUri::isValidScheme (  ) 

Reimplemented in HttpUrl.

Definition at line 411 of file GenericUri.class.php.

Referenced by isValid().

GenericUri::isValidUserInfo (  ) 

Definition at line 420 of file GenericUri.class.php.

References userInfoCharPattern().

Referenced by isValid().

Here is the call graph for this function:

GenericUri::isValidHost (  ) 

Definition at line 431 of file GenericUri.class.php.

References isValidHostName().

Referenced by isValid().

Here is the call graph for this function:

GenericUri::isValidPort (  ) 

Reimplemented in HttpUrl.

Definition at line 483 of file GenericUri.class.php.

Referenced by isValid().

GenericUri::isValidPath (  ) 

Definition at line 495 of file GenericUri.class.php.

References getAuthority(), and segmentCharPattern().

Referenced by isValid().

Here is the call graph for this function:

GenericUri::isValidQuery (  ) 

Definition at line 539 of file GenericUri.class.php.

References isValidFragmentOrQuery().

Referenced by isValid().

Here is the call graph for this function:

GenericUri::isValidFragment (  ) 

Definition at line 545 of file GenericUri.class.php.

References isValidFragmentOrQuery().

Referenced by isValid().

Here is the call graph for this function:

GenericUri::isAbsolute (  ) 

Definition at line 551 of file GenericUri.class.php.

Referenced by Url::isValid().

GenericUri::isRelative (  ) 

Definition at line 556 of file GenericUri.class.php.

Referenced by Url::isValid().

GenericUri::isValidHostName (  )  [protected]

Reimplemented in HttpUrl.

Definition at line 561 of file GenericUri.class.php.

References hostNameCharPattern().

Referenced by isValidHost().

Here is the call graph for this function:

GenericUri::charPattern ( extraChars = null,
pctEncodedPattern = true 
) [protected]

Definition at line 573 of file GenericUri.class.php.

Referenced by fragmentOrQueryCharPattern(), hostNameCharPattern(), HttpUrl::isValidHostName(), segmentCharPattern(), and userInfoCharPattern().

GenericUri::userInfoCharPattern ( pctEncoded = true  )  [protected]

Definition at line 589 of file GenericUri.class.php.

References charPattern().

Referenced by isValidUserInfo(), and normalize().

Here is the call graph for this function:

GenericUri::hostNameCharPattern ( pctEncoded = true  )  [protected]

Definition at line 594 of file GenericUri.class.php.

References charPattern().

Referenced by isValidHostName(), and normalize().

Here is the call graph for this function:

GenericUri::segmentCharPattern ( pctEncoded = true  )  [protected]

Definition at line 599 of file GenericUri.class.php.

References charPattern().

Referenced by isValidPath(), and normalize().

Here is the call graph for this function:

GenericUri::fragmentOrQueryCharPattern ( pctEncoded = true  )  [protected]

Definition at line 604 of file GenericUri.class.php.

References charPattern().

Referenced by isValidFragmentOrQuery(), and normalize().

Here is the call graph for this function:

GenericUri::isValidFragmentOrQuery ( string  )  [private]

Definition at line 609 of file GenericUri.class.php.

References fragmentOrQueryCharPattern().

Referenced by isValidFragment(), and isValidQuery().

Here is the call graph for this function:

static GenericUri::removeDotSegments ( path  )  [static, private]

Definition at line 616 of file GenericUri.class.php.

References $path.

GenericUri::mergePath ( path  )  [private]

Definition at line 670 of file GenericUri.class.php.

References $path, getAuthority(), and getPath().

Here is the call graph for this function:

GenericUri::normalize (  ) 

See also:
http://tools.ietf.org/html/rfc3986#section-6

Reimplemented in HttpUrl, and Url.

Definition at line 685 of file GenericUri.class.php.

References fragmentOrQueryCharPattern(), getFragment(), getHost(), getPath(), getQuery(), getScheme(), getUserInfo(), hostNameCharPattern(), normalizePercentEncoded(), segmentCharPattern(), setFragment(), setHost(), setPath(), setQuery(), setScheme(), setUserInfo(), and userInfoCharPattern().

Referenced by normalizePercentEncoded().

Here is the call graph for this function:

GenericUri::normalizePercentEncoded ( string,
unreservedPartChars 
) [private]

Definition at line 731 of file GenericUri.class.php.

References PercentEncodingNormalizator::create(), and normalize().

Referenced by normalize().

Here is the call graph for this function:


Member Data Documentation

const GenericUri::CHARS_UNRESERVED = 'a-z0-9-._~'

Definition at line 20 of file GenericUri.class.php.

Referenced by PercentEncodingNormalizator::normalize().

const GenericUri::CHARS_SUBDELIMS = '!$&\'()*+,;='

Definition at line 21 of file GenericUri.class.php.

const GenericUri::PATTERN_PCTENCODED = '%[0-9a-f][0-9a-f]'

Definition at line 22 of file GenericUri.class.php.

GenericUri::$scheme = null [protected]

Definition at line 24 of file GenericUri.class.php.

Referenced by HttpUrl::normalize(), and setScheme().

GenericUri::$userInfo = null [protected]

Definition at line 26 of file GenericUri.class.php.

Referenced by setUserInfo().

GenericUri::$host = null [protected]

Definition at line 27 of file GenericUri.class.php.

Referenced by setHost().

GenericUri::$port = null [protected]

Definition at line 28 of file GenericUri.class.php.

Referenced by HttpUrl::normalize(), and setPort().

GenericUri::$path = null [protected]

Definition at line 30 of file GenericUri.class.php.

Referenced by mergePath(), removeDotSegments(), setPath(), and transform().

GenericUri::$query = null [protected]

Definition at line 31 of file GenericUri.class.php.

Referenced by appendQuery(), and setQuery().

GenericUri::$fragment = null [protected]

Definition at line 32 of file GenericUri.class.php.

Referenced by setFragment().


The documentation for this class was generated from the following file:
Generated on Sun Dec 9 21:57:32 2007 for onPHP by  doxygen 1.5.4