|
| | getType () |
| | {} 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. 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...
|
| |
| | __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...
|
| |
| | getMetadata (string $name) |
| | Return the value of a piece of metadata. More...
|
| |
| | getAllMetadata () |
| | Get all entity metadata. More...
|
| |
| | setMetadata (string $name, $value, string $value_type= '', bool $multiple=false) |
| | Set metadata on this entity. More...
|
| |
| | deleteMetadata (string $name=null) |
| | Deletes all metadata on this object (metadata.entity_guid = $this->guid). 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...
|
| |
| | addRelationship (int $guid_two, string $relationship) |
| | Add a relationship between this an another entity. More...
|
| |
| | hasRelationship (int $guid_two, string $relationship) |
| | Check if this entity has a relationship with another entity. More...
|
| |
| | getRelationship (int $guid_two, string $relationship) |
| | Return the relationship if this entity has a relationship with another entity. More...
|
| |
| | getEntitiesFromRelationship (array $options=[]) |
| | Gets an array of entities with a relationship to this entity. More...
|
| |
| | countEntitiesFromRelationship (string $relationship, bool $inverse_relationship=false) |
| | Gets the number of entities from a specific relationship type. More...
|
| |
| | removeRelationship (int $guid_two, string $relationship) |
| | Remove a relationship. More...
|
| |
| | removeAllRelationships (string $relationship= '', bool $inverse_relationship=false) |
| | Remove all relationships to or from this entity. More...
|
| |
| | removeAllRelatedRiverItems () |
| | Removes all river items related to this entity. More...
|
| |
| | deleteAnnotations (string $name=null) |
| | Deletes all annotations on this object (annotations.entity_guid = $this->guid). More...
|
| |
| | deleteOwnedAnnotations (string $name=null) |
| | Deletes all annotations owned by this object (annotations.owner_guid = $this->guid). More...
|
| |
| | disableAnnotations (string $name=null) |
| | Disables annotations for this entity, optionally based on name. More...
|
| |
| | enableAnnotations (string $name=null) |
| | 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 (string $name= '') |
| | Count annotations. More...
|
| |
| | getAnnotationsAvg (string $name) |
| | Get the average of an integer type annotation. More...
|
| |
| | getAnnotationsSum (string $name) |
| | Get the sum of integer type annotations of a given name. More...
|
| |
| | getAnnotationsMin (string $name) |
| | Get the minimum of integer type annotations of given name. More...
|
| |
| | getAnnotationsMax (string $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 (array $options=[]) |
| | Returns the ACLs owned by the entity. More...
|
| |
| | getOwnedAccessCollection (string $subtype) |
| | Returns the first ACL owned by the entity with a given subtype. 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 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...
|
| |
| | saveIconFromUploadedFile (string $input_name, string $type= 'icon', array $coords=[]) |
| | Saves icons using an uploaded file as the source. More...
|
| |
| | saveIconFromLocalFile (string $filename, string $type= 'icon', array $coords=[]) |
| | Saves icons using a local file as the source. More...
|
| |
| | saveIconFromElggFile (\ElggFile $file, string $type= 'icon', array $coords=[]) |
| | Saves icons using a file located in the data store as the source. More...
|
| |
| | getIcon (string $size, string $type= 'icon') |
| | Returns entity icon as an ElggIcon object The icon file may or may not exist on filestore. More...
|
| |
| | deleteIcon (string $type= 'icon') |
| | Removes all icon files and metadata for the passed type of icon. More...
|
| |
| | getIconLastChange (string $size, string $type= 'icon') |
| | Returns the timestamp of when the icon was changed. More...
|
| |
| | hasIcon (string $size, string $type= 'icon') |
| | Returns if the entity has an icon of the passed type. More...
|
| |
| | getIconURL (string|array $params=[]) |
| | Get the URL for this entity's icon. More...
|
| |
| | save () |
| |
| | 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) |
| | Deletes the entity. 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 () |
| | {} More...
|
| |
| | getObjectFromID (int $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 (int $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 (bool $persist=true) |
| | Cache the entity in a session and persisted caches. More...
|
| |
| | invalidateCache () |
| | Invalidate cache for entity. More...
|
| |
| | hasCapability (string $capability) |
| | Checks a specific capability is enabled for the entity type/subtype. More...
|
| |
| | __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...
|
| |
| | getIconURL (array $params) |
| | Returns a URL of the icon. More...
|
| |
Public Member Functions inherited from ElggEntity
1.8.11
