ElggFile Class Reference

Inheritance diagram for ElggFile:

Public Member Functions
	__construct ($row=null)
	Loads an \ElggFile entity. More...
	setFilename ($name)
	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...
	detectMimeType ($file=null, $default=null)
	Detects mime types based on filename or actual file. More...
	setDescription ($description)
	Set the optional file description. 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 ()
	Delete this file. More...
	seek ($position)
	Seek a position in the file. More...
	tell ()
	Return the current position of the file. More...
	getSize ()
	Return the size of the file in bytes. More...
	size ()
	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...
	setFilestore (\ElggFilestore $filestore)
	Set a filestore. More...
	save ()
	Save the file. More...
	__sleep ()
	Get property names to serialize. More...
	__wakeup ()
	Reestablish filestore property. More...
Public Member Functions inherited from ElggObject
	getDisplayName ()
	{Get the entity's display name. Returns string The title or name of this entity. } More...
	setDisplayName ($displayName)
	{Sets the title or name of this entity. Parameters string $displayName The title or name of this entity. Returns void } More...
	getSites ($options="", $limit=10, $offset=0)
	Return sites that this object is a member of. More...
	addToSite ($site)
	Add this object to a site. More...
	getExportableValues ()
	Return an array of fields which can be exported. More...
	canComment ($user_guid=0)
	Can a user comment on this object? More...
Public Member Functions inherited from ElggEntity
	__clone ()
	Clone an entity. More...
	__set ($name, $value)
	Set an attribute or metadata value for this entity. More...
	set ($name, $value)
	Sets the value of an attribute or metadata. More...
	__get ($name)
	Get an attribute or metadata value. More...
	get ($name)
	Return the value of an attribute or metadata. More...
	getMetadata ($name)
	Return the value of a piece of metadata. More...
	__unset ($name)
	Unset a property from metadata or attribute. More...
	setMetadata ($name, $value, $value_type='', $multiple=false, $owner_guid=0, $access_id=null)
	Set metadata on this entity. More...
	deleteMetadata ($name=null)
	Deletes all metadata on this object (metadata.entity_guid = $this->guid). More...
	deleteOwnedMetadata ($name=null)
	Deletes all metadata owned by this object (metadata.owner_guid = $this->guid). More...
	clearMetadata ($name='')
	Remove metadata. More...
	disableMetadata ($name='')
	Disables metadata for this entity, optionally based on name. More...
	enableMetadata ($name='')
	Enables metadata for this entity, optionally based on name. 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...
	clearRelationships ()
	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...
	removePrivateSetting ($name)
	Removes private setting. 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, $vartype="")
	Adds an annotation to an entity. More...
	getAnnotations ($options=array(), $limit=50, $offset=0, $order="asc")
	Gets an array of annotations. More...
	clearAnnotations ($name="")
	Remove an annotation or all annotations for this entity. 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...
	getEntitiesFromRelationship ($options=array(), $inverse=false, $limit=50, $offset=0)
	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...
	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...
	getOwner ()
	Return the guid of the entity's owner. More...
	getOwnerEntity ()
	Gets the \ElggEntity that owns this entity. More...
	setContainerGUID ($container_guid)
	Set the container for this object. More...
	setContainer ($container_guid)
	Set the container for this object. More...
	getContainerGUID ()
	Gets the container GUID for this entity. More...
	getContainer ()
	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...
	setURL ($url)
	Overrides the URL returned by getURL() More...
	getIconURL ($params=array())
	Get the URL for this entity's icon. More...
	getIcon ($size='medium')
	Returns a URL for the entity's icon. More...
	setIcon ($url, $size='medium')
	Set an icon override for an icon and size. More...
	removeFromSite ($site)
	Remove this entity from a site. More...
	getSites ($options=array())
	Gets the sites this entity is a member of. More...
	isFullyLoaded ()
	Tests to see whether the object has been fully loaded. 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 ()
	{Get a plain old object copy for public consumption. Returns \stdClass } 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...
	setCalendarTimeAndDuration ($hour=null, $minute=null, $second=null, $day=null, $month=null, $year=null, $duration=null)
	Set the time and duration of an object. More...
	getCalendarStartTime ()
	Returns the start timestamp. More...
	getCalendarEndTime ()
	Returns the end timestamp. More...
	export ()
	Export this class into an array of ODD Elements containing all necessary fields. More...
	import (ODD $data)
	Import data from an parsed ODD xml data array. 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...
