* Strings are assumed to not contain XML-illegal characters; special
* characters (<, >, &) are escaped but illegals are not touched.
*
- * @param string $element element name
+ * @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
+ * @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
*/
public static function element( $element, $attribs = null, $contents = '', $allowShortTag = true ) {
* to set the XML attributes : attributename="value".
* The values are passed to Sanitizer::encodeAttribute.
* Return null if no attributes given.
- * @param array $attribs of attributes for an XML element
+ * @param array $attribs Array of attributes for an XML element
* @throws MWException
* @return null|string
*/
* $wgContLang->normalize() validator first to ensure that no invalid UTF-8
* is passed.
*
- * @param $element String:
+ * @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)
+ * @param string $contents Null to make an open tag only; '' for a contentless closed tag (default)
* @return string
*/
public static function elementClean( $element, $attribs = array(), $contents = '' ) {
/**
* This opens an XML element
*
- * @param string $element name of the element
- * @param array $attribs of attributes, see Xml::expandAttributes()
+ * @param string $element Name of the element
+ * @param array $attribs Array of attributes, see Xml::expandAttributes()
* @return string
*/
public static function openElement( $element, $attribs = null ) {
/**
* Shortcut to close an XML element
- * @param string $element element name
+ * @param string $element Element name
* @return string
*/
public static function closeElement( $element ) {
* 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 of attributes
- * @param string $contents content of the element
+ * @param string $element Element name
+ * @param array $attribs Array of attributes
+ * @param string $contents Content of the element
* @return string
*/
public static function tags( $element, $attribs = null, $contents ) {
/**
* Build a drop-down box for selecting a namespace
*
- * @param $selected Mixed: Namespace which should be pre-selected
- * @param $all Mixed: Value of an item denoting all namespaces, or null to omit
- * @param $element_name String: value of the "name" attribute of the select tag
- * @param string $label optional label to add to the field
+ * @param string $selected Namespace which should be pre-selected
+ * @param string|null $all Value of an item denoting all namespaces, or null to omit
+ * @param string $element_name Value of the "name" attribute of the select tag
+ * @param string $label Optional label to add to the field
* @return string
* @deprecated since 1.19
*/
/**
* Create a date selector
*
- * @param $selected Mixed: the month which should be selected, default ''
- * @param string $allmonths value of a special item denoting all month. Null to not include (default)
+ * @param string $selected The month which should be selected, default ''
+ * @param string $allmonths Value of a special item denoting all month. Null to not include (default)
* @param string $id Element identifier
- * @return String: Html string containing the month selector
+ * @return string Html string containing the month selector
*/
public static function monthSelector( $selected = '', $allmonths = null, $id = 'month' ) {
global $wgLang;
}
/**
- * @param $year Integer
- * @param $month Integer
+ * @param int $year
+ * @param int $month
* @return string Formatted HTML
*/
public static function dateMenu( $year, $month ) {
* Construct a language selector appropriate for use in a form or preferences
*
* @param string $selected The language code of the selected language
- * @param boolean $customisedOnly If true only languages which have some content are listed
+ * @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)
/**
* 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
+ * @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
*/
public static function span( $text, $class, $attribs = array() ) {
/**
* 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
+ * @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
*/
public static function wrapClass( $text, $class, $tag = 'span', $attribs = array() ) {
/**
* 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 $value mixed value of the value attribute
- * @param array $attribs other attributes
+ * @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
*/
public static function input( $name, $size = false, $value = false, $attribs = array() ) {
/**
* 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 $value mixed value of the value attribute
- * @param array $attribs other attributes
+ * @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
*/
public static function password( $name, $size = false, $value = false, $attribs = array() ) {
/**
* Internal function for use in checkboxes and radio buttons and such.
*
- * @param $name string
- * @param $present bool
+ * @param string $name
+ * @param bool $present
*
* @return array
*/
/**
* Convenience function to build an HTML checkbox
- * @param string $name value of the name attribute
+ * @param string $name Value of the name attribute
* @param bool $checked Whether the checkbox is checked or not
- * @param array $attribs other attributes
+ * @param array $attribs Array other attributes
* @return string HTML
*/
public static function check( $name, $checked = false, $attribs = array() ) {
/**
* 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 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
+ * @param array $attribs Other attributes
* @return string HTML
*/
public static function radio( $name, $value, $checked = false, $attribs = array() ) {
/**
* Convenience function to build an HTML form label
- * @param string $label text of the label
- * @param $id
- * @param array $attribs an attribute array. This will usually be
+ * @param string $label Text of the label
+ * @param string $id
+ * @param array $attribs An attribute array. This will usually 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.
/**
* 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
+ * @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
*/
public static function inputLabel( $label, $name, $id, $size = false, $value = false, $attribs = array() ) {
/**
* Same as Xml::inputLabel() but return input and label in an array
*
- * @param $label String
- * @param $name String
- * @param $id String
- * @param $size Int|Bool
- * @param $value String|Bool
- * @param $attribs array
+ * @param string $label
+ * @param string $name
+ * @param string $id
+ * @param int|bool $size
+ * @param string|bool $value
+ * @param array $attribs
*
* @return array
*/
/**
* Convenience function to build an HTML checkbox with a label
*
- * @param $label
- * @param $name
- * @param $id
- * @param $checked bool
- * @param $attribs array
+ * @param string $label
+ * @param string $name
+ * @param string $id
+ * @param bool $checked
+ * @param array $attribs
*
* @return string HTML
*/
/**
* 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
+ * @param string $label
+ * @param string $name
+ * @param string $value
+ * @param string $id
+ * @param bool $checked
+ * @param array $attribs
*
* @return string HTML
*/
/**
* Convenience function to build an HTML submit button
- * @param string $value label text for the button
- * @param array $attribs optional custom attributes
+ * @param string $value Label text for the button
+ * @param array $attribs Optional custom attributes
* @return string HTML
*/
public static function submitButton( $value, $attribs = array() ) {
/**
* 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 $selected boolean: if true, will be the default selected item
- * @param array $attribs optional additional HTML attributes
+ * @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
*/
public static function option( $text, $value = null, $selected = false,
/**
* Build a drop-down box from a textual list.
*
- * @param $name Mixed: Name and id 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 $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
+ * @param string $name Name and id for the drop-down
+ * @param string $list Correctly formatted text (newline delimited) to be used to generate the options
+ * @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
*/
public static function listDropDown( $name = '', $list = '', $other = '', $selected = '', $class = '', $tabindex = null ) {
$options = self::option( $other, 'other', $selected === 'other' );
foreach ( explode( "\n", $list ) as $option ) {
- $value = trim( $option );
- if ( $value == '' ) {
- continue;
- } elseif ( substr( $value, 0, 1 ) == '*' && substr( $value, 1, 1 ) != '*' ) {
- // A new group is starting ...
- $value = trim( substr( $value, 1 ) );
- if ( $optgroup ) {
- $options .= self::closeElement( 'optgroup' );
- }
- $options .= self::openElement( 'optgroup', array( 'label' => $value ) );
- $optgroup = true;
- } elseif ( substr( $value, 0, 2 ) == '**' ) {
- // groupmember
- $value = trim( substr( $value, 2 ) );
- $options .= self::option( $value, $value, $selected === $value );
- } else {
- // groupless reason list
- if ( $optgroup ) {
- $options .= self::closeElement( 'optgroup' );
- }
- $options .= self::option( $value, $value, $selected === $value );
- $optgroup = false;
+ $value = trim( $option );
+ if ( $value == '' ) {
+ continue;
+ } elseif ( substr( $value, 0, 1 ) == '*' && substr( $value, 1, 1 ) != '*' ) {
+ // A new group is starting ...
+ $value = trim( substr( $value, 1 ) );
+ if ( $optgroup ) {
+ $options .= self::closeElement( 'optgroup' );
}
+ $options .= self::openElement( 'optgroup', array( 'label' => $value ) );
+ $optgroup = true;
+ } elseif ( substr( $value, 0, 2 ) == '**' ) {
+ // groupmember
+ $value = trim( substr( $value, 2 ) );
+ $options .= self::option( $value, $value, $selected === $value );
+ } else {
+ // groupless reason list
+ if ( $optgroup ) {
+ $options .= self::closeElement( 'optgroup' );
+ }
+ $options .= self::option( $value, $value, $selected === $value );
+ $optgroup = false;
}
+ }
- if ( $optgroup ) {
- $options .= self::closeElement( 'optgroup' );
- }
+ if ( $optgroup ) {
+ $options .= self::closeElement( 'optgroup' );
+ }
$attribs = array();
* Illegal control characters are assumed not to be present.
*
* @deprecated since 1.21; use Xml::encodeJsVar() or Xml::encodeJsCall() instead
- * @param string $string to escape
- * @return String
+ * @param string $string String to escape
+ * @return string
*/
public static function escapeJsString( $string ) {
// See ECMA 262 section 7.8.4 for string literal format
*
* @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
+ * @return string|bool String if successful; false upon failure
*/
public static function encodeJsVar( $value, $pretty = false ) {
if ( $value instanceof XmlJsCode ) {
* which evaluates to a function object which is called.
* @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
+ * @return string|bool String if successful; false upon failure
*/
public static function encodeJsCall( $name, $args, $pretty = false ) {
foreach ( $args as &$arg ) {
* Check if a string is well-formed XML.
* Must include the surrounding tag.
*
- * @param string $text string to test.
+ * @param string $text String to test.
* @return bool
*
* @todo Error position reporting return
* Wraps fragment in an \<html\> bit and doctype, so it can be a fragment
* and can use HTML named entities.
*
- * @param $text String:
+ * @param string $text
* @return bool
*/
public static function isWellFormedXmlFragment( $text ) {
* Replace " > and < with their respective HTML entities ( ",
* >, <)
*
- * @param string $in text that might contain HTML tags.
+ * @param string $in Text that might contain HTML tags.
* @return string Escaped string
*/
public static function escapeTagsOnly( $in ) {
}
/**
- * @param $default
+ * @param string $default
*/
public function setDefault( $default ) {
$this->default = $default;
}
/**
- * @param $name string
- * @param $value
+ * @param string $name
+ * @param array $value
*/
public function setAttribute( $name, $value ) {
$this->attributes[$name] = $value;
}
/**
- * @param $name
+ * @param string $name
* @return array|null
*/
public function getAttribute( $name ) {
}
/**
- * @param $name
- * @param $value bool
+ * @param string $name
+ * @param bool $value
*/
public function addOption( $name, $value = false ) {
// Stab stab stab
* label => value
* label => ( label => value, label => value )
*
- * @param $options
+ * @param array $options
*/
public function addOptions( $options ) {
$this->options[] = $options;
* label => value
* label => ( label => value, label => value )
*
- * @param $options
+ * @param array $options
* @param bool $default
* @return string
*/
dépôts / lhc / web / wiklou.git / blobdiff