Path

ez components / documentation / api reference / 2007.1.1 / authentication


eZ Components 2007.1.1

Authentication: ezcAuthenticationUrl

[ Tutorial ] [ Security ] [ Class tree ] [ Element index ] [ ChangeLog ] [ Credits ]

Class: ezcAuthenticationUrl

Class which provides a methods for handling URLs. [source]

Method Summary

public static string appendQuery( $url, $key, $value )
Appends a query value to the provided URL and returns the complete URL.
public static string buildUrl( $parts )
Creates a string URL from the provided $parts array.
public static true fetchQuery( $url, $key )
Fetches the value of key $key from the query of the provided URL.
public static string normalize( $url )
Normalizes the provided URL.

Methods

appendQuery

string appendQuery( string $url, string $key, string $value )
Appends a query value to the provided URL and returns the complete URL.

Parameters

Name Type Description
$url string The URL to append a query value to
$key string The query key to append to the URL
$value string The query value to append to the URL

buildUrl

string buildUrl( $parts )
Creates a string URL from the provided $parts array.
The format of the $parts array is similar to the one returned by parse_url(), with the 'query' part as an array(key=>value) (obtained with the function parse_str()).

Parameters

Name Type Description
$parts array(string=>mixed) The parts of the URL

fetchQuery

true fetchQuery( string $url, string $key )
Fetches the value of key $key from the query of the provided URL.

Parameters

Name Type Description
$url string The URL from which to fetch the query value
$key string The query key for which to get the value

normalize

string normalize( string $url )
Normalizes the provided URL.
The operations performed on the provided URL:
  • trim
  • add 'http://' in front if it is missing

Parameters

Name Type Description
$url string The URL to normalize

Last updated: Wed, 28 Nov 2007