[ Index ]

PHP Cross Reference of DokuWiki

title

Body

[close]

/inc/ -> html.php (summary)

HTML output functions

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

Defines 46 functions

  html_wikilink()
  html_login()
  html_denied()
  html_secedit()
  html_secedit_button()
  html_secedit_get_button()
  html_topbtn()
  html_btn()
  html_showrev()
  html_show()
  html_draft()
  html_hilight()
  html_hilight_callback()
  html_locked()
  html_revisions()
  html_recent()
  html_index()
  html_list_index()
  html_li_index()
  html_li_default()
  html_buildlist()
  html_backlinks()
  html_diff_head()
  html_diff()
  html_diff_navigation()
  html_diff_navigationlink()
  html_insert_softbreaks()
  html_softbreak_callback()
  html_conflict()
  html_msgarea()
  html_register()
  html_updateprofile()
  html_edit()
  html_edit_form()
  html_minoredit()
  html_debug()
  html_resendpwd()
  html_TOC()
  html_list_toc()
  html_mktocitem()
  html_form()
  html_form_output()
  html_flashobject()
  html_tabs()
  html_tab()
  html_sizechange()

Functions
Functions that are not part of a class:

html_wikilink($id,$name=null,$search='')   X-Ref
Convenience function to quickly build a wikilink

author: Andreas Gohr <andi@splitbrain.org>
return: string the HTML code of the link
param: string  $id      id of the target page
param: string  $name    the name of the link, i.e. the text that is displayed
param: string|array  $search  search string(s) that shall be highlighted in the target page

html_login($svg = false)   X-Ref
The loginform

author: Andreas Gohr <andi@splitbrain.org>
param: bool $svg Whether to show svg icons in the register and resendpwd links or not

html_denied()   X-Ref
Denied page content

return: string html

html_secedit($text,$show=true)   X-Ref
inserts section edit buttons if wanted or removes the markers

author: Andreas Gohr <andi@splitbrain.org>
return: string
param: string $text
param: bool   $show show section edit buttons?

html_secedit_button($matches)   X-Ref
prepares section edit button data for event triggering
used as a callback in html_secedit

author: Andreas Gohr <andi@splitbrain.org>
return: string
triggers: HTML_SECEDIT_BUTTON
param: array $matches matches with regexp

html_secedit_get_button($data)   X-Ref
prints a section editing button
used as default action form HTML_SECEDIT_BUTTON

author: Adrian Lang <lang@cosmocode.de>
return: string html
param: array $data name, section id and target

html_topbtn()   X-Ref
Just the back to top button (in its own form)

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

html_btn($name, $id, $akey, $params, $method='get', $tooltip='', $label=false, $svg=null)   X-Ref
Displays a button (using its own form)
If tooltip exists, the access key tooltip is replaced.

author: Andreas Gohr <andi@splitbrain.org>
return: string
param: string         $name
param: string         $id
param: string         $akey   access key
param: string[] $params key-value pairs added as hidden inputs
param: string         $method
param: string         $tooltip
param: bool|string    $label  label text, false: lookup btn_$name in localization
param: string         $svg (optional) svg code, inserted into the button

html_showrev()   X-Ref
show a revision warning

author: Szymon Olewniczak <dokuwiki@imz.re>

html_show($txt=null)   X-Ref
Show a wiki page

author: Andreas Gohr <andi@splitbrain.org>
param: null|string $txt wiki text or null for showing $ID

html_draft()   X-Ref
ask the user about how to handle an exisiting draft

author: Andreas Gohr <andi@splitbrain.org>

html_hilight($html,$phrases)   X-Ref
Highlights searchqueries in HTML code

author: Andreas Gohr <andi@splitbrain.org>
author: Harry Fuecks <hfuecks@gmail.com>
return: string html
param: string $html
param: array|string $phrases

html_hilight_callback($m)   X-Ref
Callback used by html_hilight()

author: Harry Fuecks <hfuecks@gmail.com>
return: string html
param: array $m matches

html_locked()   X-Ref
Display error on locked pages

author: Andreas Gohr <andi@splitbrain.org>

html_revisions($first=0, $media_id = false)   X-Ref
list old revisions

author: Andreas Gohr <andi@splitbrain.org>
author: Ben Coburn <btcoburn@silicodon.net>
author: Kate Arzamastseva <pshns@ukr.net>
param: int $first skip the first n changelog lines
param: bool|string $media_id id of media, or false for current page

html_recent($first = 0, $show_changes = 'both')   X-Ref
display recent changes

author: Andreas Gohr <andi@splitbrain.org>
author: Matthias Grimm <matthiasgrimm@users.sourceforge.net>
author: Ben Coburn <btcoburn@silicodon.net>
author: Kate Arzamastseva <pshns@ukr.net>
param: int $first
param: string $show_changes

html_index($ns)   X-Ref
Display page index

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

html_list_index($item)   X-Ref
Index item formatter

User function for html_buildlist()

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

html_li_index($item)   X-Ref
Index List item

This user function is used in html_buildlist to build the
<li> tags for namespaces when displaying the page index
it gives different classes to opened or closed "folders"

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

html_li_default($item)   X-Ref
Default List item

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

html_buildlist($data,$class,$func,$lifunc='html_li_default',$forcewrapper=false)   X-Ref
Build an unordered list

Build an unordered list from the given $data array
Each item in the array has to have a 'level' property
the item itself gets printed by the given $func user
function. The second and optional function is used to
print the <li> tag. Both user function need to accept
a single item.

Both user functions can be given as array to point to
a member of an object.

