1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
|
<?php
/*
* Created on Sep 4, 2006
*
* API for MediaWiki 1.8+
*
* Copyright (C) 2006 Yuri Astrakhan <FirstnameLastname@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
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* 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.
* http://www.gnu.org/copyleft/gpl.html
*/
if (!defined('MEDIAWIKI')) {
// Eclipse helper - will be ignored in production
require_once ('ApiBase.php');
}
/**
* @addtogroup API
*/
class ApiResult extends ApiBase {
private $mData, $mIsRawMode;
/**
* Constructor
*/
public function __construct($main) {
parent :: __construct($main, 'result');
$this->mIsRawMode = false;
$this->reset();
}
public function reset() {
$this->mData = array ();
}
/**
* Call this function when special elements such as '_element'
* are needed by the formatter, for example in XML printing.
*/
public function setRawMode() {
$this->mIsRawMode = true;
}
public function getIsRawMode() {
return $this->mIsRawMode;
}
public function & getData() {
return $this->mData;
}
/**
* Add an output value to the array by name.
* Verifies that value with the same name has not been added before.
*/
public static function setElement(& $arr, $name, $value) {
if ($arr === null || $name === null || $value === null || !is_array($arr) || is_array($name))
ApiBase :: dieDebug(__METHOD__, 'Bad parameter');
if (!isset ($arr[$name])) {
$arr[$name] = $value;
}
elseif (is_array($arr[$name]) && is_array($value)) {
$merged = array_intersect_key($arr[$name], $value);
if (empty ($merged))
$arr[$name] += $value;
else
ApiBase :: dieDebug(__METHOD__, "Attempting to merge element $name");
} else
ApiBase :: dieDebug(__METHOD__, "Attempting to add element $name=$value, existing value is {$arr[$name]}");
}
/**
* Adds the content element to the array.
* Use this function instead of hardcoding the '*' element.
* @param string $subElemName when present, content element is created as a sub item of the 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))
ApiBase :: dieDebug(__METHOD__, 'Bad parameter');
if (is_null($subElemName)) {
ApiResult :: setElement($arr, '*', $value);
} else {
if (!isset ($arr[$subElemName]))
$arr[$subElemName] = array ();
ApiResult :: setElement($arr[$subElemName], '*', $value);
}
}
// public static function makeContentElement($tag, $value) {
// $result = array();
// ApiResult::setContent($result, )
// }
//
/**
* In case the array contains indexed values (in addition to named),
* all indexed values will have the given tag name.
*/
public function setIndexedTagName(& $arr, $tag) {
// In raw mode, add the '_element', otherwise just ignore
if (!$this->getIsRawMode())
return;
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;
}
/**
* 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
* Setting $path to array('a','b','c') is equivalent to data['a']['b']['c'] = $value
*/
public function addValue($path, $name, $value) {
$data = & $this->getData();
if (!is_null($path)) {
if (is_array($path)) {
foreach ($path as $p) {
if (!isset ($data[$p]))
$data[$p] = array ();
$data = & $data[$p];
}
} else {
if (!isset ($data[$path]))
$data[$path] = array ();
$data = & $data[$path];
}
}
ApiResult :: setElement($data, $name, $value);
}
public function execute() {
ApiBase :: dieDebug(__METHOD__, 'execute() is not supported on Result object');
}
public function getVersion() {
return __CLASS__ . ': $Id: ApiResult.php 21402 2007-04-20 08:55:14Z nickj $';
}
}
?>
|
