ScribuntoContentHandler Class Reference

Inheritance diagram for ScribuntoContentHandler:

Collaboration diagram for ScribuntoContentHandler:

Public Member Functions
	__construct ( $modelId=CONTENT_MODEL_SCRIBUNTO, $formats=[CONTENT_FORMAT_TEXT])
	canBeUsedOn (Title $title)
	Only allow this content handler to be used in the Module namespace.
	isSupportedFormat ( $format)
Public Member Functions inherited from CodeContentHandler
	getPageLanguage (Title $title, Content $content=null)
	Returns the English language, because code is English, and should be handled as such.
	getPageViewLanguage (Title $title, Content $content=null)
	Returns the English language, because code is English, and should be handled as such.
Public Member Functions inherited from TextContentHandler
	getDataForSearchIndex (WikiPage $page, ParserOutput $output, SearchEngine $engine)
	Return fields to be indexed by search engine as representation of this document.
	getFieldsForSearchIndex (SearchEngine $engine)
	Get fields definition for search index.
	makeEmptyContent ()
	Creates an empty TextContent object.
	merge3 (Content $oldContent, Content $myContent, Content $yourContent)
	Attempts to merge differences between three versions.
	serializeContent (Content $content, $format=null)
	Returns the content's text as-is.
	supportsDirectEditing ()
	unserializeContent ( $text, $format=null)
	Unserializes a Content object of the type supported by this ContentHandler.
Public Member Functions inherited from ContentHandler
	createDifferenceEngine (IContextSource $context, $old=0, $new=0, $rcid=0, $refreshCache=false, $unhide=false)
	Factory for creating an appropriate DifferenceEngine for this content model.
	exportTransform ( $blob, $format=null)
	Applies transformations on export (returns the blob unchanged per default).
	getActionOverrides ()
	Returns overrides for action handlers.
	getAutoDeleteReason (Title $title, &$hasHistory)
	Auto-generates a deletion reason.
	getAutosummary (Content $oldContent=null, Content $newContent=null, $flags=0)
	Return an applicable auto-summary if one exists for the given edit.
	getChangeTag (Content $oldContent=null, Content $newContent=null, $flags=0)
	Return an applicable tag if one exists for the given edit or return null.
	getDefaultFormat ()
	The format used for serialization/deserialization by default by this ContentHandler.
	getDeletionUpdates (Title $title, $role)
	Returns a list of DeferrableUpdate objects for removing information about content in some secondary data store.
	getModelID ()
	Returns the model id that identifies the content model this ContentHandler can handle.
	getParserOutputForIndexing (WikiPage $page, ParserCache $cache=null)
	Produce page output suitable for indexing.
	getSecondaryDataUpdates (Title $title, Content $content, $role, SlotRenderingProvider $slotOutput)
	Returns a list of DeferrableUpdate objects for recording information about the given Content in some secondary data store.
	getSlotDiffRenderer (IContextSource $context)
	Get an appropriate SlotDiffRenderer for this content model.
	getSupportedFormats ()
	Returns a list of serialization formats supported by the serializeContent() and unserializeContent() methods of this ContentHandler.
	getUndoContent ( $current, $undo, $undoafter, $undoIsLatest=false)
	Get the Content object that needs to be saved in order to undo all revisions between $undo and $undoafter.
	importTransform ( $blob, $format=null)
	Apply import transformation (per default, returns $blob unchanged).
	isParserCacheSupported ()
	Returns true for content models that support caching using the ParserCache mechanism.
	makeParserOptions ( $context)
	Get parser options suitable for rendering and caching the article.
	makeRedirectContent (Title $destination, $text='')
	Creates a new Content object that acts as a redirect to the given page, or null if redirects are not supported by this content model.
	supportsCategories ()
	Returns true if this content model supports categories.
	supportsDirectApiEditing ()
	Whether or not this content model supports direct editing via ApiEditPage.
	supportsRedirects ()
	Returns true if this content model supports redirects.
	supportsSections ()
	Returns true if this content model supports sections.

Protected Member Functions
	getContentClass ()
Protected Member Functions inherited from ContentHandler
	addSearchField (&$fields, SearchEngine $engine, $name, $type)
	Add new field definition to array.
	checkFormat ( $format)
	Convenient for checking whether a format provided as a parameter is actually supported.
	checkModelID ( $model_id)
	getDiffEngineClass ()
	Returns the name of the diff engine to use.
	getSlotDiffRendererInternal (IContextSource $context)
	Return the SlotDiffRenderer appropriate for this content handler.

Additional Inherited Members
Static Public Member Functions inherited from ContentHandler
static	cleanupHandlersCache ()
	Clean up handlers cache.
static	getAllContentFormats ()
static	getContentModels ()
static	getContentText (Content $content=null)
	Convenience function for getting flat text from a Content object.
static	getDefaultModelFor (Title $title)
	Returns the name of the default content model to be used for the page with the given title.
static	getForContent (Content $content)
	Returns the appropriate ContentHandler singleton for the given Content object.
static	getForModelID ( $modelId)
	Returns the ContentHandler singleton for the given model ID.
static	getForTitle (Title $title)
	Returns the appropriate ContentHandler singleton for the given title.
static	getLocalizedName ( $name, Language $lang=null)
	Returns the localized name for a given content model.
static	makeContent ( $text, Title $title=null, $modelId=null, $format=null)
	Convenience function for creating a Content object from a given textual representation.
Protected Attributes inherited from ContentHandler
string	$mModelID
string[]	$mSupportedFormats
Static Protected Attributes inherited from ContentHandler
static array	$handlers
	A Cache of ContentHandler instances by model id.

Detailed Description

Definition at line 12 of file ScribuntoContentHandler.php.

Constructor & Destructor Documentation

__construct()

ScribuntoContentHandler::__construct	(		$modelId = CONTENT_MODEL_SCRIBUNTO,
			$formats = [ CONTENT_FORMAT_TEXT ] )

Parameters

string	$modelId
string[]	$formats

Reimplemented from TextContentHandler.

Definition at line 18 of file ScribuntoContentHandler.php.

Member Function Documentation

canBeUsedOn()

ScribuntoContentHandler::canBeUsedOn

(

Title

$title

)

Only allow this content handler to be used in the Module namespace.

Parameters

Title

$title

Returns

bool

Reimplemented from ContentHandler.

Definition at line 45 of file ScribuntoContentHandler.php.

References $title, and NS_MODULE.

getContentClass()

ScribuntoContentHandler::getContentClass ( )

protected

Returns

string

Exceptions

MWException

Reimplemented from CodeContentHandler.

Definition at line 24 of file ScribuntoContentHandler.php.

isSupportedFormat()

ScribuntoContentHandler::isSupportedFormat

(

$format

)

Parameters

string

$format

Returns

bool

Reimplemented from ContentHandler.

Definition at line 32 of file ScribuntoContentHandler.php.

References CONTENT_FORMAT_TEXT.

---

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

• extensions/Scribunto/includes/common/ScribuntoContentHandler.php