author: Andreas Gohr <andi@splitbrain.org>
return: string html of an unordered list
param: array    $data  array with item arrays
param: string   $class class of ul wrapper
param: callable $func  callback to print an list item
param: callable $lifunc callback to the opening li tag
param: bool     $forcewrapper Trigger building a wrapper ul if the first level is

html_backlinks()   X-Ref
display backlinks

author: Andreas Gohr <andi@splitbrain.org>
author: Michael Klier <chi@chimeric.de>

html_diff_head($l_rev, $r_rev, $id = null, $media = false, $inline = false)   X-Ref
Get header of diff HTML

return: string[] HTML snippets for diff header
param: string $l_rev   Left revisions
param: string $r_rev   Right revision
param: string $id      Page id, if null $ID is used
param: bool   $media   If it is for media files
param: bool   $inline  Return the header on a single line

html_diff($text = '', $intro = true, $type = null)   X-Ref
Show diff
between current page version and provided $text
or between the revisions provided via GET or POST

author: Andreas Gohr <andi@splitbrain.org>
param: string $text  when non-empty: compare with this text with most current version
param: bool   $intro display the intro text
param: string $type  type of the diff (inline or sidebyside)

html_diff_navigation($pagelog, $type, $l_rev, $r_rev)   X-Ref
Create html for revision navigation

return: string[] html of left and right navigation elements
param: PageChangeLog $pagelog changelog object of current page
param: string        $type    inline vs sidebyside
param: int           $l_rev   left revision timestamp
param: int           $r_rev   right revision timestamp

html_diff_navigationlink($difftype, $linktype, $lrev, $rrev = null)   X-Ref
Create html link to a diff defined by two revisions

return: string html of link to a diff
param: string $difftype display type
param: string $linktype
param: int $lrev oldest revision
param: int $rrev newest revision or null for diff with current revision

html_insert_softbreaks($diffhtml)   X-Ref
Insert soft breaks in diff html

return: string
param: string $diffhtml

html_softbreak_callback($match)   X-Ref
callback which adds softbreaks

return: string the replacement
param: array $match array with first the complete match

html_conflict($text,$summary)   X-Ref
show warning on conflict detection

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

html_msgarea()   X-Ref
Prints the global message array

author: Andreas Gohr <andi@splitbrain.org>

html_register()   X-Ref
Prints the registration form

author: Andreas Gohr <andi@splitbrain.org>

html_updateprofile()   X-Ref
Print the update profile form

author: Christopher Smith <chris@jalakai.co.uk>
author: Andreas Gohr <andi@splitbrain.org>

html_edit()   X-Ref
Preprocess edit form data

author: Andreas Gohr <andi@splitbrain.org>
triggers: HTML_EDITFORM_OUTPUT

html_edit_form($param)   X-Ref
Display the default edit form

Is the default action for HTML_EDIT_FORMSELECTION.

param: mixed[] $param

html_minoredit()   X-Ref
Adds a checkbox for minor edits for logged in users

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

html_debug()   X-Ref
prints some debug info

author: Andreas Gohr <andi@splitbrain.org>

html_resendpwd()   X-Ref
Form to request a new password for an existing account

author: Benoit Chesneau <benoit@bchesneau.info>
author: Andreas Gohr <gohr@cosmocode.de>

html_TOC($toc)   X-Ref
Return the TOC rendered to XHTML

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

html_list_toc($item)   X-Ref
Callback for html_buildlist

return: string html
param: array $item

html_mktocitem($link, $text, $level, $hash=')   X-Ref
Helper function to build TOC items

Returns an array ready to be added to a TOC array

return: array the toc item
param: string $link  - where to link (if $hash set to '#' it's a local anchor)
param: string $text  - what to display in the TOC
param: int    $level - nesting level
param: string $hash  - is prepended to the given $link, set blank if you want full links

html_form($name, &$form)   X-Ref
Output a Doku_Form object.
Triggers an event with the form name: HTML_{$name}FORM_OUTPUT

author: Tom N Harris <tnharris@whoopdedo.org>
param: string     $name The name of the form
param: Doku_Form  $form The form

html_form_output($data)   X-Ref
Form print function.
Just calls printForm() on the data object.

param: Doku_Form $data The form

html_flashobject($swf,$width,$height,$params=null,$flashvars=null,$atts=null,$alt='')   X-Ref
Embed a flash object in HTML

This will create the needed HTML to embed a flash movie in a cross browser
compatble way using valid XHTML

The parameters $params, $flashvars and $atts need to be associative arrays.
No escaping needs to be done for them. The alternative content *has* to be
escaped because it is used as is. If no alternative content is given
$lang['noflash'] is used.

author: Andreas Gohr <andi@splitbrain.org>
return: string         - the XHTML markup
param: string $swf      - the SWF movie to embed
param: int $width       - width of the flash movie in pixels
param: int $height      - height of the flash movie in pixels
param: array $params    - additional parameters (<param>)
param: array $flashvars - parameters to be passed in the flashvar parameter
param: array $atts      - additional attributes for the <object> tag
param: string $alt      - alternative content (is NOT automatically escaped!)
link: http://latrine.dgx.cz/how-to-correctly-insert-a-flash-into-xhtml

html_tabs($tabs, $current_tab = null)   X-Ref
Prints HTML code for the given tab structure

param: array  $tabs        tab structure
param: string $current_tab the current tab id

html_tab($href, $caption, $selected=false)   X-Ref
Prints a single tab

author: Kate Arzamastseva <pshns@ukr.net>
author: Adrian Lang <mail@adrianlang.de>
param: string $href - tab href
param: string $caption - tab caption
param: boolean $selected - is tab selected

html_sizechange($sizechange, Doku_Form $form)   X-Ref
Display size change

param: int $sizechange - size of change in Bytes
param: Doku_Form $form - form to add elements to