Elgg  Version 3.0
Public Member Functions | Protected Member Functions | List of all members
ElggAccessCollection Class Reference
Inheritance diagram for ElggAccessCollection:
ElggData Elgg\Collections\CollectionItemInterface

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 ()
 {} More...
 
 delete ()
 {} More...
 
 canEdit ($user_guid=null)
 Check if user can this collection. More...
 
 getMembers (array $options=[])
 Returns members of the access collection. More...
 
 hasMember ($member_guid=0)
 Checks if user is already in access collection. More...
 
 addMember ($member_guid=0)
 Adds a new member to access collection. More...
 
 removeMember ($member_guid=0)
 Removes a user from access collection. More...
 
 getURL ()
 {} More...
 
 toObject (array $params=[])
 {} More...
 
 getSystemLogID ()
 {} More...
 
 getObjectFromID ($id)
 {} More...
 
 getType ()
 {} More...
 
 getSubtype ()
 {} More...
 
- Public Member Functions inherited from ElggData
 __isset ($name)
 Test if property is set either as an attribute or metadata. More...
 
 getURL ()
 Get a URL for this object. More...
 
 save ()
 Save this data to the appropriate database table. More...
 
 delete ()
 Delete this data. More...
 
 getTimeCreated ()
 Returns the UNIX epoch time that this entity was created. More...
 
 toObject (array $params=[])
 Get a plain old object copy for public consumption. 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...
 
 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 ()
 {} More...
 
 unserialize ($serialized)
 {} More...
 

Protected Member Functions

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

Additional Inherited Members

- Protected Attributes inherited from ElggData
 $attributes = []
 The main attributes of an entity. More...
 
 $valid = false
 

Detailed Description

Definition at line 13 of file ElggAccessCollection.php.

Constructor & Destructor Documentation

ElggAccessCollection::__construct ( stdClass  $row = null)

Create an access collection object.

Parameters
stdClass$rowDatabase row
Exceptions
InvalidArgumentException

Definition at line 21 of file ElggAccessCollection.php.

Member Function Documentation

ElggAccessCollection::__get (   $name)

Get an attribute.

Parameters
string$nameName
Returns
mixed

Definition at line 65 of file ElggAccessCollection.php.

ElggAccessCollection::__set (   $name,
  $value 
)

Set an attribute.

Parameters
string$nameName
mixed$valueValue
Returns
void
Exceptions
RuntimeException

Definition at line 52 of file ElggAccessCollection.php.

ElggAccessCollection::addMember (   $member_guid = 0)

Adds a new member to access collection.

Parameters
int$member_guidGUID of the user
Returns
bool

Definition at line 166 of file ElggAccessCollection.php.

ElggAccessCollection::canEdit (   $user_guid = null)

Check if user can this collection.

Parameters
int$user_guidGUID of the user
Returns
bool

Definition at line 136 of file ElggAccessCollection.php.

ElggAccessCollection::delete ( )

{}

Definition at line 126 of file ElggAccessCollection.php.

ElggAccessCollection::getDisplayName ( )

Get readable access level name for this collection.

Returns
string

Definition at line 85 of file ElggAccessCollection.php.

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

Returns members of the access collection.

Parameters
array$optionsege options
Returns
ElggEntity[]|int|false

Definition at line 146 of file ElggAccessCollection.php.

ElggAccessCollection::getObjectFromID (   $id)

{}

Definition at line 218 of file ElggAccessCollection.php.

ElggAccessCollection::getOwnerEntity ( )

Returns owner entity of the collection.

Returns
|false

Definition at line 77 of file ElggAccessCollection.php.

ElggAccessCollection::getSubtype ( )

{}

Definition at line 232 of file ElggAccessCollection.php.

ElggAccessCollection::getSystemLogID ( )

{}

Definition at line 211 of file ElggAccessCollection.php.

ElggAccessCollection::getType ( )

{}

Definition at line 225 of file ElggAccessCollection.php.

ElggAccessCollection::getURL ( )

{}

Definition at line 183 of file ElggAccessCollection.php.

ElggAccessCollection::hasMember (   $member_guid = 0)

Checks if user is already in access collection.

Parameters
int$member_guidGUID of the user
Returns
bool

Definition at line 156 of file ElggAccessCollection.php.

ElggAccessCollection::initializeAttributes ( )
protected

Initialize the attributes array.

See also
ElggData::initializeAttributes()
Returns
void

Definition at line 35 of file ElggAccessCollection.php.

ElggAccessCollection::removeMember (   $member_guid = 0)

Removes a user from access collection.

Parameters
int$member_guidGUID of the user
Returns
bool

Definition at line 176 of file ElggAccessCollection.php.

ElggAccessCollection::save ( )

{}

Definition at line 115 of file ElggAccessCollection.php.

ElggAccessCollection::toObject ( array  $params = [])

{}

Definition at line 195 of file ElggAccessCollection.php.


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