Elgg
Version 6.1
|
Plugin class containing helper functions for plugin activation/deactivation, dependency checking capabilities and (user)pluginsettings. More...
Public Member Functions | |
save () | |
{} More... | |
getID () | |
Returns the ID (dir name) of this plugin. More... | |
getDisplayName () | |
Returns the name from elgg-plugin.php if available, otherwise a nicely formatted ID. More... | |
setPath (string $path) | |
Set path. More... | |
getPath () | |
Returns the plugin's full path with trailing slash. More... | |
getStaticConfig (string $key, $default=null) | |
Get a value from the plugins' static config file. More... | |
getPriority () | |
Gets the plugin's load priority. More... | |
setPriority ($priority) | |
Sets the priority of the plugin Returns the new priority or false on error. More... | |
getSetting (string $name, $default=null) | |
Returns a plugin setting when the plugin is active. More... | |
getAllSettings () | |
Returns an array of all settings saved for this plugin when the plugin is active. More... | |
setSetting (string $name, $value) | |
Set a plugin setting for the plugin. More... | |
unsetSetting (string $name) | |
Removes a plugin setting name and value. More... | |
unsetAllSettings () | |
Removes all settings for this plugin. More... | |
unsetAllEntityAndPluginSettings () | |
Remove all entity and plugin settings for this plugin. More... | |
isValid () | |
Returns if the plugin is complete, meaning has all required files and Elgg can read them and they make sense. More... | |
assertValid () | |
Asserts if a plugin is valid. More... | |
isActive () | |
Is this plugin active? More... | |
canActivate () | |
Checks if this plugin can be activated on the current Elgg installation. More... | |
assertCanActivate () | |
Asserts if a plugin can activate. More... | |
activate () | |
Activates the plugin for the current site. More... | |
getDependencies () | |
Returns an array of dependencies as configured in the static config. More... | |
canDeactivate () | |
Checks if this plugin can be deactivated on the current Elgg installation. More... | |
assertCanDeactivate () | |
Asserts if a plugin can be deactivated. More... | |
deactivate () | |
Deactivates the plugin. More... | |
getBootstrap () | |
Bootstrap object. More... | |
autoload () | |
Register plugin classes and require composer autoloader. More... | |
register () | |
Autoload plugin classes and vendor libraries Register plugin-specific entity classes and execute bootstrapped load scripts Register languages and views. More... | |
boot () | |
Boot the plugin. More... | |
init () | |
Init the plugin. More... | |
registerLanguages () | |
Registers the plugin's languages. More... | |
__get ($name) | |
Get an attribute or setting value. More... | |
__set ($name, $value) | |
Set a value as attribute or setting. More... | |
isCacheable () | |
{} More... | |
invalidateCache () | |
{} More... | |
meetsDependencies () | |
Checks if dependencies are met. More... | |
assertDependencies () | |
Assert plugin dependencies. More... | |
getVersion () | |
Returns the plugin version. More... | |
getCategories () | |
Returns an array with categories. More... | |
getLicense () | |
Returns the license. More... | |
getDescription () | |
Return the description. More... | |
getRepositoryURL () | |
Returns the repository url. More... | |
getBugTrackerURL () | |
Returns the bug tracker page. More... | |
getWebsite () | |
Return the website. More... | |
getAuthors () | |
Returns an array of authors. More... | |
getConflicts () | |
Returns an array of projectnames with their conflicting version. More... | |
![]() | |
getDisplayName () | |
{} More... | |
setDisplayName (string $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 (string $display_name) | |
Sets the title or name of this entity. 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 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... | |
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, 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 () | |
{} More... | |
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... | |
![]() | |
__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... | |
getSystemLogID () | |
Return an identification for the object for storage in the system log. More... | |
getType () | |
Return the type of the object - eg. More... | |
getSubtype () | |
Return a subtype. More... | |
getObjectFromID (int $id) | |
For a given ID, return the object associated with it. 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... | |
Static Public Member Functions | |
static | fromId (string $plugin_id, string $path=null) |
Load a plugin object from its ID Create a new plugin entity if doesn't exist. More... | |
Public Attributes | |
const | PRIORITY_SETTING_NAME = 'elgg:internal:priority' |
const | STATIC_CONFIG_FILENAME = 'elgg-plugin.php' |
const | PUBLIC_SERVICES_FILENAME = 'elgg-services.php' |
const | ADDITIONAL_TEXT_FILES |
![]() | |
const | PRIMARY_ATTR_NAMES |
Protected Member Functions | |
initializeAttributes () | |
{} More... | |
getLanguagesPath () | |
Returns the plugin's languages directory full path with trailing slash. More... | |
normalizePriority ($priority) | |
Normalize and validate new priority. More... | |
includeFile (string $filename) | |
Includes one of the plugins files. More... | |
canReadFile (string $filename) | |
Checks whether a plugin file with the given name exists. More... | |
assertStaticConfigValid () | |
If a static config file is present, is it a serializable array? More... | |
registerPublicServices () | |
Registers the plugin public services. More... | |
registerViews () | |
Registers the plugin's views. More... | |
registerEntities () | |
Registers the plugin's entities. More... | |
registerActions () | |
Registers the plugin's actions provided in the plugin config file. More... | |
registerRoutes () | |
Registers the plugin's routes provided in the plugin config file. More... | |
registerWidgets () | |
Registers the plugin's widgets provided in the plugin config file. More... | |
loadLanguages () | |
Loads the plugin's translations. More... | |
registerClasses () | |
Registers the plugin's classes. More... | |
activateEntities () | |
Activates the plugin's entities. More... | |
deactivateEntities () | |
Deactivates the plugin's entities. More... | |
registerEvents () | |
Registers the plugin's events provided in the plugin config file. More... | |
registerViewExtensions () | |
Registers the plugin's view extensions provided in the plugin config file. More... | |
registerGroupTools () | |
Registers the plugin's group tools provided in the plugin config file. More... | |
registerViewOptions () | |
Registers the plugin's view options provided in the plugin config file. More... | |
registerNotifications () | |
Registers the plugin's notification events. More... | |
setStatus (bool $active) | |
Sets the plugin to active or inactive. More... | |
getComposer () | |
Returns the composer parser. More... | |
assertPluginDependencies () | |
Assert required plugins or plugin position. More... | |
![]() | |
initializeAttributes () | |
{} More... | |
prepareObject (\Elgg\Export\Entity $object) | |
{} More... | |
![]() | |
initializeAttributes () | |
Initialize the attributes array. 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... | |
persistentDelete (bool $recursive=true) | |
Permanently delete the entity from the database. More... | |
trash (bool $recursive=true) | |
Move the entity to the trash. 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... | |
Protected Attributes | |
$composer | |
$path | |
$static_config | |
$activated | |
![]() | |
const | INTEGER_ATTR_NAMES |
$volatile = [] | |
$orig_attributes = [] | |
$_is_cacheable = true | |
![]() | |
$attributes = [] | |
$valid = false | |
Plugin class containing helper functions for plugin activation/deactivation, dependency checking capabilities and (user)pluginsettings.
Definition at line 17 of file ElggPlugin.php.
ElggPlugin::__get | ( | $name | ) |
Get an attribute or setting value.
string | $name | Name of the attribute or setting |
Definition at line 1218 of file ElggPlugin.php.
ElggPlugin::__set | ( | $name, | |
$value | |||
) |
Set a value as attribute or setting.
string | $name | Name of the attribute or setting |
mixed | $value | Value to be set |
Definition at line 1240 of file ElggPlugin.php.
ElggPlugin::activate | ( | ) |
Activates the plugin for the current site.
Definition at line 511 of file ElggPlugin.php.
|
protected |
ElggPlugin::assertCanActivate | ( | ) |
Asserts if a plugin can activate.
Definition at line 498 of file ElggPlugin.php.
ElggPlugin::assertCanDeactivate | ( | ) |
Asserts if a plugin can be deactivated.
Definition at line 609 of file ElggPlugin.php.
ElggPlugin::assertDependencies | ( | ) |
|
protected |
Assert required plugins or plugin position.
Definition at line 1365 of file ElggPlugin.php.
|
protected |
If a static config file is present, is it a serializable array?
Definition at line 841 of file ElggPlugin.php.
ElggPlugin::assertValid | ( | ) |
ElggPlugin::autoload | ( | ) |
Register plugin classes and require composer autoloader.
Definition at line 714 of file ElggPlugin.php.
ElggPlugin::boot | ( | ) |
ElggPlugin::canActivate | ( | ) |
Checks if this plugin can be activated on the current Elgg installation.
Definition at line 477 of file ElggPlugin.php.
ElggPlugin::canDeactivate | ( | ) |
Checks if this plugin can be deactivated on the current Elgg installation.
Validates that this plugin has no active dependants.
Definition at line 588 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 831 of file ElggPlugin.php.
ElggPlugin::deactivate | ( | ) |
|
protected |
|
static |
Load a plugin object from its ID Create a new plugin entity if doesn't exist.
string | $plugin_id | Plugin ID |
string | $path | Path, defaults to /mod |
Definition at line 82 of file ElggPlugin.php.
ElggPlugin::getAllSettings | ( | ) |
Returns an array of all settings saved for this plugin when the plugin is active.
Will return an empty array if the plugin isn't active.
Definition at line 307 of file ElggPlugin.php.
ElggPlugin::getAuthors | ( | ) |
ElggPlugin::getBootstrap | ( | ) |
ElggPlugin::getBugTrackerURL | ( | ) |
Returns the bug tracker page.
Definition at line 1473 of file ElggPlugin.php.
ElggPlugin::getCategories | ( | ) |
Returns an array with categories.
Definition at line 1429 of file ElggPlugin.php.
|
protected |
ElggPlugin::getConflicts | ( | ) |
Returns an array of projectnames with their conflicting version.
Definition at line 1506 of file ElggPlugin.php.
ElggPlugin::getDependencies | ( | ) |
Returns an array of dependencies as configured in the static config.
Definition at line 576 of file ElggPlugin.php.
ElggPlugin::getDescription | ( | ) |
ElggPlugin::getDisplayName | ( | ) |
Returns the name from elgg-plugin.php if available, otherwise a nicely formatted ID.
Definition at line 149 of file ElggPlugin.php.
ElggPlugin::getID | ( | ) |
Returns the ID (dir name) of this plugin.
Implements Elgg\Collections\CollectionItemInterface.
Definition at line 139 of file ElggPlugin.php.
|
protected |
Returns the plugin's languages directory full path with trailing slash.
Returns false if directory does not exist
Definition at line 190 of file ElggPlugin.php.
ElggPlugin::getLicense | ( | ) |
ElggPlugin::getPath | ( | ) |
Returns the plugin's full path with trailing slash.
Definition at line 175 of file ElggPlugin.php.
ElggPlugin::getPriority | ( | ) |
Gets the plugin's load priority.
Implements Elgg\Collections\CollectionItemInterface.
Definition at line 226 of file ElggPlugin.php.
ElggPlugin::getRepositoryURL | ( | ) |
ElggPlugin::getSetting | ( | string | $name, |
$default = null |
|||
) |
Returns a plugin setting when the plugin is active.
Will return $default when the plugin isn't active.
string | $name | The setting name |
mixed | $default | The default value to return if none is set |
Definition at line 294 of file ElggPlugin.php.
ElggPlugin::getStaticConfig | ( | string | $key, |
$default = null |
|||
) |
Get a value from the plugins' static config file.
string | $key | Config key |
mixed | $default | Value returned if missing |
Definition at line 205 of file ElggPlugin.php.
ElggPlugin::getVersion | ( | ) |
ElggPlugin::getWebsite | ( | ) |
|
protected |
Includes one of the plugins files.
string | $filename | The name of the file |
Definition at line 791 of file ElggPlugin.php.
ElggPlugin::init | ( | ) |
|
protected |
{}
Definition at line 66 of file ElggPlugin.php.
ElggPlugin::invalidateCache | ( | ) |
{}
Definition at line 1301 of file ElggPlugin.php.
ElggPlugin::isActive | ( | ) |
ElggPlugin::isCacheable | ( | ) |
{}
Definition at line 1294 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 422 of file ElggPlugin.php.
|
protected |
Loads the plugin's translations.
Directly loads the translations for this plugin into available translations.
Use when on runtime activating a plugin.
Definition at line 1028 of file ElggPlugin.php.
ElggPlugin::meetsDependencies | ( | ) |
Checks if dependencies are met.
Definition at line 1331 of file ElggPlugin.php.
|
protected |
Normalize and validate new priority.
mixed | $priority | Priority to normalize |
Definition at line 260 of file ElggPlugin.php.
ElggPlugin::register | ( | ) |
Autoload plugin classes and vendor libraries Register plugin-specific entity classes and execute bootstrapped load scripts Register languages and views.
Definition at line 742 of file ElggPlugin.php.
|
protected |
Registers the plugin's actions provided in the plugin config file.
Definition at line 937 of file ElggPlugin.php.
|
protected |
|
protected |
|
protected |
Registers the plugin's events provided in the plugin config file.
Definition at line 1081 of file ElggPlugin.php.
|
protected |
Registers the plugin's group tools provided in the plugin config file.
Definition at line 1141 of file ElggPlugin.php.
ElggPlugin::registerLanguages | ( | ) |
Registers the plugin's languages.
Makes the language paths available to the system. Commonly used during boot of engine.
Definition at line 1015 of file ElggPlugin.php.
|
protected |
Registers the plugin's notification events.
Definition at line 1193 of file ElggPlugin.php.
|
protected |
|
protected |
Registers the plugin's routes provided in the plugin config file.
Definition at line 971 of file ElggPlugin.php.
|
protected |
Registers the plugin's view extensions provided in the plugin config file.
Definition at line 1112 of file ElggPlugin.php.
|
protected |
Registers the plugin's view options provided in the plugin config file.
Definition at line 1166 of file ElggPlugin.php.
|
protected |
|
protected |
Registers the plugin's widgets provided in the plugin config file.
Definition at line 989 of file ElggPlugin.php.
ElggPlugin::save | ( | ) |
{}
Definition at line 111 of file ElggPlugin.php.
ElggPlugin::setPath | ( | string | $path | ) |
Set path.
string | $path | Path to plugin directory |
Definition at line 166 of file ElggPlugin.php.
ElggPlugin::setPriority | ( | $priority | ) |
Sets the priority of the plugin Returns the new priority or false on error.
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 |
Definition at line 246 of file ElggPlugin.php.
ElggPlugin::setSetting | ( | string | $name, |
$value | |||
) |
Set a plugin setting for the plugin.
string | $name | The name to set |
string | $value | The value to set |
Definition at line 334 of file ElggPlugin.php.
|
protected |
Sets the plugin to active or inactive.
bool | $active | Set to active or inactive |
Definition at line 1270 of file ElggPlugin.php.
ElggPlugin::unsetAllEntityAndPluginSettings | ( | ) |
Remove all entity and plugin settings for this plugin.
Definition at line 390 of file ElggPlugin.php.
ElggPlugin::unsetAllSettings | ( | ) |
ElggPlugin::unsetSetting | ( | string | $name | ) |
Removes a plugin setting name and value.
string | $name | The setting name to remove |
Definition at line 361 of file ElggPlugin.php.
|
protected |
Definition at line 61 of file ElggPlugin.php.
|
protected |
Definition at line 44 of file ElggPlugin.php.
|
protected |
Definition at line 49 of file ElggPlugin.php.
|
protected |
Definition at line 56 of file ElggPlugin.php.
const ElggPlugin::ADDITIONAL_TEXT_FILES |
Definition at line 30 of file ElggPlugin.php.
const ElggPlugin::PRIORITY_SETTING_NAME = 'elgg:internal:priority' |
Definition at line 19 of file ElggPlugin.php.
const ElggPlugin::PUBLIC_SERVICES_FILENAME = 'elgg-services.php' |
Definition at line 21 of file ElggPlugin.php.
const ElggPlugin::STATIC_CONFIG_FILENAME = 'elgg-plugin.php' |
Definition at line 20 of file ElggPlugin.php.