MediaWiki  REL1_31
MessageContent.php
Go to the documentation of this file.
1 <?php
37 
41  protected $mMessage;
42 
47  public function __construct( $msg, $params = null ) {
48  # XXX: messages may be wikitext, html or plain text! and maybe even something else entirely.
49  parent::__construct( CONTENT_MODEL_WIKITEXT );
50 
51  if ( is_string( $msg ) ) {
52  $this->mMessage = wfMessage( $msg );
53  } else {
54  $this->mMessage = clone $msg;
55  }
56 
57  if ( $params ) {
58  $this->mMessage = $this->mMessage->params( $params );
59  }
60  }
61 
67  public function getHtml() {
68  return $this->mMessage->parse();
69  }
70 
76  public function getWikitext() {
77  return $this->mMessage->text();
78  }
79 
85  public function getNativeData() {
86  // NOTE: Message objects are mutable. Cloning here makes MessageContent immutable.
87  return clone $this->mMessage;
88  }
89 
95  public function getTextForSearchIndex() {
96  return $this->mMessage->plain();
97  }
98 
104  public function getWikitextForTransclusion() {
105  return $this->getWikitext();
106  }
107 
115  public function getTextForSummary( $maxlength = 250 ) {
116  return substr( $this->mMessage->plain(), 0, $maxlength );
117  }
118 
124  public function getSize() {
125  return strlen( $this->mMessage->plain() );
126  }
127 
133  public function copy() {
134  // MessageContent is immutable (because getNativeData() returns a clone of the Message object)
135  return $this;
136  }
137 
145  public function isCountable( $hasLinks = null ) {
146  return false;
147  }
148 
159  public function getParserOutput( Title $title, $revId = null,
160  ParserOptions $options = null, $generateHtml = true ) {
161  if ( $generateHtml ) {
162  $html = $this->getHtml();
163  } else {
164  $html = '';
165  }
166 
167  $po = new ParserOutput( $html );
168  // Message objects are in the user language.
169  $po->recordOption( 'userlang' );
170 
171  return $po;
172  }
173 
174 }
ParserOptions
Set options of the Parser.
Definition: ParserOptions.php:40
ParserOutput
Definition: ParserOutput.php:25
$html
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses & $html
Definition: hooks.txt:2013
wfMessage
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with wfMessage() -> params() ->parseAsBlock() - offset Set to overwrite offset parameter in $wgRequest set to '' to unset offset - wrap String Wrap the message in html(usually something like "&lt
MessageContent\getTextForSearchIndex
getTextForSearchIndex()
Definition: MessageContent.php:95
MessageContent\$mMessage
Message $mMessage
Definition: MessageContent.php:41
MessageContent\getNativeData
getNativeData()
Returns the message object, with any parameters already substituted.
Definition: MessageContent.php:85
$params
$params
Definition: styleTest.css.php:40
CONTENT_MODEL_WIKITEXT
const CONTENT_MODEL_WIKITEXT
Definition: Defines.php:245
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:37
MessageContent\__construct
__construct( $msg, $params=null)
Definition: MessageContent.php:47
MessageContent\getParserOutput
getParserOutput(Title $title, $revId=null, ParserOptions $options=null, $generateHtml=true)
Definition: MessageContent.php:159
MessageContent\getSize
getSize()
Definition: MessageContent.php:124
MessageContent\getHtml
getHtml()
Fully parse the text from wikitext to HTML.
Definition: MessageContent.php:67
$title
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:964
MessageContent\getWikitextForTransclusion
getWikitextForTransclusion()
Definition: MessageContent.php:104
$options
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped & $options
Definition: hooks.txt:2001
AbstractContent
Base implementation for content objects.
Definition: AbstractContent.php:34
MessageContent\getWikitext
getWikitext()
Returns the message text.
Definition: MessageContent.php:76
Title
Represents a title within MediaWiki.
Definition: Title.php:39
MessageContent
Wrapper allowing us to handle a system message as a Content object.
Definition: MessageContent.php:36
Message
The Message class provides methods which fulfil two basic services:
Definition: Message.php:159
MessageContent\copy
copy()
Definition: MessageContent.php:133
MessageContent\getTextForSummary
getTextForSummary( $maxlength=250)
Definition: MessageContent.php:115
MessageContent\isCountable
isCountable( $hasLinks=null)
Definition: MessageContent.php:145