SiteList.php

Go to the documentation of this file.

<?php

class SiteList extends GenericArrayObject {
    protected $byInternalId = [];

    protected $byGlobalId = [];

    protected $byNavigationId = [];

    public function getObjectType() {
        return 'Site';
    }

    protected function preSetElement( $index, $site ) {
        if ( $this->hasSite( $site->getGlobalId() ) ) {
            $this->removeSite( $site->getGlobalId() );
        }

        $this->byGlobalId[$site->getGlobalId()] = $index;
        $this->byInternalId[$site->getInternalId()] = $index;

        $ids = $site->getNavigationIds();
        foreach ( $ids as $navId ) {
            $this->byNavigationId[$navId] = $index;
        }

        return true;
    }

    public function offsetUnset( $index ) {
        if ( $this->offsetExists( $index ) ) {
            $site = $this->offsetGet( $index );

            unset( $this->byGlobalId[$site->getGlobalId()] );
            unset( $this->byInternalId[$site->getInternalId()] );

            $ids = $site->getNavigationIds();
            foreach ( $ids as $navId ) {
                unset( $this->byNavigationId[$navId] );
            }
        }

        parent::offsetUnset( $index );
    }

    public function getGlobalIdentifiers() {
        return array_keys( $this->byGlobalId );
    }

    public function hasSite( $globalSiteId ) {
        return array_key_exists( $globalSiteId, $this->byGlobalId );
    }

    public function getSite( $globalSiteId ) {
        return $this->offsetGet( $this->byGlobalId[$globalSiteId] );
    }

    public function removeSite( $globalSiteId ) {
        $this->offsetUnset( $this->byGlobalId[$globalSiteId] );
    }

    public function isEmpty() {
        return $this->byGlobalId === [];
    }

    public function hasInternalId( $id ) {
        return array_key_exists( $id, $this->byInternalId );
    }

    public function getSiteByInternalId( $id ) {
        return $this->offsetGet( $this->byInternalId[$id] );
    }

    public function removeSiteByInternalId( $id ) {
        $this->offsetUnset( $this->byInternalId[$id] );
    }

    public function hasNavigationId( $id ) {
        return array_key_exists( $id, $this->byNavigationId );
    }

    public function getSiteByNavigationId( $id ) {
        return $this->offsetGet( $this->byNavigationId[$id] );
    }

    public function removeSiteByNavigationId( $id ) {
        $this->offsetUnset( $this->byNavigationId[$id] );
    }

    public function setSite( Site $site ) {
        $this[] = $site;
    }

    public function getGroup( $groupName ) {
        $group = new self();

        foreach ( $this as $site ) {
            if ( $site->getGroup() === $groupName ) {
                $group[] = $site;
            }
        }

        return $group;
    }

    const SERIAL_VERSION_ID = '2014-03-17';

    public static function getSerialVersionId() {
        return self::SERIAL_VERSION_ID . '+Site:' . Site::SERIAL_VERSION_ID;
    }

    protected function getSerializationData() {
        // NOTE: When changing the structure, either implement unserialize() to handle the
        //      old structure too, or update SERIAL_VERSION_ID to kill any caches.
        return array_merge(
            parent::getSerializationData(),
            [
                'internalIds' => $this->byInternalId,
                'globalIds' => $this->byGlobalId,
                'navigationIds' => $this->byNavigationId
            ]
        );
    }

    public function unserialize( $serialization ) {
        $serializationData = parent::unserialize( $serialization );

        $this->byInternalId = $serializationData['internalIds'];
        $this->byGlobalId = $serializationData['globalIds'];
        $this->byNavigationId = $serializationData['navigationIds'];

        return $serializationData;
    }
}