ElggAccessCollection Class Reference

Inheritance diagram for ElggAccessCollection:

Public Member Functions
	__construct (?\stdClass $row=null)
	Create an access collection object. More...
	__set ($name, $value)
	Set an attribute. More...
	__get ($name)
	Get an attribute. More...
	getOwnerEntity ()
	Returns owner entity of the collection. More...
	getDisplayName ()
	Get readable access level name for this collection. More...
	save ()
	{Save this data to the appropriate database table. Returns bool } More...
	delete ()
	{Delete this data. Returns bool } More...
	canEdit (?int $user_guid=null)
	Check if user can edit this collection. More...
	getMembers (array $options=[])
	Returns members of the access collection. More...
	hasMember (int $member_guid=0)
	Checks if user is already in access collection. More...
	addMember (int $member_guid=0)
	Adds a user to access collection. More...
	removeMember (int $member_guid=0)
	Removes a user from access collection. More...
	getURL ()
	{Get a URL for this object. Returns string } More...
	toObject (array $params=[])
	{Get a plain old object copy for public consumption. Parameters array $params Export parameters Returns \Elgg\Export\Data } 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.This is used by the river functionality primarily. This is useful for checking access permissions etc on objects. Parameters int $id GUID of an entity Returns static|false } More...
	getType ()
	{Return the type of the object - eg.object, group, user, relationship, metadata, annotation etc Returns string } More...
	getSubtype ()
	{Return a subtype.For metadata & annotations this is the 'name' and for relationship this is the relationship type. Returns string } 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...
	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...

Protected Member Functions
	initializeAttributes ()
	Initialize the attributes array. More...
Protected Member Functions inherited from ElggData
	getDatabase ()
	Provides a pointer to the database object. More...

Additional Inherited Members
Protected Attributes inherited from ElggData
	$attributes = []
	$valid = false

Detailed Description

Definition at line 11 of file ElggAccessCollection.php.

Constructor & Destructor Documentation

__construct()

ElggAccessCollection::__construct

(

?\stdClass

$row = null

)

Create an access collection object.

Parameters

null | \stdClass

$row

Database row

Definition at line 18 of file ElggAccessCollection.php.

Member Function Documentation

__get()

ElggAccessCollection::__get

(

$name

)

Get an attribute.

Parameters

string

$name

The name of the attribute to get

Returns

mixed

Definition at line 87 of file ElggAccessCollection.php.

__set()

ElggAccessCollection::__set	(		$name,
			$value
	)

Set an attribute.

Parameters

string	$name	The name of the attribute
mixed	$value	The value of the attribute

Returns

void

Exceptions

Definition at line 50 of file ElggAccessCollection.php.

addMember()

ElggAccessCollection::addMember

(

int

$member_guid = 0

)

Adds a user to access collection.

Parameters

int

$member_guid

GUID of the user

Returns

bool

Definition at line 191 of file ElggAccessCollection.php.

canEdit()

ElggAccessCollection::canEdit

(

?int

$user_guid = null

)

Check if user can edit this collection.

Parameters

null | int

$user_guid

GUID of the user

Returns

bool

Definition at line 158 of file ElggAccessCollection.php.

delete()

ElggAccessCollection::delete

(

)

{Delete this data.

Returns

bool

}

Reimplemented from ElggData.

Definition at line 147 of file ElggAccessCollection.php.

getDisplayName()

ElggAccessCollection::getDisplayName

(

)

Get readable access level name for this collection.

Returns

string

Definition at line 105 of file ElggAccessCollection.php.

getMembers()

ElggAccessCollection::getMembers

(

array

$options = []

)

Returns members of the access collection.

Parameters

array

$options

ege options

Returns

ElggEntity[]|int|false

Definition at line 169 of file ElggAccessCollection.php.

getObjectFromID()

ElggAccessCollection::getObjectFromID

(

int

$id

)

{For a given ID, return the object associated with it.This is used by the river functionality primarily. This is useful for checking access permissions etc on objects.

Parameters

int

$id

GUID of an entity

Returns

static|false

}

Reimplemented from ElggData.

Definition at line 244 of file ElggAccessCollection.php.

getOwnerEntity()

ElggAccessCollection::getOwnerEntity

(

)

Returns owner entity of the collection.

Returns

\ElggEntity|null

Definition at line 96 of file ElggAccessCollection.php.

getSubtype()

ElggAccessCollection::getSubtype

(

)

{Return a subtype.For metadata & annotations this is the 'name' and for relationship this is the relationship type.

Returns

string

}

Reimplemented from ElggData.

Definition at line 258 of file ElggAccessCollection.php.

getSystemLogID()

ElggAccessCollection::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

}

Reimplemented from ElggData.

Definition at line 237 of file ElggAccessCollection.php.

getType()

ElggAccessCollection::getType

(

)

{Return the type of the object - eg.object, group, user, relationship, metadata, annotation etc

Returns

string

}

Reimplemented from ElggData.

Definition at line 251 of file ElggAccessCollection.php.

getURL()

ElggAccessCollection::getURL

(

)

{Get a URL for this object.

Returns

string

}

Reimplemented from ElggData.

Definition at line 209 of file ElggAccessCollection.php.

hasMember()

ElggAccessCollection::hasMember

(

int

$member_guid = 0

)

Checks if user is already in access collection.

Parameters

int

$member_guid

GUID of the user

Returns

bool

Definition at line 180 of file ElggAccessCollection.php.

initializeAttributes()

ElggAccessCollection::initializeAttributes ( )

protected

Initialize the attributes array.

Returns

void

See also

ElggData::initializeAttributes()

Reimplemented from ElggData.

Definition at line 32 of file ElggAccessCollection.php.

removeMember()

ElggAccessCollection::removeMember

(

int

$member_guid = 0

)

Removes a user from access collection.

Parameters

int

$member_guid

GUID of the user

Returns

bool

Definition at line 202 of file ElggAccessCollection.php.

save()

ElggAccessCollection::save

(

)

{Save this data to the appropriate database table.

Returns

bool

}

Reimplemented from ElggData.

Definition at line 136 of file ElggAccessCollection.php.

toObject()

ElggAccessCollection::toObject

(

array

$params = []

)

{Get a plain old object copy for public consumption.

Parameters

array

$params

Export parameters

Returns

\Elgg\Export\Data

}

Reimplemented from ElggData.

Definition at line 221 of file ElggAccessCollection.php.

---

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

• engine/classes/ElggAccessCollection.php