MediaWiki  master
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 
87  public function getNativeData() {
88  return $this->getMessage();
89  }
90 
98  public function getMessage() {
99  // NOTE: Message objects are mutable. Cloning here makes MessageContent immutable.
100  return clone $this->mMessage;
101  }
102 
108  public function getTextForSearchIndex() {
109  return $this->mMessage->plain();
110  }
111 
117  public function getWikitextForTransclusion() {
118  return $this->getWikitext();
119  }
120 
128  public function getTextForSummary( $maxlength = 250 ) {
129  return substr( $this->mMessage->plain(), 0, $maxlength );
130  }
131 
137  public function getSize() {
138  return strlen( $this->mMessage->plain() );
139  }
140 
146  public function copy() {
147  // MessageContent is immutable (because getNativeData() and getMessage()
148  // returns a clone of the Message object)
149  return $this;
150  }
151 
159  public function isCountable( $hasLinks = null ) {
160  return false;
161  }
162 
173  public function getParserOutput( Title $title, $revId = null,
174  ParserOptions $options = null, $generateHtml = true ) {
175  if ( $generateHtml ) {
176  $html = $this->getHtml();
177  } else {
178  $html = '';
179  }
180 
181  $po = new ParserOutput( $html );
182  // Message objects are in the user language.
183  $po->recordOption( 'userlang' );
184 
185  return $po;
186  }
187 
188 }
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:1982
getMessage()
Returns the message object, with any parameters already substituted.
getWikitext()
Returns the message text.
const CONTENT_MODEL_WIKITEXT
Definition: Defines.php:235
Wrapper allowing us to handle a system message as a Content object.
isCountable( $hasLinks=null)
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 use $formDescriptor instead 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
getNativeData()
Returns the message object, with any parameters already substituted.
Base implementation for content objects.
$params
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:1982
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 null
Definition: hooks.txt:780
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:925
getTextForSummary( $maxlength=250)
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
__construct( $msg, $params=null)
getParserOutput(Title $title, $revId=null, ParserOptions $options=null, $generateHtml=true)
getHtml()
Fully parse the text from wikitext to HTML.