Public Member Functions | |||||||||
| __set ($name, $value) | |||||||||
Set an attribute or metadata value for this entity.Anything that is not an attribute is saved as metadata.Be advised that metadata values are cast to integer or string. You can save booleans, but they will be stored and returned as integers.
| |||||||||
| __get ($name) | |||||||||
Get an attribute or metadata value.If the name matches an attribute, the attribute is returned. If metadata does not exist with that name, a null is returned.This only returns an array if there are multiple values for a particular $name key.
| |||||||||
| setFilename (string $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... | |||||||||
| getMimeType () | |||||||||
| Get the mime type of the file. More... | |||||||||
| setMimeType (string $mimetype) | |||||||||
| Set the mime type of the file. More... | |||||||||
| getSimpleType () | |||||||||
| Get the simple type of the file. More... | |||||||||
| open (string $mode) | |||||||||
| Open the file with the given mode. More... | |||||||||
| write (string $data) | |||||||||
| Write data. More... | |||||||||
| read (int $length, int $offset=0) | |||||||||
| Read data. More... | |||||||||
| grabFile () | |||||||||
| Gets the full contents of this file. More... | |||||||||
| close () | |||||||||
| Close the file and commit changes. More... | |||||||||
| delete (bool $recursive=true, bool $persistent=null) | |||||||||
| {} More... | |||||||||
| seek (int $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 (int $owner_guid, ?string $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 (int $user_guid=0, bool $default=true) | |||||||||
| Checks the download permissions for the file. More... | |||||||||
| getDownloadURL (bool $use_cookie=true, string $expires='+2 hours') | |||||||||
| Returns file's download URL. More... | |||||||||
| getInlineURL (bool $use_cookie=false, string $expires='') | |||||||||
| Returns file's URL for inline display Suitable for displaying cacheable resources, such as user avatars. More... | |||||||||
 Public Member Functions inherited from ElggObject | |||||||||
| getDisplayName () | |||||||||
{Get the entity's display name.
| |||||||||
| setDisplayName (string $display_name) | |||||||||
{Sets the title or name of this entity.
| |||||||||
| Public Member Functions inherited from ElggEntity | |||||||||
| __construct (?\stdClass $row=null) | |||||||||
| Create a new entity. More... | |||||||||
| __clone () | |||||||||
| Clone an entity. More... | |||||||||
| getOriginalAttributes () | |||||||||
| Get the original values of attribute(s) that have been modified since the entity was persisted. 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... | |||||||||
| removeAllRelatedRiverItems () | |||||||||
| Removes all river items related to this entity. More... | |||||||||
| countComments () | |||||||||
| Count the number of comments attached to this entity. 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 \ElggEntity 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... | |||||||||
| save () | |||||||||
Save this data to the appropriate database table.
| |||||||||
| 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, ?bool $persistent=null) | |||||||||
| Deletes the entity. More... | |||||||||
| restore (bool $recursive=true) | |||||||||
| Restore the entity. More... | |||||||||
| isDeleted () | |||||||||
| Is the entity marked as deleted. 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.This id must be an integer. Unsaved implementations should return 0.
| |||||||||
| getObjectFromID (int $id) | |||||||||
| For a given ID, return the object associated with it. More... | |||||||||
| updateLastAction (?int $posted=null) | |||||||||
| Update the last_action column in the entities table. More... | |||||||||
| updateTimeDeleted (?int $deleted=null) | |||||||||
| Update the time_deleted 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 () | |||||||||
| Cache the entity in a session cache. More... | |||||||||
| invalidateCache () | |||||||||
| Invalidate cache for entity. More... | |||||||||
| hasCapability (string $capability) | |||||||||
| Checks a specific capability is enabled for the entity type/subtype. More... | |||||||||
| getFields () | |||||||||
| Helper function to easily retrieve form fields for this 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... | |||||||||
| delete () | |||||||||
| Delete this data. More... | |||||||||
| getTimeCreated () | |||||||||
| Returns the UNIX epoch time that this entity was created. 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.
| |||||||||
| getPriority () | |||||||||
{Get priority (weight) of the item within a collection.
| |||||||||
| __serialize () | |||||||||
| Called during serialization. More... | |||||||||
| __unserialize (array $data) | |||||||||
| Called during unserialization. More... | |||||||||
Protected Member Functions | ||||
| initializeAttributes () | ||||
| Set subtype to 'file'. More... | ||||
| persistentDelete (bool $recursive=true) | ||||
{Permanently delete the entity from the database.
| ||||
| getFilestore () | ||||
| Return the system filestore based on dataroot. More... | ||||
| Protected Member Functions inherited from ElggObject | ||||
| prepareObject (\Elgg\Export\Entity $object) | ||||
{Prepare an object copy for toObject()
| ||||
| Protected Member Functions inherited from ElggEntity | ||||
| 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... | ||||
| trash (bool $recursive=true) | ||||
| Move the entity to the trash. More... | ||||
| Protected Member Functions inherited from ElggData | ||||
| getDatabase () | ||||
| Provides a pointer to the database object. More... | ||||
Additional Inherited Members | |
| Static Public Member Functions inherited from ElggEntity | |
| static | getDefaultFields () |
| Returns a default set of fields to be used for forms related to this entity. More... | |
| Public Attributes inherited from ElggEntity | |
| const | PRIMARY_ATTR_NAMES |
| Protected Attributes inherited from ElggEntity | |
| const | INTEGER_ATTR_NAMES |
| $volatile = [] | |
| $orig_attributes = [] | |
| $_is_cacheable = true | |
| Protected Attributes inherited from ElggData | |
| $attributes = [] | |
| $valid = false | |
Detailed Description
Definition at line 32 of file ElggFile.php.
Member Function Documentation
◆ __get()
| ElggFile::__get | ( | $name | ) |
Get an attribute or metadata value.If the name matches an attribute, the attribute is returned. If metadata does not exist with that name, a null is returned.This only returns an array if there are multiple values for a particular $name key.
- Parameters
-
string $name Name of the attribute or metadata
- Returns
- mixed
Reimplemented from ElggEntity.
Definition at line 68 of file ElggFile.php.
◆ __set()
| ElggFile::__set | ( | $name, | |
| $value | |||
| ) |
Set an attribute or metadata value for this entity.Anything that is not an attribute is saved as metadata.Be advised that metadata values are cast to integer or string. You can save booleans, but they will be stored and returned as integers.
- Parameters
-
string $name Name of the attribute or metadata mixed $value The value to be set
- Returns
- void
- Exceptions
-
Reimplemented from ElggEntity.
Definition at line 54 of file ElggFile.php.
◆ __sleep()
| ElggFile::__sleep | ( | ) |
◆ acceptUploadedFile()
| ElggFile::acceptUploadedFile | ( | UploadedFile | $upload | ) |
Writes contents of the uploaded file to an instance of ElggFile.
- Note
- Note that this function moves the file and populates properties, but does not call ElggFile::save().
- This method will automatically assign a filename on filestore based on the upload time and filename. By default, the file will be written to /file directory on owner's filestore. You can change this directory, by setting 'filestore_prefix' property of the ElggFile instance before calling this method.
- Parameters
-
UploadedFile $upload Uploaded file object
- Returns
- bool
Definition at line 395 of file ElggFile.php.
◆ canDownload()
| ElggFile::canDownload | ( | int | $user_guid = 0, |
| bool | $default = true |
||
| ) |
Checks the download permissions for the file.
- Parameters
-
int $user_guid GUID of the user (defaults to logged in user) bool $default Default permission
- Returns
- bool
Reimplemented in ElggTempFile.
Definition at line 477 of file ElggFile.php.
◆ close()
| ElggFile::close | ( | ) |
◆ delete()
| ElggFile::delete | ( | bool | $recursive = true, |
| bool | $persistent = null |
||
| ) |
{}
Definition at line 236 of file ElggFile.php.
◆ eof()
| ElggFile::eof | ( | ) |
Return a boolean value whether the file handle is at the end of the file.
- Returns
- bool
Definition at line 322 of file ElggFile.php.
◆ exists()
| ElggFile::exists | ( | ) |
◆ getDownloadURL()
| ElggFile::getDownloadURL | ( | bool | $use_cookie = true, |
| string | $expires = '+2 hours' |
||
| ) |
Returns file's download URL.
- Note
- This does not work for files with custom filestores.
- Parameters
-
bool $use_cookie Limit URL validity to current session only string $expires URL expiration, as a string suitable for strtotime()
- Returns
- string|null
Reimplemented in ElggTempFile.
Definition at line 491 of file ElggFile.php.
◆ getFilename()
| ElggFile::getFilename | ( | ) |
Return the filename.
This filename will be sanitized to prevent path traversal
- Returns
- string
Definition at line 96 of file ElggFile.php.
◆ getFilenameOnFilestore()
| ElggFile::getFilenameOnFilestore | ( | ) |
Return the filename of this file as it is/will be stored on the filestore, which may be different to the filename.
- Returns
- string
Definition at line 111 of file ElggFile.php.
◆ getFilestore()
|
protected |
Return the system filestore based on dataroot.
- Returns
- \Elgg\Filesystem\Filestore\DiskFilestore
Reimplemented in ElggTempFile.
Definition at line 340 of file ElggFile.php.
◆ getInlineURL()
| ElggFile::getInlineURL | ( | bool | $use_cookie = false, |
| string | $expires = '' |
||
| ) |
Returns file's URL for inline display Suitable for displaying cacheable resources, such as user avatars.
- Note
- This does not work for files with custom filestores.
- Parameters
-
bool $use_cookie Limit URL validity to current session only string $expires URL expiration, as a string suitable for strtotime()
- Returns
- string|null
Reimplemented in ElggTempFile.
Definition at line 520 of file ElggFile.php.
◆ getMimeType()
| ElggFile::getMimeType | ( | ) |
Get the mime type of the file.
Returns mimetype metadata value if set, otherwise attempts to detect it.
- Returns
- string|false
Definition at line 121 of file ElggFile.php.
◆ getModifiedTime()
| ElggFile::getModifiedTime | ( | ) |
◆ getSimpleType()
| ElggFile::getSimpleType | ( | ) |
Get the simple type of the file.
Returns simpletype metadata value if set, otherwise parses it from mimetype
- Returns
- string 'document', 'audio', 'video', or 'general' if the MIME type was unrecognized
Definition at line 153 of file ElggFile.php.
◆ getSize()
| ElggFile::getSize | ( | ) |
Return the size of the file in bytes.
- Returns
- int
- Since
- 1.9
Definition at line 313 of file ElggFile.php.
◆ grabFile()
| ElggFile::grabFile | ( | ) |
Gets the full contents of this file.
- Returns
- false|string The file contents.
Definition at line 214 of file ElggFile.php.
◆ initializeAttributes()
|
protected |
Set subtype to 'file'.
- Returns
- void
Reimplemented from ElggObject.
Reimplemented in ElggTempFile, and ElggIcon.
Definition at line 45 of file ElggFile.php.
◆ open()
| ElggFile::open | ( | string | $mode | ) |
Open the file with the given mode.
- Parameters
-
string $mode Either read/write/append
- Returns
- false|resource File handler
- Exceptions
-
IOException
Definition at line 171 of file ElggFile.php.
◆ persistentDelete()
|
protected |
{Permanently delete the entity from the database.
- Parameters
-
bool $recursive If true (default) then all entities which are owned or contained by $this will also be deleted.
- Returns
- bool
- Since
- 6.0
Reimplemented from ElggEntity.
Definition at line 247 of file ElggFile.php.
◆ read()
| ElggFile::read | ( | int | $length, |
| int | $offset = 0 |
||
| ) |
Read data.
- Parameters
-
int $length Amount to read. int $offset The offset to start from.
- Returns
- mixed Data or false
Definition at line 205 of file ElggFile.php.
◆ seek()
| ElggFile::seek | ( | int | $position | ) |
Seek a position in the file.
- Parameters
-
int $position Position in bytes
- Returns
- void
Definition at line 267 of file ElggFile.php.
◆ setFilename()
| ElggFile::setFilename | ( | string | $filename | ) |
Set the filename of this file.
This filename will be sanitized to prevent path traversal
- Parameters
-
string $filename The filename
- Returns
- void
Definition at line 85 of file ElggFile.php.
◆ setMimeType()
| ElggFile::setMimeType | ( | string | $mimetype | ) |
Set the mime type of the file.
- Parameters
-
string $mimetype The mimetype
- Returns
- void
Definition at line 143 of file ElggFile.php.
◆ setModifiedTime()
| ElggFile::setModifiedTime | ( | ) |
Updates modification time of the file and clears stats cache for the file.
- Returns
- bool
Definition at line 285 of file ElggFile.php.
◆ tell()
| ElggFile::tell | ( | ) |
Return the current position of the file.
- Returns
- int The file position
Definition at line 276 of file ElggFile.php.
◆ transfer()
| ElggFile::transfer | ( | int | $owner_guid, |
| ?string | $filename = null |
||
| ) |
Transfer a file to a new owner and sets a new filename, copies file contents to a new location.
This is an alternative to using rename() which fails to move files to a non-existent directory under new owner's filestore directory
- Parameters
-
int $owner_guid New owner's guid null | string $filename New filename (uses old filename if not set)
- Returns
- bool
Reimplemented in ElggTempFile.
Definition at line 356 of file ElggFile.php.
◆ write()
| ElggFile::write | ( | string | $data | ) |
Write data.
- Parameters
-
string $data The data
- Returns
- false|int
Definition at line 193 of file ElggFile.php.
The documentation for this class was generated from the following file:
- engine/classes/ElggFile.php
