Content.php

Go to the documentation of this file.

<?php
interface Content {

    public function getTextForSearchIndex();

    public function getWikitextForTransclusion();

    public function getTextForSummary( $maxLength = 250 );

    public function getNativeData();

    public function getSize();

    public function getModel();

    public function getContentHandler();

    public function getDefaultFormat();

    public function getSupportedFormats();

    public function isSupportedFormat( $format );

    public function serialize( $format = null );

    public function isEmpty();

    public function isValid();

    public function equals( Content $that = null );

    public function copy();

    public function isCountable( $hasLinks = null );

    public function getParserOutput( Title $title, $revId = null,
        ParserOptions $options = null, $generateHtml = true );

    // TODO: make RenderOutput and RenderOptions base classes

    public function getSecondaryDataUpdates( Title $title, Content $old = null,
        $recursive = true, ParserOutput $parserOutput = null );

    public function getRedirectChain();

    public function getRedirectTarget();

    public function getUltimateRedirectTarget();

    public function isRedirect();

    public function updateRedirect( Title $target );

    public function getSection( $sectionId );

    public function replaceSection( $sectionId, Content $with, $sectionTitle = '' );

    public function preSaveTransform( Title $title, User $user, ParserOptions $parserOptions );

    public function addSectionHeader( $header );

    public function preloadTransform( Title $title, ParserOptions $parserOptions, $params = [] );

    public function prepareSave( WikiPage $page, $flags, $parentRevId, User $user );

    public function getDeletionUpdates( WikiPage $page,
        ParserOutput $parserOutput = null );

    public function matchMagicWord( MagicWord $word );

    public function convert( $toModel, $lossy = '' );
    // @todo ImagePage and CategoryPage interfere with per-content action handlers
    // @todo nice&sane integration of GeSHi syntax highlighting
    //   [11:59] <vvv> Hooks are ugly; make CodeHighlighter interface and a
    //   config to set the class which handles syntax highlighting
    //   [12:00] <vvv> And default it to a DummyHighlighter

}