MediaWiki  master
TextContent.php
Go to the documentation of this file.
1 <?php
36 
42  public function __construct( $text, $model_id = CONTENT_MODEL_TEXT ) {
43  parent::__construct( $model_id );
44 
45  if ( $text === null || $text === false ) {
46  wfWarn( "TextContent constructed with \$text = " . var_export( $text, true ) . "! "
47  . "This may indicate an error in the caller's scope.", 2 );
48 
49  $text = '';
50  }
51 
52  if ( !is_string( $text ) ) {
53  throw new MWException( "TextContent expects a string in the constructor." );
54  }
55 
56  $this->mText = $text;
57  }
58 
64  public function copy() {
65  return $this; # NOTE: this is ok since TextContent are immutable.
66  }
67 
68  public function getTextForSummary( $maxlength = 250 ) {
70 
71  $text = $this->getNativeData();
72 
73  $truncatedtext = $wgContLang->truncate(
74  preg_replace( "/[\n\r]/", ' ', $text ),
75  max( 0, $maxlength ) );
76 
77  return $truncatedtext;
78  }
79 
85  public function getSize() {
86  $text = $this->getNativeData();
87 
88  return strlen( $text );
89  }
90 
100  public function isCountable( $hasLinks = null ) {
102 
103  if ( $this->isRedirect() ) {
104  return false;
105  }
106 
107  if ( $wgArticleCountMethod === 'any' ) {
108  return true;
109  }
110 
111  return false;
112  }
113 
119  public function getNativeData() {
120  return $this->mText;
121  }
122 
128  public function getTextForSearchIndex() {
129  return $this->getNativeData();
130  }
131 
140  public function getWikitextForTransclusion() {
141  $wikitext = $this->convert( CONTENT_MODEL_WIKITEXT, 'lossy' );
142 
143  if ( $wikitext ) {
144  return $wikitext->getNativeData();
145  } else {
146  return false;
147  }
148  }
149 
160  public function preSaveTransform( Title $title, User $user, ParserOptions $popts ) {
161  $text = $this->getNativeData();
162  $pst = rtrim( $text );
163 
164  return ( $text === $pst ) ? $this : new static( $pst, $this->getModel() );
165  }
166 
179  public function diff( Content $that, Language $lang = null ) {
181 
182  $this->checkModelID( $that->getModel() );
183 
184  // @todo could implement this in DifferenceEngine and just delegate here?
185 
186  if ( !$lang ) {
187  $lang = $wgContLang;
188  }
189 
190  $otext = $this->getNativeData();
191  $ntext = $that->getNativeData();
192 
193  # Note: Use native PHP diff, external engines don't give us abstract output
194  $ota = explode( "\n", $lang->segmentForDiff( $otext ) );
195  $nta = explode( "\n", $lang->segmentForDiff( $ntext ) );
196 
197  $diff = new Diff( $ota, $nta );
198 
199  return $diff;
200  }
201 
219  protected function fillParserOutput( Title $title, $revId,
221  ) {
223 
224  if ( in_array( $this->getModel(), $wgTextModelsToParse ) ) {
225  // parse just to get links etc into the database, HTML is replaced below.
226  $output = $wgParser->parse( $this->getNativeData(), $title, $options, true, true, $revId );
227  }
228 
229  if ( $generateHtml ) {
230  $html = $this->getHtml();
231  } else {
232  $html = '';
233  }
234 
235  $output->setText( $html );
236  }
237 
251  protected function getHtml() {
252  return $this->getHighlightHtml();
253  }
254 
271  protected function getHighlightHtml() {
272  return htmlspecialchars( $this->getNativeData() );
273  }
274 
288  public function convert( $toModel, $lossy = '' ) {
289  $converted = parent::convert( $toModel, $lossy );
290 
291  if ( $converted !== false ) {
292  return $converted;
293  }
294 
295  $toHandler = ContentHandler::getForModelID( $toModel );
296 
297  if ( $toHandler instanceof TextContentHandler ) {
298  // NOTE: ignore content serialization format - it's just text anyway.
299  $text = $this->getNativeData();
300  $converted = $toHandler->unserializeContent( $text );
301  }
302 
303  return $converted;
304  }
305 
306 }
getNativeData()
Returns the text represented by this Content object, as a string.
$wgArticleCountMethod
Method used to determine if a page in a content namespace should be counted as a valid article...
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:1816
const CONTENT_MODEL_WIKITEXT
Definition: Defines.php:278
$model_id
Name of the content model this Content object represents.
getWikitextForTransclusion()
Returns attempts to convert this content object to wikitext, and then returns the text string...
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context the output can only depend on parameters provided to this hook not on global state $generateHtml
Definition: hooks.txt:1020
Set options of the Parser.
$wgParser
Definition: Setup.php:816
if(!isset($args[0])) $lang
__construct($text, $model_id=CONTENT_MODEL_TEXT)
Definition: TextContent.php:42
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context $revId
Definition: hooks.txt:1020
const CONTENT_MODEL_TEXT
Definition: Defines.php:281
checkModelID($modelId)
getHtml()
Generates an HTML version of the content, for display.
Represents a title within MediaWiki.
Definition: Title.php:36
when a variable name is used in a it is silently declared as a new local masking the global
Definition: design.txt:93
The ContentHandler facility adds support for arbitrary content types on wiki instead of relying on wikitext for everything It was introduced in MediaWiki Each kind of and so on Built in content types are
The User object encapsulates all of the user-specific settings (user_id, name, rights, email address, options, last login time).
Definition: User.php:47
Content object implementation for representing flat text.
Definition: TextContent.php:35
Some quick notes on the file repository architecture Functionality is
Definition: README:3
getHighlightHtml()
Generates an HTML version of the content, for display.
wfWarn($msg, $callerOffset=1, $level=E_USER_NOTICE)
Send a warning either to the debug log or in a PHP error depending on $wgDevelopmentWarnings.
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context $options
Definition: hooks.txt:1020
Base implementation for content objects.
MediaWiki exception.
Definition: MWException.php:26
Base interface for content objects.
Definition: Content.php:34
Class representing a 'diff' between two sequences of strings.
$wgTextModelsToParse
Determines which types of text are parsed as wikitext.
Internationalisation code.
Definition: Language.php:39
Allows to change the fields on the form that will be generated are created Can be used to omit specific feeds from being outputted You must not use this hook to add use OutputPage::addFeedLink() instead.&$feedLinks conditions will AND in the final query as a Content object as a Content object $title
Definition: hooks.txt:312
getSize()
Returns the text's size in bytes.
Definition: TextContent.php:85
preSaveTransform(Title $title, User $user, ParserOptions $popts)
Returns a Content object with pre-save transformations applied.
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a local account $user
Definition: hooks.txt:242
getNativeData()
Returns native representation of the data.
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context the output can only depend on parameters provided to this hook not on global state indicating whether full HTML should be generated If generation of HTML may be but other information should still be present in the ParserOutput object & $output
Definition: hooks.txt:1020
convert($toModel, $lossy= '')
This implementation provides lossless conversion between content models based on TextContent.
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
Base content handler implementation for flat text contents.
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as and the local content language as $wgContLang
Definition: design.txt:56
getModel()
Returns the ID of the content model used by this Content object.
isCountable($hasLinks=null)
Returns true if this content is not a redirect, and $wgArticleCountMethod is "any".
fillParserOutput(Title $title, $revId, ParserOptions $options, $generateHtml, ParserOutput &$output)
Fills the provided ParserOutput object with information derived from the content. ...
diff(Content $that, Language $lang=null)
Diff this content object with another content object.
getTextForSummary($maxlength=250)
Returns a textual representation of the content suitable for use in edit summaries and log messages...
Definition: TextContent.php:68
getTextForSearchIndex()
Returns the text represented by this Content object, as a string.