Elgg
Version 4.3
|
Represents an upgrade that runs outside of the upgrade.php script. More...
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... | |
reset () | |
Resets the update in order to be able to run it again. More... | |
setStartTime ($time=null) | |
Sets the timestamp for when the upgrade started. More... | |
getStartTime () | |
Gets the time when the upgrade completed. More... | |
save () | |
__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... | |
![]() | |
getType () | |
{} More... | |
getDisplayName () | |
{} More... | |
setDisplayName ($display_name) | |
{} More... | |
![]() | |
__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... | |
addRelationship ($guid_two, $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 ($relationship, $inverse_relationship=false) | |
Gets the number of entities from a specific relationship type. More... | |
removeRelationship ($guid_two, $relationship) | |
Remove a relationship. More... | |
removeAllRelationships (string $relationship=null, bool $inverse_relationship=false) | |
Remove all relationships to or from this entity. More... | |
deleteRelationships ($relationship=null) | |
Remove all relationships to and from this entity. 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... | |
hasAccess (int $user_guid=0) | |
Check if the given user has access to this entity. More... | |
canEdit ($user_guid=0) | |
Can a user edit this entity? More... | |
canDelete ($user_guid=0) | |
Can a user delete this entity? More... | |
canWriteToContainer ($user_guid=0, $type= '', $subtype= '') | |
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... | |
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 ($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 () | |
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... | |
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 ($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... | |
hasCapability (string $capability) | |
Checks a specific capability is enabled for the entity type/subtype. More... | |
![]() | |
__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.
| |
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 | |
![]() | |
const | PRIMARY_ATTR_NAMES |
![]() | |
prepareObject (\Elgg\Export\Entity $object) | |
{} More... | |
![]() | |
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... | |
![]() | |
initializeAttributes () | |
Initialize the attributes array. More... | |
getDatabase () | |
Provides a pointer to the database object. More... | |
![]() | |
const | INTEGER_ATTR_NAMES |
$temp_metadata = [] | |
$temp_annotations = [] | |
$temp_private_settings = [] | |
$volatile = [] | |
$orig_attributes = [] | |
$_is_cacheable = true | |
$_cached_metadata | |
![]() | |
$attributes = [] | |
$valid = false | |
Represents an upgrade that runs outside of the upgrade.php script.
Definition at line 26 of file ElggUpgrade.php.
ElggUpgrade::__get | ( | $name | ) |
Get an attribute or private setting value.
string | $name | Name of the attribute or private setting |
Definition at line 237 of file ElggUpgrade.php.
ElggUpgrade::__isset | ( | $name | ) |
Definition at line 250 of file ElggUpgrade.php.
ElggUpgrade::__set | ( | $name, | |
$value | |||
) |
Set a value as private setting or attribute.
Attributes include title and description.
string | $name | Name of the attribute or private_setting |
mixed | $value | Value to be set |
Definition at line 223 of file ElggUpgrade.php.
ElggUpgrade::getBatch | ( | ) |
Return instance of the class that processes the data.
Definition at line 107 of file ElggUpgrade.php.
ElggUpgrade::getCompletedTime | ( | ) |
Gets the time when the upgrade completed.
Definition at line 150 of file ElggUpgrade.php.
ElggUpgrade::getDisplayName | ( | ) |
{}
Definition at line 262 of file ElggUpgrade.php.
ElggUpgrade::getStartTime | ( | ) |
Gets the time when the upgrade completed.
Definition at line 192 of file ElggUpgrade.php.
ElggUpgrade::initializeAttributes | ( | ) |
ElggUpgrade::isAsynchronous | ( | ) |
Check if the upgrade should be run asynchronously.
Definition at line 98 of file ElggUpgrade.php.
ElggUpgrade::isCompleted | ( | ) |
ElggUpgrade::reset | ( | ) |
Resets the update in order to be able to run it again.
Definition at line 159 of file ElggUpgrade.php.
ElggUpgrade::save | ( | ) |
Definition at line 200 of file ElggUpgrade.php.
ElggUpgrade::setClass | ( | $class | ) |
Sets a class for the upgrade.
string | $class | Fully qualified class name |
Definition at line 90 of file ElggUpgrade.php.
ElggUpgrade::setCompleted | ( | ) |
ElggUpgrade::setCompletedTime | ( | $time = null | ) |
Sets the timestamp for when the upgrade completed.
int | $time | Timestamp when upgrade finished. Defaults to now |
Definition at line 137 of file ElggUpgrade.php.
ElggUpgrade::setID | ( | $id | ) |
Sets an unique id for the upgrade.
string | $id | Upgrade id in format <plugin_name>:<yyymmddhh> |
Definition at line 80 of file ElggUpgrade.php.
ElggUpgrade::setStartTime | ( | $time = null | ) |
Sets the timestamp for when the upgrade started.
Once set it can't be altered unless the upgrade gets reset
int | $time | Timestamp when upgrade started. Defaults to now |
Definition at line 175 of file ElggUpgrade.php.