Public Member Functions inherited from ElggData
	__isset ($name)
	Test if property is set either as an attribute or metadata. More...
	getTimeCreated ()
	Returns the UNIX epoch time that this entity was created. More...
	getClassName ()
	Return the class name of the object. More...
	getObjectOwnerGUID ()
	Return the GUID of the owner of this object. 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...

Protected Member Functions
	initializeAttributes ()
	Set subtype to 'file'. More...
	getFilestore ()
	Return a filestore suitable for saving this file. More...
Protected Member Functions inherited from ElggObject
	load ($guid)
	Loads the full \ElggObject when given a guid. More...
	create ()
	{Create a new entry in the entities table.Saves the base information in the entities table for the entity. Saving the type-specific information is handled in the calling class method. Warning Entities must have an entry in both the entities table and their type table or they will throw an exception when loaded. Returns int The new entity's GUID Exceptions InvalidParameterException If the entity's type has not been set. IOException If the new row fails to write to the DB. } More...
	update ()
	{Update the entity in the database. Returns bool Whether the update was successful. Exceptions InvalidParameterException } More...
	prepareObject ($object)
	{Prepare an object copy for toObject() Parameters \stdClass $object Object representation of the entity Returns \stdClass } More...
Protected Member Functions inherited from ElggEntity
	loadAdditionalSelectValues (array $data)
	Stores non-attributes from the loading of the entity as volatile data. More...
Protected Member Functions inherited from ElggData
	initialise_attributes ($pre18_api=true)
	Initialise the attributes array. More...
	getDatabase ()
	Provides a pointer to the database object. More...

Additional Inherited Members
Static Public Member Functions inherited from ElggObject
static	getExternalAttributes ()
	Get default values for attributes stored in a separate table. More...
Protected Attributes inherited from ElggEntity
	$url_override
	If set, overrides the value of getURL() More...
	$icon_override
	Icon override, overrides the value of getIcon(). More...
	$temp_metadata = array()
	Holds metadata until entity is saved. More...
	$temp_annotations = array()
	Holds annotations until entity is saved. More...
	$temp_private_settings = array()
	Holds private settings until entity is saved. More...
	$volatile = array()
	Volatile data structure for this object, allows for storage of data in-memory that isn't sync'd back to the metadata table. More...
	$tables_split
	$tables_loaded
Protected Attributes inherited from ElggData
	$attributes = array()
	The main attributes of an entity. More...
	$valid = false

Detailed Description

Definition at line 22 of file ElggFile.php.

Constructor & Destructor Documentation

__construct()

ElggFile::__construct

(

$row = null

)

Loads an \ElggFile entity.

Parameters

\stdClass

$row

Database result or null for new \ElggFile

Reimplemented from ElggObject.

Definition at line 45 of file ElggFile.php.

Member Function Documentation

__sleep()

ElggFile::__sleep

(

)

Get property names to serialize.

Returns

string[]

Definition at line 455 of file ElggFile.php.

__wakeup()

ElggFile::__wakeup

(

)

Reestablish filestore property.

Returns

void

Exceptions

ClassNotFoundException

Definition at line 472 of file ElggFile.php.

close()

ElggFile::close

(

)

Close the file and commit changes.

Returns

bool

Definition at line 257 of file ElggFile.php.

delete()

ElggFile::delete

(

)

Delete this file.

Returns

bool

Reimplemented from ElggData.

Definition at line 274 of file ElggFile.php.

detectMimeType()

ElggFile::detectMimeType	(		$file = null,
			$default = null
	)

