Site.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Site;
 
use MediaWiki\MediaWikiServices;
use RuntimeException;
use UnexpectedValueException;
 
class Site {
    public const TYPE_UNKNOWN = 'unknown';
    public const TYPE_MEDIAWIKI = 'mediawiki';
 
    public const GROUP_NONE = 'none';
 
    public const ID_INTERWIKI = 'interwiki';
    public const ID_EQUIVALENT = 'equivalent';
 
    public const SOURCE_LOCAL = 'local';
 
    public const PATH_LINK = 'link';
 
    public const SERIAL_VERSION_ID = '2013-01-23';
 
    protected $globalId = null;
 
    protected $type = self::TYPE_UNKNOWN;
 
    protected $group = self::GROUP_NONE;
 
    protected $source = self::SOURCE_LOCAL;
 
    protected $languageCode = null;
 
    protected $localIds = [];
 
    protected $extraData = [];
 
    protected $extraConfig = [];
 
    protected $forward = false;
 
    protected $internalId = null;
 
    public function __construct( $type = self::TYPE_UNKNOWN ) {
        $this->type = $type;
    }
 
    public function getGlobalId() {
        return $this->globalId;
    }
 
    public function setGlobalId( ?string $globalId ) {
        $this->globalId = $globalId;
    }
 
    public function getType() {
        return $this->type;
    }
 
    public function getGroup() {
        return $this->group;
    }
 
    public function setGroup( string $group ) {
        $this->group = $group;
    }
 
    public function getSource() {
        return $this->source;
    }
 
    public function setSource( string $source ) {
        $this->source = $source;
    }
 
    public function shouldForward() {
        return $this->forward;
    }
 
    public function setForward( bool $shouldForward ) {
        $this->forward = $shouldForward;
    }
 
    public function getDomain(): ?string {
        $path = $this->getLinkPath();
 
        if ( $path === null ) {
            return null;
        }
 
        $domain = parse_url( $path, PHP_URL_HOST );
 
        if ( $domain === false ) {
            $domain = null;
        }
 
        return $domain;
    }
 
    public function getProtocol() {
        $path = $this->getLinkPath();
 
        if ( $path === null ) {
            return '';
        }
 
        $protocol = parse_url( $path, PHP_URL_SCHEME );
 
        // Malformed URL
        if ( $protocol === false ) {
            throw new UnexpectedValueException( "failed to parse URL '$path'" );
        }
 
        // Used for protocol relative URLs
        return $protocol ?? '';
    }
 
    public function setLinkPath( $fullUrl ) {
        $type = $this->getLinkPathType();
 
        if ( $type === null ) {
            throw new RuntimeException( "This Site does not support link paths." );
        }
 
        $this->setPath( $type, $fullUrl );
    }
 
    public function getLinkPath() {
        return $this->getPath( $this->getLinkPathType() );
    }
 
    public function getLinkPathType() {
        return self::PATH_LINK;
    }
 
    public function getPageUrl( $pageName = false ) {
        $url = $this->getLinkPath();
 
        if ( $url === null ) {
            return null;
        }
 
        if ( $pageName !== false ) {
            $url = str_replace( '$1', rawurlencode( $pageName ), $url );
        }
 
        return $url;
    }
 
    public function normalizePageName( $pageName, $followRedirect = MediaWikiPageNameNormalizer::FOLLOW_REDIRECT ) {
        return $pageName;
    }
 
    public function getExtraData() {
        return $this->extraData;
    }
 
    public function setExtraData( array $extraData ) {
        $this->extraData = $extraData;
    }
 
    public function getExtraConfig() {
        return $this->extraConfig;
    }
 
    public function setExtraConfig( array $extraConfig ) {
        $this->extraConfig = $extraConfig;
    }
 
    public function getLanguageCode() {
        return $this->languageCode;
    }
 
    public function setLanguageCode( $languageCode ) {
        $this->languageCode = $languageCode;
    }
 
    public function getInternalId() {
        return $this->internalId;
    }
 
    public function setInternalId( $internalId = null ) {
        $this->internalId = $internalId;
    }
 
    public function addLocalId( $type, $identifier ) {
        if ( $this->localIds === false ) {
            $this->localIds = [];
        }
 
        $this->localIds[$type] ??= [];
 
        if ( !in_array( $identifier, $this->localIds[$type] ) ) {
            $this->localIds[$type][] = $identifier;
        }
    }
 
    public function addInterwikiId( $identifier ) {
        $this->addLocalId( self::ID_INTERWIKI, $identifier );
    }
 
    public function addNavigationId( $identifier ) {
        $this->addLocalId( self::ID_EQUIVALENT, $identifier );
    }
 
    public function getInterwikiIds() {
        return $this->localIds[self::ID_INTERWIKI] ?? [];
    }
 
    public function getNavigationIds() {
        return $this->localIds[self::ID_EQUIVALENT] ?? [];
    }
 
    public function getLocalIds() {
        return $this->localIds;
    }
 
    public function setPath( $pathType, string $fullUrl ) {
        $this->extraData['paths'][$pathType] = $fullUrl;
    }
 
    public function getPath( $pathType ) {
        $paths = $this->getAllPaths();
        return $paths[$pathType] ?? null;
    }
 
    public function getAllPaths() {
        return $this->extraData['paths'] ?? [];
    }
 
    public function removePath( $pathType ) {
        if ( array_key_exists( 'paths', $this->extraData ) ) {
            unset( $this->extraData['paths'][$pathType] );
        }
    }
 
    public static function newForType( $siteType ) {
        return MediaWikiServices::getInstance()->getSiteSanitizer()->newSiteForType( $siteType );
    }
 
    public function __serialize() {
        return [
            'globalid' => $this->globalId,
            'type' => $this->type,
            'group' => $this->group,
            'source' => $this->source,
            'language' => $this->languageCode,
            'localids' => $this->localIds,
            'config' => $this->extraConfig,
            'data' => $this->extraData,
            'forward' => $this->forward,
            'internalid' => $this->internalId,
        ];
    }
 
    public function __unserialize( $fields ) {
        $this->__construct( $fields['type'] );
 
        $this->setGlobalId( $fields['globalid'] );
        $this->setGroup( $fields['group'] );
        $this->setSource( $fields['source'] );
        $this->setLanguageCode( $fields['language'] );
        $this->localIds = $fields['localids'];
        $this->setExtraConfig( $fields['config'] );
        $this->setExtraData( $fields['data'] );
        $this->setForward( $fields['forward'] );
        $this->setInternalId( $fields['internalid'] );
    }
}
 
class_alias( Site::class, 'Site' );