|
| save () |
| {} More...
|
|
| __set ($name, $value) |
|
| __get ($name) |
|
| setFilename ($filename) |
| Set the filename of this file. More...
|
|
| getFilename () |
| Return the filename. More...
|
|
| getFilenameOnFilestore () |
| Return the filename of this file as it is/will be stored on the filestore, which may be different to the filename. More...
|
|
| getFilestoreSize ($prefix= '', $container_guid=0) |
| Return the size of the filestore associated with this file. More...
|
|
| getMimeType () |
| Get the mime type of the file. More...
|
|
| setMimeType ($mimetype) |
| Set the mime type of the file. More...
|
|
| getSimpleType () |
| Get the simple type of the file. More...
|
|
| open ($mode) |
| Open the file with the given mode. More...
|
|
| write ($data) |
| Write data. More...
|
|
| read ($length, $offset=0) |
| Read data. More...
|
|
| grabFile () |
| Gets the full contents of this file. More...
|
|
| close () |
| Close the file and commit changes. More...
|
|
| delete ($follow_symlinks=true) |
| Delete this file. More...
|
|
| seek ($position) |
| Seek a position in the file. More...
|
|
| tell () |
| Return the current position of the file. More...
|
|
| setModifiedTime () |
| Updates modification time of the file and clears stats cache for the file. More...
|
|
| getModifiedTime () |
| Returns file modification time. More...
|
|
| getSize () |
| Return the size of the file in bytes. More...
|
|
| eof () |
| Return a boolean value whether the file handle is at the end of the file. More...
|
|
| exists () |
| Returns if the file exists. More...
|
|
| transfer ($owner_guid, $filename=null) |
| Transfer a file to a new owner and sets a new filename, copies file contents to a new location. More...
|
|
| acceptUploadedFile (UploadedFile $upload) |
| Writes contents of the uploaded file to an instance of ElggFile. More...
|
|
| __sleep () |
| Get property names to serialize. More...
|
|
| canDownload ($user_guid=0, $default=true) |
| Checks the download permissions for the file. More...
|
|
| getDownloadURL ($use_cookie=true, $expires= '+2 hours') |
| Returns file's download URL. More...
|
|
| getInlineURL ($use_cookie=false, $expires= '') |
| Returns file's URL for inline display Suitable for displaying cacheable resources, such as user avatars. More...
|
|
| getType () |
| {} More...
|
|
| getDisplayName () |
| {} More...
|
|
| setDisplayName ($display_name) |
| {} 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 ($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...
|
|
| addRelationship ($guid_two, $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 ($relationship, $inverse_relationship=false) |
| Gets the number of entities from a specific relationship type. More...
|
|
| removeRelationship ($guid_two, $relationship) |
| Remove a relationship. More...
|
|
| removeAllRelationships (string $relationship=null, bool $inverse_relationship=false) |
| Remove all relationships to or from this entity. More...
|
|
| deleteRelationships ($relationship=null) |
| Remove all relationships to and from this entity. 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...
|
|
| hasAccess (int $user_guid=0) |
| Check if the given user has access to this entity. More...
|
|
| canEdit ($user_guid=0) |
| Can a user edit this entity? More...
|
|
| canDelete ($user_guid=0) |
| Can a user delete this entity? More...
|
|
| canWriteToContainer ($user_guid=0, $type= '', $subtype= '') |
| 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...
|
|
| 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 ($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 () |
|
| 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...
|
|
| 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 () |
| 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...
|
|
| 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...
|
|
| 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 () |
| Called during serialization. More...
|
|
| __unserialize (array $data) |
| Called during unserialization. More...
|
|