ElggUpgrade Class Reference

Inheritance diagram for ElggUpgrade:

Public Member Functions
	initializeAttributes ()
	Set subtype to upgrade. More...
	setCompleted ()
	Mark this upgrade as completed. More...
	isCompleted ()
	Has this upgrade completed? More...
	setPath ($path)
	Sets an upgrade URL path. More...
	getURL ()
	Returns a normalized URL for the upgrade page. More...
	setCompletedTime ($time=null)
	Sets the timestamp for when the upgrade completed. More...
	getCompletedTime ()
	Gets the time when the upgrade completed. More...
	save ()
	Require an upgrade page. More...
	__set ($name, $value)
	Set a value as private setting or attribute. More...
	__get ($name)
	Get an attribute or private setting value. More...
	getUpgradeFromPath ($path)
	Find an ElggUpgrade object by the unique URL path. More...
Public Member Functions inherited from ElggObject
	__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...
	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)
	Sets the value of an attribute or metadata. 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...
	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...
	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...
	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...

Public Attributes
	$_callable_egefps = 'elgg_get_entities_from_private_settings'

Additional Inherited Members
Static Public Member Functions inherited from ElggObject
static	getExternalAttributes ()
	Get default values for attributes stored in a separate table. 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...
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 19 of file ElggUpgrade.php.

Member Function Documentation

__get()

ElggUpgrade::__get

(

$name

)

Get an attribute or private setting value.

Parameters

string

$name

Name of the attribute or private setting

Returns

mixed

Reimplemented from ElggEntity.

Definition at line 163 of file ElggUpgrade.php.

__set()

ElggUpgrade::__set	(		$name,
			$value
	)

Set a value as private setting or attribute.

Attributes include title and description.

Parameters

string	$name	Name of the attribute or private_setting
mixed	$value	Value to be set

Returns

void

Reimplemented from ElggEntity.

Definition at line 149 of file ElggUpgrade.php.

getCompletedTime()

ElggUpgrade::getCompletedTime

(

)

Gets the time when the upgrade completed.

Returns

string

Definition at line 120 of file ElggUpgrade.php.

getUpgradeFromPath()

ElggUpgrade::getUpgradeFromPath

(

$path

)

Find an ElggUpgrade object by the unique URL path.

Parameters

string

$path

The Upgrade URL path (after site URL)

Returns

ElggUpgrade|false

Definition at line 178 of file ElggUpgrade.php.

getURL()

ElggUpgrade::getURL

(

)

Returns a normalized URL for the upgrade page.

Returns

string

Reimplemented from ElggEntity.

Definition at line 97 of file ElggUpgrade.php.

initializeAttributes()

ElggUpgrade::initializeAttributes

(

)

Set subtype to upgrade.

Returns

null

Reimplemented from ElggObject.

Definition at line 39 of file ElggUpgrade.php.

isCompleted()

ElggUpgrade::isCompleted

(

)

Has this upgrade completed?

Returns

bool

Definition at line 67 of file ElggUpgrade.php.

save()

ElggUpgrade::save

(

)

Require an upgrade page.

Returns

mixed

Exceptions

UnexpectedValueException

Reimplemented from ElggEntity.

Definition at line 130 of file ElggUpgrade.php.

setCompleted()

ElggUpgrade::setCompleted

(

)

Mark this upgrade as completed.

Returns

bool

Definition at line 57 of file ElggUpgrade.php.

setCompletedTime()

ElggUpgrade::setCompletedTime

(

$time = null

)

Sets the timestamp for when the upgrade completed.

Parameters

int

$time

Timestamp when upgrade finished. Defaults to now.

Returns

bool

Definition at line 107 of file ElggUpgrade.php.

setPath()

ElggUpgrade::setPath

(

$path

)

Sets an upgrade URL path.

Parameters

string

$path

Set the URL path (without site URL) for the upgrade page

Returns

void

Exceptions

InvalidArgumentException

Definition at line 78 of file ElggUpgrade.php.

Member Data Documentation

$_callable_egefps

ElggUpgrade::$_callable_egefps = 'elgg_get_entities_from_private_settings'

Definition at line 32 of file ElggUpgrade.php.

---

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

• engine/classes/ElggUpgrade.php