Anomie has uploaded a new change for review. (
https://gerrit.wikimedia.org/r/380541 )
Change subject: Update documentation for IApiMessage interface
......................................................................
Update documentation for IApiMessage interface
It was created for a specific purpose, and apparently this is confusing
some people who're inexplicably trying to implement it outside of that
purpose. So, this patch more clearly documents that purpose.
Change-Id: I638482327370522bedea1ec514ecbb9d98207382
---
M includes/api/ApiMessage.php
1 file changed, 7 insertions(+), 0 deletions(-)
git pull ssh://gerrit.wikimedia.org:29418/mediawiki/core
refs/changes/41/380541/1
diff --git a/includes/api/ApiMessage.php b/includes/api/ApiMessage.php
index 9e42d5f..3347128 100644
--- a/includes/api/ApiMessage.php
+++ b/includes/api/ApiMessage.php
@@ -30,6 +30,13 @@
* (see e.g. Title::getUserPermissionsErrors()) and the API has to make do
with that.
*
* @since 1.25
+ * @note This interface exists to work around PHP's inheritance, so ApiMessage
+ * can extend Message and ApiRawMessage can extend RawMessage while still
+ * allowing an instanceof check for a Message object including this
+ * functionality. If for some reason you feel the need to implement this
+ * interface on some other class, that class must also implement all the
+ * public methods the Message class provides (not just those from
+ * MessageSpecifier, which as written is fairly useless).
* @ingroup API
*/
interface IApiMessage extends MessageSpecifier {
--
To view, visit https://gerrit.wikimedia.org/r/380541
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: I638482327370522bedea1ec514ecbb9d98207382
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/core
Gerrit-Branch: master
Gerrit-Owner: Anomie <bjor...@wikimedia.org>
_______________________________________________
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
