Represents an upgrade that runs outside of the upgrade.php script. More...
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... | ||||
| 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 () | ||||
Save this data to the appropriate database table.
| ||||
| getDisplayName () | ||||
{{Get the entity's display name.
| ||||
 Public Member Functions inherited from ElggObject | ||||
| setDisplayName (string $display_name) | ||||
{Sets the title or name of this entity.
| ||||
| 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... | ||||
| 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... | ||||
| removeAllRelatedRiverItems () | ||||
| Removes all river items related to this entity. More... | ||||
| countComments () | ||||
| Count the number of comments attached to this entity. 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) | ||||
| 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 \ElggEntity 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... | ||||
| 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, ?bool $persistent=null) | ||||
| Deletes the entity. More... | ||||
| restore (bool $recursive=true) | ||||
| Restore the entity. More... | ||||
| isDeleted () | ||||
| Is the entity marked as deleted. 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.This id must be an integer. Unsaved implementations should return 0.
| ||||
| getObjectFromID (int $id) | ||||
| For a given ID, return the object associated with it. More... | ||||
| updateLastAction (?int $posted=null) | ||||
| Update the last_action column in the entities table. More... | ||||
| updateTimeDeleted (?int $deleted=null) | ||||
| Update the time_deleted 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 () | ||||
| Cache the entity in a session cache. More... | ||||
| invalidateCache () | ||||
| Invalidate cache for entity. More... | ||||
| hasCapability (string $capability) | ||||
| Checks a specific capability is enabled for the entity type/subtype. More... | ||||
| getFields () | ||||
| Helper function to easily retrieve form fields for this 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... | ||||
| delete () | ||||
| Delete this data. More... | ||||
| getTimeCreated () | ||||
| Returns the UNIX epoch time that this entity was created. More... | ||||
| rewind () | ||||
| Iterator interface. More... | ||||
| current () | ||||
| Iterator interface. More... | ||||
| key () | ||||
| Iterator interface. More... | ||||
| next () | ||||
| Iterator interface. More... | ||||
| valid () | ||||
| Iterator interface. More... | ||||
| offsetSet ($offset, $value) | ||||
| Array access interface. More... | ||||
| offsetGet ($offset) | ||||
| Array access interface. More... | ||||
| offsetUnset ($offset) | ||||
| Array access interface. More... | ||||
| offsetExists ($offset) | ||||
| Array access interface. More... | ||||
| getID () | ||||
{Get unique item identifier within a collection.
| ||||
| getPriority () | ||||
{Get priority (weight) of the item within a collection.
| ||||
| __serialize () | ||||
| Called during serialization. More... | ||||
| __unserialize (array $data) | ||||
| Called during unserialization. More... | ||||
Additional Inherited Members | ||||
| Static Public Member Functions inherited from ElggEntity | ||||
| static | getDefaultFields () | |||
| Returns a default set of fields to be used for forms related to this entity. More... | ||||
| Public Attributes inherited from ElggEntity | ||||
| const | PRIMARY_ATTR_NAMES | |||
| Protected Member Functions inherited from ElggObject | ||||
| prepareObject (\Elgg\Export\Entity $object) | ||||
{Prepare an object copy for toObject()
| ||||
| Protected Member Functions inherited from ElggEntity | ||||
| 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... | ||||
| persistentDelete (bool $recursive=true) | ||||
| Permanently delete the entity from the database. More... | ||||
| trash (bool $recursive=true) | ||||
| Move the entity to the trash. More... | ||||
| Protected Member Functions inherited from ElggData | ||||
| getDatabase () | ||||
| Provides a pointer to the database object. More... | ||||
| Protected Attributes inherited from ElggEntity | ||||
| const | INTEGER_ATTR_NAMES | |||
| $volatile = [] | ||||
| $orig_attributes = [] | ||||
| $_is_cacheable = true | ||||
| 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
◆ getBatch()
| ElggUpgrade::getBatch | ( | ) |
Return instance of the class that processes the data.
- Returns
- Batch|false
Definition at line 107 of file ElggUpgrade.php.
◆ getCompletedTime()
| ElggUpgrade::getCompletedTime | ( | ) |
Gets the time when the upgrade completed.
- Returns
- int
Definition at line 146 of file ElggUpgrade.php.
◆ getDisplayName()
| ElggUpgrade::getDisplayName | ( | ) |
{{Get the entity's display name.
- Returns
- string The title or name of this entity.
Reimplemented from ElggObject.
Definition at line 209 of file ElggUpgrade.php.
◆ getStartTime()
| ElggUpgrade::getStartTime | ( | ) |
Gets the time when the upgrade completed.
- Returns
- int
Definition at line 184 of file ElggUpgrade.php.
◆ initializeAttributes()
| ElggUpgrade::initializeAttributes | ( | ) |
Set subtype to upgrade.
- Returns
- null
Reimplemented from ElggObject.
Definition at line 42 of file ElggUpgrade.php.
◆ isAsynchronous()
| ElggUpgrade::isAsynchronous | ( | ) |
Check if the upgrade should be run asynchronously.
- Returns
- bool
Definition at line 98 of file ElggUpgrade.php.
◆ isCompleted()
| ElggUpgrade::isCompleted | ( | ) |
◆ reset()
| ElggUpgrade::reset | ( | ) |
Resets the update in order to be able to run it again.
- Returns
- void
Definition at line 155 of file ElggUpgrade.php.
◆ save()
| ElggUpgrade::save | ( | ) |
Save this data to the appropriate database table.
- Returns
- bool
- Exceptions
-
Reimplemented from ElggEntity.
Definition at line 192 of file ElggUpgrade.php.
◆ setClass()
| ElggUpgrade::setClass | ( | string | $class | ) |
Sets a class for the upgrade.
- Parameters
-
string $class Fully qualified class name
- Returns
- void
Definition at line 90 of file ElggUpgrade.php.
◆ setCompleted()
| ElggUpgrade::setCompleted | ( | ) |
◆ setCompletedTime()
| ElggUpgrade::setCompletedTime | ( | ?int | $time = null | ) |
Sets the timestamp for when the upgrade completed.
- Parameters
-
null | int $time Timestamp when upgrade finished. Defaults to now
- Returns
- void
Definition at line 137 of file ElggUpgrade.php.
◆ setID()
| ElggUpgrade::setID | ( | string | $id | ) |
Sets an unique id for the upgrade.
- Parameters
-
string $id Upgrade id in format <plugin_name>:<yyymmddhh>
- Returns
- void
Definition at line 80 of file ElggUpgrade.php.
◆ setStartTime()
| 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
-
null | int $time Timestamp 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:
- engine/classes/ElggUpgrade.php