Detects mime types based on filename or actual file.

Parameters

mixed	$file	The full path of the file to check. For uploaded files, use tmp_name.
mixed	$default	A default. Useful to pass what the browser thinks it is.

Since

1.7.12

Returns

mixed Detected type on success, false on failure.

Definition at line 133 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 337 of file ElggFile.php.

exists()

ElggFile::exists

(

)

Returns if the file exists.

Returns

bool

Definition at line 348 of file ElggFile.php.

getFilename()

ElggFile::getFilename

(

)

Return the filename.

Returns

string

Definition at line 68 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 78 of file ElggFile.php.

getFilestore()

ElggFile::getFilestore ( )

protected

Return a filestore suitable for saving this file.

This filestore is either a pre-registered filestore, a filestore as recorded in metadata or the system default.

Returns

\ElggFilestore

Exceptions

ClassNotFoundException

Definition at line 374 of file ElggFile.php.

getFilestoreSize()

ElggFile::getFilestoreSize	(		$prefix = '',
			$container_guid = 0
	)

Return the size of the filestore associated with this file.

Parameters

string	$prefix	Storage prefix
int	$container_guid	The container GUID of the checked filestore

Returns

int

Definition at line 90 of file ElggFile.php.

getMimeType()

ElggFile::getMimeType

(

)

Get the mime type of the file.

Returns

string

Definition at line 104 of file ElggFile.php.

getSize()

ElggFile::getSize

(

)

Return the size of the file in bytes.

Returns

int

Since

1.9

Definition at line 317 of file ElggFile.php.

grabFile()

ElggFile::grabFile

(

)

Gets the full contents of this file.

Returns

mixed The file contents.

Definition at line 247 of file ElggFile.php.

initializeAttributes()

ElggFile::initializeAttributes ( )

protected

Set subtype to 'file'.

Returns

void

Reimplemented from ElggObject.

Definition at line 34 of file ElggFile.php.

open()

ElggFile::open

(

$mode

)

Open the file with the given mode.

Parameters

string

$mode

Either read/write/append

Returns

resource File handler

Exceptions

IOException|InvalidParameterException

Definition at line 185 of file ElggFile.php.

read()

ElggFile::read	(		$length,
			$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 236 of file ElggFile.php.

save()

ElggFile::save

(

)

Save the file.

Write the file's data to the filestore and save the corresponding entity.

See also

\ElggObjectsave()

Returns

bool

Reimplemented from ElggEntity.

Definition at line 433 of file ElggFile.php.

seek()

ElggFile::seek

(

$position

)

Seek a position in the file.

Parameters

int

$position

Position in bytes

Returns

bool

Definition at line 293 of file ElggFile.php.

setDescription()

ElggFile::setDescription

(

$description

)

Set the optional file description.

Parameters

string

$description

The description.

Returns

bool

Definition at line 172 of file ElggFile.php.

setFilename()

ElggFile::setFilename

(

$name

)

Set the filename of this file.

Parameters

string

$name

The filename.

Returns

void

Definition at line 59 of file ElggFile.php.

setFilestore()

ElggFile::setFilestore

(

\ElggFilestore

$filestore

)

Set a filestore.

Parameters

\ElggFilestore

$filestore

The file store.

Returns

void

Definition at line 361 of file ElggFile.php.

setMimeType()

ElggFile::setMimeType

(

$mimetype

)

Set the mime type of the file.

Parameters

string

$mimetype

The mimetype

Returns

bool

Definition at line 119 of file ElggFile.php.

size()

ElggFile::size

(

)

Return the size of the file in bytes.

Returns

int

Definition at line 327 of file ElggFile.php.

tell()

ElggFile::tell

(

)

Return the current position of the file.

Returns

int The file position

Definition at line 305 of file ElggFile.php.

write()

ElggFile::write

(

$data

)

Write data.

Parameters

string

$data

The data

Returns

bool

Definition at line 222 of file ElggFile.php.

---

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

• engine/classes/ElggFile.php