Elgg  Version 3.0
Public Member Functions | Public Attributes | Protected Member Functions | List of all members
ElggGroup Class Reference
Inheritance diagram for ElggGroup:
ElggEntity ElggData Locatable Elgg\EntityIcon Elgg\Collections\CollectionItemInterface

Public Member Functions

 getType ()
 {} More...
 
 getMetadata ($name)
 
 setMetadata ($name, $value, $value_type= '', $multiple=false)
 
 addObjectToGroup (\ElggObject $object)
 Add an to this group. More...
 
 removeObjectFromGroup (ElggObject $object)
 Remove an object from this containing group and sets the container to be object's owner. More...
 
 getMembers (array $options=[])
 Get an array of group members. 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, $params=[])
 Join a user to this group. More...
 
 leave (\ElggUser $user)
 Remove a user from the group. More...
 
 canComment ($user_guid=0, $default=null)
 Can a user comment on this group? More...
 
 isToolEnabled ($name)
 Checks if a tool option is enabled. More...
 
 enableTool ($name)
 Enables a tool option. More...
 
 disableTool ($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 ($display_name)
 Sets the title or name of this entity. More...
 
 getMetadata ($name)
 Return the value of a piece of metadata. More...
 
 getAllMetadata ()
 Get all entity metadata. More...
 
 setMetadata ($name, $value, $value_type= '', $multiple=false)
 Set metadata on this entity. More...
 
 deleteMetadata ($name=null)
 Deletes all metadata on this object (metadata.entity_guid = $this->guid). 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...
 
 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...
 
 getAllPrivateSettings ()
 Returns all private settings. More...
 
 removePrivateSetting ($name)
 Removes private setting. More...
 
 removeAllPrivateSettings ()
 Removes all private settings. More...
 
 removeAllRelatedRiverItems ()
 Removes all river items related to this entity. 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, $value_type="")
 Adds an annotation to an entity. More...
 
 getAnnotations (array $options=[])
 Gets an array of annotations. 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...
 
 getOwnedAccessCollections ($options=[])
 Returns the ACLs owned by the entity. More...
 
 getOwnedAccessCollection ($subtype)
 Returns the first ACL owned by the entity with a given subtype. More...
 
 getEntitiesFromRelationship (array $options=[])
 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...
 
 canComment ($user_guid=0, $default=null)
 Can a user comment on an entity? 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...
 
 getOwnerEntity ()
 Gets the that owns this entity. More...
 
 setContainerGUID ($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...
 
 saveIconFromUploadedFile ($input_name, $type= 'icon', array $coords=[])
 Saves icons using an uploaded file as the source. More...
 
 saveIconFromLocalFile ($filename, $type= 'icon', array $coords=[])
 Saves icons using a local file as the source. More...
 
 saveIconFromElggFile (\ElggFile $file, $type= 'icon', array $coords=[])
 Saves icons using a file located in the data store as the source. More...
 
 getIcon ($size, $type= 'icon')
 Returns entity icon as an ElggIcon object The icon file may or may not exist on filestore. More...
 
 deleteIcon ($type= 'icon')
 Removes all icon files and metadata for the passed type of icon. More...
 
 getIconLastChange ($size, $type= 'icon')
 Returns the timestamp of when the icon was changed. More...
 
 hasIcon ($size, $type= 'icon')
 Returns if the entity has an icon of the passed type. More...
 
 getIconURL ($params=[])
 Get the URL for this entity's icon. 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 (array $params=[])
 Export an entity. 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...
 
 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...
 
 updateLastAction ($posted=null)
 Update the last_action 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 ($persist=true)
 Cache the entity in a session and persisted caches. More...
 
 invalidateCache ()
 Invalidate cache for 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...
 
 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...
 

Public Attributes

const CONTENT_ACCESS_MODE_UNRESTRICTED = 'unrestricted'
 
const CONTENT_ACCESS_MODE_MEMBERS_ONLY = 'members_only'
 

Protected Member Functions

 initializeAttributes ()
 {} More...
 
 prepareObject (\Elgg\Export\Entity $object)
 {} More...
 
 getToolConfig ($name)
 Returns the registered tool configuration. More...
 
 getTool ($name)
 Returns the registered tool configuration. More...
 
- Protected Member Functions inherited from ElggEntity
 initializeAttributes ()
 Initialize the attributes array. More...
 
 setTempMetadata ($name, $value, $multiple=false)
 Set temp metadata on this entity. More...
 
 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...
 
 prepareObject (\Elgg\Export\Entity $object)
 Prepare an object copy for toObject() 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

- Static Public Attributes inherited from ElggEntity
static $primary_attr_names
 
- Protected Attributes inherited from ElggEntity
 $temp_metadata = []
 
 $temp_annotations = []
 
 $temp_private_settings = []
 
 $volatile = []
 
 $orig_attributes = []
 
 $_is_cacheable = true
 
 $_cached_metadata
 
- Protected Attributes inherited from ElggData
 $attributes = []
 The main attributes of an entity. More...
 
 $valid = false
 
- Static Protected Attributes inherited from ElggEntity
static $integer_attr_names
 

Detailed Description

Definition at line 12 of file ElggGroup.php.

Member Function Documentation

ElggGroup::addObjectToGroup ( \ElggObject  $object)

Add an to this group.

Parameters
\ElggObject$objectThe object.
Returns
bool

Definition at line 64 of file ElggGroup.php.

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$userUser
Returns
bool

Definition at line 350 of file ElggGroup.php.

ElggGroup::canComment (   $user_guid = 0,
  $default = null 
)

Can a user comment on this group?

See also
::canComment()
Parameters
int$user_guidUser guid (default is logged in user)
bool$defaultDefault permission
Returns
bool
Since
1.8.0

Definition at line 244 of file ElggGroup.php.

ElggGroup::disableTool (   $name)

Disables a tool option.

Parameters
string$nameThe option to disable
Returns
bool
Since
3.0.0

Definition at line 306 of file ElggGroup.php.

ElggGroup::enableTool (   $name)

Enables a tool option.

Parameters
string$nameThe option to enable
Returns
bool
Since
3.0.0

Definition at line 284 of file ElggGroup.php.

ElggGroup::getContentAccessMode ( )

Return the content access mode used by group_gatekeeper()

Returns
string One of CONTENT_ACCESS_MODE_* constants
Since
1.9.0

Definition at line 116 of file ElggGroup.php.

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

Get an array of group members.

Parameters
array$optionsOptions 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
[]|int|mixed

Definition at line 92 of file ElggGroup.php.

ElggGroup::getMetadata (   $name)

See also
ElggEntity::getMetadata()

Definition at line 36 of file ElggGroup.php.

ElggGroup::getTool (   $name)
protected

Returns the registered tool configuration.

Parameters
string$nameTool name
Returns
Tool|null

Definition at line 339 of file ElggGroup.php.

ElggGroup::getToolConfig (   $name)
protected

Returns the registered tool configuration.

Parameters
string$nameTool name
Returns
Tool|null

Definition at line 328 of file ElggGroup.php.

ElggGroup::getType ( )

{}

Definition at line 28 of file ElggGroup.php.

ElggGroup::initializeAttributes ( )
protected

{}

Definition at line 20 of file ElggGroup.php.

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

Is the given user a member of this group?

Parameters
\ElggUser$userThe user. Default is logged in user.
Returns
bool

Definition at line 162 of file ElggGroup.php.

ElggGroup::isPublicMembership ( )

Returns whether the current group has open membership or not.

Returns
bool

Definition at line 106 of file ElggGroup.php.

ElggGroup::isToolEnabled (   $name)

Checks if a tool option is enabled.

Parameters
string$nameTool name
Returns
bool
Since
3.0.0

Definition at line 256 of file ElggGroup.php.

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

Join a user to this group.

Parameters
\ElggUser$userUser joining the group.
array$paramsAdditional params to pass to the 'join', 'group' event
Returns
bool Whether joining was successful.

Definition at line 187 of file ElggGroup.php.

ElggGroup::leave ( \ElggUser  $user)

Remove a user from the group.

Parameters
\ElggUser$userUser to remove from the group.
Returns
bool Whether the user was removed from the group.

Definition at line 215 of file ElggGroup.php.

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

{}

Definition at line 226 of file ElggGroup.php.

ElggGroup::removeObjectFromGroup ( ElggObject  $object)

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

Parameters
\ElggObject$objectThe object.
Returns
bool

Definition at line 77 of file ElggGroup.php.

ElggGroup::setContentAccessMode (   $mode)

Set the content access mode used by group_gatekeeper()

Parameters
string$modeOne of CONTENT_ACCESS_MODE_* constants. If empty string, mode will not be changed
Returns
void
Since
1.9.0

Definition at line 142 of file ElggGroup.php.

ElggGroup::setMetadata (   $name,
  $value,
  $value_type = '',
  $multiple = false 
)

See also
ElggEntity::setMetadata()

Definition at line 48 of file ElggGroup.php.

Member Data Documentation

const ElggGroup::CONTENT_ACCESS_MODE_MEMBERS_ONLY = 'members_only'

Definition at line 15 of file ElggGroup.php.

const ElggGroup::CONTENT_ACCESS_MODE_UNRESTRICTED = 'unrestricted'

Definition at line 14 of file ElggGroup.php.


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