wiki.techinc.nl/includes/json/JsonUnserializable.php
Petr Pchelko 7c68ae9296 Safe ParserOutput extension data and JsonUnserializable helper.
One major difference with what we've had before is that now we
actually write class names into the serialization - given that
this new mechanism is extencible, we can't establish any kind
of mapping of allowed classes. I do not think it's a problem
though.

Bug: T264394
Change-Id: Ia152f3b76b967aabde2d8a182e3aec7d3002e5ea
2020-11-10 11:21:09 -07:00

48 lines
1.7 KiB
PHP

<?php
/**
* 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
* @ingroup Json
*/
namespace MediaWiki\Json;
use JsonSerializable;
/**
* Classes implementing this interface support round-trip JSON serialization/unserialization
* using the JsonUnserializer utility.
*
* The resulting JSON must be annotated with class information for unserialization to work.
* Use JsonUnserializableTrait in implementing classes which annotates the JSON automatically.
*
* @see JsonUnserializer
* @see JsonUnserializableTrait
* @since 1.36
* @package MediaWiki\Json
*/
interface JsonUnserializable extends JsonSerializable {
/**
* Creates a new instance of the class and initialized it from the $json array.
* @param JsonUnserializer $unserializer an instance of JsonUnserializer to use
* for nested properties if they need special care.
* @param array $json
* @return JsonUnserializable
*/
public static function newFromJsonArray( JsonUnserializer $unserializer, array $json );
}