[ Index ]

PHP Cross Reference of Mambo 4.6.5
[ Variables ]     [ Functions ]     [ Classes ]     [ Constants ]     [ Statistics ]

title

Body

[close]

/ -> index.php (summary)

[Source view] [Print] [Project Stats]

(no description)

Author: Mambo Foundation Inc see README.php
Copyright: (C) 2000 - 2009 Mambo Foundation Inc.
License: GNU/GPL Version 2, see LICENSE.php
File Size: 461 lines (17 kb)
Included or required: 8 times
Referenced: 25 times
Includes or requires: 1 file
 includes/pdf.php

Defines 3 functions

  mosGetParam()
  adminSide()
  indexType()

Functions
Functions that are not part of a class:

mosGetParam( &$arr, $name, $def=null, $mask=0 )   X-Ref
function to sanitize input values from arrays

This function provides a way to sanitize inputs, should be used to obtain values from
_POST, _GET, _COOKIES, etc; a default value can be passed to be used in case that not
values are founded to the element, a binary mask can be passed to discard some of  test,
, this value is matched with _MOS_NOTRIM, _MOS_ALLOWHTML and, _MOS_ALLOWRAW, currently
3 test are do it, trim, strip html and convert the value to numeric when is possible.

Example of use:

To get task variable from the URL and select the view like default task, you can use:

<code>$task = mosGetParam ($_GET,"task","view");</code>

To get task variable from the URL, select the view like default task, allows HTML and
without trim you can use :

<code>$task = mosGetParam ($_GET,"task","view",_MOS_NOTRIM+_MOS_ALLOWHTML);</code>

param: array &$arr reference to array which contains the value
param: string $name name of element searched
param: mixed $def default value to use if nothing is founded
param: int $mask mask to select checks that will do it
return: mixed value from the selected element or default value if nothing was found

adminSide($val='')   X-Ref
sets or returns the current side (frontend/backend)

This function returns TRUE when the user are in the backend area; this is set to
TRUE when are invocated /administrator/index.php, /administrator/index2.php
or /administrator/index3.php, to set this value is not a normal use.

param: bool $val value used to set the adminSide value, not planned to be used by users
return: bool TRUE when the user are in backend area, FALSE when are in frontend

indexType($val='')   X-Ref
sets or returns the index type

This function returns 1, 2 or 3 depending of called file index.php, index2.php or index3.php.

param: int $val value used to set the indexType value, not planned to be used by users
return: int return 1, 2 or 3 depending of called file