| [ Index ] |
PHP Cross Reference of DokuWiki |
[Source view] [Print] [Project Stats]
HTML output functions
| Author: | Andreas Gohr |
| License: | GPL 2 (http://www.gnu.org/licenses/gpl.html) |
| File Size: | 1069 lines (28 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
| html_wikilink($id, $name = null, $search = '') X-Ref |
| Convenience function to quickly build a wikilink 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 author: Andreas Gohr <andi@splitbrain.org> return: string the HTML code of the link |
| html_login($svg = false) X-Ref |
| The loginform param: bool $svg Whether to show svg icons in the register and resendpwd links or not author: Andreas Gohr <andi@splitbrain.org> |
| html_denied() X-Ref |
| Denied page content |
| html_secedit($text, $show = true) X-Ref |
| inserts section edit buttons if wanted or removes the markers param: string $text param: bool $show show section edit buttons? author: Andreas Gohr <andi@splitbrain.org> return: string |
| html_secedit_button($matches) X-Ref |
| prepares section edit button data for event triggering used as a callback in html_secedit param: array $matches matches with regexp author: Andreas Gohr <andi@splitbrain.org> return: string triggers: HTML_SECEDIT_BUTTON |
| html_secedit_get_button($data) X-Ref |
| prints a section editing button used as default action form HTML_SECEDIT_BUTTON param: array $data name, section id and target author: Adrian Lang <lang@cosmocode.de> return: string html |
| 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. 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 author: Andreas Gohr <andi@splitbrain.org> return: string |
| html_showrev() X-Ref |
| show a revision warning author: Szymon Olewniczak <dokuwiki@imz.re> |
| html_show($txt = null) X-Ref |
| Show a wiki page param: null|string $txt wiki text or null for showing $ID author: Andreas Gohr <andi@splitbrain.org> |
| 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 param: string $html param: array|string $phrases author: Andreas Gohr <andi@splitbrain.org> author: Harry Fuecks <hfuecks@gmail.com> return: string html |
| html_locked() X-Ref |
| Display error on locked pages author: Andreas Gohr <andi@splitbrain.org> |
| html_revisions($first = -1, $media_id = '') X-Ref |
| list old revisions param: int $first skip the first n changelog lines param: string $media_id id of media, or empty for current page author: Andreas Gohr <andi@splitbrain.org> author: Ben Coburn <btcoburn@silicodon.net> author: Kate Arzamastseva <pshns@ukr.net> |
| html_recent($first = 0, $show_changes = 'both') X-Ref |
| display recent changes param: int $first param: string $show_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> |
| html_index($ns) X-Ref |
| Display page index param: string $ns author: Andreas Gohr <andi@splitbrain.org> |
| html_list_index($item) X-Ref |
| Index tree item formatter for html_buildlist() User function for html_buildlist() param: array $item author: Andreas Gohr <andi@splitbrain.org> return: string |
| html_li_index($item) X-Ref |
| Index list item formatter for html_buildlist() 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" param: array $item author: Andreas Gohr <andi@splitbrain.org> return: string html |
| html_li_default($item) X-Ref |
| Default list item formatter for html_buildlist() param: array $item author: Andreas Gohr <andi@splitbrain.org> return: string html |
| html_buildlist($data, $class, $func, $lifunc = null, $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. 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 (optional) callback to the opening li tag param: bool $forcewrapper (optional) Trigger building a wrapper ul if the first level is author: Andreas Gohr <andi@splitbrain.org> return: string html of an unordered list |
| 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 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 return: string[] HTML snippets for diff header |
| 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 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) author: Andreas Gohr <andi@splitbrain.org> |
| html_diff_navigation($pagelog, $type, $l_rev, $r_rev) X-Ref |
| Create html for revision navigation 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 return: string[] html of left and right navigation elements |
| html_diff_navigationlink($difftype, $linktype, $lrev, $rrev = null) X-Ref |
| Create html link to a diff defined by two revisions 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 return: string html of link to a diff |
| html_insert_softbreaks($diffhtml) X-Ref |
| Insert soft breaks in diff html param: string $diffhtml return: string |
| html_conflict($text, $summary) X-Ref |
| show warning on conflict detection param: string $text param: string $summary author: Andreas Gohr <andi@splitbrain.org> |
| 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> |
| html_edit_form($param) X-Ref |
| Display the default edit form Is the default action for HTML_EDIT_FORMSELECTION. param: array $param |
| 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 param: array $toc author: Andreas Gohr <andi@splitbrain.org> return: string html |
| html_list_toc($item) X-Ref |
| Callback for html_buildlist param: array $item return: string html |
| 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 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 return: array the toc item |
| html_form($name, $form) X-Ref |
| Output a Doku_Form object. Triggers an event with the form name: HTML_{$name}FORM_OUTPUT param: string $name The name of the form param: Doku_Form $form The form author: Tom N Harris <tnharris@whoopdedo.org> return: void |
| html_form_output($form) X-Ref |
| Form print function. Just calls printForm() on the form object. param: Doku_Form $form The form return: void |
| 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. 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 author: Andreas Gohr <andi@splitbrain.org> return: string - the XHTML markup |
| 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 return: void |
| html_tab($href, $caption, $selected = false) X-Ref |
| Prints a single tab param: string $href - tab href param: string $caption - tab caption param: boolean $selected - is tab selected author: Kate Arzamastseva <pshns@ukr.net> author: Adrian Lang <mail@adrianlang.de> return: void |
| html_sizechange($sizechange, $form = null) X-Ref |
| Display size change param: int $sizechange - size of change in Bytes param: Doku_Form $form - (optional) form to add elements to return: void|string |