1 files changed, 300 insertions, 0 deletions
diff --git a/includes/site/SiteList.php b/includes/site/SiteList.php
new file mode 100644
index 00000000..b0d1f95b
--- /dev/null
+++ b/includes/site/SiteList.php
@@ -0,0 +1,300 @@
+<?php
+
+/**
+ * Collection of Site objects.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @since 1.21
+ *
+ * @file
+ * @ingroup Site
+ *
+ * @license GNU GPL v2+
+ * @author Jeroen De Dauw < jeroendedauw@gmail.com >
+ */
+class SiteList extends GenericArrayObject {
+
+	/**
+	 * Internal site identifiers pointing to their sites offset value.
+	 *
+	 * @since 1.21
+	 *
+	 * @var array of integer
+	 */
+	protected $byInternalId = array();
+
+	/**
+	 * Global site identifiers pointing to their sites offset value.
+	 *
+	 * @since 1.21
+	 *
+	 * @var array of string
+	 */
+	protected $byGlobalId = array();
+
+	/**
+	 * @see GenericArrayObject::getObjectType
+	 *
+	 * @since 1.21
+	 *
+	 * @return string
+	 */
+	public function getObjectType() {
+		return 'Site';
+	}
+
+	/**
+	 * @see GenericArrayObject::preSetElement
+	 *
+	 * @since 1.21
+	 *
+	 * @param int|string $index
+	 * @param Site $site
+	 *
+	 * @return boolean
+	 */
+	protected function preSetElement( $index, $site ) {
+		if ( $this->hasSite( $site->getGlobalId() ) ) {
+			$this->removeSite( $site->getGlobalId() );
+		}
+
+		$this->byGlobalId[$site->getGlobalId()] = $index;
+		$this->byInternalId[$site->getInternalId()] = $index;
+
+		return true;
+	}
+
+	/**
+	 * @see ArrayObject::offsetUnset()
+	 *
+	 * @since 1.21
+	 *
+	 * @param mixed $index
+	 */
+	public function offsetUnset( $index ) {
+		if ( $this->offsetExists( $index ) ) {
+			/**
+			 * @var Site $site
+			 */
+			$site = $this->offsetGet( $index );
+
+			unset( $this->byGlobalId[$site->getGlobalId()] );
+			unset( $this->byInternalId[$site->getInternalId()] );
+		}
+
+		parent::offsetUnset( $index );
+	}
+
+	/**
+	 * Returns all the global site identifiers.
+	 * Optionally only those belonging to the specified group.
+	 *
+	 * @since 1.21
+	 *
+	 * @return array
+	 */
+	public function getGlobalIdentifiers() {
+		return array_keys( $this->byGlobalId );
+	}
+
+	/**
+	 * Returns if the list contains the site with the provided global site identifier.
+	 *
+	 * @param string $globalSiteId
+	 *
+	 * @return boolean
+	 */
+	public function hasSite( $globalSiteId ) {
+		return array_key_exists( $globalSiteId, $this->byGlobalId );
+	}
+
+	/**
+	 * Returns the Site with the provided global site identifier.
+	 * The site needs to exist, so if not sure, call hasGlobalId first.
+	 *
+	 * @since 1.21
+	 *
+	 * @param string $globalSiteId
+	 *
+	 * @return Site
+	 */
+	public function getSite( $globalSiteId ) {
+		return $this->offsetGet( $this->byGlobalId[$globalSiteId] );
+	}
+
+	/**
+	 * Removes the site with the specified global site identifier.
+	 * The site needs to exist, so if not sure, call hasGlobalId first.
+	 *
+	 * @since 1.21
+	 *
+	 * @param string $globalSiteId
+	 */
+	public function removeSite( $globalSiteId ) {
+		$this->offsetUnset( $this->byGlobalId[$globalSiteId] );
+	}
+
+	/**
+	 * Returns if the list contains no sites.
+	 *
+	 * @since 1.21
+	 *
+	 * @return boolean
+	 */
+	public function isEmpty() {
+		return $this->byGlobalId === array();
+	}
+
+	/**
+	 * Returns if the list contains the site with the provided site id.
+	 *
+	 * @param integer $id
+	 *
+	 * @return boolean
+	 */
+	public function hasInternalId( $id ) {
+		return array_key_exists( $id, $this->byInternalId );
+	}
+
+	/**
+	 * Returns the Site with the provided site id.
+	 * The site needs to exist, so if not sure, call has first.
+	 *
+	 * @since 1.21
+	 *
+	 * @param integer $id
+	 *
+	 * @return Site
+	 */
+	public function getSiteByInternalId( $id ) {
+		return $this->offsetGet( $this->byInternalId[$id] );
+	}
+
+	/**
+	 * Removes the site with the specified site id.
+	 * The site needs to exist, so if not sure, call has first.
+	 *
+	 * @since 1.21
+	 *
+	 * @param integer $id
+	 */
+	public function removeSiteByInternalId( $id ) {
+		$this->offsetUnset( $this->byInternalId[$id] );
+	}
+
+	/**
+	 * Sets a site in the list. If the site was not there,
+	 * it will be added. If it was, it will be updated.
+	 *
+	 * @since 1.21
+	 *
+	 * @param Site $site
+	 */
+	public function setSite( Site $site ) {
+		$this[] = $site;
+	}
+
+	/**
+	 * Returns the sites that are in the provided group.
+	 *
+	 * @since 1.21
+	 *
+	 * @param string $groupName
+	 *
+	 * @return SiteList
+	 */
+	public function getGroup( $groupName ) {
+		$group = new self();
+
+		/**
+		 * @var \Site $site
+		 */
+		foreach ( $this as $site ) {
+			if ( $site->getGroup() === $groupName ) {
+				$group[] = $site;
+			}
+		}
+
+		return $group;
+	}
+
+	/**
+	 * A version ID that identifies the serialization structure used by getSerializationData()
+	 * and unserialize(). This is useful for constructing cache keys in cases where the cache relies
+	 * on serialization for storing the SiteList.
+	 *
+	 * @var string A string uniquely identifying the version of the serialization structure,
+	 *             not including any sub-structures.
+	 */
+	const SERIAL_VERSION_ID = '2013-02-07';
+
+	/**
+	 * Returns the version ID that identifies the serialization structure used by
+	 * getSerializationData() and unserialize(), including the structure of any nested structures.
+	 * This is useful for constructing cache keys in cases where the cache relies
+	 * on serialization for storing the SiteList.
+	 *
+	 * @return string A string uniquely identifying the version of the serialization structure,
+	 *                including any sub-structures.
+	 */
+	public static function getSerialVersionId() {
+		return self::SERIAL_VERSION_ID . '+Site:' . Site::SERIAL_VERSION_ID;
+	}
+
+	/**
+	 * @see GenericArrayObject::getSerializationData
+	 *
+	 * @since 1.21
+	 *
+	 * @return array
+	 */
+	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(),
+			array(
+				'internalIds' => $this->byInternalId,
+				'globalIds' => $this->byGlobalId,
+			)
+		);
+	}
+
+	/**
+	 * @see GenericArrayObject::unserialize
+	 *
+	 * @since 1.21
+	 *
+	 * @param string $serialization
+	 *
+	 * @return array
+	 */
+	public function unserialize( $serialization ) {
+		$serializationData = parent::unserialize( $serialization );
+
+		$this->byInternalId = $serializationData['internalIds'];
+		$this->byGlobalId = $serializationData['globalIds'];
+
+		return $serializationData;
+	}
+
+}
+
+/**
+ * @deprecated
+ */
+class SiteArray extends SiteList {}