[ Index ]

PHP Cross Reference of DokuWiki

title

Body

[close]

/lib/exe/ -> js.php (summary)

DokuWiki JavaScript creator

Author: Andreas Gohr
License: GPL 2 (http://www.gnu.org/licenses/gpl.html)
File Size: 340 lines (11 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 1 file
 inc/init.php

Defines 7 functions

  js_out()
  js_load()
  js_pluginscripts()
  js_pluginstrings()
  js_templatestrings()
  js_escape()
  js_runonstart()

Functions
Functions that are not part of a class:

js_out()   X-Ref
Output all needed JavaScript

author: Andreas Gohr <andi@splitbrain.org>

js_load($file)   X-Ref
Load the given file, handle include calls and print it

author: Andreas Gohr <andi@splitbrain.org>
param: string $file filename path to file

js_pluginscripts()   X-Ref
Returns a list of possible Plugin Scripts (no existance check here)

author: Andreas Gohr <andi@splitbrain.org>
return: array

js_pluginstrings()   X-Ref
Return an two-dimensional array with strings from the language file of each plugin.

- $lang['js'] must be an array.
- Nothing is returned for plugins without an entry for $lang['js']

author: Gabriel Birke <birke@d-scribe.de>
return: array

js_templatestrings($tpl)   X-Ref
Return an two-dimensional array with strings from the language file of current active template.

- $lang['js'] must be an array.
- Nothing is returned for template without an entry for $lang['js']

param: string $tpl
return: array

js_escape($string)   X-Ref
Escapes a String to be embedded in a JavaScript call, keeps \n
as newline

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

js_runonstart($func)   X-Ref
Adds the given JavaScript code to the window.onload() event

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