* and converted to a space-separated string. In addition to a numerical
* array, the attribute value may also be an associative array. See the
* example below for how that works.
- * @example Numerical array
- * <code>
+ *
+ * @par Numerical array
+ * @code
* Html::element( 'em', array(
* 'class' => array( 'foo', 'bar' )
* ) );
* // gives '<em class="foo bar"></em>'
- * </code>
- * @example Associative array
- * <code>
+ * @endcode
+ *
+ * @par Associative array
+ * @code
* Html::element( 'em', array(
* 'class' => array( 'foo', 'bar', 'foo' => false, 'quux' => true )
* ) );
* // gives '<em class="bar quux"></em>'
- * </code>
+ * @endcode
*
* @param $attribs array Associative array of attributes, e.g., array(
* 'href' => 'http://www.mediawiki.org/' ). Values will be HTML-escaped.
}
/**
- * Output a <script> tag with the given contents. TODO: do some useful
- * escaping as well, like if $contents contains literal '</script>' or (for
- * XML) literal "]]>".
+ * Output a "<script>" tag with the given contents.
+ *
+ * @todo do some useful escaping as well, like if $contents contains
+ * literal "</script>" or (for XML) literal "]]>".
*
* @param $contents string JavaScript
* @return string Raw HTML
}
/**
- * Output a <script> tag linking to the given URL, e.g.,
- * <script src=foo.js></script>.
+ * Output a "<script>" tag linking to the given URL, e.g.,
+ * "<script src=foo.js></script>".
*
* @param $url string
* @return string Raw HTML
}
/**
- * Output a <style> tag with the given contents for the given media type
+ * Output a "<style>" tag with the given contents for the given media type
* (if any). TODO: do some useful escaping as well, like if $contents
- * contains literal '</style>' (admittedly unlikely).
+ * contains literal "</style>" (admittedly unlikely).
*
* @param $contents string CSS
* @param $media mixed A media type string, like 'screen'
}
/**
- * Output a <link rel=stylesheet> linking to the given URL for the given
+ * Output a "<link rel=stylesheet>" linking to the given URL for the given
* media type (if any).
*
* @param $url string
}
/**
- * Convenience function to produce an <input> element. This supports the
+ * Convenience function to produce an "<input>" element. This supports the
* new HTML5 input types and attributes, and will silently strip them if
* $wgHtml5 is false.
*
}
/**
- * Convenience function to produce an <input> element. This supports leaving
- * out the cols= and rows= which Xml requires and are required by HTML4/XHTML
- * but not required by HTML5 and will silently set cols="" and rows="" if
- * $wgHtml5 is false and cols and rows are omitted (HTML4 validates present
- * but empty cols="" and rows="" as valid).
+ * Convenience function to produce an "<input>" element.
+ *
+ * This supports leaving out the cols= and rows= which Xml requires and are
+ * required by HTML4/XHTML but not required by HTML5 and will silently set
+ * cols="" and rows="" if $wgHtml5 is false and cols and rows are omitted
+ * (HTML4 validates present but empty cols="" and rows="" as valid).
*
* @param $name string name attribute
* @param $value string value attribute
*
* @param $params array:
* - selected: [optional] Id of namespace which should be pre-selected
- * - all: [optional] Value of item for "all namespaces". If null or unset, <option> is omitted.
+ * - all: [optional] Value of item for "all namespaces". If null or unset, no "<option>" is generated to select all namespaces
* - label: text for label to add before the field
- * @param $selectAttribs array
- * @return string
+ * - exclude: [optional] Array of namespace ids to exclude
+ * - disable: [optional] Array of namespace ids for which the option should be disabled in the selector
+ * @param $selectAttribs array HTML attributes for the generated select element.
+ * - id: [optional], default: 'namespace'
+ * - name: [optional], default: 'namespace'
+ * @return string HTML code to select a namespace.
*/
public static function namespaceSelector( Array $params = array(), Array $selectAttribs = array() ) {
global $wgContLang;
- $selectAttribs = $selectAttribs + array(
- 'id' => 'namespace',
- 'name' => 'namespace',
- );
ksort( $selectAttribs );
+ // Is a namespace selected?
if ( isset( $params['selected'] ) ) {
// If string only contains digits, convert to clean int. Selected could also
// be "all" or "" etc. which needs to be left untouched.
if ( preg_match( '/^\d+$/', $params['selected'] ) ) {
$params['selected'] = intval( $params['selected'] );
}
+ // else: leaves it untouched for later processing
} else {
$params['selected'] = '';
}
+ if ( !isset( $params['exclude'] ) || !is_array( $params['exclude'] ) ) {
+ $params['exclude'] = array();
+ }
+ if ( !isset( $params['disable'] ) || !is_array( $params['disable'] ) ) {
+ $params['disable'] = array();
+ }
+
+ // Associative array between option-values and option-labels
$options = array();
+
if ( isset( $params['all'] ) ) {
- $options[$params['all']] = wfMsg( 'namespacesall' );
+ // add an option that would let the user select all namespaces.
+ // Value is provided by user, the name shown is localized for the user.
+ $options[$params['all']] = wfMessage( 'namespacesall' )->text();
}
+ // Add all namespaces as options (in the content langauge)
$options += $wgContLang->getFormattedNamespaces();
+ // Convert $options to HTML and filter out namespaces below 0
$optionsHtml = array();
foreach ( $options as $nsId => $nsName ) {
- if ( $nsId < NS_MAIN ) {
+ if ( $nsId < NS_MAIN || in_array( $nsId, $params['exclude'] ) ) {
continue;
}
if ( $nsId === 0 ) {
- $nsName = wfMsg( 'blanknamespace' );
+ // For other namespaces use use the namespace prefix as label, but for
+ // main we don't use "" but the user message descripting it (e.g. "(Main)" or "(Article)")
+ $nsName = wfMessage( 'blanknamespace' )->text();
}
- $optionsHtml[] = Xml::option( $nsName, $nsId, $nsId === $params['selected'] );
+ $optionsHtml[] = Html::element(
+ 'option', array(
+ 'disabled' => in_array( $nsId, $params['disable'] ),
+ 'value' => $nsId,
+ 'selected' => $nsId === $params['selected'],
+ ), $nsName
+ );
}
- $ret = Html::openElement( 'select', $selectAttribs )
+ $ret = '';
+ if ( isset( $params['label'] ) ) {
+ $ret .= Html::element(
+ 'label', array(
+ 'for' => isset( $selectAttribs['id'] ) ? $selectAttribs['id'] : null,
+ ), $params['label']
+ ) . ' ';
+ }
+
+ // Wrap options in a <select>
+ $ret .= Html::openElement( 'select', $selectAttribs )
. "\n"
. implode( "\n", $optionsHtml )
. "\n"
. Html::closeElement( 'select' );
- if ( isset( $params['label'] ) ) {
- $ret = Xml::label( $params['label'], $selectAttribs['id'] ) . ' ' . $ret;
- }
+
return $ret;
}
/**
* Get HTML for an info box with an icon.
*
- * @param $text String: wikitext, get this with wfMsgNoTrans()
+ * @param $text String: wikitext, get this with wfMessage()->plain()
* @param $icon String: icon name, file in skins/common/images
* @param $alt String: alternate text for the icon
* @param $class String: additional class name to add to the wrapper div
dépôts / lhc / web / wiklou.git / blobdiff