ElggObject Class Reference

Inheritance diagram for ElggObject:

Public Member Functions
	__construct ($row=null)
	Create a new \ElggObject. More...
	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...
	getExportableValues ()
	Return an array of fields which can be exported. More...
	canComment ($user_guid=0, $default=null)
	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...
	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...
	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...
	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...
	storeInPersistedCache (\ElggSharedMemoryCache $cache, $last_action=0)
	Cache the entity in a persisted cache. 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...
	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...
	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...
	getOwnerEntity ()
	Gets the \ElggEntity 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...
	setURL ($url)
	Overrides the URL returned by getURL() More...
	saveIconFromUploadedFile ($input_name, $type='icon', array $coords=array())
	Saves icons using an uploaded file as the source. More...
	saveIconFromLocalFile ($filename, $type='icon', array $coords=array())
	Saves icons using a local file as the source. More...
	saveIconFromElggFile (\ElggFile $file, $type='icon', array $coords=array())
	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=array())
	Get the URL for this entity's icon. More...
	addToSite ($site)
	Add this entity to a site. 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 persisted. 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 ()
	{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...
	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...
	updateLastAction ($posted=null)
	Update the last_action column in the entities table. More...
Public Member Functions inherited from ElggData
	__isset ($name)
	Test if property is set either as an attribute or metadata. More...
	delete ()
	Delete this data. More...
	getTimeCreated ()
	Returns the UNIX epoch time that this entity was created. More...
	getClassName ()
	Return the class name of the 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...

Static Public Member Functions
static	getExternalAttributes ()
	Get default values for attributes stored in a separate table. More...

Protected Member Functions
	initializeAttributes ()
	Initialize the attributes array to include the type, title, and description. More...
	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
	getDatabase ()
	Provides a pointer to the database object. More...

Additional Inherited Members
Protected Attributes inherited from ElggEntity
	$url_override
	If set, overrides the value of getURL() 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...
	$orig_attributes = array()
	Holds the original (persisted) attribute values that have been changed but not yet saved. More...
Protected Attributes inherited from ElggData
	$attributes = array()
	The main attributes of an entity. More...
	$valid = false

Detailed Description

Definition at line 22 of file ElggObject.php.

Constructor & Destructor Documentation

__construct()

ElggObject::__construct

(

$row = null

)

Create a new \ElggObject.

Plugin developers should only use the constructor to create a new entity. To retrieve entities, use get_entity() and the elgg_get_entities* functions.

If no arguments are passed, it creates a new entity. If a database result is passed as a \stdClass instance, it instantiates that entity.

Parameters

\stdClass

$row

Database row result. Default is null to create a new object.

Exceptions

IOException	If cannot load remaining data from db
InvalidParameterException	If not passed a db row result

Reimplemented in ElggPlugin.

Definition at line 67 of file ElggObject.php.

Member Function Documentation

canComment()

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

Can a user comment on this object?

See also

\ElggEntity::canComment()

Parameters

int	$user_guid	User guid (default is logged in user)
bool	$default	Default permission

Returns

bool

Since

1.8.0

Reimplemented from ElggEntity.

Reimplemented in ElggComment.

Definition at line 228 of file ElggObject.php.

create()

ElggObject::create ( )

protected

{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.

}

Reimplemented from ElggEntity.

Definition at line 118 of file ElggObject.php.

getDisplayName()

ElggObject::getDisplayName

(

)

{Get the entity's display name.

Returns

string The title or name of this entity.

}

Reimplemented from ElggEntity.

Definition at line 179 of file ElggObject.php.

getExportableValues()

ElggObject::getExportableValues

(

)

Return an array of fields which can be exported.

Returns

array

Reimplemented from ElggEntity.

Definition at line 211 of file ElggObject.php.

getExternalAttributes()

static ElggObject::getExternalAttributes ( )

staticfinal

Get default values for attributes stored in a separate table.

Returns

array @access private

See also

\Elgg\Database\EntityTable::getEntities

Definition at line 45 of file ElggObject.php.

initializeAttributes()

ElggObject::initializeAttributes ( )

protected

Initialize the attributes array to include the type, title, and description.

Returns

void

Reimplemented from ElggEntity.

Reimplemented in ElggWidget, ElggUpgrade, ElggPlugin, ElggIcon, ElggFile, and ElggComment.

Definition at line 30 of file ElggObject.php.

load()

ElggObject::load (   $guid )

protected

Loads the full \ElggObject when given a guid.

Parameters

mixed

$guid

GUID of an \ElggObject or the \stdClass object from entities table

Returns

bool

Exceptions

InvalidClassException

Reimplemented from ElggEntity.

Definition at line 98 of file ElggObject.php.

prepareObject()

ElggObject::prepareObject (   $object )

protected

{Prepare an object copy for toObject()

Parameters

\stdClass

$object

Object representation of the entity

Returns

\stdClass

}

Reimplemented from ElggEntity.

Definition at line 193 of file ElggObject.php.

setDisplayName()

ElggObject::setDisplayName

(

$displayName

)

{Sets the title or name of this entity.

Parameters

string

$displayName

The title or name of this entity.

Returns

void

}

Reimplemented from ElggEntity.

Definition at line 186 of file ElggObject.php.

update()

ElggObject::update ( )

protected

{Update the entity in the database.

Returns

bool Whether the update was successful.

Exceptions

InvalidParameterException

}

Reimplemented from ElggEntity.

Definition at line 152 of file ElggObject.php.

---

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

• engine/classes/ElggObject.php