diff options
Diffstat (limited to 'includes/Xml.php')
| -rw-r--r-- | includes/Xml.php | 202 |
1 files changed, 136 insertions, 66 deletions
diff --git a/includes/Xml.php b/includes/Xml.php index 970444fa..45ee8720 100644 --- a/includes/Xml.php +++ b/includes/Xml.php @@ -191,7 +191,7 @@ class Xml { } if( $year ) { $encYear = intval( $year ); - } else if( $encMonth ) { + } elseif( $encMonth ) { $thisMonth = intval( gmdate( 'n' ) ); $thisYear = intval( gmdate( 'Y' ) ); if( intval($encMonth) > $thisMonth ) { @@ -209,8 +209,8 @@ class Xml { /** * - * @param $selected The language code of the selected language - * @param $customisedOnly If true only languages which have some content are listed + * @param $selected string The language code of the selected language + * @param $customisedOnly bool If true only languages which have some content are listed * @return array of label and select */ public static function languageSelector( $selected, $customisedOnly = true ) { @@ -250,10 +250,10 @@ class Xml { * Shortcut to make a span element * @param $text String content of the element, will be escaped * @param $class String class name of the span element - * @param $attribs other attributes + * @param $attribs array other attributes * @return string */ - public static function span( $text, $class, $attribs=array() ) { + public static function span( $text, $class, $attribs = array() ) { return self::element( 'span', array( 'class' => $class ) + $attribs, $text ); } @@ -261,23 +261,23 @@ class Xml { * Shortcut to make a specific element with a class attribute * @param $text content of the element, will be escaped * @param $class class name of the span element - * @param $tag element name - * @param $attribs other attributes + * @param $tag string element name + * @param $attribs array other attributes * @return string */ - public static function wrapClass( $text, $class, $tag='span', $attribs=array() ) { + public static function wrapClass( $text, $class, $tag = 'span', $attribs = array() ) { return self::tags( $tag, array( 'class' => $class ) + $attribs, $text ); } /** * Convenience function to build an HTML text input field * @param $name String value of the name attribute - * @param $size value of the size attribute - * @param $value value of the value attribute - * @param $attribs other attributes + * @param $size int value of the size attribute + * @param $value mixed value of the value attribute + * @param $attribs array other attributes * @return string HTML */ - public static function input( $name, $size=false, $value=false, $attribs=array() ) { + public static function input( $name, $size = false, $value = false, $attribs = array() ) { $attributes = array( 'name' => $name ); if( $size ) { @@ -293,18 +293,22 @@ class Xml { /** * Convenience function to build an HTML password input field - * @param $name value of the name attribute - * @param $size value of the size attribute - * @param $value value of the value attribute - * @param $attribs other attributes + * @param $name string value of the name attribute + * @param $size int value of the size attribute + * @param $value mixed value of the value attribute + * @param $attribs array other attributes * @return string HTML */ - public static function password( $name, $size=false, $value=false, $attribs=array() ) { - return self::input( $name, $size, $value, array_merge($attribs, array('type' => 'password'))); + public static function password( $name, $size = false, $value = false, $attribs = array() ) { + return self::input( $name, $size, $value, array_merge( $attribs, array( 'type' => 'password' ) ) ); } /** * Internal function for use in checkboxes and radio buttons and such. + * + * @param $name string + * @param $present bool + * * @return array */ public static function attrib( $name, $present = true ) { @@ -318,7 +322,7 @@ class Xml { * @param $attribs Array other attributes * @return string HTML */ - public static function check( $name, $checked=false, $attribs=array() ) { + public static function check( $name, $checked = false, $attribs=array() ) { return self::element( 'input', array_merge( array( 'name' => $name, @@ -336,7 +340,7 @@ class Xml { * @param $attribs other attributes * @return string HTML */ - public static function radio( $name, $value, $checked=false, $attribs=array() ) { + public static function radio( $name, $value, $checked = false, $attribs = array() ) { return self::element( 'input', array( 'name' => $name, 'type' => 'radio', @@ -347,17 +351,23 @@ class Xml { * Convenience function to build an HTML form label * @param $label String text of the label * @param $id - * @param $attribs Array an attribute array. This will usuall be + * @param $attribs Array an attribute array. This will usuall be * the same array as is passed to the corresponding input element, - * so this function will cherry-pick appropriate attributes to - * apply to the label as well; currently only class is applied. + * so this function will cherry-pick appropriate attributes to + * apply to the label as well; only class and title are applied. * @return string HTML */ - public static function label( $label, $id, $attribs=array() ) { + public static function label( $label, $id, $attribs = array() ) { $a = array( 'for' => $id ); + + # FIXME avoid copy pasting below: if( isset( $attribs['class'] ) ){ $a['class'] = $attribs['class']; } + if( isset( $attribs['title'] ) ){ + $a['title'] = $attribs['title']; + } + return self::element( 'label', $a, $label ); } @@ -366,20 +376,29 @@ class Xml { * @param $label String text of the label * @param $name String value of the name attribute * @param $id String id of the input - * @param $size value of the size attribute + * @param $size int value of the size attribute * @param $value value of the value attribute - * @param $attribs other attributes + * @param $attribs array other attributes * @return string HTML */ - public static function inputLabel( $label, $name, $id, $size=false, $value=false, $attribs=array() ) { + public static function inputLabel( $label, $name, $id, $size=false, $value=false, $attribs = array() ) { list( $label, $input ) = self::inputLabelSep( $label, $name, $id, $size, $value, $attribs ); return $label . ' ' . $input; } /** * Same as Xml::inputLabel() but return input and label in an array + * + * @param $label + * @param $name + * @param $id + * @param $size + * @param $value + * @param $attribs array + * + * @return array */ - public static function inputLabelSep( $label, $name, $id, $size=false, $value=false, $attribs=array() ) { + public static function inputLabelSep( $label, $name, $id, $size = false, $value = false, $attribs = array() ) { return array( Xml::label( $label, $id, $attribs ), self::input( $name, $size, $value, array( 'id' => $id ) + $attribs ) @@ -388,9 +407,16 @@ class Xml { /** * Convenience function to build an HTML checkbox with a label + * + * @param $label + * @param $name + * @param $id + * @param $checked bool + * @param $attribs array + * * @return string HTML */ - public static function checkLabel( $label, $name, $id, $checked=false, $attribs=array() ) { + public static function checkLabel( $label, $name, $id, $checked = false, $attribs = array() ) { return self::check( $name, $checked, array( 'id' => $id ) + $attribs ) . ' ' . self::label( $label, $id, $attribs ); @@ -398,9 +424,17 @@ class Xml { /** * Convenience function to build an HTML radio button with a label + * + * @param $label + * @param $name + * @param $value + * @param $id + * @param $checked bool + * @param $attribs array + * * @return string HTML */ - public static function radioLabel( $label, $name, $value, $id, $checked=false, $attribs=array() ) { + public static function radioLabel( $label, $name, $value, $id, $checked = false, $attribs = array() ) { return self::radio( $name, $value, $checked, array( 'id' => $id ) + $attribs ) . ' ' . self::label( $label, $id, $attribs ); @@ -412,18 +446,11 @@ class Xml { * @param $attribs Array: optional custom attributes * @return string HTML */ - public static function submitButton( $value, $attribs=array() ) { + public static function submitButton( $value, $attribs = array() ) { return Html::element( 'input', array( 'type' => 'submit', 'value' => $value ) + $attribs ); } /** - * @deprecated Synonymous to Html::hidden() - */ - public static function hidden( $name, $value, $attribs = array() ) { - return Html::hidden( $name, $value, $attribs ); - } - - /** * Convenience function to build an HTML drop-down list item. * @param $text String: text for this item * @param $value String: form submission value; if empty, use text @@ -431,8 +458,8 @@ class Xml { * @param $attribs array: optional additional HTML attributes * @return string HTML */ - public static function option( $text, $value=null, $selected=false, - $attribs=array() ) { + public static function option( $text, $value=null, $selected = false, + $attribs = array() ) { if( !is_null( $value ) ) { $attribs['value'] = $value; } @@ -446,14 +473,14 @@ class Xml { * Build a drop-down box from a textual list. * * @param $name Mixed: Name and id for the drop-down - * @param $class Mixed: CSS classes for the drop-down + * @param $list Mixed: Correctly formatted text (newline delimited) to be used to generate the options * @param $other Mixed: Text for the "Other reasons" option - * @param $list Mixed: Correctly formatted text to be used to generate the options * @param $selected Mixed: Option which should be pre-selected + * @param $class Mixed: CSS classes for the drop-down * @param $tabindex Mixed: Value of the tabindex attribute * @return string */ - public static function listDropDown( $name= '', $list = '', $other = '', $selected = '', $class = '', $tabindex = Null ) { + public static function listDropDown( $name= '', $list = '', $other = '', $selected = '', $class = '', $tabindex = null ) { $optgroup = false; $options = self::option( $other, 'other', $selected === 'other' ); @@ -504,7 +531,9 @@ class Xml { * * @param $legend Legend of the fieldset. If evaluates to false, legend is not added. * @param $content Pre-escaped content for the fieldset. If false, only open fieldset is returned. - * @param $attribs Any attributes to fieldset-element. + * @param $attribs array Any attributes to fieldset-element. + * + * @return string */ public static function fieldset( $legend = false, $content = false, $attribs = array() ) { $s = Xml::openElement( 'fieldset', $attribs ) . "\n"; @@ -522,11 +551,13 @@ class Xml { /** * Shortcut for creating textareas. * - * @param $name The 'name' for the textarea - * @param $content Content for the textarea - * @param $cols The number of columns for the textarea - * @param $rows The number of rows for the textarea - * @param $attribs Any other attributes for the textarea + * @param $name string The 'name' for the textarea + * @param $content string Content for the textarea + * @param $cols int The number of columns for the textarea + * @param $rows int The number of rows for the textarea + * @param $attribs array Any other attributes for the textarea + * + * @return string */ public static function textarea( $name, $content, $cols = 40, $rows = 5, $attribs = array() ) { return self::element( 'textarea', @@ -577,6 +608,10 @@ class Xml { * Arrays are converted to JS arrays, objects are converted to JS associative * arrays (objects). So cast your PHP associative arrays to objects before * passing them to here. + * + * @param $value + * + * @return string */ public static function encodeJsVar( $value ) { if ( is_bool( $value ) ) { @@ -617,13 +652,16 @@ class Xml { } /** - * Create a call to a JavaScript function. The supplied arguments will be - * encoded using Xml::encodeJsVar(). + * Create a call to a JavaScript function. The supplied arguments will be + * encoded using Xml::encodeJsVar(). * - * @param $name The name of the function to call, or a JavaScript expression + * @param $name String The name of the function to call, or a JavaScript expression * which evaluates to a function object which is called. * @param $args Array of arguments to pass to the function. + * * @since 1.17 + * + * @return string */ public static function encodeJsCall( $name, $args ) { $s = "$name("; @@ -733,9 +771,9 @@ class Xml { /** * Build a table of data - * @param $rows An array of arrays of strings, each to be a row in a table - * @param $attribs An array of attributes to apply to the table tag [optional] - * @param $headers An array of strings to use as table headers [optional] + * @param $rows array An array of arrays of strings, each to be a row in a table + * @param $attribs array An array of attributes to apply to the table tag [optional] + * @param $headers array An array of strings to use as table headers [optional] * @return string */ public static function buildTable( $rows, $attribs = array(), $headers = null ) { @@ -791,14 +829,25 @@ class XmlSelect { } } + /** + * @param $default + */ public function setDefault( $default ) { $this->default = $default; } + /** + * @param $name string + * @param $value + */ public function setAttribute( $name, $value ) { $this->attributes[$name] = $value; } + /** + * @param $name + * @return array|null + */ public function getAttribute( $name ) { if ( isset($this->attributes[$name]) ) { return $this->attributes[$name]; @@ -807,22 +856,36 @@ class XmlSelect { } } + /** + * @param $name + * @param $value bool + */ public function addOption( $name, $value = false ) { // Stab stab stab $value = ($value !== false) ? $value : $name; - $this->options[] = Xml::option( $name, $value, $value === $this->default ); + $this->options[] = array( $name => $value ); } - // This accepts an array of form - // label => value - // label => ( label => value, label => value ) + /** + * This accepts an array of form + * label => value + * label => ( label => value, label => value ) + * + * @param $options + */ public function addOptions( $options ) { - $this->options[] = trim(self::formatOptions( $options, $this->default )); + $this->options[] = $options; } - // This accepts an array of form - // label => value - // label => ( label => value, label => value ) + /** + * This accepts an array of form + * label => value + * label => ( label => value, label => value ) + * + * @param $options + * @param bool $default + * @return string + */ static function formatOptions( $options, $default = false ) { $data = ''; foreach( $options as $label => $value ) { @@ -837,15 +900,22 @@ class XmlSelect { return $data; } + /** + * @return string + */ public function getHTML() { - return Xml::tags( 'select', $this->attributes, implode( "\n", $this->options ) ); + $contents = ''; + foreach ( $this->options as $options ) { + $contents .= self::formatOptions( $options, $this->default ); + } + return Xml::tags( 'select', $this->attributes, rtrim( $contents ) ); } } /** - * A wrapper class which causes Xml::encodeJsVar() and Xml::encodeJsCall() to - * interpret a given string as being a JavaScript expression, instead of string + * A wrapper class which causes Xml::encodeJsVar() and Xml::encodeJsCall() to + * interpret a given string as being a JavaScript expression, instead of string * data. * * Example: |