[ Index ]

PHP Cross Reference of DokuWiki

title

Body

[close]

/inc/ -> infoutils.php (summary)

Information and debugging functions

Author: Andreas Gohr
License: GPL 2 (http://www.gnu.org/licenses/gpl.html)
File Size: 523 lines (16 kb)
Included or required: 1 time
Referenced: 0 times
Includes or requires: 0 files

Defines 11 functions

  checkUpdateMessages()
  getVersionData()
  getVersion()
  check()
  msg()
  info_msg_allowed()
  dbg()
  dbglog()
  dbg_deprecated()
  dbg_backtrace()
  debug_guard()

Functions
Functions that are not part of a class:

checkUpdateMessages()   X-Ref
Check for new messages from upstream

author: Andreas Gohr <andi@splitbrain.org>

getVersionData()   X-Ref
Return DokuWiki's version (split up in date and type)

author: Andreas Gohr <andi@splitbrain.org>

getVersion()   X-Ref
Return DokuWiki's version (as a string)

author: Anika Henke <anika@selfthinker.org>

check()   X-Ref
Run a few sanity checks

author: Andreas Gohr <andi@splitbrain.org>

msg($message,$lvl=0,$line='',$file='',$allow=MSG_PUBLIC)   X-Ref
Display a message to the user

param: string $message
param: int    $lvl   -1 = error, 0 = info, 1 = success, 2 = notify
param: string $line  line number
param: string $file  file number
param: int    $allow who's allowed to see the message, see MSG_* constants

info_msg_allowed($msg)   X-Ref
Determine whether the current user is allowed to view the message
in the $msg data structure

return: bool
param: $msg   array    dokuwiki msg structure

dbg($msg,$hidden=false)   X-Ref
print debug messages

little function to print the content of a var

author: Andreas Gohr <andi@splitbrain.org>
param: string $msg
param: bool $hidden

dbglog($msg,$header='')   X-Ref
Print info to a log file

author: Andreas Gohr <andi@splitbrain.org>
param: string $msg
param: string $header

dbg_deprecated($alternative = '')   X-Ref
Log accesses to deprecated fucntions to the debug log

triggers: INFO_DEPRECATION_LOG
param: string $alternative The function or method that should be used instead

dbg_backtrace()   X-Ref
Print a reversed, prettyprinted backtrace

author: Gary Owen <gary_owen@bigfoot.com>

debug_guard(&$data)   X-Ref
Remove all data from an array where the key seems to point to sensitive data

This is used to remove passwords, mail addresses and similar data from the
debug output

author: Andreas Gohr <andi@splitbrain.org>
param: array $data