includes/api/ApiSerializable.php

   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
  23 /**
  24  * This interface allows for overriding the default conversion applied by
  25  * ApiResult::validateValue().
  26  *
  27  * @note This is currently an informal interface; it need not be explicitly
  28  *   implemented, as long as the method is provided. This allows for extension
  29  *   code to maintain compatibility with older MediaWiki while still taking
  30  *   advantage of this where it exists.
  31  *
  32  * @ingroup API
  33  * @since 1.25
  34  */
  35 interface ApiSerializable {
  36         /**
  37          * Return the value to be added to ApiResult in place of this object.
  38          *
  39          * The returned value must not be an object, and must pass
  40          * all checks done by ApiResult::validateValue().
  41          *
  42          * @return mixed
  43          */
  44         public function serializeForApiResult();
  45 }