FileBasedSiteLookup.php

Go to the documentation of this file.

<?php
class FileBasedSiteLookup implements SiteLookup {
 
    private $sites = null;
 
    private $cacheFile;
 
    public function __construct( $cacheFile ) {
        wfDeprecated( __CLASS__, '1.33' );
        $this->cacheFile = $cacheFile;
    }
 
    public function getSites() {
        if ( $this->sites === null ) {
            $this->sites = $this->loadSitesFromCache();
        }
 
        return $this->sites;
    }
 
    public function getSite( $globalId ) {
        $sites = $this->getSites();
 
        return $sites->hasSite( $globalId ) ? $sites->getSite( $globalId ) : null;
    }
 
    private function loadSitesFromCache() {
        $data = $this->loadJsonFile();
 
        $sites = new SiteList();
 
        // @todo lazy initialize the site objects in the site list (e.g. only when needed to access)
        foreach ( $data['sites'] as $siteArray ) {
            $sites[] = $this->newSiteFromArray( $siteArray );
        }
 
        return $sites;
    }
 
    private function loadJsonFile() {
        if ( !is_readable( $this->cacheFile ) ) {
            throw new MWException( 'SiteList cache file not found.' );
        }
 
        $contents = file_get_contents( $this->cacheFile );
        $data = json_decode( $contents, true );
 
        if ( !is_array( $data ) || !is_array( $data['sites'] )
            || !array_key_exists( 'sites', $data )
        ) {
            throw new MWException( 'SiteStore json cache data is invalid.' );
        }
 
        return $data;
    }
 
    private function newSiteFromArray( array $data ) {
        $siteType = array_key_exists( 'type', $data ) ? $data['type'] : Site::TYPE_UNKNOWN;
        $site = Site::newForType( $siteType );
 
        $site->setGlobalId( $data['globalid'] );
        $site->setForward( $data['forward'] );
        $site->setGroup( $data['group'] );
        $site->setLanguageCode( $data['language'] );
        $site->setSource( $data['source'] );
        $site->setExtraData( $data['data'] );
        $site->setExtraConfig( $data['config'] );
 
        foreach ( $data['identifiers'] as $identifier ) {
            $site->addLocalId( $identifier['type'], $identifier['key'] );
        }
 
        return $site;
    }
 
}