fix merge of Iec98e472

[lhc/web/wiklou.git] / includes / api / ApiResult.php

diff --git a/includes/api/ApiResult.php b/includes/api/ApiResult.php
index 48cd5b1..91e2081 100644 (file)
--- a/includes/api/ApiResult.php
+++ b/includes/api/ApiResult.php
@@ -4,7 +4,7 @@
  *
  * Created on Sep 4, 2006
  *
- * Copyright © 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
+ * Copyright © 2006 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"
  *
  * 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
@@ -24,11 +24,6 @@
  * @file
  */
 
-if ( !defined( 'MEDIAWIKI' ) ) {
-       // Eclipse helper - will be ignored in production
-       require_once( 'ApiBase.php' );
-}
-
 /**
  * This class represents the result of the API operations.
  * It simply wraps a nested array() structure, adding some functions to simplify array's modifications.
@@ -170,7 +165,7 @@ class ApiResult extends ApiBase {
         * @param $value Mixed
         * @param $subElemName string when present, content element is created
         *  as a sub item of $arr. Use this parameter to create elements in
-        *  format <elem>text</elem> without attributes
+        *  format "<elem>text</elem>" without attributes.
         */
        public static function setContent( &$arr, $value, $subElemName = null ) {
                if ( is_array( $value ) ) {
@@ -246,13 +241,21 @@ class ApiResult extends ApiBase {
 
        /**
         * Add value to the output data at the given path.
-        * Path is an indexed array, each element specifying the branch at which to add the new value
-        * Setting $path to array('a','b','c') is equivalent to data['a']['b']['c'] = $value
-        * If $name is empty, the $value is added as a next list element data[] = $value
+        * Path can be an indexed array, each element specifying the branch at which to add the new
+        * value. Setting $path to array('a','b','c') is equivalent to data['a']['b']['c'] = $value.
+        * If $path is null, the value will be inserted at the data root.
+        * If $name is empty, the $value is added as a next list element data[] = $value.
+        *
+        * @param $path array|string|null
+        * @param $name string
+        * @param $value mixed
+        * @param $overwrite bool
+        *
         * @return bool True if $value fits in the result, false if not
         */
        public function addValue( $path, $name, $value, $overwrite = false ) {
                global $wgAPIMaxResultSize;
+
                $data = &$this->mData;
                if ( $this->mCheckingSize ) {
                        $newsize = $this->mSize + self::size( $value );
@@ -330,6 +333,8 @@ class ApiResult extends ApiBase {
 
        /**
         * Callback function for cleanUpUTF8()
+        *
+        * @param $s string
         */
        private static function cleanUp_helper( &$s ) {
                if ( !is_string( $s ) ) {
@@ -338,7 +343,6 @@ class ApiResult extends ApiBase {
                global $wgContLang;
                $s = $wgContLang->normalize( $s );
        }
-       
 
        /**
         * Converts a Status object to an array suitable for addValue
@@ -350,7 +354,7 @@ class ApiResult extends ApiBase {
                if ( $status->isGood() ) {
                        return array();
                }
-               
+
                $result = array();
                foreach ( $status->getErrorsByType( $errorType ) as $error ) {
                        $this->setIndexedTagName( $error['params'], 'param' );