From: Bartosz Dziewoński <matma.rex@gmail.com>
Date: Thu, 30 Jul 2015 21:03:19 +0000 (+0200)
Subject: XmlSelect: Tweak documentation
X-Git-Tag: 1.31.0-rc.0~10566
X-Git-Url: https://git.cyclocoop.org/%27.WWW_URL.%27admin/?a=commitdiff_plain;h=e0e15f2cadd76db6ec128495ef7ce9e4fb2a62c6;p=lhc%2Fweb%2Fwiklou.git

XmlSelect: Tweak documentation

Correct some variable names and types, also some words.

Change-Id: I7ff0664f7ac4f26be8427a2140e2280aa7620657
---

diff --git a/includes/XmlSelect.php b/includes/XmlSelect.php
index 1cd04ae10e..e765eedbc3 100644
--- a/includes/XmlSelect.php
+++ b/includes/XmlSelect.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * Class to generate XML <select>.
+ * Class for generating HTML <select> elements.
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -21,7 +21,7 @@
  */
 
 /**
- * Module of static functions for generating XML <select> elements
+ * Class for generating HTML <select> elements.
  */
 class XmlSelect {
 	protected $options = array();
@@ -51,7 +51,7 @@ class XmlSelect {
 
 	/**
 	 * @param string $name
-	 * @param array $value
+	 * @param string $value
 	 */
 	public function setAttribute( $name, $value ) {
 		$this->attributes[$name] = $value;
@@ -59,7 +59,7 @@ class XmlSelect {
 
 	/**
 	 * @param string $name
-	 * @return array|null
+	 * @return string|null
 	 */
 	public function getAttribute( $name ) {
 		if ( isset( $this->attributes[$name] ) ) {
@@ -70,14 +70,12 @@ class XmlSelect {
 	}
 
 	/**
-	 * @param string $name
-	 * @param bool $value
+	 * @param string $label
+	 * @param string $value If not given, assumed equal to $label
 	 */
-	public function addOption( $name, $value = false ) {
-		// Stab stab stab
-		$value = $value !== false ? $value : $name;
-
-		$this->options[] = array( $name => $value );
+	public function addOption( $label, $value = false ) {
+		$value = $value !== false ? $value : $label;
+		$this->options[] = array( $label => $value );
 	}
 
 	/**
@@ -92,12 +90,12 @@ class XmlSelect {
 	}
 
 	/**
-	 * This accepts an array of form
+	 * This accepts an array of form:
 	 * label => value
 	 * label => ( label => value, label => value )
 	 *
 	 * @param array $options
-	 * @param bool $default
+	 * @param string $default
 	 * @return string
 	 */
 	static function formatOptions( $options, $default = false ) {