4 * Created on Sep 4, 2006
6 * API for MediaWiki 1.8+
8 * Copyright © 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License along
21 * with this program; if not, write to the Free Software Foundation, Inc.,
22 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
23 * http://www.gnu.org/copyleft/gpl.html
26 if ( !defined( 'MEDIAWIKI' ) ) {
27 // Eclipse helper - will be ignored in production
28 require_once( 'ApiBase.php' );
32 * This class represents the result of the API operations.
33 * It simply wraps a nested array() structure, adding some functions to simplify array's modifications.
34 * As various modules execute, they add different pieces of information to this result,
35 * structuring it as it will be given to the client.
37 * Each subarray may either be a dictionary - key-value pairs with unique keys,
38 * or lists, where the items are added using $data[] = $value notation.
40 * There are two special key values that change how XML output is generated:
41 * '_element' This key sets the tag name for the rest of the elements in the current array.
42 * It is only inserted if the formatter returned true for getNeedsRawData()
43 * '*' This key has special meaning only to the XML formatter, and is outputed as is
44 * for all others. In XML it becomes the content of the current element.
48 class ApiResult
extends ApiBase
{
50 private $mData, $mIsRawMode, $mSize, $mCheckingSize;
54 * @param $main ApiMain object
56 public function __construct( $main ) {
57 parent
::__construct( $main, 'result' );
58 $this->mIsRawMode
= false;
59 $this->mCheckingSize
= true;
64 * Clear the current result data.
66 public function reset() {
67 $this->mData
= array();
72 * Call this function when special elements such as '_element'
73 * are needed by the formatter, for example in XML printing.
75 public function setRawMode() {
76 $this->mIsRawMode
= true;
80 * Returns true whether the formatter requested raw data.
83 public function getIsRawMode() {
84 return $this->mIsRawMode
;
88 * Get the result's internal data array (read-only)
91 public function getData() {
96 * Get the 'real' size of a result item. This means the strlen() of the item,
97 * or the sum of the strlen()s of the elements if the item is an array.
101 public static function size( $value ) {
103 if ( is_array( $value ) ) {
104 foreach ( $value as $v ) {
105 $s +
= self
::size( $v );
107 } elseif ( !is_object( $value ) ) {
108 // Objects can't always be cast to string
109 $s = strlen( $value );
115 * Get the size of the result, i.e. the amount of bytes in it
118 public function getSize() {
123 * Disable size checking in addValue(). Don't use this unless you
124 * REALLY know what you're doing. Values added while size checking
125 * was disabled will not be counted (ever)
127 public function disableSizeCheck() {
128 $this->mCheckingSize
= false;
132 * Re-enable size checking in addValue()
134 public function enableSizeCheck() {
135 $this->mCheckingSize
= true;
139 * Add an output value to the array by name.
140 * Verifies that value with the same name has not been added before.
141 * @param $arr array to add $value to
142 * @param $name string Index of $arr to add $value at
143 * @param $value mixed
145 public static function setElement( &$arr, $name, $value ) {
146 if ( $arr === null ||
$name === null ||
$value === null ||
!is_array( $arr ) ||
is_array( $name ) ) {
147 ApiBase
::dieDebug( __METHOD__
, 'Bad parameter' );
150 if ( !isset ( $arr[$name] ) ) {
151 $arr[$name] = $value;
152 } elseif ( is_array( $arr[$name] ) && is_array( $value ) ) {
153 $merged = array_intersect_key( $arr[$name], $value );
154 if ( !count( $merged ) ) {
155 $arr[$name] +
= $value;
157 ApiBase
::dieDebug( __METHOD__
, "Attempting to merge element $name" );
160 ApiBase
::dieDebug( __METHOD__
, "Attempting to add element $name=$value, existing value is {$arr[$name]}" );
165 * Adds a content element to an array.
166 * Use this function instead of hardcoding the '*' element.
167 * @param $arr array to add the content element to
168 * @param $subElemName string when present, content element is created
169 * as a sub item of $arr. Use this parameter to create elements in
170 * format <elem>text</elem> without attributes
172 public static function setContent( &$arr, $value, $subElemName = null ) {
173 if ( is_array( $value ) ) {
174 ApiBase
::dieDebug( __METHOD__
, 'Bad parameter' );
176 if ( is_null( $subElemName ) ) {
177 ApiResult
::setElement( $arr, '*', $value );
179 if ( !isset( $arr[$subElemName] ) ) {
180 $arr[$subElemName] = array();
182 ApiResult
::setElement( $arr[$subElemName], '*', $value );
187 * In case the array contains indexed values (in addition to named),
188 * give all indexed values the given tag name. This function MUST be
189 * called on every arrray that has numerical indexes.
191 * @param $tag string Tag name
193 public function setIndexedTagName( &$arr, $tag ) {
194 // In raw mode, add the '_element', otherwise just ignore
195 if ( !$this->getIsRawMode() ) {
198 if ( $arr === null ||
$tag === null ||
!is_array( $arr ) ||
is_array( $tag ) )
200 ApiBase
::dieDebug( __METHOD__
, 'Bad parameter' );
202 // Do not use setElement() as it is ok to call this more than once
203 $arr['_element'] = $tag;
207 * Calls setIndexedTagName() on each sub-array of $arr
209 * @param $tag string Tag name
211 public function setIndexedTagName_recursive( &$arr, $tag ) {
212 if ( !is_array( $arr ) ) {
215 foreach ( $arr as &$a ) {
216 if ( !is_array( $a ) ) {
219 $this->setIndexedTagName( $a, $tag );
220 $this->setIndexedTagName_recursive( $a, $tag );
225 * Calls setIndexedTagName() on an array already in the result.
226 * Don't specify a path to a value that's not in the result, or
227 * you'll get nasty errors.
228 * @param $path array Path to the array, like addValue()'s $path
231 public function setIndexedTagName_internal( $path, $tag ) {
232 $data = &$this->mData
;
233 foreach ( (array)$path as $p ) {
234 if ( !isset( $data[$p] ) ) {
239 if ( is_null( $data ) ) {
242 $this->setIndexedTagName( $data, $tag );
246 * Add value to the output data at the given path.
247 * Path is an indexed array, each element specifing the branch at which to add the new value
248 * Setting $path to array('a','b','c') is equivalent to data['a']['b']['c'] = $value
249 * If $name is empty, the $value is added as a next list element data[] = $value
250 * @return bool True if $value fits in the result, false if not
252 public function addValue( $path, $name, $value ) {
253 global $wgAPIMaxResultSize;
254 $data = &$this->mData
;
255 if ( $this->mCheckingSize
) {
256 $newsize = $this->mSize + self
::size( $value );
257 if ( $newsize > $wgAPIMaxResultSize ) {
260 $this->mSize
= $newsize;
263 if ( !is_null( $path ) ) {
264 if ( is_array( $path ) ) {
265 foreach ( $path as $p ) {
266 if ( !isset( $data[$p] ) ) {
272 if ( !isset( $data[$path] ) ) {
273 $data[$path] = array();
275 $data = &$data[$path];
280 $data[] = $value; // Add list element
282 ApiResult
::setElement( $data, $name, $value ); // Add named element
288 * Unset a value previously added to the result set.
289 * Fails silently if the value isn't found.
290 * For parameters, see addValue()
292 * @param $name string
294 public function unsetValue( $path, $name ) {
295 $data = &$this->mData
;
296 if ( !is_null( $path ) ) {
297 foreach ( (array)$path as $p ) {
298 if ( !isset( $data[$p] ) ) {
304 $this->mSize
-= self
::size( $data[$name] );
305 unset( $data[$name] );
309 * Ensure all values in this result are valid UTF-8.
311 public function cleanUpUTF8() {
312 array_walk_recursive( $this->mData
, array( 'ApiResult', 'cleanUp_helper' ) );
316 * Callback function for cleanUpUTF8()
318 private static function cleanUp_helper( &$s ) {
319 if ( !is_string( $s ) ) {
323 $s = $wgContLang->normalize( $s );
326 public function execute() {
327 ApiBase
::dieDebug( __METHOD__
, 'execute() is not supported on Result object' );
330 public function getVersion() {
331 return __CLASS__
. ': $Id$';