MediaWiki master
|
Base implementation for content objects. More...
Inherits MediaWiki\Content\Content.
Inherited by MediaWiki\Content\FallbackContent, and MediaWiki\Content\TextContent.
Public Member Functions | |
__construct ( $modelId=null) | |
addSectionHeader ( $header) | |
convert ( $toModel, $lossy='') | |
This base implementation calls the hook ConvertContent to enable custom conversions. | |
equals (?Content $that=null) | |
Decides whether two Content objects are equal. | |
getContentHandler () | |
getDefaultFormat () | |
getModel () | |
getNativeData () | |
Returns native representation of the data. | |
getRedirectTarget () | |
Subclasses that implement redirects should override this. | |
getSection ( $sectionId) | |
getSupportedFormats () | |
isEmpty () | |
isRedirect () | |
isSupportedFormat ( $format) | |
isValid () | |
Subclasses may override this to implement (light weight) validation. | |
matchMagicWord (MagicWord $word) | |
This default implementation always returns false. | |
replaceSection ( $sectionId, Content $with, $sectionTitle='') | |
serialize ( $format=null) | |
updateRedirect (Title $target) | |
This default implementation always returns $this. | |
![]() | |
copy () | |
Return a copy of this Content object. | |
getSize () | |
Returns the content's nominal size in "bogo-bytes". | |
getTextForSearchIndex () | |
getTextForSummary ( $maxLength=250) | |
Returns a textual representation of the content suitable for use in edit summaries and log messages. | |
getWikitextForTransclusion () | |
isCountable ( $hasLinks=null) | |
Returns true if this content is countable as a "real" wiki page, provided that it's also in a countable location (e.g. | |
Protected Member Functions | |
checkFormat ( $format) | |
checkModelID ( $modelId) | |
equalsInternal (Content $that) | |
Checks whether $that is logically equal to this Content object. | |
getContentHandlerFactory () | |
Protected Attributes | |
string | $model_id |
Name of the content model this Content object represents. | |
Base implementation for content objects.
Definition at line 45 of file AbstractContent.php.
MediaWiki\Content\AbstractContent::__construct | ( | $modelId = null | ) |
string | null | $modelId |
Reimplemented in MediaWiki\Content\WikitextContent.
Definition at line 63 of file AbstractContent.php.
MediaWiki\Content\AbstractContent::addSectionHeader | ( | $header | ) |
string | $header |
Implements MediaWiki\Content\Content.
Reimplemented in MediaWiki\Content\WikitextContent.
Definition at line 370 of file AbstractContent.php.
|
protected |
string | $format | The serialization format to check. |
MWException | If the format is not supported by this content handler. |
Definition at line 153 of file AbstractContent.php.
|
protected |
string | $modelId | The model to check |
MWException | If the provided ID is not the ID of the content model supported by this Content object. |
Definition at line 85 of file AbstractContent.php.
Referenced by MediaWiki\Content\TextContent\diff().
MediaWiki\Content\AbstractContent::convert | ( | $toModel, | |
$lossy = '' ) |
This base implementation calls the hook ConvertContent to enable custom conversions.
Subclasses may override this to implement conversion for "their" content model.
string | $toModel | |
string | $lossy |
Implements MediaWiki\Content\Content.
Reimplemented in MediaWiki\Content\FallbackContent, and MediaWiki\Content\TextContent.
Definition at line 404 of file AbstractContent.php.
References MediaWiki\MediaWikiServices\getInstance().
MediaWiki\Content\AbstractContent::equals | ( | ?Content | $that = null | ) |
Decides whether two Content objects are equal.
Two Content objects MUST not be considered equal if they do not share the same content model. Two Content objects that are equal SHOULD have the same serialization.
This default implementation relies on equalsInternal() to determine whether the Content objects are logically equivalent. Subclasses that need to implement a custom equality check should consider overriding equalsInternal(). Subclasses that override equals() itself MUST make sure that the implementation returns false for $that === null, and true for $that === this. It MUST also return false if $that does not have the same content model.
Content | null | $that |
Implements MediaWiki\Content\Content.
Definition at line 246 of file AbstractContent.php.
Referenced by MediaWiki\Content\CssContent\getRedirectTarget().
|
protected |
Checks whether $that is logically equal to this Content object.
This method can be overwritten by subclasses that need to implement custom equality checks.
This default implementation checks whether the serializations of $this and $that are the same: $this->serialize() === $that->serialize()
Implementors can assume that $that is an instance of the same class as the present Content object, as long as equalsInternal() is only called by the standard implementation of equals().
Content | $that |
Reimplemented in MediaWiki\Content\FallbackContent.
Definition at line 287 of file AbstractContent.php.
References MediaWiki\Content\Content\serialize().
MediaWiki\Content\AbstractContent::getContentHandler | ( | ) |
Implements MediaWiki\Content\Content.
Reimplemented in MediaWiki\Content\WikitextContent.
Definition at line 101 of file AbstractContent.php.
References MediaWiki\Content\AbstractContent\getContentHandlerFactory(), and MediaWiki\Content\AbstractContent\getModel().
Referenced by MediaWiki\Content\CssContent\getRedirectTarget(), MediaWiki\Content\JavaScriptContent\getRedirectTarget(), MediaWiki\Content\CssContent\updateRedirect(), and MediaWiki\Content\JavaScriptContent\updateRedirect().
|
protected |
Definition at line 105 of file AbstractContent.php.
Referenced by MediaWiki\Content\TextContent\convert(), and MediaWiki\Content\AbstractContent\getContentHandler().
MediaWiki\Content\AbstractContent::getDefaultFormat | ( | ) |
Implements MediaWiki\Content\Content.
Definition at line 115 of file AbstractContent.php.
MediaWiki\Content\AbstractContent::getModel | ( | ) |
Implements MediaWiki\Content\Content.
Definition at line 73 of file AbstractContent.php.
References MediaWiki\Content\AbstractContent\$model_id.
Referenced by MediaWiki\Content\AbstractContent\getContentHandler(), and MediaWiki\Content\WikitextContent\replaceSection().
MediaWiki\Content\AbstractContent::getNativeData | ( | ) |
Returns native representation of the data.
Interpretation depends on the data model used, as given by getDataModel().
LogicException |
Implements MediaWiki\Content\Content.
Reimplemented in MediaWiki\Content\FallbackContent, and MediaWiki\Content\TextContent.
Definition at line 194 of file AbstractContent.php.
References wfDeprecated().
MediaWiki\Content\AbstractContent::getRedirectTarget | ( | ) |
Subclasses that implement redirects should override this.
Implements MediaWiki\Content\Content.
Reimplemented in MediaWiki\Content\CssContent, MediaWiki\Content\JavaScriptContent, and MediaWiki\Content\WikitextContent.
Definition at line 301 of file AbstractContent.php.
MediaWiki\Content\AbstractContent::getSection | ( | $sectionId | ) |
string | int | $sectionId |
Implements MediaWiki\Content\Content.
Reimplemented in MediaWiki\Content\WikitextContent.
Definition at line 342 of file AbstractContent.php.
MediaWiki\Content\AbstractContent::getSupportedFormats | ( | ) |
Implements MediaWiki\Content\Content.
Definition at line 125 of file AbstractContent.php.
MediaWiki\Content\AbstractContent::isEmpty | ( | ) |
Implements MediaWiki\Content\Content.
Definition at line 207 of file AbstractContent.php.
MediaWiki\Content\AbstractContent::isRedirect | ( | ) |
Implements MediaWiki\Content\Content.
Definition at line 312 of file AbstractContent.php.
Referenced by MediaWiki\Content\TextContent\isCountable(), MediaWiki\Content\WikitextContent\isCountable(), MediaWiki\Content\CssContent\updateRedirect(), MediaWiki\Content\JavaScriptContent\updateRedirect(), and MediaWiki\Content\WikitextContent\updateRedirect().
MediaWiki\Content\AbstractContent::isSupportedFormat | ( | $format | ) |
string | $format |
Implements MediaWiki\Content\Content.
Definition at line 138 of file AbstractContent.php.
MediaWiki\Content\AbstractContent::isValid | ( | ) |
Subclasses may override this to implement (light weight) validation.
Implements MediaWiki\Content\Content.
Reimplemented in MediaWiki\Content\JsonContent.
Definition at line 221 of file AbstractContent.php.
MediaWiki\Content\AbstractContent::matchMagicWord | ( | MagicWord | $word | ) |
This default implementation always returns false.
Subclasses may override this to supply matching logic.
MagicWord | $word |
Implements MediaWiki\Content\Content.
Reimplemented in MediaWiki\Content\WikitextContent.
Definition at line 387 of file AbstractContent.php.
MediaWiki\Content\AbstractContent::replaceSection | ( | $sectionId, | |
Content | $with, | ||
$sectionTitle = '' ) |
string | int | null | false | $sectionId | |
Content | $with | |
string | $sectionTitle |
Implements MediaWiki\Content\Content.
Reimplemented in MediaWiki\Content\WikitextContent.
Definition at line 357 of file AbstractContent.php.
MediaWiki\Content\AbstractContent::serialize | ( | $format = null | ) |
string | null | $format |
Implements MediaWiki\Content\Content.
Reimplemented in MediaWiki\Content\FallbackContent.
Definition at line 172 of file AbstractContent.php.
MediaWiki\Content\AbstractContent::updateRedirect | ( | Title | $target | ) |
This default implementation always returns $this.
Subclasses that implement redirects should override this.
Title | $target |
Implements MediaWiki\Content\Content.
Reimplemented in MediaWiki\Content\CssContent, MediaWiki\Content\JavaScriptContent, and MediaWiki\Content\WikitextContent.
Definition at line 329 of file AbstractContent.php.
|
protected |
Name of the content model this Content object represents.
Use with CONTENT_MODEL_XXX constants
Definition at line 54 of file AbstractContent.php.
Referenced by MediaWiki\Content\FallbackContent\__construct(), MediaWiki\Content\TextContent\__construct(), and MediaWiki\Content\AbstractContent\getModel().