lib/ezutils/classes/ezuri.php

Show:

inherited

Classes
- \eZURI

Table of Contents

File containing the eZURI class.

Copyright: Copyright (C) 1999-2011 eZ Systems AS. All rights reserved.
License: eZ Business Use License Agreement Version 2.0
Package: lib
Version: 4.6.0

\eZURI
jump to top

Package: eZHTTP

Provides access to the HTTP uri

The URI can be accessed one element at a time with element() and elements() and can be iterated with increase() and the current index returned with index(). Movin the beginning and end is done with toBeginning() and toEnd(). The base can be retrieved with base() and the elements with elements().

This class also supports the attribute system.

The index starts at 0

Properties

int
                 $Index= ''

The current index

Details

Type: int

string
                 $URI= ''

The original URI string

Details

Type: string

array
                 $URIArray= ''

The URI array

Details

Type: array

array
                 $UserArray= ''

User defined template variables

Details

Type: array

string
                 $transformURIMode= '"relative"'

static

URI transformation mode used by transformURI().

Default value"relative"Details

Type: string
See: \transformURI()
See: \getTransformURIMode()
See: \setTransformURIMode()

Methods

__construct(
          string $uri
          )
        
        :
          void

Initializes with the URI string $uri. The URI string is split on / into an array.

Parameters

Name	Type	Description
$uri	string	the URI to use

attribute(
          string $attr
          )
        
        :
          boolean

Get value for an attribute

Parameters

Name	Type	Description
$attr	string

Returns

Type	Description
boolean	the value for attribute $attr or null if it does not exist.

attributes(
          
          )
        
        :
          array

Export all attributes of the object

Returns

Type	Description
array	the attributes for the object

base(
          \type $as_text
              =
              true
          )
        
        :
          string | array

Return the elements before pointer

Parameters

Name	Type	Description
$as_text	\type	return as text or array

Returns

Type	Description
string \| array	the base string or the base elements as an array if $as_text is true.

codecURL(
          string $url, boolean $encode
          )
        
        :
          string

static

Parse URL and encode/decode its path string

Parameters

Name	Type	Description
$url	string	the URL to parse
$encode	boolean	tells to encode the URI

Returns

Type	Description
string	the parsed url

convertFilterString(
          
          )
        
        :
          string

Converts filter string to current locale. When an user types in browser url like: "/content/view/full/2/(namefilter)/a" 'a' letter should be urldecoded and converted from utf-8 to current locale.

Returns

Type	Description
string	converted string

decodeIRI(
          string $str
          )
        
        :
          string

static

Decodes a path string which is in IRI format and returns the new path in the internal encoding.

