blob: 70e93a6c2ae692b58872f532b4af83a3ca6313e8 (
plain)
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
|
<?php
/**
* Created on Feb 25, 2015
*
* Copyright © 2015 Brad Jorsch "bjorsch@wikimedia.org"
*
* 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.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
*/
/**
* This interface allows for overriding the default conversion applied by
* ApiResult::validateValue().
*
* @note This is currently an informal interface; it need not be explicitly
* implemented, as long as the method is provided. This allows for extension
* code to maintain compatibility with older MediaWiki while still taking
* advantage of this where it exists.
*
* @ingroup API
* @since 1.25
*/
interface ApiSerializable {
/**
* Return the value to be added to ApiResult in place of this object.
*
* The returned value must not be an object, and must pass
* all checks done by ApiResult::validateValue().
*
* @return mixed
*/
public function serializeForApiResult();
}
|
