wikimedia/mediawiki-core

View on GitHub
includes/api/ApiRawMessage.php

Summary

Maintainability
B
4 hrs
Test Coverage
<?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
 */

use MediaWiki\Language\RawMessage;

/**
 * Extension of RawMessage implementing IApiMessage
 * @newable
 * @since 1.25
 * @ingroup API
 */
class ApiRawMessage extends RawMessage implements IApiMessage {
    use ApiMessageTrait;

    /**
     * @stable to call
     * @param RawMessage|string|array $msg
     *  - RawMessage: is cloned
     *  - array: first element is $key, rest are $params to RawMessage::__construct
     *  - string: passed to RawMessage::__construct
     * @param string|null $code
     * @param array|null $data
     */
    public function __construct( $msg, $code = null, array $data = null ) {
        if ( $msg instanceof RawMessage ) {
            foreach ( get_class_vars( get_class( $this ) ) as $key => $value ) {
                if ( isset( $msg->$key ) ) {
                    $this->$key = $msg->$key;
                }
            }
        } elseif ( is_array( $msg ) ) {
            $key = array_shift( $msg );
            parent::__construct( $key, $msg );
        } else {
            parent::__construct( $msg );
        }
        $this->setApiCode( $code, $data );
    }
}