Elgg  Version master
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 (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 ()
 {} More...
 
 toObject (array $params=[])
 {} More...
 
 getSystemLogID ()
 {} More...
 
 getObjectFromID (int $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...
 
 __unset ($name)
 Unset a property from metadata or attribute. 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...
 
 getSystemLogID ()
 Return an identification for the object for storage in the system log. More...
 
 getType ()
 Return the type of the object - eg. More...
 
 getSubtype ()
 Return a subtype. More...
 
 getObjectFromID (int $id)
 For a given ID, return the object associated with it. 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
 initializeAttributes ()
 Initialize the attributes array. More...
 
 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

ElggAccessCollection::__construct ( stdClass  $row = null)

Create an access collection object.

Parameters
stdClass$rowDatabase row

Definition at line 18 of file ElggAccessCollection.php.

Member Function Documentation

ElggAccessCollection::__get (   $name)

Get an attribute.

Parameters
string$nameThe name of the attribute to get
Returns
mixed

Definition at line 87 of file ElggAccessCollection.php.

ElggAccessCollection::__set (   $name,
  $value 
)

Set an attribute.

Parameters
string$nameThe name of the attribute
mixed$valueThe value of the attribute
Returns
void
Exceptions

Definition at line 50 of file ElggAccessCollection.php.

ElggAccessCollection::addMember ( int  $member_guid = 0)

Adds a user to access collection.

Parameters
int$member_guidGUID of the user
Returns
bool

Definition at line 191 of file ElggAccessCollection.php.

ElggAccessCollection::canEdit ( int  $user_guid = null)

Check if user can edit this collection.

Parameters
int$user_guidGUID of the user
Returns
bool

Definition at line 158 of file ElggAccessCollection.php.

ElggAccessCollection::delete ( )

{}

Definition at line 147 of file ElggAccessCollection.php.

ElggAccessCollection::getDisplayName ( )

Get readable access level name for this collection.

Returns
string

Definition at line 105 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 169 of file ElggAccessCollection.php.

ElggAccessCollection::getObjectFromID ( int  $id)

{}

Definition at line 244 of file ElggAccessCollection.php.

ElggAccessCollection::getOwnerEntity ( )

Returns owner entity of the collection.

Returns
|null

Definition at line 96 of file ElggAccessCollection.php.

ElggAccessCollection::getSubtype ( )

{}

Definition at line 258 of file ElggAccessCollection.php.

ElggAccessCollection::getSystemLogID ( )

{}

Definition at line 237 of file ElggAccessCollection.php.

ElggAccessCollection::getType ( )

{}

Definition at line 251 of file ElggAccessCollection.php.

ElggAccessCollection::getURL ( )

{}

Definition at line 209 of file ElggAccessCollection.php.

ElggAccessCollection::hasMember ( int  $member_guid = 0)

Checks if user is already in access collection.

Parameters
int$member_guidGUID of the user
Returns
bool

Definition at line 180 of file ElggAccessCollection.php.

ElggAccessCollection::initializeAttributes ( )
protected

Initialize the attributes array.

Returns
void
See also
ElggData::initializeAttributes()

Definition at line 32 of file ElggAccessCollection.php.

ElggAccessCollection::removeMember ( int  $member_guid = 0)

Removes a user from access collection.

Parameters
int$member_guidGUID of the user
Returns
bool

Definition at line 202 of file ElggAccessCollection.php.

ElggAccessCollection::save ( )

{}

Definition at line 136 of file ElggAccessCollection.php.

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

{}

Definition at line 221 of file ElggAccessCollection.php.


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