Elgg
Version 2.3
|
Public Member Functions | ||||
__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 \ElggPluginManifest object. More... | ||||
getPackage () | ||||
Returns this plugin's \ElggPluginPackage object. More... | ||||
![]() | ||||
getDisplayName () | ||||
{Get the entity's display name.
| ||||
setDisplayName ($displayName) | ||||
{Sets the title or name of this entity.
| ||||
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... | ||||
getOriginalAttributes () | ||||
Get the original values of attribute(s) that have been modified since the entity was persisted. 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... | ||||
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 \ElggEntity 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... | ||||
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 () | ||||
{Get a plain old object copy for public consumption.
| ||||
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... | ||||
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... | ||||
delete () | ||||
Delete this data. More... | ||||
getTimeCreated () | ||||
Returns the UNIX epoch time that this entity was created. 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... | ||||
Protected Member Functions | |||||
initializeAttributes () | |||||
Set subtype to 'plugin'. More... | |||||
includeFile ($filename) | |||||
Includes one of the plugins files. More... | |||||
canReadFile ($filename) | |||||
Checks whether a plugin file with the given name exists. More... | |||||
registerViews () | |||||
Registers the plugin's views. More... | |||||
registerLanguages () | |||||
Registers the plugin's languages. More... | |||||
registerClasses () | |||||
Registers the plugin's classes. More... | |||||
![]() | |||||
load ($guid) | |||||
Loads the full \ElggObject when given a guid. More... | |||||
create () | |||||
{Create a new entry in the entities table.Saves the base information in the entities table for the entity. Saving the type-specific information is handled in the calling class method.
| |||||
update () | |||||
{Update the entity in the database.
| |||||
prepareObject ($object) | |||||
{Prepare an object copy for toObject()
| |||||
![]() | |||||
loadAdditionalSelectValues (array $data) | |||||
Stores non-attributes from the loading of the entity as volatile data. More... | |||||
![]() | |||||
getDatabase () | |||||
Provides a pointer to the database object. More... | |||||
Static Protected Member Functions | |
static | getConfigWrapper () |
Get the config object in a deprecation wrapper. More... | |
Additional Inherited Members | |
![]() | |
static | getExternalAttributes () |
Get default values for attributes stored in a separate table. More... | |
![]() | |
$url_override | |
If set, overrides the value of getURL() More... | |
$temp_metadata = array() | |
Holds metadata until entity is saved. More... | |
$temp_annotations = array() | |
Holds annotations until entity is saved. More... | |
$temp_private_settings = array() | |
Holds private settings until entity is saved. More... | |
$volatile = array() | |
Volatile data structure for this object, allows for storage of data in-memory that isn't sync'd back to the metadata table. More... | |
$orig_attributes = array() | |
Holds the original (persisted) attribute values that have been changed but not yet saved. More... | |
![]() | |
$attributes = array() | |
The main attributes of an entity. More... | |
$valid = false | |
Definition at line 14 of file ElggPlugin.php.
ElggPlugin::__construct | ( | $path | ) |
Creates a new plugin from path.
string | $path | The absolute path of the plugin |
PluginException |
Reimplemented from ElggObject.
Definition at line 54 of file ElggPlugin.php.
ElggPlugin::__get | ( | $name | ) |
Get an attribute or private setting value.
string | $name | Name of the attribute or private setting |
Reimplemented from ElggEntity.
Definition at line 1036 of file ElggPlugin.php.
ElggPlugin::__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 |
Reimplemented from ElggEntity.
Definition at line 1076 of file ElggPlugin.php.
ElggPlugin::activate | ( | $site_guid = null | ) |
Actives the plugin for the current site.
mixed | $site_guid | Optional site GUID. |
Definition at line 711 of file ElggPlugin.php.
ElggPlugin::canActivate | ( | $site_guid = null | ) |
Checks if this plugin can be activated on the current Elgg installation.
mixed | $site_guid | Optional site guid |
Definition at line 685 of file ElggPlugin.php.
ElggPlugin::canDeactivate | ( | $site_guid = null | ) |
Checks if this plugin can be deactivated on the current Elgg installation.
Validates that this plugin has no active dependants.
mixed | $site_guid | Optional site guid |
Definition at line 768 of file ElggPlugin.php.
|
protected |
Checks whether a plugin file with the given name exists.
string | $filename | The name of the file |
Definition at line 939 of file ElggPlugin.php.
ElggPlugin::deactivate | ( | $site_guid = null | ) |
Deactivates the plugin.
mixed | $site_guid | Optional site GUID. |
Definition at line 815 of file ElggPlugin.php.
ElggPlugin::get | ( | $name | ) |
Get a value from private settings.
string | $name | Name |
Reimplemented from ElggEntity.
Definition at line 1062 of file ElggPlugin.php.
ElggPlugin::getAllSettings | ( | ) |
Returns an array of all settings saved for this plugin.
Definition at line 334 of file ElggPlugin.php.
ElggPlugin::getAllUserSettings | ( | $user_guid = 0 | ) |
Returns an array of all user settings saved for this plugin for the user.
int | $user_guid | The user GUID. Defaults to logged in. |
Definition at line 473 of file ElggPlugin.php.
ElggPlugin::getAvailableTextFiles | ( | ) |
Returns an array of available markdown files for this plugin.
Definition at line 202 of file ElggPlugin.php.
|
staticprotected |
Get the config object in a deprecation wrapper.
Definition at line 889 of file ElggPlugin.php.
ElggPlugin::getError | ( | ) |
Returns the last error message registered.
Definition at line 1146 of file ElggPlugin.php.
ElggPlugin::getFriendlyName | ( | ) |
Returns the manifest's name if available, otherwise the ID.
Definition at line 140 of file ElggPlugin.php.
ElggPlugin::getID | ( | ) |
Returns the ID (dir name) of this plugin.
Definition at line 130 of file ElggPlugin.php.
ElggPlugin::getManifest | ( | ) |
Returns this plugin's \ElggPluginManifest object.
Definition at line 1155 of file ElggPlugin.php.
ElggPlugin::getPackage | ( | ) |
Returns this plugin's \ElggPluginPackage object.
Definition at line 1179 of file ElggPlugin.php.
ElggPlugin::getPath | ( | ) |
Returns the plugin's full path with trailing slash.
Definition at line 154 of file ElggPlugin.php.
ElggPlugin::getPriority | ( | ) |
ElggPlugin::getSetting | ( | $name, | |
$default = null |
|||
) |
Returns a plugin setting.
string | $name | The setting name |
mixed | $default | The default value to return if none is set |
Definition at line 316 of file ElggPlugin.php.
ElggPlugin::getStaticConfig | ( | $key, | |
$default = null |
|||
) |
Get a value from the plugins's static config file.
string | $key | Config key |
mixed | $default | Value returned if missing |
PluginException | @access private |
Definition at line 171 of file ElggPlugin.php.
ElggPlugin::getUserSetting | ( | $name, | |
$user_guid = 0 , |
|||
$default = null |
|||
) |
Returns a user's setting for this plugin.
string | $name | The setting name |
int | $user_guid | The user GUID |
mixed | $default | The default value to return if none is set |
Definition at line 446 of file ElggPlugin.php.
|
protected |
Includes one of the plugins files.
string | $filename | The name of the file |
PluginException |
Definition at line 907 of file ElggPlugin.php.
|
protected |
Set subtype to 'plugin'.
Reimplemented from ElggObject.
Definition at line 33 of file ElggPlugin.php.
ElggPlugin::isActive | ( | $site_guid = null | ) |
Is this plugin active?
int | $site_guid | Optional site guid. |
Definition at line 658 of file ElggPlugin.php.
ElggPlugin::isValid | ( | ) |
Returns if the plugin is complete, meaning has all required files and Elgg can read them and they make sense.
Definition at line 633 of file ElggPlugin.php.
|
protected |
Registers the plugin's classes.
PluginException |
Definition at line 1020 of file ElggPlugin.php.
|
protected |
Registers the plugin's languages.
PluginException |
Definition at line 1010 of file ElggPlugin.php.
|
protected |
Registers the plugin's views.
PluginException |
Definition at line 978 of file ElggPlugin.php.
ElggPlugin::save | ( | ) |
Save the plugin object.
Make sure required values exist.
Reimplemented from ElggEntity.
Definition at line 104 of file ElggPlugin.php.
ElggPlugin::set | ( | $name, | |
$value | |||
) |
Save a value as private setting or attribute.
Attributes include title and description.
string | $name | Name |
mixed | $value | Value |
Reimplemented from ElggEntity.
Definition at line 1099 of file ElggPlugin.php.
ElggPlugin::setID | ( | $id | ) |
Sets the location of this plugin.
string | $id | The path to the plugin's dir. |
Definition at line 193 of file ElggPlugin.php.
ElggPlugin::setPriority | ( | $priority, | |
$site_guid = null |
|||
) |
Sets the priority of the plugin.
mixed | $priority | The priority to set. One of +1, -1, first, last, or a number. If given a number, this will displace all plugins at that number and set their priorities +1 |
mixed | $site_guid | Optional site GUID. |
Definition at line 236 of file ElggPlugin.php.
ElggPlugin::setSetting | ( | $name, | |
$value | |||
) |
Set a plugin setting for the plugin.
string | $name | The name to set |
string | $value | The value to set |
Definition at line 378 of file ElggPlugin.php.
ElggPlugin::setUserSetting | ( | $name, | |
$value, | |||
$user_guid = 0 |
|||
) |
Sets a user setting for a plugin.
string | $name | The setting name |
string | $value | The setting value |
int | $user_guid | The user GUID |
Definition at line 521 of file ElggPlugin.php.
ElggPlugin::start | ( | $flags | ) |
Start the plugin.
int | $flags | Start flags for the plugin. See the constants in lib/plugins.php for details. |
PluginException |
Definition at line 853 of file ElggPlugin.php.
ElggPlugin::unsetAllSettings | ( | ) |
ElggPlugin::unsetAllUserSettings | ( | $user_guid | ) |
Removes all User Settings for this plugin for a particular user.
Use removeAllUsersSettings() to remove all user settings for all users. (Note the plural 'Users'.)
int | $user_guid | The user GUID to remove user settings. |
Definition at line 593 of file ElggPlugin.php.
ElggPlugin::unsetAllUsersSettings | ( | ) |
Removes this plugin's user settings for all users.
Use removeAllUserSettings() if you just want to remove settings for a single user.
Definition at line 612 of file ElggPlugin.php.
ElggPlugin::unsetSetting | ( | $name | ) |
Removes a plugin setting name and value.
string | $name | The setting name to remove |
Definition at line 406 of file ElggPlugin.php.
ElggPlugin::unsetUserSetting | ( | $name, | |
$user_guid = 0 |
|||
) |
Removes a user setting name and value.
string | $name | The user setting name |
int | $user_guid | The user GUID |
Definition at line 562 of file ElggPlugin.php.