ElggGroup Class Reference

Inheritance diagram for ElggGroup:

Public Member Functions
	__construct ($row=null)
	Construct a new group entity. More...
	getDisplayName ()
	{Get the entity's display name. Returns string The title or name of this entity. } More...
	setDisplayName ($displayName)
	{Sets the title or name of this entity. Parameters string $displayName The title or name of this entity. Returns void } More...
	addObjectToGroup (\ElggObject $object)
	Add an \ElggObject to this group. More...
	removeObjectFromGroup ($object)
	Remove an object from this containing group and sets the container to be object's owner. More...
	__get ($name)
	Wrapper around \ElggEntity::__get() More...
	get ($name)
	Wrapper around \ElggEntity::get() More...
	addFriend ($friend_guid)
	Start friendable compatibility block: More...
	removeFriend ($friend_guid)
	For compatibility with Friendable. More...
	isFriend ()
	For compatibility with Friendable. More...
	isFriendsWith ($user_guid)
	For compatibility with Friendable. More...
	isFriendOf ($user_guid)
	For compatibility with Friendable. More...
	getFriends ($subtype="", $limit=10, $offset=0)
	For compatibility with Friendable. More...
	getFriendsOf ($subtype="", $limit=10, $offset=0)
	For compatibility with Friendable. More...
	getObjects ($subtype="", $limit=10, $offset=0)
	Get objects contained in this group. More...
	getFriendsObjects ($subtype="", $limit=10, $offset=0)
	For compatibility with Friendable. More...
	countObjects ($subtype="")
	For compatibility with Friendable. More...
	getMembers ($options=array(), $offset=0, $count=false)
	End friendable compatibility block. More...
	isPublicMembership ()
	Returns whether the current group has open membership or not. More...
	getContentAccessMode ()
	Return the content access mode used by group_gatekeeper() More...
	setContentAccessMode ($mode)
	Set the content access mode used by group_gatekeeper() More...
	isMember (\ElggUser $user=null)
	Is the given user a member of this group? More...
	join (\ElggUser $user)
	Join a user to this group. More...
	leave (\ElggUser $user)
	Remove a user from the group. More...
	getExportableValues ()
	Return an array of fields which can be exported. More...
	canComment ($user_guid=0)
	Can a user comment on this group? More...
Public Member Functions inherited from ElggEntity
	__clone ()
	Clone an entity. More...
	__set ($name, $value)
	Set an attribute or metadata value for this entity. More...
	set ($name, $value)
	Sets the value of an attribute or metadata. More...
	getMetadata ($name)
	Return the value of a piece of metadata. More...
	__unset ($name)
	Unset a property from metadata or attribute. More...
	setMetadata ($name, $value, $value_type='', $multiple=false, $owner_guid=0, $access_id=null)
	Set metadata on this entity. More...
	deleteMetadata ($name=null)
	Deletes all metadata on this object (metadata.entity_guid = $this->guid). More...
	deleteOwnedMetadata ($name=null)
	Deletes all metadata owned by this object (metadata.owner_guid = $this->guid). More...
	clearMetadata ($name='')
	Remove metadata. More...
	disableMetadata ($name='')
	Disables metadata for this entity, optionally based on name. More...
	enableMetadata ($name='')
	Enables metadata for this entity, optionally based on name. More...
	getVolatileData ($name)
	Get a piece of volatile (non-persisted) data on this entity. More...
	setVolatileData ($name, $value)
	Set a piece of volatile (non-persisted) data on this entity. More...
	deleteRelationships ($relationship=null)
	Remove all relationships to and from this entity. More...
	clearRelationships ()
	Remove all relationships to and from this entity. More...
	addRelationship ($guid_two, $relationship)
	Add a relationship between this an another entity. More...
	removeRelationship ($guid_two, $relationship)
	Remove a relationship. More...
	setPrivateSetting ($name, $value)
	Adds a private setting to this entity. More...
	getPrivateSetting ($name)
	Returns a private setting value. More...
	removePrivateSetting ($name)
	Removes private setting. More...
	deleteAnnotations ($name=null)
	Deletes all annotations on this object (annotations.entity_guid = $this->guid). More...
	deleteOwnedAnnotations ($name=null)
	Deletes all annotations owned by this object (annotations.owner_guid = $this->guid). More...
	disableAnnotations ($name='')
	Disables annotations for this entity, optionally based on name. More...
	enableAnnotations ($name='')
	Enables annotations for this entity, optionally based on name. More...
	annotate ($name, $value, $access_id=ACCESS_PRIVATE, $owner_guid=0, $vartype="")
	Adds an annotation to an entity. More...
	getAnnotations ($options=array(), $limit=50, $offset=0, $order="asc")
	Gets an array of annotations. More...
	clearAnnotations ($name="")
	Remove an annotation or all annotations for this entity. More...
	countAnnotations ($name="")
	Count annotations. More...
	getAnnotationsAvg ($name)
	Get the average of an integer type annotation. More...
	getAnnotationsSum ($name)
	Get the sum of integer type annotations of a given name. More...
	getAnnotationsMin ($name)
	Get the minimum of integer type annotations of given name. More...
	getAnnotationsMax ($name)
	Get the maximum of integer type annotations of a given name. More...
	countComments ()
	Count the number of comments attached to this entity. More...
	getEntitiesFromRelationship ($options=array(), $inverse=false, $limit=50, $offset=0)
	Gets an array of entities with a relationship to this entity. More...
	countEntitiesFromRelationship ($relationship, $inverse_relationship=false)
	Gets the number of entities from a specific relationship type. More...
	canEdit ($user_guid=0)
	Can a user edit this entity? More...
	canDelete ($user_guid=0)
	Can a user delete this entity? More...
	canEditMetadata ($metadata=null, $user_guid=0)
	Can a user edit metadata on this entity? More...
	canWriteToContainer ($user_guid=0, $type='all', $subtype='all')
	Can a user add an entity to this container. More...
	canAnnotate ($user_guid=0, $annotation_name='')
	Can a user annotate an entity? More...
	getAccessID ()
	Returns the access_id. More...
	getGUID ()
	Returns the guid. More...
	getType ()
	Returns the entity type. More...
	getSubtype ()
	Get the entity subtype. More...
	getOwnerGUID ()
	Get the guid of the entity's owner. More...
	getOwner ()
	Return the guid of the entity's owner. More...
	getOwnerEntity ()
	Gets the \ElggEntity that owns this entity. More...
	setContainerGUID ($container_guid)
	Set the container for this object. More...
	setContainer ($container_guid)
	Set the container for this object. More...
	getContainerGUID ()
	Gets the container GUID for this entity. More...
	getContainer ()
	Gets the container GUID for this entity. More...
	getContainerEntity ()
	Get the container entity for this object. More...
	getTimeUpdated ()
	Returns the UNIX epoch time that this entity was last updated. More...
	getURL ()
	Gets the URL for this entity. More...
	setURL ($url)
	Overrides the URL returned by getURL() More...
	getIconURL ($params=array())
	Get the URL for this entity's icon. More...
	getIcon ($size='medium')
	Returns a URL for the entity's icon. More...
	setIcon ($url, $size='medium')
	Set an icon override for an icon and size. More...
	addToSite ($site)
	Add this entity to a site. More...
	removeFromSite ($site)
	Remove this entity from a site. More...
	getSites ($options=array())
	Gets the sites this entity is a member of. More...
	isFullyLoaded ()
	Tests to see whether the object has been fully loaded. More...
	save ()
	Save an entity. More...
	refresh (\stdClass $row)
	Load new data from database into existing entity. More...
	disable ($reason="", $recursive=true)
	Disable this entity. More...
	enable ($recursive=true)
	Enable the entity. More...
	isEnabled ()
	Is this entity enabled? More...
	delete ($recursive=true)
	Deletes the entity. More...
	toObject ()
	{Get a plain old object copy for public consumption. Returns \stdClass } More...
	getLocation ()
	Gets the 'location' metadata for the entity. More...
	setLocation ($location)
	Sets the 'location' metadata for the entity. More...
	setLatLong ($lat, $long)
	Set latitude and longitude metadata tags for a given entity. More...
	getLatitude ()
	Return the entity's latitude. More...
	getLongitude ()
	Return the entity's longitude. More...
	setCalendarTimeAndDuration ($hour=null, $minute=null, $second=null, $day=null, $month=null, $year=null, $duration=null)
	Set the time and duration of an object. More...
	getCalendarStartTime ()
	Returns the start timestamp. More...
	getCalendarEndTime ()
	Returns the end timestamp. More...
	export ()
	Export this class into an array of ODD Elements containing all necessary fields. More...
	import (ODD $data)
	Import data from an parsed ODD xml data array. More...
	getSystemLogID ()
	Return an identification for the object for storage in the system log. More...
	getObjectFromID ($id)
	For a given ID, return the object associated with it. More...
	getTags ($tag_names=null)
	Returns tags for this entity. More...
	deleteAccessCollectionMemberships ()
	Remove the membership of all access collections for this entity (if the entity is a user) More...
	deleteOwnedAccessCollections ()
	Remove all access collections owned by this entity. More...
Public Member Functions inherited from ElggData
	__isset ($name)
	Test if property is set either as an attribute or metadata. More...
	delete ()
	Delete this data. More...
	getTimeCreated ()
	Returns the UNIX epoch time that this entity was created. More...
	getClassName ()
	Return the class name of the object. More...
	getObjectOwnerGUID ()
	Return the GUID of the owner of this object. More...
	rewind ()
	Iterator interface. More...
	current ()
	Iterator interface. More...
	key ()
	Iterator interface. More...
	next ()
	Iterator interface. More...
	valid ()
	Iterator interface. More...
	offsetSet ($key, $value)
	Array access interface. More...
	offsetGet ($key)
	Array access interface. More...
	offsetUnset ($key)
	Array access interface. More...
	offsetExists ($offset)
	Array access interface. More...

Static Public Member Functions
static	getExternalAttributes ()
	Get default values for attributes stored in a separate table. More...

Public Attributes
const	CONTENT_ACCESS_MODE_UNRESTRICTED = 'unrestricted'
const	CONTENT_ACCESS_MODE_MEMBERS_ONLY = 'members_only'

Protected Member Functions
	initializeAttributes ()
	Sets the type to group. More...
	load ($guid)
	Load the \ElggGroup data from the database. More...
	update ()
	{Update the entity in the database. Returns bool Whether the update was successful. Exceptions InvalidParameterException } More...
	create ()
	{Create a new entry in the entities table.Saves the base information in the entities table for the entity. Saving the type-specific information is handled in the calling class method. Warning Entities must have an entry in both the entities table and their type table or they will throw an exception when loaded. Returns int The new entity's GUID Exceptions InvalidParameterException If the entity's type has not been set. IOException If the new row fails to write to the DB. } More...
	prepareObject ($object)
	{Prepare an object copy for toObject() Parameters \stdClass $object Object representation of the entity Returns \stdClass } More...
Protected Member Functions inherited from ElggEntity
	loadAdditionalSelectValues (array $data)
	Stores non-attributes from the loading of the entity as volatile data. More...
Protected Member Functions inherited from ElggData
	initialise_attributes ($pre18_api=true)
	Initialise the attributes array. More...
	getDatabase ()
	Provides a pointer to the database object. More...

Additional Inherited Members
Protected Attributes inherited from ElggEntity
	$url_override
	If set, overrides the value of getURL() More...
	$icon_override
	Icon override, overrides the value of getIcon(). More...
	$temp_metadata = array()
	Holds metadata until entity is saved. More...
	$temp_annotations = array()
	Holds annotations until entity is saved. More...
	$temp_private_settings = array()
	Holds private settings until entity is saved. More...
	$volatile = array()
	Volatile data structure for this object, allows for storage of data in-memory that isn't sync'd back to the metadata table. More...
	$tables_split
	$tables_loaded
Protected Attributes inherited from ElggData
	$attributes = array()
	The main attributes of an entity. More...
	$valid = false

Detailed Description

Definition at line 12 of file ElggGroup.php.

Constructor & Destructor Documentation

__construct()

ElggGroup::__construct

(

$row = null

)

Construct a new group entity.

Plugin developers should only use the constructor to create a new entity. To retrieve entities, use get_entity() and the elgg_get_entities* functions.

Parameters

\stdClass

$row

Database row result. Default is null to create a new group.

Exceptions

IOException|InvalidParameterException

if there was a problem creating the group.

Definition at line 56 of file ElggGroup.php.

Member Function Documentation

__get()

ElggGroup::__get

(

$name

)

Wrapper around \ElggEntity::__get()

See also

\ElggEntity::__get()

Parameters

string

$name

Name

Returns

mixed

Reimplemented from ElggEntity.

Definition at line 145 of file ElggGroup.php.

addFriend()

ElggGroup::addFriend

(

$friend_guid

)

Start friendable compatibility block:

public function addFriend($friend_guid);

public function removeFriend($friend_guid); public function isFriend(); public function isFriendsWith($user_guid); public function isFriendOf($user_guid); public function getFriends($subtype = "", $limit = 10, $offset = 0); public function getFriendsOf($subtype = "", $limit = 10, $offset = 0); public function getObjects($subtype="", $limit = 10, $offset = 0); public function getFriendsObjects($subtype = "", $limit = 10, $offset = 0); public function countObjects($subtype = ""); For compatibility with Friendable.

Join a group when you friend \ElggGroup.

Parameters

int

$friend_guid

The GUID of the user joining the group.

Returns

bool

Implements Friendable.

Definition at line 189 of file ElggGroup.php.

addObjectToGroup()

ElggGroup::addObjectToGroup

(

\ElggObject

$object

)

Add an \ElggObject to this group.

Parameters

\ElggObject

$object

The object.

Returns

bool

Definition at line 109 of file ElggGroup.php.

canComment()

ElggGroup::canComment

(

$user_guid = 0

)

Can a user comment on this group?

See also

\ElggEntity::canComment()

Parameters

int

$user_guid

User guid (default is logged in user)

Returns

bool

Since

1.8.0

Reimplemented from ElggEntity.

Definition at line 583 of file ElggGroup.php.

countObjects()

ElggGroup::countObjects

(

$subtype = ""

)

For compatibility with Friendable.

Parameters

string

$subtype

Subtype of entities

Returns

array|false

Implements Friendable.

Definition at line 320 of file ElggGroup.php.

create()

ElggGroup::create ( )

protected

{Create a new entry in the entities table.Saves the base information in the entities table for the entity. Saving the type-specific information is handled in the calling class method.

Warning

Entities must have an entry in both the entities table and their type table or they will throw an exception when loaded.

Returns

int The new entity's GUID

Exceptions

InvalidParameterException	If the entity's type has not been set.
IOException	If the new row fails to write to the DB.

}

Reimplemented from ElggEntity.

Definition at line 522 of file ElggGroup.php.

get()

ElggGroup::get

(

$name

)

Wrapper around \ElggEntity::get()

Parameters

string

$name

Name

Returns

mixed

Reimplemented from ElggEntity.

Definition at line 159 of file ElggGroup.php.

getContentAccessMode()

ElggGroup::getContentAccessMode

(

)

Return the content access mode used by group_gatekeeper()

Returns

string One of CONTENT_ACCESS_MODE_* constants @access private

Since

1.9.0

Definition at line 380 of file ElggGroup.php.

getDisplayName()

ElggGroup::getDisplayName

(

)

{Get the entity's display name.

Returns

string The title or name of this entity.

}

Reimplemented from ElggEntity.

Definition at line 91 of file ElggGroup.php.

getExportableValues()

ElggGroup::getExportableValues

(

)

Return an array of fields which can be exported.

Returns

array

Reimplemented from ElggEntity.

Definition at line 567 of file ElggGroup.php.

getExternalAttributes()

static ElggGroup::getExternalAttributes ( )

staticfinal

Get default values for attributes stored in a separate table.

Returns

array @access private

See also

\Elgg\Database\EntityTable::getEntities

Definition at line 39 of file ElggGroup.php.

getFriends()

ElggGroup::getFriends	(		$subtype = "",
			$limit = 10,
			$offset = 0
	)

For compatibility with Friendable.

Parameters

string	$subtype	The GUID of a user to check.
int	$limit	Limit
int	$offset	Offset

Returns

bool

Implements Friendable.

Definition at line 262 of file ElggGroup.php.

getFriendsObjects()

ElggGroup::getFriendsObjects	(		$subtype = "",
			$limit = 10,
			$offset = 0
	)

For compatibility with Friendable.

Parameters

string	$subtype	Entity subtype
int	$limit	Limit
int	$offset	Offset

Returns

array|false

Implements Friendable.

Definition at line 307 of file ElggGroup.php.

getFriendsOf()

ElggGroup::getFriendsOf	(		$subtype = "",
			$limit = 10,
			$offset = 0
	)

For compatibility with Friendable.

Parameters

string	$subtype	The GUID of a user to check.
int	$limit	Limit
int	$offset	Offset

Returns

bool

Implements Friendable.

Definition at line 277 of file ElggGroup.php.

getMembers()

ElggGroup::getMembers	(		$options = array(),
			$offset = 0,
			$count = false
	)

End friendable compatibility block.

Get an array of group members.

Parameters

array	$options	Options array. See elgg_get_entities_from_relationships for a complete list. Common ones are 'limit', 'offset', and 'count'. Options set automatically are 'relationship', 'relationship_guid', 'inverse_relationship', and 'type'. This argument used to set the limit (deprecated usage)
int	$offset	Offset (deprecated)
bool	$count	Count (deprecated)

Returns

array

Definition at line 342 of file ElggGroup.php.

getObjects()

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

Get objects contained in this group.

Parameters

string	$subtype	Entity subtype
int	$limit	Limit
int	$offset	Offset

Returns

array|false

Implements Friendable.

Definition at line 292 of file ElggGroup.php.

initializeAttributes()

ElggGroup::initializeAttributes ( )

protected

Sets the type to group.

Returns

void

Reimplemented from ElggEntity.

Definition at line 23 of file ElggGroup.php.

isFriend()

ElggGroup::isFriend

(

)

For compatibility with Friendable.

Friending a group adds you as a member

Returns

bool

Implements Friendable.

Definition at line 219 of file ElggGroup.php.

isFriendOf()

ElggGroup::isFriendOf

(

$user_guid

)

For compatibility with Friendable.

Parameters

int

$user_guid

The GUID of a user to check.

Returns

bool

Implements Friendable.

Definition at line 246 of file ElggGroup.php.

isFriendsWith()

ElggGroup::isFriendsWith

(

$user_guid

)

For compatibility with Friendable.

Parameters

int

$user_guid

The GUID of a user to check.

Returns

bool

Implements Friendable.

Definition at line 232 of file ElggGroup.php.

isMember()

ElggGroup::isMember

(

\ElggUser

$user = null

)

Is the given user a member of this group?

Parameters

\ElggUser

$user

The user. Default is logged in user.

Returns

bool

Definition at line 424 of file ElggGroup.php.

isPublicMembership()

ElggGroup::isPublicMembership

(

)

Returns whether the current group has open membership or not.

Returns

bool

Definition at line 369 of file ElggGroup.php.

join()

ElggGroup::join

(

\ElggUser

$user

)

Join a user to this group.

Parameters

\ElggUser

$user

User joining the group.

Returns

bool Whether joining was successful.

Definition at line 448 of file ElggGroup.php.

leave()

ElggGroup::leave

(

\ElggUser

$user

)

Remove a user from the group.

Parameters

\ElggUser

$user

User to remove from the group.

Returns

bool Whether the user was removed from the group.

Definition at line 466 of file ElggGroup.php.

load()

ElggGroup::load (   $guid )

protected

Load the \ElggGroup data from the database.

Parameters

mixed

$guid

GUID of an \ElggGroup entity or database row from entity table

Returns

bool

Reimplemented from ElggEntity.

Definition at line 481 of file ElggGroup.php.

prepareObject()

ElggGroup::prepareObject (   $object )

protected

{Prepare an object copy for toObject()

Parameters

\stdClass

$object

Object representation of the entity

Returns

\stdClass

}

Reimplemented from ElggEntity.

Definition at line 550 of file ElggGroup.php.

removeFriend()

ElggGroup::removeFriend

(

$friend_guid

)

For compatibility with Friendable.

Leave group when you unfriend \ElggGroup.

Parameters

int

$friend_guid

The GUID of the user leaving.

Returns

bool

Implements Friendable.

Definition at line 205 of file ElggGroup.php.

removeObjectFromGroup()

ElggGroup::removeObjectFromGroup

(

$object

)

Remove an object from this containing group and sets the container to be object's owner.

Parameters

\ElggObject

$object

The object.

Returns

bool

Definition at line 122 of file ElggGroup.php.

setContentAccessMode()

ElggGroup::setContentAccessMode

(

$mode

)

Set the content access mode used by group_gatekeeper()

Parameters

string

$mode

One of CONTENT_ACCESS_MODE_* constants

Returns

void @access private

Since

1.9.0

Definition at line 408 of file ElggGroup.php.

setDisplayName()

ElggGroup::setDisplayName

(

$displayName

)

{Sets the title or name of this entity.

Parameters

string

$displayName

The title or name of this entity.

Returns

void

}

Reimplemented from ElggEntity.

Definition at line 98 of file ElggGroup.php.

update()

ElggGroup::update ( )

protected

{Update the entity in the database.

Returns

bool Whether the update was successful.

Exceptions

InvalidParameterException

}

Reimplemented from ElggEntity.

Definition at line 502 of file ElggGroup.php.

Member Data Documentation

CONTENT_ACCESS_MODE_MEMBERS_ONLY

const ElggGroup::CONTENT_ACCESS_MODE_MEMBERS_ONLY = 'members_only'

Definition at line 16 of file ElggGroup.php.

CONTENT_ACCESS_MODE_UNRESTRICTED

const ElggGroup::CONTENT_ACCESS_MODE_UNRESTRICTED = 'unrestricted'

Definition at line 15 of file ElggGroup.php.

---

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

• engine/classes/ElggGroup.php