SpecialCachedPage.php

Go to the documentation of this file.

<?php

abstract class SpecialCachedPage extends SpecialPage implements ICacheHelper {

        protected $cacheHelper;

        protected $cacheEnabled = true;

        protected function afterExecute( $subPage ) {
                $this->saveCache();

                parent::afterExecute( $subPage );
        }

        public function setCacheEnabled( $cacheEnabled ) {
                $this->cacheHelper->setCacheEnabled( $cacheEnabled );
        }

        public function startCache( $cacheExpiry = null, $cacheEnabled = null ) {
                if ( !isset( $this->cacheHelper ) ) {
                        $this->cacheHelper = new CacheHelper();

                        $this->cacheHelper->setCacheEnabled( $this->cacheEnabled );
                        $this->cacheHelper->setOnInitializedHandler( array( $this, 'onCacheInitialized' ) );

                        $keyArgs = $this->getCacheKey();

                        if ( array_key_exists( 'action', $keyArgs ) && $keyArgs['action'] === 'purge' ) {
                                unset( $keyArgs['action'] );
                        }

                        $this->cacheHelper->setCacheKey( $keyArgs );

                        if ( $this->getRequest()->getText( 'action' ) === 'purge' ) {
                                $this->cacheHelper->rebuildOnDemand();
                        }
                }

                $this->cacheHelper->startCache( $cacheExpiry, $cacheEnabled );
        }

        public function getCachedValue( $computeFunction, $args = array(), $key = null ) {
                return $this->cacheHelper->getCachedValue( $computeFunction, $args, $key );
        }

        public function addCachedHTML( $computeFunction, $args = array(), $key = null ) {
                $this->getOutput()->addHTML( $this->cacheHelper->getCachedValue( $computeFunction, $args, $key ) );
        }

        public function saveCache() {
                if ( isset( $this->cacheHelper ) ) {
                        $this->cacheHelper->saveCache();
                }
        }

        public function setExpiry( $cacheExpiry ) {
                $this->cacheHelper->setExpiry( $cacheExpiry );
        }

        protected function getCacheKey() {
                return array(
                        $this->mName,
                        $this->getLanguage()->getCode()
                );
        }

        public function onCacheInitialized( $hasCached ) {
                if ( $hasCached ) {
                        $this->getOutput()->setSubtitle( $this->cacheHelper->getCachedNotice( $this->getContext() ) );
                }
        }

}