if( is_null( $attribs ) ) {
return null;
} elseif( is_array( $attribs ) ) {
- foreach( $attribs as $name => $val )
+ foreach( $attribs as $name => $val ) {
$out .= " {$name}=\"" . Sanitizer::encodeAttribute( $val ) . '"';
+ }
return $out;
} else {
throw new MWException( 'Expected attribute array, got something else in ' . __METHOD__ );
/**
* This opens an XML element
*
- * @param $element name of the element
+ * @param $element String name of the element
* @param $attribs array of attributes, see Xml::expandAttributes()
* @return string
*/
/**
* Shortcut to close an XML element
- * @param $element element name
+ * @param $element String element name
* @return string
*/
public static function closeElement( $element ) { return "</$element>"; }
* Same as Xml::element(), but does not escape contents. Handy when the
* content you have is already valid xml.
*
- * @param $element element name
+ * @param $element String element name
* @param $attribs array of attributes
- * @param $contents content of the element
+ * @param $contents String content of the element
* @return string
*/
public static function tags( $element, $attribs = null, $contents ) {
if( !is_null( $all ) )
$namespaces = array( $all => wfMsg( 'namespacesall' ) ) + $namespaces;
foreach( $namespaces as $index => $name ) {
- if( $index < NS_MAIN )
+ if( $index < NS_MAIN ) {
continue;
- if( $index === 0 )
+ }
+ if( $index === 0 ) {
$name = wfMsg( 'blanknamespace' );
+ }
$options[] = self::option( $name, $index, $index === $selected );
}
. "\n"
. Xml::closeElement( 'select' );
if ( !is_null( $label ) ) {
- $ret = Xml::label( $label, $element_name ) . ' ' . $ret;
+ $ret = Xml::label( $label, $element_name ) . ' ' . $ret;
}
return $ret;
}
}
if( $year ) {
$encYear = intval( $year );
- } else if( $encMonth ) {
+ } elseif( $encMonth ) {
$thisMonth = intval( gmdate( 'n' ) );
$thisYear = intval( gmdate( 'Y' ) );
if( intval($encMonth) > $thisMonth ) {
/**
*
- * @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 ) {
- global $wgContLanguageCode;
+ global $wgLanguageCode;
/**
* Make sure the site language is in the list; a custom language code
* might not have a defined name...
*/
$languages = Language::getLanguageNames( $customisedOnly );
- if( !array_key_exists( $wgContLanguageCode, $languages ) ) {
- $languages[$wgContLanguageCode] = $wgContLanguageCode;
+ if( !array_key_exists( $wgLanguageCode, $languages ) ) {
+ $languages[$wgLanguageCode] = $wgLanguageCode;
}
ksort( $languages );
* Otherwise, no default is selected and the user ends up
* with an Afrikaans interface since it's first in the list.
*/
- $selected = isset( $languages[$selected] ) ? $selected : $wgContLanguageCode;
+ $selected = isset( $languages[$selected] ) ? $selected : $wgLanguageCode;
$options = "\n";
foreach( $languages as $code => $name ) {
$options .= Xml::option( "$code - $name", $code, ($code == $selected) ) . "\n";
/**
* Shortcut to make a span element
- * @param $text content of the element, will be escaped
- * @param $class class name of the span element
- * @param $attribs other attributes
+ * @param $text String content of the element, will be escaped
+ * @param $class String class name of the span element
+ * @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 );
}
* 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 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 input( $name, $size=false, $value=false, $attribs=array() ) {
- $attributes = array();
+ public static function input( $name, $size = false, $value = false, $attribs = array() ) {
+ $attributes = array( 'name' => $name );
+
if( $size ) {
$attributes['size'] = $size;
}
- if( $value ) {
+ if( $value !== false ) { // maybe 0
$attributes['value'] = $value;
}
- $attributes['name'] = $name;
-
return self::element( 'input', $attributes + $attribs );
}
/**
* 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 ) {
/**
* Convenience function to build an HTML checkbox
- * @param $name value of the name attribute
- * @param $checked Whether the checkbox is checked or not
- * @param $attribs other attributes
+ * @param $name String value of the name attribute
+ * @param $checked Bool Whether the checkbox is checked or not
+ * @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,
* @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',
/**
* Convenience function to build an HTML form label
- * @param $label text of the label
+ * @param $label String text of the label
* @param $id
- * @param $attribs Array, other attributes
+ * @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; 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 );
}
/**
* Convenience function to build an HTML text input field with a label
- * @param $label text of the label
- * @param $name value of the name attribute
- * @param $id id of the input
- * @param $size value of the size attribute
+ * @param $label String text of the label
+ * @param $name String value of the name attribute
+ * @param $id String id of the input
+ * @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;
+ 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 )
/**
* 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 );
}
/**
* 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 );
}
* @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 $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;
}
* 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 ) {
- $options = '';
+ public static function listDropDown( $name= '', $list = '', $other = '', $selected = '', $class = '', $tabindex = null ) {
$optgroup = false;
$options = self::option( $other, 'other', $selected === 'other' );
$optgroup = false;
}
}
+
if( $optgroup ) $options .= self::closeElement('optgroup');
$attribs = array();
+
if( $name ) {
$attribs['id'] = $name;
$attribs['name'] = $name;
}
+
if( $class ) {
$attribs['class'] = $class;
}
+
if( $tabindex ) {
$attribs['tabindex'] = $tabindex;
}
+
return Xml::openElement( 'select', $attribs )
. "\n"
. $options
*
* @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";
+
if ( $legend ) {
$s .= Xml::element( 'legend', null, $legend ) . "\n";
}
+
if ( $content !== false ) {
$s .= $content . "\n";
$s .= Xml::closeElement( 'fieldset' ) . "\n";
/**
* 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',
"\xe2\x80\x8c" => "\\u200c", // ZERO WIDTH NON-JOINER
"\xe2\x80\x8d" => "\\u200d", // ZERO WIDTH JOINER
);
+
return strtr( $string, $pairs );
}
* 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 ) ) {
$s = $value ? 'true' : 'false';
} elseif ( is_null( $value ) ) {
$s = 'null';
- } elseif ( is_int( $value ) ) {
- $s = $value;
+ } elseif ( is_int( $value ) || is_float( $value ) ) {
+ $s = strval($value);
} elseif ( is_array( $value ) && // Make sure it's not associative.
array_keys($value) === range( 0, count($value) - 1 ) ||
count($value) == 0
$s .= self::encodeJsVar( $elt );
}
$s .= ']';
+ } elseif ( $value instanceof XmlJsCode ) {
+ $s = $value->value;
} elseif ( is_object( $value ) || is_array( $value ) ) {
// Objects and associative arrays
$s = '{';
if ( $s != '{' ) {
$s .= ', ';
}
+
$s .= '"' . self::escapeJsString( $name ) . '": ' .
self::encodeJsVar( $elt );
}
return $s;
}
+ /**
+ * Create a call to a JavaScript function. The supplied arguments will be
+ * encoded using Xml::encodeJsVar().
+ *
+ * @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(";
+ $first = true;
+
+ foreach ( $args as $arg ) {
+ if ( $first ) {
+ $first = false;
+ } else {
+ $s .= ', ';
+ }
+
+ $s .= Xml::encodeJsVar( $arg );
+ }
+
+ $s .= ");\n";
+
+ return $s;
+ }
/**
* Check if a string is well-formed XML.
xml_parser_free( $parser );
return false;
}
+
xml_parser_free( $parser );
+
return true;
}
'<html>' .
$text .
'</html>';
+
return Xml::isWellFormed( $html );
}
/**
* Generate a form (without the opening form element).
* Output optionally includes a submit button.
- * @param $fields Associative array, key is message corresponding to a description for the field (colon is in the message), value is appropriate input.
- * @param $submitLabel A message containing a label for the submit button.
+ * @param $fields Array Associative array, key is message corresponding to a description for the field (colon is in the message), value is appropriate input.
+ * @param $submitLabel String A message containing a label for the submit button.
* @return string HTML form.
*/
public static function buildForm( $fields, $submitLabel = null ) {
$form .= "</tbody></table>";
-
return $form;
}
/**
* 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 ) {
$s = Xml::openElement( 'table', $attribs );
+
if ( is_array( $headers ) ) {
+ $s .= Xml::openElement( 'thead', $attribs );
+
foreach( $headers as $id => $header ) {
$attribs = array();
- if ( is_string( $id ) ) $attribs['id'] = $id;
+
+ if ( is_string( $id ) ) {
+ $attribs['id'] = $id;
+ }
+
$s .= Xml::element( 'th', $attribs, $header );
}
+ $s .= Xml::closeElement( 'thead' );
}
+
foreach( $rows as $id => $row ) {
$attribs = array();
- if ( is_string( $id ) ) $attribs['id'] = $id;
+
+ if ( is_string( $id ) ) {
+ $attribs['id'] = $id;
+ }
+
$s .= Xml::buildTableRow( $attribs, $row );
}
+
$s .= Xml::closeElement( 'table' );
+
return $s;
}
/**
* Build a row for a table
- * @param $attribs An array of attributes to apply to the tr tag
- * @param $cells An array of strings to put in <td>
+ * @param $attribs array An array of attributes to apply to the tr tag
+ * @param $cells array An array of strings to put in <td>
* @return string
*/
public static function buildTableRow( $attribs, $cells ) {
$s = Xml::openElement( 'tr', $attribs );
+
foreach( $cells as $id => $cell ) {
+
$attribs = array();
- if ( is_string( $id ) ) $attribs['id'] = $id;
+
+ if ( is_string( $id ) ) {
+ $attribs['id'] = $id;
+ }
+
$s .= Xml::element( 'td', $attribs, $cell );
}
+
$s .= Xml::closeElement( 'tr' );
+
return $s;
}
}
protected $attributes = array();
public function __construct( $name = false, $id = false, $default = false ) {
- if ( $name ) $this->setAttribute( 'name', $name );
- if ( $id ) $this->setAttribute( 'id', $id );
- if ( $default !== false ) $this->default = $default;
+ if ( $name ) {
+ $this->setAttribute( 'name', $name );
+ }
+
+ if ( $id ) {
+ $this->setAttribute( 'id', $id );
+ }
+
+ if ( $default !== false ) {
+ $this->default = $default;
+ }
}
+ /**
+ * @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];
}
}
+ /**
+ * @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 ) {
if ( is_array( $value ) ) {
$contents = self::formatOptions( $value, $default );
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
+ * data.
+ *
+ * Example:
+ *
+ * Xml::encodeJsVar( new XmlJsCode( 'a + b' ) );
+ *
+ * Returns "a + b".
+ * @since 1.17
+ */
+class XmlJsCode {
+ public $value;
+
+ function __construct( $value ) {
+ $this->value = $value;
+ }
}
dépôts / lhc / web / wiklou.git / blobdiff