<?php
/**
- * Defines an interface for messages with additional machine-readable data for
- * use by the API, and provides concrete implementations of that interface.
- *
* 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
* @file
*/
-/**
- * Interface for messages with machine-readable data for use by the API
- *
- * The idea is that it's a Message that has some extra data for the API to use when interpreting it
- * as an error (or, in the future, as a warning). Internals of MediaWiki often use messages (or
- * message keys, or Status objects containing messages) to pass information about errors to the user
- * (see e.g. Title::getUserPermissionsErrors()) and the API has to make do with that.
- *
- * @since 1.25
- * @ingroup API
- */
-interface IApiMessage extends MessageSpecifier {
- /**
- * Returns a machine-readable code for use by the API
- *
- * The message key is often sufficient, but sometimes there are multiple
- * messages used for what is really the same underlying condition (e.g.
- * badaccess-groups and badaccess-group0)
- * @return string
- */
- public function getApiCode();
-
- /**
- * Returns additional machine-readable data about the error condition
- * @return array
- */
- public function getApiData();
-
- /**
- * Sets the machine-readable code for use by the API
- * @param string|null $code If null, the message key should be returned by self::getApiCode()
- * @param array|null $data If non-null, passed to self::setApiData()
- */
- public function setApiCode( $code, array $data = null );
-
- /**
- * Sets additional machine-readable data about the error condition
- * @param array $data
- */
- public function setApiData( array $data );
-}
-
-/**
- * Trait to implement the IApiMessage interface for Message subclasses
- * @since 1.27
- * @ingroup API
- */
-trait ApiMessageTrait {
- protected $apiCode = null;
- protected $apiData = [];
-
- public function getApiCode() {
- return $this->apiCode === null ? $this->getKey() : $this->apiCode;
- }
-
- public function setApiCode( $code, array $data = null ) {
- $this->apiCode = $code;
- if ( $data !== null ) {
- $this->setApiData( $data );
- }
- }
-
- public function getApiData() {
- return $this->apiData;
- }
-
- public function setApiData( array $data ) {
- $this->apiData = $data;
- }
-
- public function serialize() {
- return serialize( [
- 'parent' => parent::serialize(),
- 'apiCode' => $this->apiCode,
- 'apiData' => $this->apiData,
- ] );
- }
-
- public function unserialize( $serialized ) {
- $data = unserialize( $serialized );
- parent::unserialize( $data['parent'] );
- $this->apiCode = $data['apiCode'];
- $this->apiData = $data['apiData'];
- }
-}
-
/**
* Extension of Message implementing IApiMessage
* @since 1.25
* @param Message|RawMessage|array|string $msg
* @param string|null $code
* @param array|null $data
- * @return ApiMessage
+ * @return IApiMessage
*/
public static function create( $msg, $code = null, array $data = null ) {
+ if ( is_array( $msg ) ) {
+ // From StatusValue
+ if ( isset( $msg['message'] ) ) {
+ if ( isset( $msg['params'] ) ) {
+ $msg = array_merge( [ $msg['message'] ], $msg['params'] );
+ } else {
+ $msg = [ $msg['message'] ];
+ }
+ }
+
+ // Weirdness that comes in sometimes, including the above
+ if ( $msg[0] instanceof MessageSpecifier ) {
+ $msg = $msg[0];
+ }
+ }
+
if ( $msg instanceof IApiMessage ) {
return $msg;
} elseif ( $msg instanceof RawMessage ) {
* - string: passed to Message::__construct
* @param string|null $code
* @param array|null $data
- * @return ApiMessage
*/
public function __construct( $msg, $code = null, array $data = null ) {
if ( $msg instanceof Message ) {
} else {
parent::__construct( $msg );
}
- $this->apiCode = $code;
- $this->apiData = (array)$data;
- }
-}
-
-/**
- * Extension of RawMessage implementing IApiMessage
- * @since 1.25
- * @ingroup API
- */
-class ApiRawMessage extends RawMessage implements IApiMessage {
- use ApiMessageTrait;
-
- /**
- * @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->apiCode = $code;
- $this->apiData = (array)$data;
+ $this->setApiCode( $code, $data );
}
}