http://www.mediawiki.org/wiki/Special:Code/MediaWiki/100197
Revision: 100197
Author: kaldari
Date: 2011-10-19 00:53:39 +0000 (Wed, 19 Oct 2011)
Log Message:
-----------
more accurate documentation for addValue() method
Modified Paths:
--------------
trunk/phase3/includes/api/ApiResult.php
Modified: trunk/phase3/includes/api/ApiResult.php
===================================================================
--- trunk/phase3/includes/api/ApiResult.php 2011-10-19 00:47:22 UTC (rev
100196)
+++ trunk/phase3/includes/api/ApiResult.php 2011-10-19 00:53:39 UTC (rev
100197)
@@ -246,11 +246,12 @@
/**
* 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
+ * @param $path array|string|null
* @param $name string
* @param $value mixed
* @param $overwrite bool
_______________________________________________
MediaWiki-CVS mailing list
MediaWiki-CVS@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-cvs
