includes/json/JsonSerializer.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 InvalidArgumentException;
  25
  26 /**
  27  * Serializes things to JSON.
  28  *
  29  * @stable to type
  30  * @since 1.36
  31  * @package MediaWiki\Json
  32  */
  33 interface JsonSerializer {
  34
  35         /**
  36          * Encode $value as JSON with an intent to use JsonDeserializer::unserialize
  37          * to decode it back.
  38          *
  39          * @param mixed|JsonDeserializable $value A value to encode. Can be any scalar,
  40          * array, stdClass, JsonDeserializable or any combination of them.
  41          * @throws InvalidArgumentException if the value can not be serialized.
  42          * @return string
  43          */
  44         public function serialize( $value );
  45
  46         // TODO: move more methods from FormatJson to here.
  47 }