Elgg  Version 3.0
Public Member Functions | Public Attributes | List of all members
ElggUpgrade Class Reference
Inheritance diagram for ElggUpgrade:
ElggObject ElggEntity ElggData Locatable Elgg\EntityIcon Elgg\Collections\CollectionItemInterface

Public Member Functions

 initializeAttributes ()
 Set subtype to upgrade. More...
 
 setCompleted ()
 Mark this upgrade as completed. More...
 
 isCompleted ()
 Has this upgrade completed? More...
 
 setID ($id)
 Sets an unique id for the upgrade. More...
 
 setClass ($class)
 Sets a class for the upgrade. More...
 
 isAsynchronous ()
 Check if the upgrade should be run asynchronously. More...
 
 getBatch ()
 Return instance of the class that processes the data. 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...
 
 __isset ($name)
 
 getDisplayName ()
 {} More...
 
- Public Member Functions inherited from ElggObject
 getType ()
 {} More...
 
 getDisplayName ()
 {} More...
 
 setDisplayName ($display_name)
 {} More...
 
 canComment ($user_guid=0, $default=null)
 Can a user comment on this object? More...
 
- Public Member Functions inherited from ElggEntity
 __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...
 
 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...
 
 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...
 
 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...
 
 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...
 
 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...
 
 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 ()
 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 (array $params=[])
 Export an entity. 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...
 
 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...
 
- 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...
 
 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 ()
 {} More...
 
 unserialize ($serialized)
 {} More...
 

Public Attributes

 $_callable_egefps = 'elgg_get_entities_from_private_settings'
 

Additional Inherited Members

- Static Public Attributes inherited from ElggEntity
static $primary_attr_names
 
- Protected Member Functions inherited from ElggObject
 prepareObject (\Elgg\Export\Entity $object)
 {} More...
 
- Protected Member Functions inherited from ElggEntity
 initializeAttributes ()
 Initialize the attributes array. More...
 
 setTempMetadata ($name, $value, $multiple=false)
 Set temp metadata on this entity. More...
 
 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...
 
 prepareObject (\Elgg\Export\Entity $object)
 Prepare an object copy for toObject() More...
 
- Protected Member Functions inherited from ElggData
 initializeAttributes ()
 Initialize the attributes array. More...
 
 getDatabase ()
 Provides a pointer to the database object. More...
 
- Protected Attributes inherited from ElggEntity
 $temp_metadata = []
 
 $temp_annotations = []
 
 $temp_private_settings = []
 
 $volatile = []
 
 $orig_attributes = []
 
 $_is_cacheable = true
 
 $_cached_metadata
 
- Protected Attributes inherited from ElggData
 $attributes = []
 The main attributes of an entity. More...
 
 $valid = false
 
- Static Protected Attributes inherited from ElggEntity
static $integer_attr_names
 

Detailed Description

Definition at line 26 of file ElggUpgrade.php.

Member Function Documentation

ElggUpgrade::__get (   $name)

Get an attribute or private setting value.

Parameters
string$nameName of the attribute or private setting
Returns
mixed

Definition at line 202 of file ElggUpgrade.php.

ElggUpgrade::__isset (   $name)

See also
ElggData::__isset()

Definition at line 215 of file ElggUpgrade.php.

ElggUpgrade::__set (   $name,
  $value 
)

Set a value as private setting or attribute.

Attributes include title and description.

Parameters
string$nameName of the attribute or private_setting
mixed$valueValue to be set
Returns
void

Definition at line 188 of file ElggUpgrade.php.

ElggUpgrade::getBatch ( )

Return instance of the class that processes the data.

Returns
Batch|false

Definition at line 112 of file ElggUpgrade.php.

ElggUpgrade::getCompletedTime ( )

Gets the time when the upgrade completed.

Returns
string

Definition at line 155 of file ElggUpgrade.php.

ElggUpgrade::getDisplayName ( )

{}

Definition at line 227 of file ElggUpgrade.php.

ElggUpgrade::initializeAttributes ( )

Set subtype to upgrade.

Returns
null

Definition at line 48 of file ElggUpgrade.php.

ElggUpgrade::isAsynchronous ( )

Check if the upgrade should be run asynchronously.

Returns
bool

Definition at line 103 of file ElggUpgrade.php.

ElggUpgrade::isCompleted ( )

Has this upgrade completed?

Returns
bool

Definition at line 75 of file ElggUpgrade.php.

ElggUpgrade::save ( )

Require an upgrade page.

Returns
mixed
Exceptions
UnexpectedValueException

Definition at line 165 of file ElggUpgrade.php.

ElggUpgrade::setClass (   $class)

Sets a class for the upgrade.

Parameters
string$classFully qualified class name
Returns
void

Definition at line 95 of file ElggUpgrade.php.

ElggUpgrade::setCompleted ( )

Mark this upgrade as completed.

Returns
bool

Definition at line 63 of file ElggUpgrade.php.

ElggUpgrade::setCompletedTime (   $time = null)

Sets the timestamp for when the upgrade completed.

Parameters
int$timeTimestamp when upgrade finished. Defaults to now
Returns
int

Definition at line 142 of file ElggUpgrade.php.

ElggUpgrade::setID (   $id)

Sets an unique id for the upgrade.

Parameters
string$idUpgrade id in format <plugin_name>:<yyymmddhh>
Returns
void

Definition at line 85 of file ElggUpgrade.php.

Member Data Documentation

ElggUpgrade::$_callable_egefps = 'elgg_get_entities_from_private_settings'

Definition at line 41 of file ElggUpgrade.php.


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