More info on IRI here: {@link http://www.w3.org/International/O-URL-and-ident.html}

Parameters

Name	Type	Description
$str	string	the string to decode

Returns

Type	Description
string	decoded version of $str

decodeURL(
          string $url
          )
        
        :
          string

static

Decodes URL which has path string is in IRI format and returns the new URL with path in the internal encoding.

Parameters

Name	Type	Description
$url	string	url to decode

Returns

Type	Description
string	the decoded url

dropBase(
          
          )
        
        :
          void

Removes all elements below the current index, recreates the URI string and sets index to 0.

element(
          integer $index
              =
              0, boolean $relative
              =
              true
          )
        
        :
          string | null

Get element index from uri

Parameters

Name	Type	Description
$index	integer	the index of URI to return
$relative	boolean	if index is relative to the internal pointer

Returns

Type	Description
string \| null	the element at $index

elements(
          boolean $as_text
              =
              true
          )
        
        :
          array | string

Return all URI elements

Parameters

Name	Type	Description
$as_text	boolean	return the elements as string

Returns

Type	Description
array \| string	all elements as string/array depending on $as_text

encodeIRI(
          string $str
          )
        
        :
          string

static

Encodes path string in internal encoding to a new string which conforms to the IRI specification.

More info on IRI here: {@link http://www.w3.org/International/O-URL-and-ident.html}

Parameters

Name	Type	Description
$str	string	the IRI to encode

Returns

Type	Description
string	$str encoded as IRU

encodeURL(
          \type $url
          )
        
        :
          string

static

Encodes path string of URL in internal encoding to a new string which conforms to the IRI specification.

Parameters

Name	Type	Description
$url	\type

Returns

Type	Description
string	the encoded url

getTransformURIMode(
          
          )
        
        :
          string

static

Returns the current mode used for transformURI().

Returns

Type	Description
string

Details

See: \transformURI()
See: \setTransformURIMode()

hasAttribute(
          string $attr
          )
        
        :
          boolean

Check if attribute exsits

Parameters

Name	Type	Description
$attr	string	the attrbiute to check if exists

Returns

Type	Description
boolean

increase(
          int $num
              =
              1
          )
        
        :
          void

Moves the index 1 step up or $num if specified.

Parameters

Name	Type	Description
$num	int	number of steps to move pointer

Return the current position of pointer

Returns

Type	Description
int	the current pointer position.

instance(
          false | string $uri
              =
              false
          )
        
        :
          \eZURI

static

Returns a shared instance of the eZURI class IF $uri is false or the same as current request uri, if not then a new non shared instance is created.

Parameters

Name	Type	Description
$uri	false \| string	Shared uri instance if false

Returns

Type	Description
\eZURI

isEmpty(
          
          )
        
        :
          boolean

Check if there URI is set

Returns

Type	Description
boolean	true if the URI is empty, ie it's equal to / or empty string.

matchBase(
          \eZURI $uri
          )
        
        :
          boolean

Tries to match the base of $uri against this base and returns the result.

A match is made if all elements of this object match the base elements of the $uri object, this means that $uri's base may be longer than this base but not shorter.

Parameters

Name	Type	Description
$uri	\eZURI	the uri to match against

Returns

Type	Description
boolean

originalURIString(
          boolean $withLeadingSlash
              =
              false
          )
        
        :
          string

Return the original URI

the URI will not include the leading / if $withLeadingSlash is true.

Parameters

Name	Type	Description
$withLeadingSlash	boolean	prefix the uri with /

Returns

Type	Description
string	the URI passed to the object with user parameters (if any).

setTransformURIMode(
          string $mode
          )
        
        :
          void

static

Sets the current mode used for transformURI() to $mode.

Parameters

Name	Type	Description
$mode	string

Details

See: \transformURI()
See: \getTransformURIMode()

setURIString(
          string $uri, boolean $fullInitialize
              =
              true
          )
        
        :
          void

Sets uri string for instance

Sets the current URI string to $uri, the URI is then split into array elements and index reset to 1.

Parameters

Name	Type	Description
$uri	string
$fullInitialize	boolean

toBeginning(
          
          )
        
        :
          void

Reset the internal pointer

Moves the index to the end.

transformURI(
          string $href, boolean $ignoreIndexDir
              =
              false, string $serverURL
              =
              null
          )
        
        :
          string

static

Implementation of an 'ezurl' template operator Makes valid eZ Publish urls to use in links

Parameters

Name	Type	Description
$href	string	&$href
$ignoreIndexDir	boolean
$serverURL	string	full\|relative

Returns

Type	Description
string	the link to use

uriString(
          boolean $withLeadingSlash
              =
              false
          )
        
        :
          string

Get the uri string

The URI will not include the leading / if $withLeadingSlash is true.

Parameters

Name	Type	Description
$withLeadingSlash	boolean	prefix the uri with /

Returns

Type	Description
string	the URI passed as to the object

userParameters(
          
          )
        
        :
          array

Get user variables

Returns

Type	Description
array	all the user defined variables

lib/ezutils/classes/ezuri.php

\eZURIjump to top

Properties

Methods

\eZURI
jump to top