| [ Index ] |
PHP Cross Reference of MediaWiki-1.24.0 |
[Source view] [Print] [Project Stats]
Methods to generate XML. This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
| File Size: | 1005 lines (30 kb) |
| Included or required: | 0 times |
| Referenced: | 3 times |
| Includes or requires: | 0 files |
Xml:: (35 methods):
element()
expandAttributes()
elementClean()
openElement()
closeElement()
tags()
monthSelector()
dateMenu()
languageSelector()
span()
wrapClass()
input()
password()
attrib()
check()
radio()
label()
inputLabel()
inputLabelSep()
checkLabel()
radioLabel()
submitButton()
option()
listDropDown()
fieldset()
textarea()
escapeJsString()
encodeJsVar()
encodeJsCall()
isWellFormed()
isWellFormedXmlFragment()
escapeTagsOnly()
buildForm()
buildTable()
buildTableRow()
XmlSelect:: (8 methods):
__construct()
setDefault()
setAttribute()
getAttribute()
addOption()
addOptions()
formatOptions()
getHTML()
XmlJsCode:: (1 method):
__construct()
| element( $element, $attribs = null, $contents = '',$allowShortTag = true) X-Ref |
| Format an XML element with given attributes and, optionally, text content. Element and attribute names are assumed to be ready for literal inclusion. Strings are assumed to not contain XML-illegal characters; special characters (<, >, &) are escaped but illegals are not touched. param: string $element Element name param: array $attribs Name=>value pairs. Values will be escaped. param: string $contents Null to make an open tag only; '' for a contentless closed tag (default) param: bool $allowShortTag Whether '' in $contents will result in a contentless closed tag return: string |
| expandAttributes( $attribs ) X-Ref |
| Given an array of ('attributename' => 'value'), it generates the code to set the XML attributes : attributename="value". The values are passed to Sanitizer::encodeAttribute. Return null if no attributes given. param: array $attribs Array of attributes for an XML element return: null|string |
| elementClean( $element, $attribs = array() X-Ref |
| Format an XML element as with self::element(), but run text through the $wgContLang->normalize() validator first to ensure that no invalid UTF-8 is passed. param: string $element param: array $attribs Name=>value pairs. Values will be escaped. param: string $contents Null to make an open tag only; '' for a contentless closed tag (default) return: string |
| openElement( $element, $attribs = null ) X-Ref |
| This opens an XML element param: string $element Name of the element param: array $attribs Array of attributes, see Xml::expandAttributes() return: string |
| closeElement( $element ) X-Ref |
| Shortcut to close an XML element param: string $element Element name return: string |
| tags( $element, $attribs = null, $contents ) X-Ref |
| Same as Xml::element(), but does not escape contents. Handy when the content you have is already valid xml. param: string $element Element name param: array $attribs Array of attributes param: string $contents Content of the element return: string |
| monthSelector( $selected = '', $allmonths = null, $id = 'month' ) X-Ref |
| Create a date selector param: string $selected The month which should be selected, default ''. param: string $allmonths Value of a special item denoting all month. param: string $id Element identifier return: string Html string containing the month selector |
| dateMenu( $year, $month ) X-Ref |
param: int $year param: int $month return: string Formatted HTML |
| languageSelector( $selected, $customisedOnly = true,$inLanguage = null, $overrideAttrs = array() X-Ref |
| Construct a language selector appropriate for use in a form or preferences param: string $selected The language code of the selected language param: bool $customisedOnly If true only languages which have some content are listed param: string $inLanguage The ISO code of the language to display the select list in (optional) param: array $overrideAttrs Override the attributes of the select tag (since 1.20) param: Message|null $msg Label message key (since 1.20) return: array Array containing 2 items: label HTML and select list HTML |
| span( $text, $class, $attribs = array() X-Ref |
| Shortcut to make a span element param: string $text Content of the element, will be escaped param: string $class Class name of the span element param: array $attribs Other attributes return: string |
| wrapClass( $text, $class, $tag = 'span', $attribs = array() X-Ref |
| Shortcut to make a specific element with a class attribute param: string $text Content of the element, will be escaped param: string $class Class name of the span element param: string $tag Element name param: array $attribs Other attributes return: string |
| input( $name, $size = false, $value = false, $attribs = array() X-Ref |
| Convenience function to build an HTML text input field param: string $name Value of the name attribute param: int $size Value of the size attribute param: mixed $value Value of the value attribute param: array $attribs Other attributes return: string HTML |
| password( $name, $size = false, $value = false,$attribs = array() X-Ref |
| Convenience function to build an HTML password input field param: string $name Value of the name attribute param: int $size Value of the size attribute param: mixed $value Value of the value attribute param: array $attribs Other attributes return: string HTML |
| attrib( $name, $present = true ) X-Ref |
| Internal function for use in checkboxes and radio buttons and such. param: string $name param: bool $present return: array |
| check( $name, $checked = false, $attribs = array() X-Ref |
| Convenience function to build an HTML checkbox param: string $name Value of the name attribute param: bool $checked Whether the checkbox is checked or not param: array $attribs Array other attributes return: string HTML |
| radio( $name, $value, $checked = false, $attribs = array() X-Ref |
| Convenience function to build an HTML radio button param: string $name Value of the name attribute param: string $value Value of the value attribute param: bool $checked Whether the checkbox is checked or not param: array $attribs Other attributes return: string HTML |
| label( $label, $id, $attribs = array() X-Ref |
| Convenience function to build an HTML form label param: string $label Text of the label param: string $id param: array $attribs An attribute array. This will usually be return: string HTML |
| inputLabel( $label, $name, $id, $size = false,$value = false, $attribs = array() X-Ref |
| Convenience function to build an HTML text input field with a label param: string $label Text of the label param: string $name Value of the name attribute param: string $id Id of the input param: int|bool $size Value of the size attribute param: string|bool $value Value of the value attribute param: array $attribs Other attributes return: string HTML |
| inputLabelSep( $label, $name, $id, $size = false,$value = false, $attribs = array() X-Ref |
| Same as Xml::inputLabel() but return input and label in an array param: string $label param: string $name param: string $id param: int|bool $size param: string|bool $value param: array $attribs return: array |
| checkLabel( $label, $name, $id, $checked = false, $attribs = array() X-Ref |
| Convenience function to build an HTML checkbox with a label param: string $label param: string $name param: string $id param: bool $checked param: array $attribs return: string HTML |
| radioLabel( $label, $name, $value, $id,$checked = false, $attribs = array() X-Ref |
| Convenience function to build an HTML radio button with a label param: string $label param: string $name param: string $value param: string $id param: bool $checked param: array $attribs return: string HTML |
| submitButton( $value, $attribs = array() X-Ref |
| Convenience function to build an HTML submit button When $wgUseMediaWikiUIEverywhere is true it will default to a constructive button param: string $value Label text for the button param: array $attribs Optional custom attributes return: string HTML |
| option( $text, $value = null, $selected = false,$attribs = array() X-Ref |
| Convenience function to build an HTML drop-down list item. param: string $text Text for this item. Will be HTML escaped param: string $value Form submission value; if empty, use text param: bool $selected If true, will be the default selected item param: array $attribs Optional additional HTML attributes return: string HTML |
| listDropDown( $name = '', $list = '', $other = '',$selected = '', $class = '', $tabindex = null) X-Ref |
| Build a drop-down box from a textual list. param: string $name Name and id for the drop-down param: string $list Correctly formatted text (newline delimited) to be param: string $other Text for the "Other reasons" option param: string $selected Option which should be pre-selected param: string $class CSS classes for the drop-down param: int $tabindex Value of the tabindex attribute return: string |
| fieldset( $legend = false, $content = false, $attribs = array() X-Ref |
| Shortcut for creating fieldsets. param: string|bool $legend Legend of the fieldset. If evaluates to false, param: string $content Pre-escaped content for the fieldset. If false, param: array $attribs Any attributes to fieldset-element. return: string |
| textarea( $name, $content, $cols = 40, $rows = 5, $attribs = array() X-Ref |
| Shortcut for creating textareas. param: string $name The 'name' for the textarea param: string $content Content for the textarea param: int $cols The number of columns for the textarea param: int $rows The number of rows for the textarea param: array $attribs Any other attributes for the textarea return: string |
| escapeJsString( $string ) X-Ref |
| Returns an escaped string suitable for inclusion in a string literal for JavaScript source code. Illegal control characters are assumed not to be present. param: string $string String to escape return: string |
| encodeJsVar( $value, $pretty = false ) X-Ref |
| Encode a variable of arbitrary type to JavaScript. If the value is an XmlJsCode object, pass through the object's value verbatim. param: mixed $value The value being encoded. Can be any type except a resource. param: bool $pretty If true, add non-significant whitespace to improve readability. return: string|bool String if successful; false upon failure |
| encodeJsCall( $name, $args, $pretty = false ) X-Ref |
| Create a call to a JavaScript function. The supplied arguments will be encoded using Xml::encodeJsVar(). param: string $name The name of the function to call, or a JavaScript expression param: array $args The arguments to pass to the function. param: bool $pretty If true, add non-significant whitespace to improve readability. return: string|bool String if successful; false upon failure |
| isWellFormed( $text ) X-Ref |
| Check if a string is well-formed XML. Must include the surrounding tag. param: string $text String to test. return: bool |
| isWellFormedXmlFragment( $text ) X-Ref |
| Check if a string is a well-formed XML fragment. Wraps fragment in an \<html\> bit and doctype, so it can be a fragment and can use HTML named entities. param: string $text return: bool |
| escapeTagsOnly( $in ) X-Ref |
| Replace " > and < with their respective HTML entities ( ", >, <) param: string $in Text that might contain HTML tags. return: string Escaped string |
| buildForm( $fields, $submitLabel = null, $submitAttribs = array() X-Ref |
| Generate a form (without the opening form element). Output optionally includes a submit button. param: array $fields Associative array, key is the name of a message that param: string $submitLabel The name of a message containing a label for param: array $submitAttribs The attributes to add to the submit button return: string HTML form. |
| buildTable( $rows, $attribs = array() X-Ref |
| Build a table of data param: array $rows An array of arrays of strings, each to be a row in a table param: array $attribs An array of attributes to apply to the table tag [optional] param: array $headers An array of strings to use as table headers [optional] return: string |
| buildTableRow( $attribs, $cells ) X-Ref |
| Build a row for a table param: array $attribs An array of attributes to apply to the tr tag param: array $cells An array of strings to put in <td> return: string |
| __construct( $name = false, $id = false, $default = false ) X-Ref |
| No description |
| setDefault( $default ) X-Ref |
param: string $default |
| setAttribute( $name, $value ) X-Ref |
param: string $name param: array $value |
| getAttribute( $name ) X-Ref |
param: string $name return: array|null |
| addOption( $name, $value = false ) X-Ref |
param: string $name param: bool $value |
| addOptions( $options ) X-Ref |
| This accepts an array of form label => value label => ( label => value, label => value ) param: array $options |
| formatOptions( $options, $default = false ) X-Ref |
| This accepts an array of form label => value label => ( label => value, label => value ) param: array $options param: bool $default return: string |
| getHTML() X-Ref |
return: string |
| __construct( $value ) X-Ref |
| No description |
| Generated: Fri Nov 28 14:03:12 2014 | Cross-referenced by PHPXref 0.7.1 |