ElggSite Class Reference

Inheritance diagram for ElggSite:

List of all members.

Public Member Functions
	__construct ($guid=null)
	Construct a new site object, optionally from a given id value.
	save ()
	Override the save function.
	delete ()
	Delete this site.
	disable ($reason="")
	Disable override to add safety rail.
	getMembers ($limit=10, $offset=0)
	Return a list of users using this site.
	addUser ($user_guid)
	Add a user to the site.
	removeUser ($user_guid)
	Remove a site user.
	getObjects ($subtype="", $limit=10, $offset=0)
	Get an array of member ElggObjects.
	addObject ($object_guid)
	Add an object to the site.
	removeObject ($object_guid)
	Remove a site user.
	getCollections ($subtype="", $limit=10, $offset=0)
	Get the collections associated with a site.
	getExportableValues ()
	Return an array of fields which can be exported.
Protected Member Functions
	initialise_attributes ()
	Initialise the attributes array.
	load ($guid)
	Override the load function.

---

Detailed Description

Definition at line 22 of file sites.php.

---

Constructor & Destructor Documentation

ElggSite::__construct

(

$

guid = null

)

Construct a new site object, optionally from a given id value.

Parameters:

mixed

$guid If an int, load that GUID. If a db row then will attempt to load the rest of the data.

Exceptions:

Exception

if there was a problem creating the site.

Definition at line 48 of file sites.php.

---

Member Function Documentation

ElggSite::addObject

(

$

object_guid

)

Add an object to the site.

Parameters:

int

$user_id

Definition at line 196 of file sites.php.

ElggSite::addUser

(

$

user_guid

)

Add a user to the site.

Parameters:

int

$user_guid

Definition at line 173 of file sites.php.

ElggSite::delete

(

)

Delete this site.

Reimplemented from ElggEntity.

Definition at line 136 of file sites.php.

ElggSite::disable

(

$

reason = ""

)

Disable override to add safety rail.

Parameters:

unknown_type

$reason

Definition at line 150 of file sites.php.

ElggSite::getCollections	(	$	subtype = "",
		$	limit = 10,
		$	offset = 0
	)

Get the collections associated with a site.

Parameters:

	string	$type
	int	$limit
	int	$offset

Returns:

unknown

Definition at line 213 of file sites.php.

ElggSite::getExportableValues

(

)

Return an array of fields which can be exported.

Reimplemented from ElggEntity.

Definition at line 220 of file sites.php.

ElggSite::getMembers	(	$	limit = 10,
		$	offset = 0
	)

Return a list of users using this site.

Parameters:

	int	$limit
	int	$offset

Returns:

array of ElggUsers

Definition at line 166 of file sites.php.

ElggSite::getObjects	(	$	subtype = "",
		$	limit = 10,
		$	offset = 0
	)

Get an array of member ElggObjects.

Parameters:

	string	$subtype
	int	$limit
	int	$offset

Definition at line 189 of file sites.php.

ElggSite::initialise_attributes

(

)

[protected]

Initialise the attributes array.

This is vital to distinguish between metadata and base parameters.

Place your base parameters here.

Reimplemented from ElggEntity.

Definition at line 30 of file sites.php.

ElggSite::load

(

$

guid

)

[protected]

Override the load function.

This function will ensure that all data is loaded (were possible), so if only part of the ElggSite is loaded, it'll load the rest.

Parameters:

int

$guid

Reimplemented from ElggEntity.

Definition at line 98 of file sites.php.

ElggSite::removeObject

(

$

object_guid

)

Remove a site user.

Parameters:

int

$user_id

Definition at line 203 of file sites.php.

ElggSite::removeUser

(

$

user_guid

)

Remove a site user.

Parameters:

int

$user_guid

Definition at line 180 of file sites.php.

ElggSite::save

(

)

Override the save function.

Reimplemented from ElggEntity.

Definition at line 123 of file sites.php.

---

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

• engine/lib/sites.php