MediaWiki  1.34.0
ScribuntoContent Class Reference

Represents the content of a Scribunto script page. More...

Inheritance diagram for ScribuntoContent:
Collaboration diagram for ScribuntoContent:

Public Member Functions

 __construct ( $text)
 
 prepareSave (WikiPage $page, $flags, $parentRevId, User $user)
 
 validate (Title $title)
 Checks whether the script is valid. More...
 
- Public Member Functions inherited from TextContent
 __construct ( $text, $model_id=CONTENT_MODEL_TEXT)
 
 convert ( $toModel, $lossy='')
 This implementation provides lossless conversion between content models based on TextContent. More...
 
 copy ()
 
 diff (Content $that, Language $lang=null)
 Diff this content object with another content object. More...
 
 getNativeData ()
 Returns the text represented by this Content object, as a string. More...
 
 getSize ()
 Returns the text's size in bytes. More...
 
 getText ()
 Returns the text represented by this Content object, as a string. More...
 
 getTextForSearchIndex ()
 Returns the text represented by this Content object, as a string. More...
 
 getTextForSummary ( $maxlength=250)
 Returns a textual representation of the content suitable for use in edit summaries and log messages. More...
 
 getWikitextForTransclusion ()
 Returns attempts to convert this content object to wikitext, and then returns the text string. More...
 
 isCountable ( $hasLinks=null)
 Returns true if this content is not a redirect, and $wgArticleCountMethod is "any". More...
 
 preSaveTransform (Title $title, User $user, ParserOptions $popts)
 Returns a Content object with pre-save transformations applied. More...
 
- Public Member Functions inherited from AbstractContent
 addSectionHeader ( $header)
 
 equals (Content $that=null)
 Decides whether two Content objects are equal. More...
 
 getContentHandler ()
 
 getDefaultFormat ()
 
 getDeletionUpdates (WikiPage $page, ParserOutput $parserOutput=null)
 
 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...
 
 getSecondaryDataUpdates (Title $title, Content $old=null, $recursive=true, ParserOutput $parserOutput=null)
 Returns a list of DataUpdate objects for recording information about this Content in some secondary data store. 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=[])
 
 replaceSection ( $sectionId, Content $with, $sectionTitle='')
 
 serialize ( $format=null)
 
 updateRedirect (Title $target)
 This default implementation always returns $this. More...
 

Protected Member Functions

 fillParserOutput (Title $title, $revId, ParserOptions $options, $generateHtml, ParserOutput &$output)
 Parse the Content object and generate a ParserOutput from the result. More...
 
 highlight ( $text, ParserOutput $output, ScribuntoEngineBase $engine)
 Adds syntax highlighting to the output (or do not touch it and return false). More...
 
- Protected Member Functions inherited from TextContent
 getHighlightHtml ()
 Generates an HTML version of the content, for display. More...
 
 getHtml ()
 Generates an HTML version of the content, for display. More...
 
- Protected Member Functions inherited from AbstractContent
 checkFormat ( $format)
 
 checkModelID ( $modelId)
 
 equalsInternal (Content $that)
 Checks whether $that is logically equal to this Content object. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from TextContent
static normalizeLineEndings ( $text)
 Do a "\\r\\n" -> "\\n" and "\\r" -> "\\n" transformation as well as trim trailing whitespace. More...
 
- Protected Attributes inherited from TextContent
string $mText
 
- Protected Attributes inherited from AbstractContent
 $model_id
 Name of the content model this Content object represents. More...
 

Detailed Description

Represents the content of a Scribunto script page.

Definition at line 15 of file ScribuntoContent.php.

Constructor & Destructor Documentation

◆ __construct()

ScribuntoContent::__construct (   $modelId)
Parameters
string | null$modelId
Since
1.21

Reimplemented from AbstractContent.

Definition at line 17 of file ScribuntoContent.php.

Member Function Documentation

◆ fillParserOutput()

ScribuntoContent::fillParserOutput ( Title  $title,
  $revId,
ParserOptions  $options,
  $generateHtml,
ParserOutput $output 
)
protected

Parse the Content object and generate a ParserOutput from the result.

Parameters
Title$titleThe page title to use as a context for rendering
null | int$revIdThe revision being rendered (optional)
ParserOptions$optionsAny parser options
bool$generateHtmlWhether to generate HTML (default: true).
ParserOutput&$outputParserOutput representing the HTML form of the text.
Returns
ParserOutput

Reimplemented from TextContent.

Definition at line 47 of file ScribuntoContent.php.

References $output, $status, $title, $wgParser, Scribunto\getDocPage(), ParserOptions\getTargetLanguage(), TextContent\getText(), highlight(), Scribunto\newDefaultEngine(), ParserOptions\setTargetLanguage(), validate(), and wfMessage().

◆ highlight()

ScribuntoContent::highlight (   $text,
ParserOutput  $output,
ScribuntoEngineBase  $engine 
)
protected

Adds syntax highlighting to the output (or do not touch it and return false).

Parameters
string$text
ParserOutput$output
ScribuntoEngineBase$engine
Returns
bool Success status

Definition at line 140 of file ScribuntoContent.php.

References $output, $status, and ScribuntoEngineBase\getGeSHiLanguage().

Referenced by fillParserOutput().

◆ prepareSave()

ScribuntoContent::prepareSave ( WikiPage  $page,
  $flags,
  $parentRevId,
User  $user 
)
Since
1.21
Parameters
WikiPage$page
int$flags
int$parentRevId
User$user
Returns
Status
See also
Content::prepareSave

Reimplemented from AbstractContent.

Definition at line 33 of file ScribuntoContent.php.

References WikiPage\getTitle(), and validate().

◆ validate()

ScribuntoContent::validate ( Title  $title)

Checks whether the script is valid.

Parameters
Title$title
Returns
Status

Definition at line 27 of file ScribuntoContent.php.

References $title, Title\getPrefixedDBkey(), TextContent\getText(), and Scribunto\newDefaultEngine().

Referenced by fillParserOutput(), and prepareSave().


The documentation for this class was generated from the following file: