X-Git-Url: https://git.cyclocoop.org/%27.WWW_URL.%27admin/?a=blobdiff_plain;f=includes%2FFormOptions.php;h=530b0946d76cd29766b3e23f69e06168df951a69;hb=2849d8a6b3542795d230515a600670533adb2692;hp=1cfe88e89133d038a6f97fe21679a92b49647166;hpb=8b08a7db916cc4e303e348fd2cb28f45bedc52cc;p=lhc%2Fweb%2Fwiklou.git

diff --git a/includes/FormOptions.php b/includes/FormOptions.php
index 1cfe88e891..530b0946d7 100644
--- a/includes/FormOptions.php
+++ b/includes/FormOptions.php
@@ -2,7 +2,7 @@
 /**
  * Helper class to keep track of options when mixing links and form elements.
  *
- * Copyright © 2008, Niklas Laxstiröm
+ * Copyright © 2008, Niklas Laxström
  * Copyright © 2011, Antoine Musso
  *
  * This program is free software; you can redistribute it and/or modify
@@ -104,7 +104,7 @@ class FormOptions implements ArrayAccess {
 	/**
 	 * Verify the given option name exist.
 	 *
-	 * @param $name String: option name
+	 * @param string $name option name
 	 * @param $strict Boolean: throw an exception when the option does not exist (default false)
 	 * @throws MWException
 	 * @return Boolean: true if option exist, false otherwise
@@ -123,7 +123,7 @@ class FormOptions implements ArrayAccess {
 	/**
 	 * Use to set the value of an option.
 	 *
-	 * @param $name String: option name
+	 * @param string $name option name
 	 * @param $value Mixed: value for the option
 	 * @param $force Boolean: whether to set the value when it is equivalent to the default value for this option (default false).
 	 * @return null
@@ -143,7 +143,7 @@ class FormOptions implements ArrayAccess {
 	 * Get the value for the given option name.
 	 * Internally use getValueReal()
 	 *
-	 * @param $name String: option name
+	 * @param string $name option name
 	 * @return Mixed
 	 */
 	public function getValue( $name ) {
@@ -154,7 +154,7 @@ class FormOptions implements ArrayAccess {
 
 	/**
 	 * @todo Document
-	 * @param $option Array: array structure describing the option
+	 * @param array $option array structure describing the option
 	 * @return Mixed. Value or the default value if it is null
 	 */
 	protected function getValueReal( $option ) {
@@ -168,7 +168,7 @@ class FormOptions implements ArrayAccess {
 	/**
 	 * Delete the option value.
 	 * This will make future calls to getValue()  return the default value.
-	 * @param $name String: option name
+	 * @param string $name option name
 	 * @return null
 	 */
 	public function reset( $name ) {
@@ -178,8 +178,9 @@ class FormOptions implements ArrayAccess {
 
 	/**
 	 * @todo Document
-	 * @param $name String: option name
-	 * @return null
+	 * @param string $name Option name
+	 * @throws MWException If option does not exist.
+	 * @return mixed Value or the default value if it is null.
 	 */
 	public function consumeValue( $name ) {
 		$this->validateName( $name, true );
@@ -190,7 +191,7 @@ class FormOptions implements ArrayAccess {
 
 	/**
 	 * @todo Document
-	 * @param $names Array: array of option names
+	 * @param array $names array of option names
 	 * @return null
 	 */
 	public function consumeValues( /*Array*/ $names ) {
@@ -209,9 +210,9 @@ class FormOptions implements ArrayAccess {
 	 * Validate and set an option integer value
 	 * The value will be altered to fit in the range.
 	 *
-	 * @param $name String: option name
-	 * @param $min Int: minimum value
-	 * @param $max Int: maximum value
+	 * @param string $name option name
+	 * @param int $min minimum value
+	 * @param int $max maximum value
 	 * @throws MWException
 	 * @exception MWException Option is not of type int
 	 * @return null
@@ -289,15 +290,19 @@ class FormOptions implements ArrayAccess {
 			$default = $this->options[$name]['default'];
 			$type = $this->options[$name]['type'];
 
-			switch( $type ) {
+			switch ( $type ) {
 				case self::BOOL:
-					$value = $r->getBool( $name, $default ); break;
+					$value = $r->getBool( $name, $default );
+					break;
 				case self::INT:
-					$value = $r->getInt( $name, $default ); break;
+					$value = $r->getInt( $name, $default );
+					break;
 				case self::STRING:
-					$value = $r->getText( $name, $default ); break;
+					$value = $r->getText( $name, $default );
+					break;
 				case self::INTNULL:
-					$value = $r->getIntOrNull( $name ); break;
+					$value = $r->getIntOrNull( $name );
+					break;
 				default:
 					throw new MWException( 'Unsupported datatype' );
 			}