Wikia code/includes/api/ApiResult.php
 | This page is obsolete. It is being retained for archival purposes. It may document extensions or features that are obsolete and/or no longer supported. Do not rely on the information here being up-to-date. The information shown below refers to the now unmaintained 1.16 MediaWiki release. The current stable release number is 1.42.3. |
--- D:\Programming\SVN\mediawiki\branches\REL1_16\phase3\includes\api\ApiResult.php 2011-07-18 22:31:07.039062500 +0100
+++ D:\Programming\SVN\wikia\trunk\includes\api\ApiResult.php 2011-08-17 15:28:14.253906200 +0100
@@ -1,11 +1,10 @@
<?php
-
-/*
- * Created on Sep 4, 2006
+/**
*
- * API for MediaWiki 1.8+
*
- * Copyright (C) 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
+ * Created on Sep 4, 2006
+ *
+ * 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
@@ -19,8 +18,10 @@
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
- * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
@@ -100,12 +101,14 @@
*/
public static function size( $value ) {
$s = 0;
- if ( is_array( $value ) )
- foreach ( $value as $v )
+ if ( is_array( $value ) ) {
+ foreach ( $value as $v ) {
$s += self::size( $v );
- else if ( !is_object( $value ) )
+ }
+ } elseif ( !is_object( $value ) ) {
// Objects can't always be cast to string
$s = strlen( $value );
+ }
return $s;
}
@@ -139,40 +142,46 @@
* @param $arr array to add $value to
* @param $name string Index of $arr to add $value at
* @param $value mixed
+ * @param $overwrite bool Whether overwriting an existing element is allowed
*/
- public static function setElement( & $arr, $name, $value ) {
- if ( $arr === null || $name === null || $value === null || !is_array( $arr ) || is_array( $name ) )
+ public static function setElement( &$arr, $name, $value, $overwrite = false ) {
+ if ( $arr === null || $name === null || $value === null || !is_array( $arr ) || is_array( $name ) ) {
ApiBase :: dieDebug( __METHOD__, 'Bad parameter' );
+ }
- if ( !isset ( $arr[$name] ) ) {
+ if ( !isset ( $arr[$name] ) || $overwrite ) {
$arr[$name] = $value;
- }
- elseif ( is_array( $arr[$name] ) && is_array( $value ) ) {
+ } elseif ( is_array( $arr[$name] ) && is_array( $value ) ) {
$merged = array_intersect_key( $arr[$name], $value );
- if ( !count( $merged ) )
+ if ( !count( $merged ) ) {
$arr[$name] += $value;
- else
+ } else {
ApiBase :: dieDebug( __METHOD__, "Attempting to merge element $name" );
- } else
+ }
+ } else {
ApiBase :: dieDebug( __METHOD__, "Attempting to add element $name=$value, existing value is {$arr[$name]}" );
}
+ }
/**
* Adds a content element to an array.
* Use this function instead of hardcoding the '*' element.
* @param $arr array to add the content element to
+ * @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
*/
public static function setContent( & $arr, $value, $subElemName = null ) {
- if ( is_array( $value ) )
+ if ( is_array( $value ) ) {
ApiBase :: dieDebug( __METHOD__, 'Bad parameter' );
+ }
if ( is_null( $subElemName ) ) {
ApiResult :: setElement( $arr, '*', $value );
} else {
- if ( !isset ( $arr[$subElemName] ) )
+ if ( !isset( $arr[$subElemName] ) ) {
$arr[$subElemName] = array ();
+ }
ApiResult :: setElement( $arr[$subElemName], '*', $value );
}
}
@@ -180,16 +189,18 @@
/**
* In case the array contains indexed values (in addition to named),
* give all indexed values the given tag name. This function MUST be
- * called on every arrray that has numerical indexes.
+ * called on every array that has numerical indexes.
* @param $arr array
* @param $tag string Tag name
*/
public function setIndexedTagName( & $arr, $tag ) {
// In raw mode, add the '_element', otherwise just ignore
- if ( !$this->getIsRawMode() )
+ if ( !$this->getIsRawMode() ) {
return;
- if ( $arr === null || $tag === null || !is_array( $arr ) || is_array( $tag ) )
+ }
+ if ( $arr === null || $tag === null || !is_array( $arr ) || is_array( $tag ) ) {
ApiBase :: dieDebug( __METHOD__, 'Bad parameter' );
+ }
// Do not use setElement() as it is ok to call this more than once
$arr['_element'] = $tag;
}
@@ -200,12 +211,13 @@
* @param $tag string Tag name
*/
public function setIndexedTagName_recursive( &$arr, $tag ) {
- if ( !is_array( $arr ) )
+ if ( !is_array( $arr ) ) {
return;
- foreach ( $arr as &$a )
- {
- if ( !is_array( $a ) )
+ }
+ foreach ( $arr as &$a ) {
+ if ( !is_array( $a ) ) {
continue;
+ }
$this->setIndexedTagName( $a, $tag );
$this->setIndexedTagName_recursive( $a, $tag );
}
@@ -226,50 +238,69 @@
}
$data = & $data[$p];
}
- if ( is_null( $data ) )
+ if ( is_null( $data ) ) {
return;
+ }
$this->setIndexedTagName( $data, $tag );
}
/**
* Add value to the output data at the given path.
- * Path is an indexed array, each element specifing the branch at which to add the new value
+ * 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
* @return bool True if $value fits in the result, false if not
*/
- public function addValue( $path, $name, $value ) {
+ public function addValue( $path, $name, $value, $overwrite = false ) {
global $wgAPIMaxResultSize;
$data = & $this->mData;
if ( $this->mCheckingSize ) {
$newsize = $this->mSize + self::size( $value );
- if ( $newsize > $wgAPIMaxResultSize )
+ if ( $newsize > $wgAPIMaxResultSize ) {
+ $this->setWarning(
+ "This result was truncated because it would otherwise be larger than the " .
+ "limit of {$wgAPIMaxResultSize} bytes" );
return false;
+ }
$this->mSize = $newsize;
}
if ( !is_null( $path ) ) {
if ( is_array( $path ) ) {
foreach ( $path as $p ) {
- if ( !isset ( $data[$p] ) )
+ if ( !isset( $data[$p] ) ) {
$data[$p] = array ();
+ }
$data = & $data[$p];
}
} else {
- if ( !isset ( $data[$path] ) )
+ if ( !isset( $data[$path] ) ) {
$data[$path] = array ();
+ }
$data = & $data[$path];
}
}
- if ( !$name )
+ if ( !$name ) {
$data[] = $value; // Add list element
- else
- ApiResult :: setElement( $data, $name, $value ); // Add named element
+ } else {
+ self::setElement( $data, $name, $value, $overwrite ); // Add named element
+ }
return true;
}
/**
+ * Add a parsed limit=max to the result.
+ *
+ * @param $moduleName string
+ * @param $limit int
+ */
+ public function setParsedLimit( $moduleName, $limit ) {
+ // Add value, allowing overwriting
+ $this->addValue( 'limits', $moduleName, $limit, true );
+ }
+
+ /**
* Unset a value previously added to the result set.
* Fails silently if the value isn't found.
* For parameters, see addValue()
@@ -278,12 +309,14 @@
*/
public function unsetValue( $path, $name ) {
$data = & $this->mData;
- if ( !is_null( $path ) )
+ if ( !is_null( $path ) ) {
foreach ( (array)$path as $p ) {
- if ( !isset( $data[$p] ) )
+ if ( !isset( $data[$p] ) ) {
return;
+ }
$data = & $data[$p];
}
+ }
$this->mSize -= self::size( $data[$name] );
unset( $data[$name] );
}
@@ -291,18 +324,17 @@
/**
* Ensure all values in this result are valid UTF-8.
*/
- public function cleanUpUTF8()
- {
+ public function cleanUpUTF8() {
array_walk_recursive( $this->mData, array( 'ApiResult', 'cleanUp_helper' ) );
}
/**
* Callback function for cleanUpUTF8()
*/
- private static function cleanUp_helper( &$s )
- {
- if ( !is_string( $s ) )
+ private static function cleanUp_helper( &$s ) {
+ if ( !is_string( $s ) ) {
return;
+ }
global $wgContLang;
$s = $wgContLang->normalize( $s );
}
@@ -312,6 +344,6 @@
}
public function getVersion() {
- return __CLASS__ . ': $Id: ApiResult.php 62354 2010-02-12 06:44:16Z mah $';
+ return __CLASS__ . ': $Id: ApiResult.php 78829 2010-12-22 20:52:06Z reedy $';
}
}