|
| | __construct ($path) |
| | Creates a new plugin from path. More...
|
| |
| | save () |
| | Save the plugin object. More...
|
| |
| | getID () |
| | Returns the ID (dir name) of this plugin. More...
|
| |
| | getFriendlyName () |
| | Returns the manifest's name if available, otherwise the ID. More...
|
| |
| | getPath () |
| | Returns the plugin's full path with trailing slash. More...
|
| |
| | getStaticConfig ($key, $default=null) |
| | Get a value from the plugins's static config file. More...
|
| |
| | setID ($id) |
| | Sets the location of this plugin. More...
|
| |
| | getAvailableTextFiles () |
| | Returns an array of available markdown files for this plugin. More...
|
| |
| | getPriority () |
| | Gets the plugin's load priority. More...
|
| |
| | setPriority ($priority, $site_guid=null) |
| | Sets the priority of the plugin. More...
|
| |
| | getSetting ($name, $default=null) |
| | Returns a plugin setting. More...
|
| |
| | getAllSettings () |
| | Returns an array of all settings saved for this plugin. More...
|
| |
| | setSetting ($name, $value) |
| | Set a plugin setting for the plugin. More...
|
| |
| | unsetSetting ($name) |
| | Removes a plugin setting name and value. More...
|
| |
| | unsetAllSettings () |
| | Removes all settings for this plugin. More...
|
| |
| | getUserSetting ($name, $user_guid=0, $default=null) |
| | Returns a user's setting for this plugin. More...
|
| |
| | getAllUserSettings ($user_guid=0) |
| | Returns an array of all user settings saved for this plugin for the user. More...
|
| |
| | setUserSetting ($name, $value, $user_guid=0) |
| | Sets a user setting for a plugin. More...
|
| |
| | unsetUserSetting ($name, $user_guid=0) |
| | Removes a user setting name and value. More...
|
| |
| | unsetAllUserSettings ($user_guid) |
| | Removes all User Settings for this plugin for a particular user. More...
|
| |
| | unsetAllUsersSettings () |
| | Removes this plugin's user settings for all users. More...
|
| |
| | isValid () |
| | Returns if the plugin is complete, meaning has all required files and Elgg can read them and they make sense. More...
|
| |
| | isActive ($site_guid=null) |
| | Is this plugin active? More...
|
| |
| | canActivate ($site_guid=null) |
| | Checks if this plugin can be activated on the current Elgg installation. More...
|
| |
| | activate ($site_guid=null) |
| | Actives the plugin for the current site. More...
|
| |
| | canDeactivate ($site_guid=null) |
| | Checks if this plugin can be deactivated on the current Elgg installation. More...
|
| |
| | deactivate ($site_guid=null) |
| | Deactivates the plugin. More...
|
| |
| | start ($flags) |
| | Start the plugin. More...
|
| |
| | __get ($name) |
| | Get an attribute or private setting value. More...
|
| |
| | get ($name) |
| | Get a value from private settings. More...
|
| |
| | __set ($name, $value) |
| | Set a value as private setting or attribute. More...
|
| |
| | set ($name, $value) |
| | Save a value as private setting or attribute. More...
|
| |
| | getError () |
| | Returns the last error message registered. More...
|
| |
| | getManifest () |
| | Returns this plugin's object. More...
|
| |
| | getPackage () |
| | Returns this plugin's object. More...
|
| |
| | __construct ($row=null) |
| | Create a new . More...
|
| |
| | getDisplayName () |
| | {} More...
|
| |
| | setDisplayName ($displayName) |
| | {} More...
|
| |
| | getExportableValues () |
| | Return an array of fields which can be exported. More...
|
| |
| | canComment ($user_guid=0, $default=null) |
| | Can a user comment on this object? More...
|
| |
| | __clone () |
| | Clone an entity. More...
|
| |
| | __set ($name, $value) |
| | Set an attribute or metadata value for this entity. More...
|
| |
| | set ($name, $value) |
| | Sets the value of an attribute or metadata. 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...
|
| |
| | get ($name) |
| | Return the value of an attribute or metadata. More...
|
| |
| | getDisplayName () |
| | Get the entity's display name. More...
|
| |
| | setDisplayName ($displayName) |
| | Sets the title or name of this entity. 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...
|
| |
| | 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...
|
| |
| | storeInPersistedCache (\ElggSharedMemoryCache $cache, $last_action=0) |
| | Cache the entity in a persisted cache. 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...
|
| |
| | 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...
|
| |
| | 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...
|
| |
| | 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...
|
| |
| | setURL ($url) |
| | Overrides the URL returned by getURL() More...
|
| |
| | saveIconFromUploadedFile ($input_name, $type= 'icon', array $coords=array()) |
| | Saves icons using an uploaded file as the source. More...
|
| |
| | saveIconFromLocalFile ($filename, $type= 'icon', array $coords=array()) |
| | Saves icons using a local file as the source. More...
|
| |
| | saveIconFromElggFile (\ElggFile $file, $type= 'icon', array $coords=array()) |
| | 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=array()) |
| | Get the URL for this entity's icon. More...
|
| |
| | addToSite ($site) |
| | Add this entity to a site. 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 persisted. 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 () |
| | {} 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...
|
| |
| | getExportableValues () |
| | Returns an array of fields which can be exported. 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...
|
| |
| | updateLastAction ($posted=null) |
| | Update the last_action column in the entities table. More...
|
| |
| | __isset ($name) |
| | Test if property is set either as an attribute or metadata. 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 () |
| | Get a plain old object copy for public consumption. More...
|
| |
| | getClassName () |
| | Return the class name of the 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 Member Functions inherited from ElggObject
1.8.11
