Inheritance diagram for ElggGroup:

Public Member Functions
	getMembers (array $options=[])
	Get an array of group members. More...

	isPublicMembership ()
	Returns whether the current group has open membership or not. More...

	isInviteOnlyMembership ()
	Returns whether the current group has an invitation only membership. More...

	getContentAccessMode ()
	Return the content access mode. More...

	setContentAccessMode (string $mode)
	Set the content access mode. More...

	isMember (?\ElggUser $user=null)
	Is the given user a member of this group? More...

	join (\ElggUser $user, array $params=[])
	Join a user to this group. More...

	leave (\ElggUser $user)
	Remove a user from the group. More...

	isToolEnabled (string $name)
	Checks if a tool option is enabled. More...

	enableTool (string $name)
	Enables a tool option. More...

	disableTool (string $name)
	Disables a tool option. More...

	canAccessContent (?\ElggUser $user=null)
	Check if current user can access group content based on his/her membership status and group's content access policy. More...

Public Member Functions inherited from ElggEntity
	__construct (?\stdClass $row=null)
	Create a new entity. More...

	__clone ()
	Clone an entity. More...

	__set ($name, $value)
	Set an attribute or metadata value for this entity. More...

	getOriginalAttributes ()
	Get the original values of attribute(s) that have been modified since the entity was persisted. More...

	__get ($name)
	Get an attribute or metadata value. More...

	getDisplayName ()
	Get the entity's display name. More...

	setDisplayName (string $display_name)
	Sets the title or name of this entity. More...

	getVolatileData (string $name)
	Get a piece of volatile (non-persisted) data on this entity. More...

	setVolatileData (string $name, $value)
	Set a piece of volatile (non-persisted) data on this entity. More...

	removeAllRelatedRiverItems ()
	Removes all river items related to this entity. More...

	countComments ()
	Count the number of comments attached to this entity. More...

	hasAccess (int $user_guid=0)
	Check if the given user has access to this entity. More...

	canEdit (int $user_guid=0)
	Can a user edit this entity? More...

	canDelete (int $user_guid=0)
	Can a user delete this entity? More...

	canWriteToContainer (int $user_guid=0, string $type='', string $subtype='')
	Can a user add an entity to this container. More...

	canComment (int $user_guid=0)
	Can a user comment on an entity? More...

	canAnnotate (int $user_guid=0, string $annotation_name='')
	Can a user annotate an entity? More...

	getGUID ()
	Returns the guid. More...

	getType ()
	Returns the entity type. More...

	setSubtype (string $subtype)
	Set the subtype of the entity. More...

	getSubtype ()
	Get the entity subtype. More...

	getOwnerGUID ()
	Get the guid of the entity's owner. More...

	getOwnerEntity ()
	Gets the \ElggEntity that owns this entity. More...

	setContainerGUID (int $container_guid)
	Set the container for this object. More...

	getContainerGUID ()
	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...

	save ()
	Save this data to the appropriate database table. Returns bool More...

	disable (string $reason='', bool $recursive=true)
	Disable this entity. More...

	enable (bool $recursive=true)
	Enable the entity. More...

	isEnabled ()
	Is this entity enabled? More...

	delete (bool $recursive=true, ?bool $persistent=null)
	Deletes the entity. More...

	restore (bool $recursive=true)
	Restore the entity. More...

	isDeleted ()
	Is the entity marked as deleted. More...

	toObject (array $params=[])
	Export an entity. More...

	setLatLong (float $lat, float $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...

	getSystemLogID ()
	{Return an identification for the object for storage in the system log.This id must be an integer. Unsaved implementations should return 0. Returns int } More...

	getObjectFromID (int $id)
	For a given ID, return the object associated with it. More...

	updateLastAction (?int $posted=null)
	Update the last_action column in the entities table. More...

	updateTimeDeleted (?int $deleted=null)
	Update the time_deleted column in the entities table. More...

	disableCaching ()
	Disable runtime caching for entity. More...

	enableCaching ()
	Enable runtime caching for entity. More...

	isCacheable ()
	Is entity cacheable in the runtime cache. More...

	cache ()
	Cache the entity in a session cache. More...

	invalidateCache ()
	Invalidate cache for entity. More...

	hasCapability (string $capability)
	Checks a specific capability is enabled for the entity type/subtype. More...

	getFields ()
	Helper function to easily retrieve form fields for this entity. More...

Public Member Functions inherited from ElggData
	__isset ($name)
	Test if property is set either as an attribute or metadata. More...

	__unset ($name)
	Unset a property from metadata or attribute. More...

	delete ()
	Delete this data. More...

	getTimeCreated ()
	Returns the UNIX epoch time that this entity was created. More...

	rewind ()
	Iterator interface. More...

	current ()
	Iterator interface. More...

	key ()
	Iterator interface. More...

	next ()
	Iterator interface. More...

	valid ()
	Iterator interface. More...

	offsetSet ($offset, $value)
	Array access interface. More...

	offsetGet ($offset)
	Array access interface. More...

	offsetUnset ($offset)
	Array access interface. More...

	offsetExists ($offset)
	Array access interface. More...

	getID ()
	{Get unique item identifier within a collection. Returns string\|int } More...

	getPriority ()
	{Get priority (weight) of the item within a collection. Returns int } More...

	__serialize ()
	Called during serialization. More...

	__unserialize (array $data)
	Called during unserialization. More...

Public Attributes
const	CONTENT_ACCESS_MODE_UNRESTRICTED = 'unrestricted'

const	CONTENT_ACCESS_MODE_MEMBERS_ONLY = 'members_only'

const	MEMBERSHIP_CLOSED = 0

const	MEMBERSHIP_INVITE_ONLY = 1

const	MEMBERSHIP_PUBLIC = 2

Public Attributes inherited from ElggEntity
const	PRIMARY_ATTR_NAMES

Protected Member Functions

initializeAttributes ()

{Initialize the attributes array.This is vital to distinguish between metadata and base parameters.

Returns: void

} More...

prepareObject (\Elgg\Export\Entity $object)

{Prepare an object copy for toObject()

Parameters

\Elgg\Export\Entity $object Object representation of the entity

Returns: \Elgg\Export\Entity

} More...

getTool (string $name)

Returns the registered tool configuration. More...

Protected Member Functions inherited from ElggEntity

create ()

Create a new entry in the entities table. More...

update ()

Update the entity in the database. More...

load (stdClass $row)

Loads attributes from the entities table into the object. More...

persistentDelete (bool $recursive=true)

Permanently delete the entity from the database. More...

trash (bool $recursive=true)

Move the entity to the trash. More...

Protected Member Functions inherited from ElggData

getDatabase ()

Provides a pointer to the database object. More...

Additional Inherited Members
Static Public Member Functions inherited from ElggEntity
static	getDefaultFields ()
	Returns a default set of fields to be used for forms related to this entity. More...

Protected Attributes inherited from ElggEntity
const	INTEGER_ATTR_NAMES

	$volatile = []

	$orig_attributes = []

	$_is_cacheable = true

Protected Attributes inherited from ElggData
	$attributes = []

	$valid = false

Detailed Description

Definition at line 14 of file ElggGroup.php.

Member Function Documentation

◆ canAccessContent()

ElggGroup::canAccessContent ( ?\ElggUser $user = null )

Check if current user can access group content based on his/her membership status and group's content access policy.

Parameters

\ElggUser | null $user User

Returns: bool

Definition at line 280 of file ElggGroup.php.

◆ disableTool()

ElggGroup::disableTool ( string $name )

Disables a tool option.

Parameters

string $name The option to disable

Returns: bool

Since: 3.0.0

Definition at line 247 of file ElggGroup.php.

◆ enableTool()

ElggGroup::enableTool ( string $name )

Enables a tool option.

Parameters

string $name The option to enable

Returns: bool

Since: 3.0.0

Definition at line 225 of file ElggGroup.php.

◆ getContentAccessMode()

ElggGroup::getContentAccessMode ( )

Return the content access mode.

Returns: string One of CONTENT_ACCESS_MODE_* constants

Since: 1.9.0

Definition at line 80 of file ElggGroup.php.

◆ getMembers()

ElggGroup::getMembers ( array $options = [] )

Get an array of group members.

Parameters

array $options Options array. See elgg_get_entities for a complete list. Common ones are 'limit', 'offset', and 'count'. Options set automatically are 'relationship', 'relationship_guid', 'inverse_relationship', and 'type'.

Returns: \ElggEntity[]|int|mixed

Definition at line 46 of file ElggGroup.php.

◆ getTool()

ElggGroup::getTool ( string $name )

protected

Returns the registered tool configuration.

Parameters

string $name Tool name

Returns: Tool|null

Definition at line 268 of file ElggGroup.php.

◆ initializeAttributes()

ElggGroup::initializeAttributes ( )

protected

{Initialize the attributes array.This is vital to distinguish between metadata and base parameters.

Returns: void

}

Reimplemented from ElggEntity.

Definition at line 28 of file ElggGroup.php.

◆ isInviteOnlyMembership()

ElggGroup::isInviteOnlyMembership ( )

Returns whether the current group has an invitation only membership.

Returns: bool

Since: 7.1

Definition at line 70 of file ElggGroup.php.

◆ isMember()

ElggGroup::isMember ( ?\ElggUser $user = null )

Is the given user a member of this group?

Parameters

null | \ElggUser $user The user. Default is logged-in user.

Returns: bool

Definition at line 127 of file ElggGroup.php.

◆ isPublicMembership()

ElggGroup::isPublicMembership ( )

Returns whether the current group has open membership or not.

Returns: bool

Definition at line 60 of file ElggGroup.php.

◆ isToolEnabled()

ElggGroup::isToolEnabled ( string $name )

Checks if a tool option is enabled.

Parameters

string $name Tool name

Returns: bool

Since: 3.0.0

Definition at line 197 of file ElggGroup.php.

◆ join()

ElggGroup::join	(	\ElggUser	$user,
		array	$params = `[]`
	)

Join a user to this group.

Parameters

\ElggUser	$user	User joining the group.
array	$params	Additional params to pass to the 'join', 'group' event

Returns: bool Whether joining was successful.

Definition at line 147 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 167 of file ElggGroup.php.

◆ prepareObject()

ElggGroup::prepareObject ( \Elgg\Export\Entity $object )

protected

{Prepare an object copy for toObject()

Parameters

\Elgg\Export\Entity $object Object representation of the entity

Returns: \Elgg\Export\Entity

}

Reimplemented from ElggEntity.

Definition at line 181 of file ElggGroup.php.

◆ setContentAccessMode()

ElggGroup::setContentAccessMode ( string $mode )

Set the content access mode.

Parameters

string $mode One of CONTENT_ACCESS_MODE_* constants. If empty string, mode will not be changed

Returns: void

Since: 1.9.0

Definition at line 107 of file ElggGroup.php.

Member Data Documentation

◆ CONTENT_ACCESS_MODE_MEMBERS_ONLY

const ElggGroup::CONTENT_ACCESS_MODE_MEMBERS_ONLY = 'members_only'

Definition at line 17 of file ElggGroup.php.

◆ CONTENT_ACCESS_MODE_UNRESTRICTED

const ElggGroup::CONTENT_ACCESS_MODE_UNRESTRICTED = 'unrestricted'

Definition at line 16 of file ElggGroup.php.

◆ MEMBERSHIP_CLOSED

const ElggGroup::MEMBERSHIP_CLOSED = 0

Definition at line 19 of file ElggGroup.php.

◆ MEMBERSHIP_INVITE_ONLY

const ElggGroup::MEMBERSHIP_INVITE_ONLY = 1

Definition at line 20 of file ElggGroup.php.

◆ MEMBERSHIP_PUBLIC

const ElggGroup::MEMBERSHIP_PUBLIC = 2

Definition at line 21 of file ElggGroup.php.

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

engine/classes/ElggGroup.php

Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ canAccessContent()

◆ disableTool()

◆ enableTool()

◆ getContentAccessMode()

◆ getMembers()

◆ getTool()

◆ initializeAttributes()

◆ isInviteOnlyMembership()

◆ isMember()

◆ isPublicMembership()

◆ isToolEnabled()

◆ join()

◆ leave()

◆ prepareObject()

◆ setContentAccessMode()

Member Data Documentation

◆ CONTENT_ACCESS_MODE_MEMBERS_ONLY

◆ CONTENT_ACCESS_MODE_UNRESTRICTED

◆ MEMBERSHIP_CLOSED

◆ MEMBERSHIP_INVITE_ONLY

◆ MEMBERSHIP_PUBLIC