BlueSpice MediaWiki master
 All Classes Namespaces Files Functions Variables Groups Pages
SiteList Class Reference
Inheritance diagram for SiteList:
Collaboration diagram for SiteList:

Public Member Functions

 getObjectType ()
 
 getGlobalIdentifiers ()
 
 hasSite ($globalSiteId)
 
 getSite ($globalSiteId)
 
 removeSite ($globalSiteId)
 
 isEmpty ()
 
 hasInternalId ($id)
 
 getSiteByInternalId ($id)
 
 removeSiteByInternalId ($id)
 
 hasNavigationId ($id)
 
 getSiteByNavigationId ($id)
 
 removeSiteByNavigationId ($id)
 
 setSite (Site $site)
 
 unserialize ($serialization)
 
- Public Member Functions inherited from GenericArrayObject
 getObjectType ()
 
 __construct ($input=null, $flags=0, $iterator_class= 'ArrayIterator')
 
 append ($value)
 
 offsetSet ($index, $value)
 
 serialize ()
 
 unserialize ($serialization)
 
 isEmpty ()
 
- Public Member Functions inherited from ArrayObject
 __construct ($input=null, $flags=0, $iterator_class="ArrayIterator")
 
 offsetExists ($index)
 
 offsetGet ($index)
 
 offsetSet ($index, $newval)
 
 offsetUnset ($index)
 
 append ($value)
 
 getArrayCopy ()
 
 count ()
 
 getFlags ()
 
 setFlags ($flags)
 
 asort ()
 
 ksort ()
 
 uasort ($cmp_function)
 
 uksort ($cmp_function)
 
 natsort ()
 
 natcasesort ()
 
 unserialize ($serialized)
 
 serialize ()
 
 getIterator ()
 
 exchangeArray ($input)
 
 setIteratorClass ($iterator_class)
 
 getIteratorClass ()
 

Static Public Member Functions

static getSerialVersionId ()
 

Public Attributes

const SERIAL_VERSION_ID = '2014-03-17'
 
- Public Attributes inherited from ArrayObject
const STD_PROP_LIST = 1
 
const ARRAY_AS_PROPS = 2
 

Protected Member Functions

 preSetElement ($index, $site)
 
 getSerializationData ()
 
- Protected Member Functions inherited from GenericArrayObject
 getNewOffset ()
 
 hasValidType ($value)
 
 setElement ($index, $value)
 
 preSetElement ($index, $value)
 
 getSerializationData ()
 

Protected Attributes

 $byInternalId = []
 
 $byGlobalId = []
 
 $byNavigationId = []
 
- Protected Attributes inherited from GenericArrayObject
 $indexOffset = 0
 

Member Function Documentation

SiteList::getGlobalIdentifiers ( )

Returns all the global site identifiers. Optionally only those belonging to the specified group.

Since
1.21
Returns
array
SiteList::getObjectType ( )
See Also
GenericArrayObject::getObjectType
Since
1.21
Returns
string
SiteList::getSerializationData ( )
protected
See Also
GenericArrayObject::getSerializationData
Since
1.21
Returns
array
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.
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
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
int$id
Returns
Site
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
SiteList::hasInternalId (   $id)

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

Parameters
int$id
Returns
bool
SiteList::hasNavigationId (   $id)

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

Parameters
string$id
Returns
bool
SiteList::hasSite (   $globalSiteId)

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

Parameters
string$globalSiteId
Returns
bool
SiteList::isEmpty ( )

Returns if the list contains no sites.

Since
1.21
Returns
bool
SiteList::preSetElement (   $index,
  $site 
)
protected
See Also
GenericArrayObject::preSetElement
Since
1.21
Parameters
int | string$index
Site$site
Returns
bool
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
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
int$id
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
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
SiteList::unserialize (   $serialization)
See Also
GenericArrayObject::unserialize
Since
1.21
Parameters
string$serialization
Returns
array

Implements Serializable.


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