common-functions.inc File Reference

Functions
	repMapString ($map)
	basePath ()
	loadFile ($sFilename, $sCharset= 'UTF-8')
	errorPage ($errorText, $errorCode=403)
	genUrl ($urlParams, $keys=array(), $nonQueryParams=array())
	getElementByTagName ($obj, $name)
	startswith ($haystack, $needle)
	endsWith ($haystack, $needle)
	opttostring ($opts)

Detailed Description

Functionality which doesn't belong anywhere else

Function Documentation

basePath

(

)

Get the location on the server where the top level script is located

Returns

directory

endsWith	(		$haystack,
			$needle
	)

Checks if one string ends with another string

Parameters

$haystack	the string to search
$needle	the string to search for

Returns

bool if match

errorPage	(		$errorText,
			$errorCode = 403
	)

Generate a status page and exit

Parameters

$errorText	the text to be displayed in the body
$errorCode	the status code to be served

genUrl	(		$urlParams,
			$keys = array(),
			$nonQueryParams = array()
	)

Generates an URL for the specified parameters

Parameters

$urlParams	an associative array of the values already set
$keys	a set of values to override $urlParams
$nonQueryParams	a list of keys, where values should be in the URL, rather than the query part, note that the order is important

getElementByTagName	(		$obj,
			$name
	)

Retrieves a single subelement

Exceptions

Exception

if number of elements are different from 1

Todo:

Throw more specific exception

Parameters

$obj	the xml element to search in
$name	the name of the element to search for

loadFile	(		$sFilename,
			$sCharset = 'UTF-8'
	)

Loads a file

Parameters

$sFilename	name of the file to load
$sCharset	the character encoding of the file

Todo:

make this function throw instead of returning codes

Returns

the contents of the file, or a status code (-3 if file does not exists, if file could not be opened -2)

opttostring

(

$opts

)

Generates the query part of an URI

Parameters

$opts

an associative array of options

Returns

a string that can be used for the query part of an URI

repMapString

(

$map

)

Generates a representation for an array of key => value pairs

Note

Behaviour is undefined if value is a composite structure.

Parameters

$map	the input array

Returns

a string representation that may be eval'ed

startswith	(		$haystack,
			$needle
	)

Checks if one string start with another string

Parameters

$haystack	the string to search
$needle	the string to search for

Returns

bool if match