MediaWiki  master
JavaScriptContent Class Reference

Content for JavaScript pages. More...

Inheritance diagram for JavaScriptContent:
Collaboration diagram for JavaScriptContent:

Public Member Functions

 __construct ( $text, $modelId=CONTENT_MODEL_JAVASCRIPT)
 
 getRedirectTarget ()
 
 preSaveTransform (Title $title, User $user, ParserOptions $popts)
 Returns a Content object with pre-save transformations applied using Parser::preSaveTransform(). More...
 
 updateRedirect (Title $target)
 If this page is a redirect, return the content if it should redirect to $target instead. More...
 
- Public Member Functions inherited from TextContent
 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...
 
- Public Member Functions inherited from AbstractContent
 __construct ( $modelId=null)
 
 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 ()
 
 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=[])
 
 prepareSave (WikiPage $page, $flags, $parentRevId, User $user)
 
 replaceSection ( $sectionId, Content $with, $sectionTitle='')
 
 serialize ( $format=null)
 

Protected Member Functions

 getHtml ()
 
- Protected Member Functions inherited from TextContent
 fillParserOutput (Title $title, $revId, ParserOptions $options, $generateHtml, ParserOutput &$output)
 Fills the provided ParserOutput object with information derived from the content. 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...
 

Private Attributes

bool Title null $redirectTarget = false
 

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
string $model_id
 Name of the content model this Content object represents. More...
 

Detailed Description

Content for JavaScript pages.

Definition at line 35 of file JavaScriptContent.php.

Constructor & Destructor Documentation

◆ __construct()

JavaScriptContent::__construct (   $text,
  $modelId = CONTENT_MODEL_JAVASCRIPT 
)
Parameters
string$textJavaScript code.
string$modelIdthe content model name

Reimplemented from TextContent.

Definition at line 46 of file JavaScriptContent.php.

Member Function Documentation

◆ getHtml()

JavaScriptContent::getHtml ( )
protected
Returns
string JavaScript wrapped in a
 tag.

Reimplemented from TextContent.

Definition at line 74 of file JavaScriptContent.php.

References TextContent\getText().

◆ getRedirectTarget()

JavaScriptContent::getRedirectTarget ( )

◆ preSaveTransform()

JavaScriptContent::preSaveTransform ( Title  $title,
User  $user,
ParserOptions  $popts 
)

Returns a Content object with pre-save transformations applied using Parser::preSaveTransform().

Parameters
Title$title
User$user
ParserOptions$popts
Returns
JavaScriptContent

Reimplemented from TextContent.

Definition at line 60 of file JavaScriptContent.php.

References $title, and TextContent\getText().

◆ updateRedirect()

JavaScriptContent::updateRedirect ( Title  $target)

If this page is a redirect, return the content if it should redirect to $target instead.

Parameters
Title$target
Returns
JavaScriptContent

Reimplemented from AbstractContent.

Definition at line 88 of file JavaScriptContent.php.

References AbstractContent\getContentHandler(), and AbstractContent\isRedirect().

Member Data Documentation

◆ $redirectTarget

bool Title null JavaScriptContent::$redirectTarget = false
private

Definition at line 40 of file JavaScriptContent.php.

Referenced by getRedirectTarget().


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