Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
0.00% covered (danger)
0.00%
0 / 1
n/a
0 / 0
 CRAP
n/a
0 / 0
1<?php
2/**
3 * Copyright © 2015 Wikimedia Foundation and contributors
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
19 *
20 * @file
21 */
22
23namespace MediaWiki\Api;
24
25/**
26 * This interface allows for overriding the default conversion applied by
27 * ApiResult::validateValue().
28 *
29 * @note This is currently an informal interface; it need not be explicitly
30 *   implemented, as long as the method is provided. This allows for extension
31 *   code to maintain compatibility with older MediaWiki while still taking
32 *   advantage of this where it exists.
33 *
34 * @stable to implement
35 *
36 * @ingroup API
37 * @since 1.25
38 */
39interface ApiSerializable {
40    /**
41     * Return the value to be added to ApiResult in place of this object.
42     *
43     * The returned value must not be an object, and must pass
44     * all checks done by ApiResult::validateValue().
45     *
46     * @return mixed
47     */
48    public function serializeForApiResult();
49}
50
51/** @deprecated class alias since 1.43 */
52class_alias( ApiSerializable::class, 'ApiSerializable' );