Thijs/wiki.techinc.nl
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Improve Html/Xml element generation docs

Browse source 
Corrects some docs to match actual behavior + clarifies what
syntax is allowed for attributes.

Change-Id: I45b27bc4d536063c508d902f592ad4d0dc265ed3
This commit is contained in:
Gergő Tisza 2017-03-01 16:13:29 -08:00
parent 5346a4410f
commit 72d1859b94
2 changed files with 11 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
includes/Html.php
View file

@ -220,8 +220,10 @@ class Html {
* Identical to rawElement(), but HTML-escapes $contents (like * Identical to rawElement(), but HTML-escapes $contents (like
* Xml::element()). * Xml::element()).
* *
* @param string $element * @param string $element Name of the element, e.g., 'a'
* @param array $attribs * @param array $attribs Associative array of attributes, e.g., [
* 'href' => 'https://www.mediawiki.org/' ]. See expandAttributes() for
* further documentation.
* @param string $contents * @param string $contents
* *
* @return string * @return string
@ -239,8 +241,10 @@ class Html {
* Identical to rawElement(), but has no third parameter and omits the end * Identical to rawElement(), but has no third parameter and omits the end
* tag (and the self-closing '/' in XML mode for empty elements). * tag (and the self-closing '/' in XML mode for empty elements).
* *
* @param string $element * @param string $element Name of the element, e.g., 'a'
* @param array $attribs * @param array $attribs Associative array of attributes, e.g., [
* 'href' => 'https://www.mediawiki.org/' ]. See expandAttributes() for
* further documentation.
* *
* @return string * @return string
*/ */
@ -459,7 +463,7 @@ class Html {
* *
* @param array $attribs Associative array of attributes, e.g., [ * @param array $attribs Associative array of attributes, e.g., [
* 'href' => 'https://www.mediawiki.org/' ]. Values will be HTML-escaped. * 'href' => 'https://www.mediawiki.org/' ]. Values will be HTML-escaped.
* A value of false means to omit the attribute. For boolean attributes, * A value of false or null means to omit the attribute. For boolean attributes,
* you can omit the key, e.g., [ 'checked' ] instead of * you can omit the key, e.g., [ 'checked' ] instead of
* [ 'checked' => 'checked' ] or such. * [ 'checked' => 'checked' ] or such.
* *

4
includes/Xml.php
View file

@ -59,8 +59,8 @@ class Xml {
* Given an array of ('attributename' => 'value'), it generates the code * Given an array of ('attributename' => 'value'), it generates the code
* to set the XML attributes : attributename="value". * to set the XML attributes : attributename="value".
* The values are passed to Sanitizer::encodeAttribute. * The values are passed to Sanitizer::encodeAttribute.
* Return null if no attributes given. * Returns null or empty string if no attributes given.
* @param array $attribs Array of attributes for an XML element * @param array|null $attribs Array of attributes for an XML element
* @throws MWException * @throws MWException
* @return null|string * @return null|string
*/ */