PHPXRef 0.7.1 : MediaWiki-1.24.0 : Detail view of SiteList.php

(no description)

File Size:	358 lines (8 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

Defines 2 classes

SiteList:: (19 methods):
  getObjectType()
  preSetElement()
  offsetUnset()
  getGlobalIdentifiers()
  hasSite()
  getSite()
  removeSite()
  isEmpty()
  hasInternalId()
  getSiteByInternalId()
  removeSiteByInternalId()
  hasNavigationId()
  getSiteByNavigationId()
  removeSiteByNavigationId()
  setSite()
  getGroup()
  getSerialVersionId()
  getSerializationData()
  unserialize()

SiteArray:: (0 methods):

Class: SiteList - X-Ref

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

getObjectType() X-Ref

return: string

preSetElement( $index, $site ) X-Ref

param: int|string $index
param: Site $site
return: bool

offsetUnset( $index ) X-Ref

param: mixed $index

getGlobalIdentifiers() X-Ref

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

return: array

hasSite( $globalSiteId ) X-Ref

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

param: string $globalSiteId
return: bool

getSite( $globalSiteId ) X-Ref

Returns the Site with the provided global site identifier.
The site needs to exist, so if not sure, call hasGlobalId first.

param: string $globalSiteId
return: Site

removeSite( $globalSiteId ) X-Ref

Removes the site with the specified global site identifier.
The site needs to exist, so if not sure, call hasGlobalId first.

param: string $globalSiteId

isEmpty() X-Ref

Returns if the list contains no sites.

return: bool

hasInternalId( $id ) X-Ref

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

param: int $id
return: bool

getSiteByInternalId( $id ) X-Ref

Returns the Site with the provided site id.
The site needs to exist, so if not sure, call has first.

param: int $id
return: Site

removeSiteByInternalId( $id ) X-Ref

Removes the site with the specified site id.
The site needs to exist, so if not sure, call has first.

param: int $id

hasNavigationId( $id ) X-Ref

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

param: string $id
return: bool

getSiteByNavigationId( $id ) X-Ref

Returns the Site with the provided navigational site id.
The site needs to exist, so if not sure, call has first.

param: string $id
return: Site

removeSiteByNavigationId( $id ) X-Ref

Removes the site with the specified navigational site id.
The site needs to exist, so if not sure, call has first.

param: string $id

setSite( Site $site ) X-Ref

Sets a site in the list. If the site was not there,
it will be added. If it was, it will be updated.

param: Site $site

getGroup( $groupName ) X-Ref

Returns the sites that are in the provided group.

param: string $groupName
return: SiteList

getSerialVersionId() X-Ref

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,

getSerializationData() X-Ref

return: array

unserialize( $serialization ) X-Ref

param: string $serialization
return: array

Class: SiteArray - X-Ref

PHP Cross Reference of MediaWiki-1.24.0

/includes/site/ -> SiteList.php (summary)

Defines 2 classes