/core/functions.inc

Description

functions.inc - helper functions used throughout the system

Functions
CreateGUID (line 24)

returns a Globally Unique Identifier string.

note: these GUIDs are not compatible with Microsoft's GUIDs

  • return: a unique identified string.
string CreateGUID ()
debug (line 106)

outputs an object's internals, then dies.

void debug (mixed $obj)
get_config_url (line 332)

gets a usable URL that is in the configuration file. This allows 'use_clean_urls' to be used

  • return: the URL, taking use_clean_urls into account, and $args into account. '' on error.
string get_config_url (string $name, [bool $args = false])
  • string $name: the configuration variable name
  • bool $args: an associative array of parameters to add to the URL
is_Page (line 98)

tests to see if an object is a page object

  • return: TRUE if the object is a Page object, FALSE if not.
bool is_Page (mixed $object)
ListOfPipelinesToHTML (line 180)

Returns an HTML string containing a SELECT control populated with the available Pipelines

  • return: the HTML string containing the available Pipelines
  • todo: move this to a Control
string ListOfPipelinesToHTML (mixed $_name, mixed $_selVal)
ListOfTemplatesToHTML (line 162)

Returns an HTML string containing a SELECT control populated with the available templates

  • return: the HTML string containing the available templates
  • todo: move this to a Control
string ListOfTemplatesToHTML (mixed $_name, mixed $_selVal)
LoadPipeline (line 74)

returns an initialized pipeline object with a given pipeline name

  • return: An initialized Pipeline object, or NULL if the pipeline is not found
pipelineBase LoadPipeline (string $pipelinename, Context $context)
  • Context $context: the current context object
  • string $pipelinename: @pipelinename the pipeline class to load
OutputError (line 58)

outputs an HTTP error message, with its associated HTTP header

  • todo: a 404 not found error could redirect to a special "not found handler" template.
void OutputError (mixed $errnum)
OutputMimeHeader (line 257)

outputs the mime header for a given requested. The $_req must have a filename extension to find the filetype.

  • return: TRUE if the header was sent, FALSE if not.
bool OutputMimeHeader (string $_req)
  • string $_req: the requested path+file (with the path levels delimited using '/'). Does not work with a query string.
relativePath (line 215)

Return the relative path between two paths / Retourne le chemin relatif entre 2 chemins

If $path2 is empty, get the current directory (getcwd).

string relativePath (mixed $path1, [mixed $path2 = ''])
removeFileExtension (line 40)

removes the file extension and query string from a given pathstring.

  • return: the origional path+filename without
string removeFileExtension (string $pathname)
  • string $pathname: the requested file path with extension and query string
req_isSet (line 315)

tests to see if a variable is set in the $_REQUEST variable, and that it is not blank

  • return: TRUE if the variable exists and is not blank, FALSE otherwise
bool req_isSet (mixed $req_name)
strEndsWith (line 198)

Tests if returns a boolean true if str ends with ending (case insensitive)

  • return: TRUE if $str ends with $ending
bool strEndsWith (string $str, string $ending)
  • string $str: the string to search
  • string $ending: the ending to search for in $str

Documentation generated on Tue, 4 Oct 2005 21:59:09 -0700 by phpDocumentor 1.3.0RC3