includes/json/JsonUnserializable.php

   1 <?php
   2 /**
   3  * This program is free software; you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation; either version 2 of the License, or
   6  * (at your option) any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along
  14  * with this program; if not, write to the Free Software Foundation, Inc.,
  15  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  16  * http://www.gnu.org/copyleft/gpl.html
  17  *
  18  * @file
  19  * @ingroup Json
  20  */
  21
  22 namespace MediaWiki\Json;
  23
  24 use JsonSerializable;
  25
  26 /**
  27  * Classes implementing this interface support round-trip JSON serialization/unserialization
  28  * using the JsonUnserializer utility.
  29  *
  30  * The resulting JSON must be annotated with class information for unserialization to work.
  31  * Use JsonUnserializableTrait in implementing classes which annotates the JSON automatically.
  32  *
  33  * @see JsonUnserializer
  34  * @see JsonUnserializableTrait
  35  * @since 1.36
  36  * @package MediaWiki\Json
  37  */
  38 interface JsonUnserializable extends JsonSerializable {
  39
  40         /**
  41          * Creates a new instance of the class and initialized it from the $json array.
  42          * @param JsonUnserializer $unserializer an instance of JsonUnserializer to use
  43          *   for nested properties if they need special care.
  44          * @param array $json
  45          * @return JsonUnserializable
  46          */
  47         public static function newFromJsonArray( JsonUnserializer $unserializer, array $json );
  48 }