MediaWiki  1.33.0
ApiMessage.php
Go to the documentation of this file.
1 <?php
26 class ApiMessage extends Message implements IApiMessage {
27  use ApiMessageTrait;
28 
40  public static function create( $msg, $code = null, array $data = null ) {
41  if ( is_array( $msg ) ) {
42  // From StatusValue
43  if ( isset( $msg['message'] ) ) {
44  if ( isset( $msg['params'] ) ) {
45  $msg = array_merge( [ $msg['message'] ], $msg['params'] );
46  } else {
47  $msg = [ $msg['message'] ];
48  }
49  }
50 
51  // Weirdness that comes in sometimes, including the above
52  if ( $msg[0] instanceof MessageSpecifier ) {
53  $msg = $msg[0];
54  }
55  }
56 
57  if ( $msg instanceof IApiMessage ) {
58  return $msg;
59  } elseif ( $msg instanceof RawMessage ) {
60  return new ApiRawMessage( $msg, $code, $data );
61  } else {
62  return new ApiMessage( $msg, $code, $data );
63  }
64  }
65 
74  public function __construct( $msg, $code = null, array $data = null ) {
75  if ( $msg instanceof Message ) {
76  foreach ( get_class_vars( get_class( $this ) ) as $key => $value ) {
77  if ( isset( $msg->$key ) ) {
78  $this->$key = $msg->$key;
79  }
80  }
81  } elseif ( is_array( $msg ) ) {
82  $key = array_shift( $msg );
83  parent::__construct( $key, $msg );
84  } else {
85  parent::__construct( $msg );
86  }
87  $this->setApiCode( $code, $data );
88  }
89 }
MessageSpecifier
Definition: MessageSpecifier.php:21
ApiMessage\__construct
__construct( $msg, $code=null, array $data=null)
Definition: ApiMessage.php:74
IApiMessage
Interface for messages with machine-readable data for use by the API.
Definition: IApiMessage.php:39
php
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
ApiRawMessage
Extension of RawMessage implementing IApiMessage.
Definition: ApiRawMessage.php:26
ApiMessage
Extension of Message implementing IApiMessage.
Definition: ApiMessage.php:26
$data
$data
Utility to generate mapping file used in mw.Title (phpCharToUpper.json)
Definition: generatePhpCharToUpperMappings.php:13
use
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
Definition: MIT-LICENSE.txt:10
$code
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not it can be in the form of< username >< more info > e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable & $code
Definition: hooks.txt:780
ApiMessage\create
static create( $msg, $code=null, array $data=null)
Create an IApiMessage for the message.
Definition: ApiMessage.php:40
array
The wiki should then use memcached to cache various data To use multiple just add more items to the array To increase the weight of a make its entry a array("192.168.0.1:11211", 2))
IApiMessage\setApiCode
setApiCode( $code, array $data=null)
Sets the machine-readable code for use by the API.
$value
$value
Definition: styleTest.css.php:49
ApiMessageTrait
trait ApiMessageTrait
Trait to implement the IApiMessage interface for Message subclasses.
Definition: ApiMessageTrait.php:26
as
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
RawMessage
Variant of the Message class.
Definition: RawMessage.php:34