5 * Created on Sep 4, 2006
7 * API for MediaWiki 1.8+
9 * Copyright (C) 2006 Yuri Astrakhan <FirstnameLastname@gmail.com>
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License along
22 * with this program; if not, write to the Free Software Foundation, Inc.,
23 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
24 * http://www.gnu.org/copyleft/gpl.html
27 if (!defined('MEDIAWIKI')) {
28 // Eclipse helper - will be ignored in production
29 require_once ("ApiBase.php");
32 class ApiResult
extends ApiBase
{
39 public function __construct($main) {
40 parent
:: __construct($main);
44 public function Reset() {
45 $this->mData
= array();
52 function AddMessage($mainSection, $subSection, $value, $multiitem = false, $preserveXmlSpacing = false) {
53 if (!array_key_exists($mainSection, $this->mData
)) {
54 $this->mData
[$mainSection] = array ();
56 if ($subSection !== null) {
57 if (!array_key_exists($subSection, $this->mData
[$mainSection])) {
58 $this->mData
[$mainSection][$subSection] = array ();
60 $element = & $this->mData
[$mainSection][$subSection];
62 $element = & $this->mData
[$mainSection];
65 $element['_element'] = $multiitem;
68 if (is_array($value)) {
69 $element = array_merge($element, $value);
70 if (!array_key_exists('*', $element)) {
74 if (array_key_exists('*', $element)) {
75 $element['*'] .= $value;
77 $element['*'] = $value;
79 if ($preserveXmlSpacing) {
80 $element['xml:space'] = 'preserve';
87 * Recursivelly removes any elements from the array that begin with an '_'.
88 * The content element '*' is the only special element that is left.
89 * Use this method when the entire data object gets sent to the user.
91 public function SanitizeData() {
92 ApiResult
:: SanitizeDataInt($this->mData
);
95 private static function SanitizeDataInt(& $data) {
96 foreach ($data as $key => & $value) {
97 if ($key[0] === '_') {
100 elseif ($key === '*' && $value === '') {
103 elseif (is_array($value)) {
104 ApiResult
:: SanitizeDataInt($value);
109 public function Execute() {
110 $this->DieDebug("Execute() is not supported on Result object");