Inheritance diagram for SiteList:

Collaboration diagram for SiteList:

Public Member Functions
	getGlobalIdentifiers ()
	Returns all the global site identifiers.
	getGroup ($groupName)
	Returns the sites that are in the provided group.
	getObjectType ()
	getSite ($globalSiteId)
	Returns the Site with the provided global site identifier.
	getSiteByInternalId ($id)
	Returns the Site with the provided site id.
	hasInternalId ($id)
	Returns if the list contains the site with the provided site id.
	hasSite ($globalSiteId)
	Returns if the list contains the site with the provided global site identifier.
	isEmpty ()
	Returns if the list contains no sites.
	offsetUnset ($index)
	removeSite ($globalSiteId)
	Removes the site with the specified global site identifier.
	removeSiteByInternalId ($id)
	Removes the site with the specified site id.
	setSite (Site $site)
	Sets a site in the list.
	unserialize ($serialization)
Static Public Member Functions
static	getSerialVersionId ()
	Returns the version ID that identifies the serialization structure used by getSerializationData() and unserialize(), including the structure of any nested structures.
Public Attributes
const	SERIAL_VERSION_ID = '2013-02-07'
Protected Member Functions
	getSerializationData ()
	preSetElement ($index, $site)
Protected Attributes
array	$byGlobalId = array()
	Global site identifiers pointing to their sites offset value.
array	$byInternalId = array()
	Internal site identifiers pointing to their sites offset value.

Detailed Description

Definition at line 29 of file SiteList.php.

Member Function Documentation

SiteList::getGlobalIdentifiers ( )

Returns all the global site identifiers.

Optionally only those belonging to the specified group.

Since:: 1.21

Returns:: array

Definition at line 108 of file SiteList.php.

Referenced by SiteListTest\testGetGlobalIdentifiers(), and SiteListTest\testSerialization().

SiteList::getGroup ( $ groupName )

Returns the sites that are in the provided group.

Since:: 1.21

Parameters:

string $groupName

Returns:: SiteList

Definition at line 218 of file SiteList.php.

SiteList::getObjectType ( )

See also:: GenericArrayObject::getObjectType

Since:: 1.21

Returns:: string

Reimplemented from GenericArrayObject.

Definition at line 54 of file SiteList.php.

SiteList::getSerializationData ( ) [protected]

See also:: GenericArrayObject::getSerializationData

Since:: 1.21

Returns:: array

Reimplemented from GenericArrayObject.

Definition at line 263 of file SiteList.php.

static SiteList::getSerialVersionId ( ) [static]

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.

Returns:: string A string uniquely identifying the version of the serialization structure, including any sub-structures.

Definition at line 252 of file SiteList.php.

SiteList::getSite ( $ globalSiteId )

Returns the Site with the provided global site identifier.

The site needs to exist, so if not sure, call hasGlobalId first.

Since:: 1.21

Parameters:

string $globalSiteId

Returns:: Site

Definition at line 133 of file SiteList.php.

Referenced by SiteListTest\testGetSiteByGlobalId().

SiteList::getSiteByInternalId ( $ id )

Returns the Site with the provided site id.

The site needs to exist, so if not sure, call has first.

Since:: 1.21

Parameters:

integer $id

Returns:: Site

Definition at line 181 of file SiteList.php.

SiteList::hasInternalId ( $ id )

Returns if the list contains the site with the provided site id.

Parameters:

integer $id

Returns:: boolean

Definition at line 167 of file SiteList.php.

SiteList::hasSite ( $ globalSiteId )

Returns if the list contains the site with the provided global site identifier.

Parameters:

string $globalSiteId

Returns:: boolean

Definition at line 119 of file SiteList.php.

SiteList::isEmpty ( )

Returns if the list contains no sites.

Since:: 1.21

Returns:: boolean

Reimplemented from GenericArrayObject.

Definition at line 156 of file SiteList.php.

Referenced by SiteListTest\testGetSiteByGlobalId(), and SiteListTest\testIsEmpty().

SiteList::offsetUnset ( $ index )

See also:: ArrayObject::offsetUnset()

Since:: 1.21

Parameters:

mixed $index

Definition at line 86 of file SiteList.php.

SiteList::preSetElement	(	$	index,
		$	site
	)		`[protected]`

See also:: GenericArrayObject::preSetElement

Since:: 1.21

Parameters:

int \| string	$index
Site	$site

Returns:: boolean

Reimplemented from GenericArrayObject.

Definition at line 68 of file SiteList.php.

SiteList::removeSite ( $ 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

Parameters:

string $globalSiteId

Definition at line 145 of file SiteList.php.

SiteList::removeSiteByInternalId ( $ id )

Removes the site with the specified site id.

The site needs to exist, so if not sure, call has first.

Since:: 1.21

Parameters:

integer $id

Definition at line 193 of file SiteList.php.

SiteList::setSite ( Site $ site )

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

Parameters:

Site $site

Definition at line 205 of file SiteList.php.

SiteList::unserialize ( $ serialization )

See also:: GenericArrayObject::unserialize

Since:: 1.21

Parameters:

string $serialization

Returns:: array

Reimplemented from GenericArrayObject.

Definition at line 284 of file SiteList.php.

Member Data Documentation

array SiteList::$byGlobalId = array() [protected]

Global site identifiers pointing to their sites offset value.

Since:: 1.21

of string

Definition at line 45 of file SiteList.php.

array SiteList::$byInternalId = array() [protected]

Internal site identifiers pointing to their sites offset value.

Since:: 1.21

of integer

Definition at line 37 of file SiteList.php.

const SiteList::SERIAL_VERSION_ID = '2013-02-07'

Definition at line 241 of file SiteList.php.

The documentation for this class was generated from the following file:

includes/site/SiteList.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

Member Data Documentation