Wrapper allowing us to handle a system message as a Content object. More...
Public Member Functions | |
| __construct ( $msg, $params=null) | |
| copy () | |
| getMessage () | |
| Returns the message object, with any parameters already substituted. More... | |
| getNativeData () | |
| Returns the message object, with any parameters already substituted. More... | |
| getSize () | |
| getTextForSearchIndex () | |
| getTextForSummary ( $maxlength=250) | |
| getWikitext () | |
| Returns the message text. More... | |
| getWikitextForTransclusion () | |
| isCountable ( $hasLinks=null) | |
 Public Member Functions inherited from AbstractContent | |
| __construct ( $modelId=null) | |
| addSectionHeader ( $header) | |
| convert ( $toModel, $lossy='') | |
| This base implementation calls the hook ConvertContent to enable custom conversions. More... | |
| equals (Content $that=null) | |
| Decides whether two Content objects are equal. More... | |
| getContentHandler () | |
| getDefaultFormat () | |
| getModel () | |
| getParserOutput (Title $title, $revId=null, ParserOptions $options=null, $generateHtml=true) | |
| Returns a ParserOutput object containing information derived from this content. More... | |
| getRedirectChain () | |
| getRedirectTarget () | |
| Subclasses that implement redirects should override this. More... | |
| getSection ( $sectionId) | |
| getSupportedFormats () | |
| getUltimateRedirectTarget () | |
| isEmpty () | |
| isRedirect () | |
| isSupportedFormat ( $format) | |
| isValid () | |
| Subclasses may override this to implement (light weight) validation. More... | |
| matchMagicWord (MagicWord $word) | |
| This default implementation always returns false. More... | |
| preloadTransform (Title $title, ParserOptions $popts, $params=[]) | |
| prepareSave (WikiPage $page, $flags, $parentRevId, User $user) | |
| preSaveTransform (Title $title, User $user, ParserOptions $popts) | |
| replaceSection ( $sectionId, Content $with, $sectionTitle='') | |
| serialize ( $format=null) | |
| updateRedirect (Title $target) | |
| This default implementation always returns $this. More... | |
Protected Attributes | |
| Message | $mMessage |
| Protected Attributes inherited from AbstractContent | |
| string | $model_id |
| Name of the content model this Content object represents. More... | |
Additional Inherited Members | |
| Protected Member Functions inherited from AbstractContent | |
| checkFormat ( $format) | |
| checkModelID ( $modelId) | |
| equalsInternal (Content $that) | |
| Checks whether $that is logically equal to this Content object. More... | |
| fillParserOutput (Title $title, $revId, ParserOptions $options, $generateHtml, ParserOutput &$output) | |
| Fills the provided ParserOutput with information derived from the content. More... | |
| getContentHandlerFactory () | |
Detailed Description
Wrapper allowing us to handle a system message as a Content object.
Note that this is generally not used to represent content from the MediaWiki namespace. MessageContent is just intended as glue for wrapping a message programmatically.
Definition at line 37 of file MessageContent.php.
Constructor & Destructor Documentation
◆ __construct()
| MessageContent::__construct | ( | $msg, | |
$params = null |
|||
| ) |
- Parameters
-
Message | string $msg A Message object, or a message key. string[] | null $params An optional array of message parameters.
Definition at line 48 of file MessageContent.php.
References CONTENT_MODEL_WIKITEXT, wfDeprecated(), and wfMessage().
Member Function Documentation
◆ copy()
| MessageContent::copy | ( | ) |
- Returns
- Content A copy of this object
- See also
- Content::copy
Implements Content.
Definition at line 139 of file MessageContent.php.
◆ getMessage()
| MessageContent::getMessage | ( | ) |
Returns the message object, with any parameters already substituted.
- Since
- 1.33
- Returns
- Message
Definition at line 91 of file MessageContent.php.
References $mMessage.
Referenced by getNativeData().
◆ getNativeData()
| MessageContent::getNativeData | ( | ) |
Returns the message object, with any parameters already substituted.
- Deprecated:
- since 1.33 use getMessage() instead.
- Returns
- Message
Reimplemented from AbstractContent.
Definition at line 80 of file MessageContent.php.
References getMessage().
◆ getSize()
| MessageContent::getSize | ( | ) |
- Returns
- int
- See also
- Content::getSize
Implements Content.
Definition at line 130 of file MessageContent.php.
◆ getTextForSearchIndex()
| MessageContent::getTextForSearchIndex | ( | ) |
- Returns
- string
- See also
- Content::getTextForSearchIndex
Implements Content.
Definition at line 101 of file MessageContent.php.
◆ getTextForSummary()
| MessageContent::getTextForSummary | ( | $maxlength = 250 | ) |
- Parameters
-
int $maxlength Maximum length of the summary text, defaults to 250.
- Returns
- string The summary text.
- See also
- Content::getTextForSummary
Implements Content.
Definition at line 121 of file MessageContent.php.
◆ getWikitext()
| MessageContent::getWikitext | ( | ) |
Returns the message text.
{{-transformation is done.
- Returns
- string Unescaped message text.
Definition at line 69 of file MessageContent.php.
Referenced by getWikitextForTransclusion().
◆ getWikitextForTransclusion()
| MessageContent::getWikitextForTransclusion | ( | ) |
- Returns
- string
Implements Content.
Definition at line 110 of file MessageContent.php.
References getWikitext().
◆ isCountable()
| MessageContent::isCountable | ( | $hasLinks = null | ) |
- Parameters
-
bool | null $hasLinks
- Returns
- bool Always false.
- See also
- Content::isCountable
Implements Content.
Definition at line 152 of file MessageContent.php.
Member Data Documentation
◆ $mMessage
|
protected |
Definition at line 42 of file MessageContent.php.
Referenced by getMessage().
The documentation for this class was generated from the following file:
- includes/content/MessageContent.php
