ePages 6.11.0 - DE_EPAGES/Core/API/Url.pm

Package DE_EPAGES::Core::API::Url

Some functions to build urls.

@EXPORT_OK
UrlEncodeValue
BuildParameterString
StringIsURL
ParseQueryString

Functions

BuildParameterString
ParseQueryString
StringIsURL
UrlEncodeValue

BuildParameterString

Builds a query string (example: key1=value1&key2=value2&key3=value3). The result will not start with a '?'. all keys and values will be encoded using UrlEncodeValue.

Syntax
$ParamString = BuildParameterString($hParams);
$ParamString = BuildParameterString($hParams, $noutf8);
Example
$ParamString = BuildParameterString({'ReturnUrl' => 'http://www.shop.de/epages/?ChangeAction=Change&ViewAction=View'});
$ParamString = BuildParameterString({'ChangeAction' => ['BlockMonitor', 'Save'], 'ViewAction' => 'View'});
Input
$hParams (ref.hash)
parameters to build string from; values may be strings or arrays of strings
$noutf8 (boolean)
do not use utf8 to encode the parameters
Return
$ParamString (string)
parmeters string

ParseQueryString

Parses an url-encoded query string.

Syntax
$hValues = ParseQueryString($QueryString, $Encoding);
Input
$QueryString (string)
query string
$Encoding (string)
encoding
Return
$haValues (ref.hash.array)
query values

StringIsURL

Tests whether the given string is an URL.

Syntax
$IsUrl = StringIsURL($String);
Input
$String (string)
string containing a url - or not
Return
(boolean)
true if $String is an URL

UrlEncodeValue

Encodes special characters in values to use as parameters in a query string.

Syntax
$EncodedValue = UrlEncodeValue($Value);
$EncodedValue = UrlEncodeValue($Value, $noutf8);
Example
$EncodedValue = UrlEncodeValue('abcd:');
Input
$Value (string)
value to encode
$noutf8 (boolean)
do not use utf8 to encode
Return
$EncodedValue (string)
encoded value