Fix documentation comments for some WebRequest methods
authorRicordisamoa <ricordisamoa@openmailbox.org>
Mon, 20 Feb 2017 21:19:47 +0000 (22:19 +0100)
committerRicordisamoa <ricordisamoa@openmailbox.org>
Mon, 20 Feb 2017 21:25:02 +0000 (22:25 +0100)
WebRequest methods getRawVal(), getVal() and getArray()
can return null.

Change-Id: I555dfd93c7cdebc83aab89f3efe4de3018bc9de0

includes/WebRequest.php

index 3bbdc3f..78d7444 100644 (file)
@@ -408,7 +408,7 @@ class WebRequest {
         * @since 1.28
         * @param string $name
         * @param string|null $default Optional default
-        * @return string
+        * @return string|null
         */
        public function getRawVal( $name, $default = null ) {
                $name = strtr( $name, '.', '_' ); // See comment in self::getGPCVal()
@@ -432,7 +432,7 @@ class WebRequest {
         *
         * @param string $name
         * @param string $default Optional default (or null)
-        * @return string
+        * @return string|null
         */
        public function getVal( $name, $default = null ) {
                $val = $this->getGPCVal( $this->data, $name, $default );
@@ -482,7 +482,7 @@ class WebRequest {
         *
         * @param string $name
         * @param array $default Optional default (or null)
-        * @return array
+        * @return array|null
         */
        public function getArray( $name, $default = null ) {
                $val = $this->getGPCVal( $this->data, $name, $default );