Elgg  Version master
Public Member Functions | List of all members
ElggUpgrade Class Reference

Represents an upgrade that runs outside of the upgrade.php script. More...

Inheritance diagram for ElggUpgrade:
ElggObject ElggEntity ElggData 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 (string $id)
 Sets an unique id for the upgrade. More...
 
 setClass (string $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 (int $time=null)
 Sets the timestamp for when the upgrade completed. More...
 
 getCompletedTime ()
 Gets the time when the upgrade completed. More...
 
 reset ()
 Resets the update in order to be able to run it again. More...
 
 setStartTime (int $time=null)
 Sets the timestamp for when the upgrade started. More...
 
 getStartTime ()
 Gets the time when the upgrade completed. More...
 
 save ()
 
 getDisplayName ()
 {} More...
 
- Public Member Functions inherited from ElggObject
 getType ()
 {} More...
 
 getDisplayName ()
 {} More...
 
 setDisplayName (string $display_name)
 {} 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 (string $display_name)
 Sets the title or name of this entity. More...
 
 getMetadata (string $name)
 Return the value of a piece of metadata. More...
 
 getAllMetadata ()
 Get all entity metadata. More...
 
 setMetadata (string $name, $value, string $value_type= '', bool $multiple=false)
 Set metadata on this entity. More...
 
 deleteMetadata (string $name=null)
 Deletes all metadata on this object (metadata.entity_guid = $this->guid). 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...
 
 addRelationship (int $guid_two, string $relationship)
 Add a relationship between this an another entity. More...
 
 hasRelationship (int $guid_two, string $relationship)
 Check if this entity has a relationship with another entity. More...
 
 getRelationship (int $guid_two, string $relationship)
 Return the relationship if this entity has a relationship with another entity. More...
 
 getEntitiesFromRelationship (array $options=[])
 Gets an array of entities with a relationship to this entity. More...
 
 countEntitiesFromRelationship (string $relationship, bool $inverse_relationship=false)
 Gets the number of entities from a specific relationship type. More...
 
 removeRelationship (int $guid_two, string $relationship)
 Remove a relationship. More...
 
 removeAllRelationships (string $relationship=null, bool $inverse_relationship=false)
 Remove all relationships to or from this entity. More...
 
 removeAllRelatedRiverItems ()
 Removes all river items related to this entity. More...
 
 deleteAnnotations (string $name=null)
 Deletes all annotations on this object (annotations.entity_guid = $this->guid). More...
 
 deleteOwnedAnnotations (string $name=null)
 Deletes all annotations owned by this object (annotations.owner_guid = $this->guid). More...
 
 disableAnnotations (string $name=null)
 Disables annotations for this entity, optionally based on name. More...
 
 enableAnnotations (string $name=null)
 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 (string $name= '')
 Count annotations. More...
 
 getAnnotationsAvg (string $name)
 Get the average of an integer type annotation. More...
 
 getAnnotationsSum (string $name)
 Get the sum of integer type annotations of a given name. More...
 
 getAnnotationsMin (string $name)
 Get the minimum of integer type annotations of given name. More...
 
 getAnnotationsMax (string $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 (array $options=[])
 Returns the ACLs owned by the entity. More...
 
 getOwnedAccessCollection (string $subtype)
 Returns the first ACL owned by the entity with a given subtype. 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, bool $default=null)
 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 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...
 
 saveIconFromUploadedFile (string $input_name, string $type= 'icon', array $coords=[])
 Saves icons using an uploaded file as the source. More...
 
 saveIconFromLocalFile (string $filename, string $type= 'icon', array $coords=[])
 Saves icons using a local file as the source. More...
 
 saveIconFromElggFile (\ElggFile $file, string $type= 'icon', array $coords=[])
 Saves icons using a file located in the data store as the source. More...
 
 getIcon (string $size, string $type= 'icon')
 Returns entity icon as an ElggIcon object The icon file may or may not exist on filestore. More...
 
 deleteIcon (string $type= 'icon')
 Removes all icon files and metadata for the passed type of icon. More...
 
 getIconLastChange (string $size, string $type= 'icon')
 Returns the timestamp of when the icon was changed. More...
 
 hasIcon (string $size, string $type= 'icon')
 Returns if the entity has an icon of the passed type. More...
 
 getIconURL (string|array $params=[])
 Get the URL for this entity's icon. More...
 
 save ()
 
 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)
 Deletes the entity. 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. More...
 
 getObjectFromID (int $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 (int $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 (bool $persist=true)
 Cache the entity in a session and persisted caches. More...
 
 invalidateCache ()
 Invalidate cache for entity. More...
 
 hasCapability (string $capability)
 Checks a specific capability is enabled for the entity type/subtype. 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 ()
 Called during serialization. More...
 
 __unserialize (array $data)
 Called during unserialization. More...
 
- Public Member Functions inherited from Elgg\EntityIcon
 getIconURL (array $params)
 Returns a URL of the icon. More...
 

Additional Inherited Members

- Public Attributes inherited from ElggEntity
const 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 (string $name, $value, bool $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
const INTEGER_ATTR_NAMES
 
 $temp_metadata = []
 
 $temp_annotations = []
 
 $volatile = []
 
 $orig_attributes = []
 
 $_is_cacheable = true
 
 $_cached_metadata
 
- Protected Attributes inherited from ElggData
 $attributes = []
 
 $valid = false
 

Detailed Description

Represents an upgrade that runs outside of the upgrade.php script.

Definition at line 26 of file ElggUpgrade.php.

Member Function Documentation

ElggUpgrade::getBatch ( )

Return instance of the class that processes the data.

Returns
Batch|false

Definition at line 107 of file ElggUpgrade.php.

ElggUpgrade::getCompletedTime ( )

Gets the time when the upgrade completed.

Returns
int

Definition at line 146 of file ElggUpgrade.php.

ElggUpgrade::getDisplayName ( )

{}

Definition at line 209 of file ElggUpgrade.php.

ElggUpgrade::getStartTime ( )

Gets the time when the upgrade completed.

Returns
int

Definition at line 184 of file ElggUpgrade.php.

ElggUpgrade::initializeAttributes ( )

Set subtype to upgrade.

Returns
null

Definition at line 42 of file ElggUpgrade.php.

ElggUpgrade::isAsynchronous ( )

Check if the upgrade should be run asynchronously.

Returns
bool

Definition at line 98 of file ElggUpgrade.php.

ElggUpgrade::isCompleted ( )

Has this upgrade completed?

Returns
bool

Definition at line 70 of file ElggUpgrade.php.

ElggUpgrade::reset ( )

Resets the update in order to be able to run it again.

Returns
void

Definition at line 155 of file ElggUpgrade.php.

ElggUpgrade::save ( )

Exceptions

Definition at line 192 of file ElggUpgrade.php.

ElggUpgrade::setClass ( string  $class)

Sets a class for the upgrade.

Parameters
string$classFully qualified class name
Returns
void

Definition at line 90 of file ElggUpgrade.php.

ElggUpgrade::setCompleted ( )

Mark this upgrade as completed.

Returns
void

Definition at line 57 of file ElggUpgrade.php.

ElggUpgrade::setCompletedTime ( int  $time = null)

Sets the timestamp for when the upgrade completed.

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

Definition at line 137 of file ElggUpgrade.php.

ElggUpgrade::setID ( string  $id)

Sets an unique id for the upgrade.

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

Definition at line 80 of file ElggUpgrade.php.

ElggUpgrade::setStartTime ( int  $time = null)

Sets the timestamp for when the upgrade started.

Once set it can't be altered unless the upgrade gets reset

Parameters
int$timeTimestamp when upgrade started. Defaults to now
Returns
void

Definition at line 171 of file ElggUpgrade.php.


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