4 * Created on Sep 4, 2006
6 * API for MediaWiki 1.8+
8 * Copyright (C) 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 );
106 else if ( !is_object( $value ) )
107 // Objects can't always be cast to string
108 $s = strlen( $value );
113 * Get the size of the result, i.e. the amount of bytes in it
116 public function getSize() {
121 * Disable size checking in addValue(). Don't use this unless you
122 * REALLY know what you're doing. Values added while size checking
123 * was disabled will not be counted (ever)
125 public function disableSizeCheck() {
126 $this->mCheckingSize
= false;
130 * Re-enable size checking in addValue()
132 public function enableSizeCheck() {
133 $this->mCheckingSize
= true;
137 * Add an output value to the array by name.
138 * Verifies that value with the same name has not been added before.
139 * @param $arr array to add $value to
140 * @param $name string Index of $arr to add $value at
141 * @param $value mixed
143 public static function setElement( & $arr, $name, $value ) {
144 if ( $arr === null ||
$name === null ||
$value === null ||
!is_array( $arr ) ||
is_array( $name ) )
145 ApiBase
:: dieDebug( __METHOD__
, 'Bad parameter' );
147 if ( !isset ( $arr[$name] ) ) {
148 $arr[$name] = $value;
150 elseif ( is_array( $arr[$name] ) && is_array( $value ) ) {
151 $merged = array_intersect_key( $arr[$name], $value );
152 if ( !count( $merged ) )
153 $arr[$name] +
= $value;
155 ApiBase
:: dieDebug( __METHOD__
, "Attempting to merge element $name" );
157 ApiBase
:: dieDebug( __METHOD__
, "Attempting to add element $name=$value, existing value is {$arr[$name]}" );
161 * Adds a content element to an array.
162 * Use this function instead of hardcoding the '*' element.
163 * @param $arr array to add the content element to
164 * @param $subElemName string when present, content element is created
165 * as a sub item of $arr. Use this parameter to create elements in
166 * format <elem>text</elem> without attributes
168 public static function setContent( & $arr, $value, $subElemName = null ) {
169 if ( is_array( $value ) )
170 ApiBase
:: dieDebug( __METHOD__
, 'Bad parameter' );
171 if ( is_null( $subElemName ) ) {
172 ApiResult
:: setElement( $arr, '*', $value );
174 if ( !isset ( $arr[$subElemName] ) )
175 $arr[$subElemName] = array ();
176 ApiResult
:: setElement( $arr[$subElemName], '*', $value );
181 * In case the array contains indexed values (in addition to named),
182 * give all indexed values the given tag name. This function MUST be
183 * called on every arrray that has numerical indexes.
185 * @param $tag string Tag name
187 public function setIndexedTagName( & $arr, $tag ) {
188 // In raw mode, add the '_element', otherwise just ignore
189 if ( !$this->getIsRawMode() )
191 if ( $arr === null ||
$tag === null ||
!is_array( $arr ) ||
is_array( $tag ) )
192 ApiBase
:: dieDebug( __METHOD__
, 'Bad parameter' );
193 // Do not use setElement() as it is ok to call this more than once
194 $arr['_element'] = $tag;
198 * Calls setIndexedTagName() on each sub-array of $arr
200 * @param $tag string Tag name
202 public function setIndexedTagName_recursive( &$arr, $tag )
204 if ( !is_array( $arr ) )
206 foreach ( $arr as &$a )
208 if ( !is_array( $a ) )
210 $this->setIndexedTagName( $a, $tag );
211 $this->setIndexedTagName_recursive( $a, $tag );
216 * Calls setIndexedTagName() on an array already in the result.
217 * Don't specify a path to a value that's not in the result, or
218 * you'll get nasty errors.
219 * @param $path array Path to the array, like addValue()'s $path
222 public function setIndexedTagName_internal( $path, $tag ) {
223 $data = & $this->mData
;
224 foreach ( (array)$path as $p ) {
225 if ( !isset( $data[$p] ) ) {
230 if ( is_null( $data ) )
232 $this->setIndexedTagName( $data, $tag );
236 * Add value to the output data at the given path.
237 * Path is an indexed array, each element specifing the branch at which to add the new value
238 * Setting $path to array('a','b','c') is equivalent to data['a']['b']['c'] = $value
239 * If $name is empty, the $value is added as a next list element data[] = $value
240 * @return bool True if $value fits in the result, false if not
242 public function addValue( $path, $name, $value ) {
243 global $wgAPIMaxResultSize;
244 $data = & $this->mData
;
245 if ( $this->mCheckingSize
) {
246 $newsize = $this->mSize + self
::size( $value );
247 if ( $newsize > $wgAPIMaxResultSize )
249 $this->mSize
= $newsize;
252 if ( !is_null( $path ) ) {
253 if ( is_array( $path ) ) {
254 foreach ( $path as $p ) {
255 if ( !isset ( $data[$p] ) )
256 $data[$p] = array ();
260 if ( !isset ( $data[$path] ) )
261 $data[$path] = array ();
262 $data = & $data[$path];
267 $data[] = $value; // Add list element
269 ApiResult
:: setElement( $data, $name, $value ); // Add named element
274 * Unset a value previously added to the result set.
275 * Fails silently if the value isn't found.
276 * For parameters, see addValue()
278 * @param $name string
280 public function unsetValue( $path, $name ) {
281 $data = & $this->mData
;
282 if ( !is_null( $path ) )
283 foreach ( (array)$path as $p ) {
284 if ( !isset( $data[$p] ) )
288 $this->mSize
-= self
::size( $data[$name] );
289 unset( $data[$name] );
293 * Ensure all values in this result are valid UTF-8.
295 public function cleanUpUTF8()
297 array_walk_recursive( $this->mData
, array( 'ApiResult', 'cleanUp_helper' ) );
301 * Callback function for cleanUpUTF8()
303 private static function cleanUp_helper( &$s )
305 if ( !is_string( $s ) )
308 $s = $wgContLang->normalize( $s );
311 public function execute() {
312 ApiBase
:: dieDebug( __METHOD__
, 'execute() is not supported on Result object' );
315 public function getVersion() {
316 return __CLASS__
. ': $Id$';
320 /* For compatibility with PHP versions < 5.1.0, define our own array_intersect_key function. */
321 if ( !function_exists( 'array_intersect_key' ) ) {
322 function array_intersect_key( $isec, $keys ) {
323 $argc = func_num_args();
326 for ( $i = 1; $isec && $i < $argc; $i++
) {
327 $arr = func_get_arg( $i );
329 foreach ( array_keys( $isec ) as $key ) {
330 if ( !isset( $arr[$key] ) )
331 unset( $isec[$key] );
338 foreach ( array_keys( $isec ) as $key ) {
339 if ( isset( $keys[$key] ) )
340 $res[$key] = $isec[$key];