|
| $byInternalId = [] |
|
| $byGlobalId = [] |
|
| $byNavigationId = [] |
|
| $indexOffset = 0 |
|
SiteList::getGlobalIdentifiers |
( |
| ) |
|
Returns all the global site identifiers. Optionally only those belonging to the specified group.
- Since
- 1.21
- Returns
- array
SiteList::getObjectType |
( |
| ) |
|
SiteList::getSerializationData |
( |
| ) |
|
|
protected |
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
-
- 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
-
- 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
-
- Returns
- Site
SiteList::hasInternalId |
( |
|
$id | ) |
|
Returns if the list contains the site with the provided site id.
- Parameters
-
- Returns
- bool
SiteList::hasNavigationId |
( |
|
$id | ) |
|
Returns if the list contains the site with the provided navigational site id.
- Parameters
-
- Returns
- bool
SiteList::hasSite |
( |
|
$globalSiteId | ) |
|
Returns if the list contains the site with the provided global site identifier.
- Parameters
-
- Returns
- bool
Returns if the list contains no sites.
- Since
- 1.21
- Returns
- bool
SiteList::preSetElement |
( |
|
$index, |
|
|
|
$site |
|
) |
| |
|
protected |
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
-
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
-
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
-
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
-
SiteList::unserialize |
( |
|
$serialization | ) |
|
The documentation for this class was generated from the following file:
- /home/hwfunc/workspace/leonid/BlueSpiceDoc-composer/mediawiki-master/includes/site/SiteList.php