includes/api/ApiRawMessage.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  */
  20
  21 namespace MediaWiki\Api;
  22
  23 use MediaWiki\Language\RawMessage;
  24
  25 /**
  26  * Extension of RawMessage implementing IApiMessage
  27  * @newable
  28  * @since 1.25
  29  * @ingroup API
  30  */
  31 class ApiRawMessage extends RawMessage implements IApiMessage {
  32         use ApiMessageTrait;
  33
  34         /**
  35          * @stable to call
  36          * @param RawMessage|string|array $msg
  37          *  - RawMessage: is cloned
  38          *  - array: first element is $key, rest are $params to RawMessage::__construct
  39          *  - string: passed to RawMessage::__construct
  40          * @param string|null $code
  41          * @param array|null $data
  42          */
  43         public function __construct( $msg, $code = null, ?array $data = null ) {
  44                 if ( $msg instanceof RawMessage ) {
  45                         foreach ( get_class_vars( get_class( $this ) ) as $key => $value ) {
  46                                 if ( isset( $msg->$key ) ) {
  47                                         $this->$key = $msg->$key;
  48                                 }
  49                         }
  50                 } elseif ( is_array( $msg ) ) {
  51                         $key = array_shift( $msg );
  52                         parent::__construct( $key, $msg );
  53                 } else {
  54                         parent::__construct( $msg );
  55                 }
  56                 $this->setApiCode( $code, $data );
  57         }
  58
  59         public function getApiCode() {
  60                 if ( $this->apiCode === null ) {
  61                         // Copied from ApiMessageTrait to avoid changing the error codes. This causes T350248,
  62                         // but there's nothing better we can do when a RawMessage is used.
  63                         $this->apiCode = preg_replace( '/[^a-zA-Z0-9_-]/', '_', $this->getTextOfRawMessage() );
  64                 }
  65                 return $this->apiCode;
  66         }
  67 }
  68
  69 /** @deprecated class alias since 1.43 */
  70 class_alias( ApiRawMessage::class, 'ApiRawMessage' );