[ Index ]

Source Code Reference for V1.00

title

Body

[close]

/includes/ -> main_functions.php (summary)

(no description)

File Size: 1519 lines (49 kb)
Included or required: 9 times
Referenced: 0 times
Includes or requires: 0 files

Defines 52 functions

  bestColor()
  arraySelect()
  arraySelectTree()
  tree_recurse()
  projectSelectWithOptGroup()
  arrayMerge()
  breadCrumbs()
  contextHelp()
  w2PcontextHelp()
  w2PgetConfig()
  w2PgetUsername()
  w2PgetUsernameFromID()
  w2PgetUsers()
  w2PgetUsersList()
  w2PgetUsersHashList()
  w2PshowModuleConfig()
  w2PfindImage()
  w2PshowImage()
  defVal()
  w2PgetParam()
  w2PgetCleanParam()
  addHistory()
  w2PgetSysVal()
  w2PuserHasRole()
  w2PformatDuration()
  w2PsetMicroTime()
  w2PgetMicroDiff()
  w2PformSafe()
  convert2days()
  formatTime()
  formatCurrency()
  format_backtrace()
  dprint()
  findTabModules()
  findCrumbModules()
  showFVar()
  getUsersArray()
  getUsersCombo()
  formatHours()
  w2Psgn()
  dpRealPath()
  w2PrequiredFields()
  htmlspecialchars_decode()
  w2PgetBytes()
  w2PcheckMem()
  w2PHTMLDecode()
  w2PtoolTip()
  w2PendTip()
  w2Phtmlspecialchars()
  w2Phtml_entity_decode()
  w2PcheckCharset()
  w2PwriteDebug()

Functions
Functions that are not part of a class:

bestColor($bg, $lt = ')   X-Ref
No description

arraySelect(&$arr, $select_name, $select_attribs, $selected, $translate = false)   X-Ref
No description

arraySelectTree(&$arr, $select_name, $select_attribs, $selected, $translate = false)   X-Ref
No description

tree_recurse($id, $indent, $list, $children)   X-Ref
No description

projectSelectWithOptGroup($user_id, $select_name, $select_attribs, $selected, $excludeProjWithId = null)   X-Ref
Provide Projects Selectbox sorted by Companies
@author gregorerhardt with special thanks to original author aramis
@param     int         userID
@param     string     HTML select box name identifier
@param    string    HTML attributes
@param    int            Proejct ID for preselection
@param     int            Project ID which will be excluded from the list
(e.g. in the tasks import list exclude the project to import into)
@return    string     HTML selectbox


arrayMerge($a1, $a2)   X-Ref
No description

breadCrumbs(&$arr)   X-Ref
No description

contextHelp($title, $link = '')   X-Ref
No description

w2PcontextHelp($title, $link = '')   X-Ref
No description

w2PgetConfig($key, $default = null)   X-Ref
Retrieves a configuration setting.

param: $key string The name of a configuration setting
param: $default string The default value to return if the key not found.
return: The value of the setting, or the default value if not found.

w2PgetUsername($user)   X-Ref
No description

w2PgetUsernameFromID($user)   X-Ref
No description

w2PgetUsers($module = '')   X-Ref
No description

w2PgetUsersList($stub = null, $where = null, $orderby = 'contact_first_name, contact_last_name')   X-Ref
No description

w2PgetUsersHashList($stub = null, $where = null, $orderby = 'contact_first_name, contact_last_name')   X-Ref
No description

w2PshowModuleConfig($config)   X-Ref
No description

w2PfindImage($name, $module = null)   X-Ref
Function to recussively find an image in a number of places

param: string The name of the image
param: string Optional name of the current module

w2PshowImage($src, $wid = '', $hgt = '', $alt = '', $title = '', $module = null)   X-Ref
Workaround removed due to problems in Opera and other issues
with IE6.
Workaround to display png images with alpha-transparency in IE6.0

param: string The name of the image
param: string The image width
param: string The image height
param: string The alt text for the image

defVal($var, $def)   X-Ref
function to return a default value if a variable is not set


w2PgetParam(&$arr, $name, $def = null)   X-Ref
Utility function to return a value from a named array or a specified default, and avoid poisoning the URL by denying:
1) the use of spaces (for SQL and XSS injection)
2) the use of <, ", [, ; and { (for XSS injection)


w2PgetCleanParam(&$arr, $name, $def = null)   X-Ref
Alternative to protect from XSS attacks.


addHistory($table, $id, $action = 'modify', $description = '', $project_id = 0)   X-Ref
No description

w2PgetSysVal($title)   X-Ref
No description

w2PuserHasRole($name)   X-Ref
No description

w2PformatDuration($x)   X-Ref
No description

w2PsetMicroTime()   X-Ref
No description

w2PgetMicroDiff()   X-Ref
No description

w2PformSafe($txt, $deslash = false)   X-Ref
Make text safe to output into double-quote enclosed attirbutes of an HTML tag


convert2days($durn, $units)   X-Ref
No description

formatTime($uts)   X-Ref
No description

formatCurrency($number, $format)   X-Ref
This function is necessary because Windows likes to
write their own standards.  Nothing that depends on locales
can be trusted in Windows.


format_backtrace($bt, $file, $line, $msg)   X-Ref
No description

dprint($file, $line, $level, $msg)   X-Ref
No description

findTabModules($module, $file = null)   X-Ref
Return a list of modules that are associated with tabs for this
page.  This can be used to find post handlers, for instance.


findCrumbModules($module, $file = null)   X-Ref
Return a list of modules that are associated with crumbs for this
page.  This can be used to find post handlers, for instance.


showFVar(&$var, $title = '')   X-Ref

param: mixed $var
param: char $title
return: void

getUsersArray()   X-Ref
No description

getUsersCombo($default_user_id = 0, $first_option = 'All users')   X-Ref
No description

formatHours($hours)   X-Ref
Function to format hours into useful numbers.
Supplied by GrahamJB.


w2Psgn($x)   X-Ref
PHP doesn't come with a signum function


dpRealPath($file)   X-Ref
This function is now deprecated and will be removed.
In the interim it now does nothing.


w2PrequiredFields($requiredFields)   X-Ref
No description

htmlspecialchars_decode($str)   X-Ref
No description

w2PgetBytes($str)   X-Ref
Return the number of bytes represented by a PHP.INI value


w2PcheckMem($min = 0, $revert = false)   X-Ref
Check for a memory limit, if we can't generate it then we fail.

param: int $min minimum amount of memory needed
param: bool $revert revert back to original config after test.
return: bool true if we have the minimum amount of RAM and if we can modify RAM

w2PHTMLDecode($txt)   X-Ref
decode HTML entities


w2PtoolTip($header = '', $tip = '', $raw = false, $id = '')   X-Ref
No description

w2PendTip()   X-Ref
No description

w2Phtmlspecialchars($string)   X-Ref
No description

w2Phtml_entity_decode($string)   X-Ref
No description

w2PcheckCharset($charset)   X-Ref
Corrects the charset name if needed be

param: string $charset the charset string to be checked

w2PwriteDebug($s, $t = '', $f = '?', $l = '?')   X-Ref
Write debugging to debug.log file

param: string $s the debug message
param: string $t the header of the message
param: string $f the script filename
param: string $l the script line



Generated: Sat Jul 17 03:00:04 2010 Cross-referenced by PHPXref 0.7