AbstractContent.php

Go to the documentation of this file.

<?php
abstract class AbstractContent implements Content {

        protected $model_id;

        public function __construct( $modelId = null ) {
                $this->model_id = $modelId;
        }

        public function getModel() {
                return $this->model_id;
        }

        protected function checkModelID( $modelId ) {
                if ( $modelId !== $this->model_id ) {
                        throw new MWException(
                                "Bad content model: " .
                                "expected {$this->model_id} " .
                                "but got $modelId."
                        );
                }
        }

        public function getContentHandler() {
                return ContentHandler::getForContent( $this );
        }

        public function getDefaultFormat() {
                return $this->getContentHandler()->getDefaultFormat();
        }

        public function getSupportedFormats() {
                return $this->getContentHandler()->getSupportedFormats();
        }

        public function isSupportedFormat( $format ) {
                if ( !$format ) {
                        return true; // this means "use the default"
                }

                return $this->getContentHandler()->isSupportedFormat( $format );
        }

        protected function checkFormat( $format ) {
                if ( !$this->isSupportedFormat( $format ) ) {
                        throw new MWException(
                                "Format $format is not supported for content model " .
                                $this->getModel()
                        );
                }
        }

        public function serialize( $format = null ) {
                return $this->getContentHandler()->serializeContent( $this, $format );
        }

        public function isEmpty() {
                return $this->getSize() === 0;
        }

        public function isValid() {
                return true;
        }

        public function equals( Content $that = null ) {
                if ( is_null( $that ) ) {
                        return false;
                }

                if ( $that === $this ) {
                        return true;
                }

                if ( $that->getModel() !== $this->getModel() ) {
                        return false;
                }

                return $this->getNativeData() === $that->getNativeData();
        }

        public function getSecondaryDataUpdates( Title $title,
                Content $old = null,
                $recursive = true, ParserOutput $parserOutput = null
        ) {
                if ( $parserOutput === null ) {
                        $parserOutput = $this->getParserOutput( $title, null, null, false );
                }

                return $parserOutput->getSecondaryDataUpdates( $title, $recursive );
        }

        public function getRedirectChain() {
                global $wgMaxRedirects;
                $title = $this->getRedirectTarget();
                if ( is_null( $title ) ) {
                        return null;
                }
                // recursive check to follow double redirects
                $recurse = $wgMaxRedirects;
                $titles = array( $title );
                while ( --$recurse > 0 ) {
                        if ( $title->isRedirect() ) {
                                $page = WikiPage::factory( $title );
                                $newtitle = $page->getRedirectTarget();
                        } else {
                                break;
                        }
                        // Redirects to some special pages are not permitted
                        if ( $newtitle instanceOf Title && $newtitle->isValidRedirectTarget() ) {
                                // The new title passes the checks, so make that our current
                                // title so that further recursion can be checked
                                $title = $newtitle;
                                $titles[] = $newtitle;
                        } else {
                                break;
                        }
                }
                return $titles;
        }

        public function getRedirectTarget() {
                return null;
        }

        public function getUltimateRedirectTarget() {
                $titles = $this->getRedirectChain();
                return $titles ? array_pop( $titles ) : null;
        }

        public function isRedirect() {
                return $this->getRedirectTarget() !== null;
        }

        public function updateRedirect( Title $target ) {
                return $this;
        }

        public function getSection( $sectionId ) {
                return null;
        }

        public function replaceSection( $section, Content $with, $sectionTitle = '' ) {
                return null;
        }

        public function preSaveTransform( Title $title, User $user, ParserOptions $popts ) {
                return $this;
        }

        public function addSectionHeader( $header ) {
                return $this;
        }

        public function preloadTransform( Title $title, ParserOptions $popts ) {
                return $this;
        }

        public function prepareSave( WikiPage $page, $flags, $baseRevId, User $user ) {
                if ( $this->isValid() ) {
                        return Status::newGood();
                } else {
                        return Status::newFatal( "invalid-content-data" );
                }
        }

        public function getDeletionUpdates( WikiPage $page,
                ParserOutput $parserOutput = null )
        {
                return array(
                        new LinksDeletionUpdate( $page ),
                );
        }

        public function matchMagicWord( MagicWord $word ) {
                return false;
        }

        public function convert( $toModel, $lossy = '' ) {
                if ( $this->getModel() === $toModel ) {
                        //nothing to do, shorten out.
                        return $this;
                }

                $lossy = ( $lossy === 'lossy' ); // string flag, convert to boolean for convenience
                $result = false;

                wfRunHooks( 'ConvertContent', array( $this, $toModel, $lossy, &$result ) );
                return $result;
        }
}