Inheritance diagram for SiteList:

[legend]

Collaboration diagram for SiteList:

Public Member Functions
	getGlobalIdentifiers ()
	Returns all the global site identifiers. More...

	getGroup ( $groupName)
	Returns the sites that are in the provided group. More...

	getObjectType ()

	getSite ( $globalSiteId)
	Returns the Site with the provided global site identifier. More...

	getSiteByInternalId ( $id)
	Returns the Site with the provided site id. More...

	getSiteByNavigationId ( $id)
	Returns the Site with the provided navigational site id. More...

	hasInternalId ( $id)
	Returns if the list contains the site with the provided site id. More...

	hasNavigationId ( $id)
	Returns if the list contains the site with the provided navigational site id. More...

	hasSite ( $globalSiteId)
	Returns if the list contains the site with the provided global site identifier. More...

	isEmpty ()
	Returns if the list contains no sites. More...

	offsetUnset ( $index)

	removeSite ( $globalSiteId)
	Removes the site with the specified global site identifier. More...

	removeSiteByInternalId ( $id)
	Removes the site with the specified site id. More...

	removeSiteByNavigationId ( $id)
	Removes the site with the specified navigational site id. More...

	setSite (Site $site)
	Sets a site in the list. More...

	unserialize ( $serialization)

Public Member Functions inherited from GenericArrayObject
	__construct ( $input=null, $flags=0, $iterator_class='ArrayIterator')
	Constructor. More...

	append ( $value)

	offsetSet ( $index, $value)

	serialize ()

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. More...

Public Attributes
const	SERIAL_VERSION_ID = '2014-03-17'

Protected Member Functions
	getSerializationData ()

	preSetElement ( $index, $site)

Protected Member Functions inherited from GenericArrayObject
	getNewOffset ()
	Finds a new offset for when appending an element. More...

	hasValidType ( $value)
	Returns if the provided value has the same type as the elements that can be added to this ArrayObject. More...

	setElement ( $index, $value)
	Method that actually sets the element and holds all common code needed for set operations, including type checking and offset resolving. More...

Protected Attributes
array	$byGlobalId = array()
	Global site identifiers pointing to their sites offset value. More...

array	$byInternalId = array()
	Internal site identifiers pointing to their sites offset value. More...

array	$byNavigationId = array()
	Navigational site identifiers alias inter-language prefixes pointing to their sites offset value. More...

Protected Attributes inherited from GenericArrayObject
integer	$indexOffset = 0

Detailed Description

Definition at line 29 of file SiteList.php.

Member Function Documentation

◆ getGlobalIdentifiers()

SiteList::getGlobalIdentifiers ( )

Returns all the global site identifiers.

Optionally only those belonging to the specified group.

Since: 1.21

Returns: array

Definition at line 127 of file SiteList.php.

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

◆ getGroup()

SiteList::getGroup ( $groupName )

Returns the sites that are in the provided group.

Since: 1.21

Parameters

string $groupName

Returns: SiteList

Definition at line 274 of file SiteList.php.

References as.

◆ getObjectType()

SiteList::getObjectType ( )

See also: GenericArrayObject::getObjectType

Since: 1.21

Returns: string

Reimplemented from GenericArrayObject.

Definition at line 63 of file SiteList.php.

◆ getSerializationData()

SiteList::getSerializationData ( )

protected

See also: GenericArrayObject::getSerializationData

Since: 1.21

Returns: array

Reimplemented from GenericArrayObject.

Definition at line 319 of file SiteList.php.

References array().

◆ getSerialVersionId()

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 308 of file SiteList.php.

References Site\SERIAL_VERSION_ID.

Referenced by SiteSQLStore\getCacheKey().

◆ getSite()

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 152 of file SiteList.php.

Referenced by SiteSQLStore\getSite(), and SiteListTest\testGetSiteByGlobalId().

◆ getSiteByInternalId()

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 200 of file SiteList.php.

◆ getSiteByNavigationId()

SiteList::getSiteByNavigationId ( $id )

Returns the Site with the provided navigational site id.

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

Since: 1.23

Parameters

string $id

Returns: Site

Definition at line 237 of file SiteList.php.

◆ hasInternalId()

SiteList::hasInternalId ( $id )

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

Parameters

integer $id

Returns: boolean

Definition at line 186 of file SiteList.php.

◆ hasNavigationId()

SiteList::hasNavigationId ( $id )

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

Parameters

string $id

Returns: boolean

Definition at line 223 of file SiteList.php.

◆ hasSite()

SiteList::hasSite ( $globalSiteId )

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

Parameters

string $globalSiteId

Returns: boolean

Definition at line 138 of file SiteList.php.

Referenced by SiteSQLStore\getSite(), and preSetElement().

◆ isEmpty()

SiteList::isEmpty ( )

Returns if the list contains no sites.

Since: 1.21

Returns: boolean

Reimplemented from GenericArrayObject.

Definition at line 175 of file SiteList.php.

References array().

Referenced by SiteListTest\testIsEmpty().

◆ offsetUnset()

SiteList::offsetUnset ( $index )

See also: ArrayObject::offsetUnset()

Since: 1.21

Parameters

mixed $index

Definition at line 100 of file SiteList.php.

References as.

Referenced by removeSite(), removeSiteByInternalId(), and removeSiteByNavigationId().

◆ preSetElement()

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 77 of file SiteList.php.

References as, hasSite(), and removeSite().

◆ removeSite()

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 164 of file SiteList.php.

References offsetUnset().

Referenced by preSetElement().

◆ removeSiteByInternalId()

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 212 of file SiteList.php.

References offsetUnset().

◆ removeSiteByNavigationId()

SiteList::removeSiteByNavigationId ( $id )

Removes the site with the specified navigational site id.

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

Since: 1.23

Parameters

string $id

Definition at line 249 of file SiteList.php.

References offsetUnset().

◆ setSite()

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 261 of file SiteList.php.

◆ unserialize()

SiteList::unserialize ( $serialization )

See also: GenericArrayObject::unserialize

Since: 1.21

Parameters

string $serialization

Returns: array

Reimplemented from GenericArrayObject.

Definition at line 341 of file SiteList.php.

Member Data Documentation

◆ $byGlobalId

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.

◆ $byInternalId

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.

◆ $byNavigationId

array SiteList::$byNavigationId = array()

protected

Navigational site identifiers alias inter-language prefixes pointing to their sites offset value.

Since: 1.23

of string

Definition at line 54 of file SiteList.php.

◆ SERIAL_VERSION_ID

const SiteList::SERIAL_VERSION_ID = '2014-03-17'

Definition at line 297 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

◆ getGlobalIdentifiers()

◆ getGroup()

◆ getObjectType()

◆ getSerializationData()

◆ getSerialVersionId()

◆ getSite()

◆ getSiteByInternalId()

◆ getSiteByNavigationId()

◆ hasInternalId()

◆ hasNavigationId()

◆ hasSite()

◆ isEmpty()

◆ offsetUnset()

◆ preSetElement()

◆ removeSite()

◆ removeSiteByInternalId()

◆ removeSiteByNavigationId()

◆ setSite()

◆ unserialize()

Member Data Documentation

◆ $byGlobalId

◆ $byInternalId

◆ $byNavigationId

◆ SERIAL_VERSION_ID