Elgg  Version 4.x
Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
ElggPlugin Class Reference

Plugin class containing helper functions for plugin activation/deactivation, dependency checking capabilities and (user)pluginsettings. More...

Inheritance diagram for ElggPlugin:
ElggObject ElggEntity ElggData Elgg\EntityIcon Elgg\Collections\CollectionItemInterface

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 ($path)
 Set path. 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...
 
 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. More...
 
 getAllSettings ()
 Returns an array of all settings saved for this plugin. 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...
 
 getUserSetting (string $name, int $user_guid=0, $default=null)
 Returns a user's setting for this plugin. More...
 
 setUserSetting (string $name, $value, int $user_guid=0)
 Sets a user setting for a plugin. More...
 
 unsetUserSetting (string $name, int $user_guid=0)
 Removes a user setting name and value. 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, metadata or private setting value. More...
 
 __set ($name, $value)
 Set a value as attribute, metadata or private setting. More...
 
 isCacheable ()
 {} More...
 
 cache ($persist=true)
 {} 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...
 
- Public Member Functions inherited from ElggObject
 getType ()
 {} More...
 
 getDisplayName ()
 {} More...
 
 setDisplayName ($display_name)
 {} More...
 
- 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...
 
 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...
 
 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...
 
 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...
 
 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...
 
 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...
 
- 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...
 
 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.
Returns
string|int
} More...
 
 getPriority ()
 {Get priority (weight) of the item within a collection.
Returns
int
} More...
 
 __serialize ()
 Called during serialization. More...
 
 __unserialize (array $data)
 Called during unserialization. More...
 

Static Public Member Functions

static fromId ($plugin_id, $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
 
- Public Attributes inherited from ElggEntity
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...
 
 registerHooks ()
 Registers the plugin's hooks provided in the plugin config file. 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...
 
- Protected Member Functions inherited from ElggObject
 prepareObject (\Elgg\Export\Entity $object)
 {} More...
 
- Protected Member Functions inherited from ElggEntity
 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...
 
- Protected Member Functions inherited from ElggData
 initializeAttributes ()
 Initialize the attributes array. More...
 
 getDatabase ()
 Provides a pointer to the database object. More...
 

Protected Attributes

 $composer
 
 $path
 
 $static_config
 
 $activated
 
- Protected Attributes inherited from ElggEntity
const INTEGER_ATTR_NAMES
 
 $temp_metadata = []
 
 $temp_annotations = []
 
 $temp_private_settings = []
 
 $volatile = []
 
 $orig_attributes = []
 
 $_is_cacheable = true
 
 $_cached_metadata
 
- Protected Attributes inherited from ElggData
 $attributes = []
 
 $valid = false
 

Detailed Description

Plugin class containing helper functions for plugin activation/deactivation, dependency checking capabilities and (user)pluginsettings.

Definition at line 15 of file ElggPlugin.php.

Member Function Documentation

ElggPlugin::__get (   $name)

Get an attribute, metadata or private setting value.

Parameters
string$nameName of the attribute or private setting
Returns
mixed

Definition at line 1328 of file ElggPlugin.php.

ElggPlugin::__set (   $name,
  $value 
)

Set a value as attribute, metadata or private setting.

Metadata applies to title and description.

Parameters
string$nameName of the attribute or private_setting
mixed$valueValue to be set
Returns
void

Definition at line 1359 of file ElggPlugin.php.

ElggPlugin::activate ( )

Activates the plugin for the current site.

Returns
bool
Exceptions

Definition at line 581 of file ElggPlugin.php.

ElggPlugin::activateEntities ( )
protected

Activates the plugin's entities.

Returns
void

Definition at line 1130 of file ElggPlugin.php.

ElggPlugin::assertCanActivate ( )

Asserts if a plugin can activate.

Returns
void
Exceptions

Definition at line 568 of file ElggPlugin.php.

ElggPlugin::assertCanDeactivate ( )

Asserts if a plugin can be deactivated.

Returns
void
Exceptions

Definition at line 679 of file ElggPlugin.php.

ElggPlugin::assertDependencies ( )

Assert plugin dependencies.

Returns
void
Exceptions

Definition at line 1478 of file ElggPlugin.php.

ElggPlugin::assertPluginDependencies ( )
protected

Assert required plugins or plugin position.

Returns
void
Exceptions

Definition at line 1494 of file ElggPlugin.php.

ElggPlugin::assertStaticConfigValid ( )
protected

If a static config file is present, is it a serializable array?

Returns
void
Exceptions

Definition at line 914 of file ElggPlugin.php.

ElggPlugin::assertValid ( )

Asserts if a plugin is valid.

Returns
void
Exceptions

Definition at line 509 of file ElggPlugin.php.

ElggPlugin::autoload ( )

Register plugin classes and require composer autoloader.

Returns
void

Definition at line 784 of file ElggPlugin.php.

ElggPlugin::boot ( )

Boot the plugin.

Returns
void

Definition at line 829 of file ElggPlugin.php.

ElggPlugin::cache (   $persist = true)

{}

Definition at line 1420 of file ElggPlugin.php.

ElggPlugin::canActivate ( )

Checks if this plugin can be activated on the current Elgg installation.

Returns
bool

Definition at line 547 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.

Returns
bool

Definition at line 658 of file ElggPlugin.php.

ElggPlugin::canReadFile ( string  $filename)
protected

Checks whether a plugin file with the given name exists.

Parameters
string$filenameThe name of the file
Returns
bool

Definition at line 902 of file ElggPlugin.php.

ElggPlugin::deactivate ( )

Deactivates the plugin.

Returns
bool
Exceptions

Definition at line 722 of file ElggPlugin.php.

ElggPlugin::deactivateEntities ( )
protected

Deactivates the plugin's entities.

Returns
void

Definition at line 1145 of file ElggPlugin.php.

static ElggPlugin::fromId (   $plugin_id,
  $path = null 
)
static

Load a plugin object from its ID Create a new plugin entity if doesn't exist.

Parameters
string$plugin_idPlugin ID
string$pathPath, defaults to /mod
Returns
ElggPlugin
Exceptions
ElggInvalidArgumentException

Definition at line 80 of file ElggPlugin.php.

ElggPlugin::getAllSettings ( )

Returns an array of all settings saved for this plugin.

Note
Unlike user settings, plugin settings are not namespaced.
Returns
array An array of key/value pairs.

Definition at line 314 of file ElggPlugin.php.

ElggPlugin::getAuthors ( )

Returns an array of authors.

Returns
[]
Since
4.0

Definition at line 1624 of file ElggPlugin.php.

ElggPlugin::getBootstrap ( )

Bootstrap object.

Returns
Exceptions

Definition at line 759 of file ElggPlugin.php.

ElggPlugin::getBugTrackerURL ( )

Returns the bug tracker page.

Returns
string
Since
4.0

Definition at line 1602 of file ElggPlugin.php.

ElggPlugin::getCategories ( )

Returns an array with categories.

Returns
array
Since
4.0

Definition at line 1558 of file ElggPlugin.php.

ElggPlugin::getComposer ( )
protected

Returns the composer parser.

Returns
Since
4.0

Definition at line 1444 of file ElggPlugin.php.

ElggPlugin::getConflicts ( )

Returns an array of projectnames with their conflicting version.

Returns
array
Since
4.0

Definition at line 1635 of file ElggPlugin.php.

ElggPlugin::getDependencies ( )

Returns an array of dependencies as configured in the static config.

Returns
array

Definition at line 646 of file ElggPlugin.php.

ElggPlugin::getDescription ( )

Return the description.

Returns
string
Since
4.0

Definition at line 1580 of file ElggPlugin.php.

ElggPlugin::getDisplayName ( )

Returns the name from elgg-plugin.php if available, otherwise a nicely formatted ID.

Returns
string
Since
3.0

Definition at line 147 of file ElggPlugin.php.

ElggPlugin::getID ( )

Returns the ID (dir name) of this plugin.

Returns
string

Implements Elgg\Collections\CollectionItemInterface.

Definition at line 137 of file ElggPlugin.php.

ElggPlugin::getLanguagesPath ( )
protected

Returns the plugin's languages directory full path with trailing slash.

Returns false if directory does not exist

Returns
string|false

Definition at line 188 of file ElggPlugin.php.

ElggPlugin::getLicense ( )

Returns the license.

Returns
string
Since
4.0

Definition at line 1569 of file ElggPlugin.php.

ElggPlugin::getPath ( )

Returns the plugin's full path with trailing slash.

Returns
string

Definition at line 173 of file ElggPlugin.php.

ElggPlugin::getPriority ( )

Gets the plugin's load priority.

Returns
int|null

Implements Elgg\Collections\CollectionItemInterface.

Definition at line 235 of file ElggPlugin.php.

ElggPlugin::getRepositoryURL ( )

Returns the repository url.

Returns
string
Since
4.0

Definition at line 1591 of file ElggPlugin.php.

ElggPlugin::getSetting ( string  $name,
  $default = null 
)

Returns a plugin setting.

Parameters
string$nameThe setting name
mixed$defaultThe default value to return if none is set
Returns
mixed

Definition at line 302 of file ElggPlugin.php.

ElggPlugin::getStaticConfig (   $key,
  $default = null 
)

Get a value from the plugins's static config file.

Note
If the system cache is on, Elgg APIs should not call this on every request.
Parameters
string$keyConfig key
mixed$defaultValue returned if missing
Returns
mixed

Definition at line 208 of file ElggPlugin.php.

ElggPlugin::getUserSetting ( string  $name,
int  $user_guid = 0,
  $default = null 
)

Returns a user's setting for this plugin.

Parameters
string$nameThe setting name
int$user_guidThe user GUID
mixed$defaultThe default value to return if none is set
Returns
mixed The setting string value or the default value

Definition at line 400 of file ElggPlugin.php.

ElggPlugin::getVersion ( )

Returns the plugin version.

Returns
string

Definition at line 1529 of file ElggPlugin.php.

ElggPlugin::getWebsite ( )

Return the website.

Returns
string
Since
4.0

Definition at line 1613 of file ElggPlugin.php.

ElggPlugin::includeFile ( string  $filename)
protected

Includes one of the plugins files.

Parameters
string$filenameThe name of the file
Returns
mixed The return value of the included file (or 1 if there is none)
Exceptions

Definition at line 862 of file ElggPlugin.php.

ElggPlugin::init ( )

Init the plugin.

Returns
void

Definition at line 839 of file ElggPlugin.php.

ElggPlugin::initializeAttributes ( )
protected

{}

Definition at line 64 of file ElggPlugin.php.

ElggPlugin::invalidateCache ( )

{}

Definition at line 1429 of file ElggPlugin.php.

ElggPlugin::isActive ( )

Is this plugin active?

Returns
bool

Definition at line 532 of file ElggPlugin.php.

ElggPlugin::isCacheable ( )

{}

Definition at line 1413 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.

Returns
bool

Definition at line 492 of file ElggPlugin.php.

ElggPlugin::loadLanguages ( )
protected

Loads the plugin's translations.

Directly loads the translations for this plugin into available translations.

Use when on runtime activating a plugin.

Returns
void

Definition at line 1107 of file ElggPlugin.php.

ElggPlugin::meetsDependencies ( )

Checks if dependencies are met.

Returns
boolean
Since
4.0

Definition at line 1460 of file ElggPlugin.php.

ElggPlugin::normalizePriority (   $priority)
protected

Normalize and validate new priority.

Parameters
mixed$priorityPriority to normalize
Returns
int

Definition at line 269 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.

Returns
void

Definition at line 812 of file ElggPlugin.php.

ElggPlugin::registerActions ( )
protected

Registers the plugin's actions provided in the plugin config file.

Returns
void

Definition at line 1017 of file ElggPlugin.php.

ElggPlugin::registerClasses ( )
protected

Registers the plugin's classes.

Returns
void

Definition at line 1121 of file ElggPlugin.php.

ElggPlugin::registerEntities ( )
protected

Registers the plugin's entities.

Returns
void

Definition at line 990 of file ElggPlugin.php.

ElggPlugin::registerEvents ( )
protected

Registers the plugin's events provided in the plugin config file.

Returns
void

Definition at line 1191 of file ElggPlugin.php.

ElggPlugin::registerGroupTools ( )
protected

Registers the plugin's group tools provided in the plugin config file.

Returns
void

Definition at line 1251 of file ElggPlugin.php.

ElggPlugin::registerHooks ( )
protected

Registers the plugin's hooks provided in the plugin config file.

Returns
void

Definition at line 1160 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.

Returns
void

Definition at line 1089 of file ElggPlugin.php.

ElggPlugin::registerNotifications ( )
protected

Registers the plugin's notification events.

Returns
void

Definition at line 1303 of file ElggPlugin.php.

ElggPlugin::registerPublicServices ( )
protected

Registers the plugin public services.

Returns
void

Definition at line 943 of file ElggPlugin.php.

ElggPlugin::registerRoutes ( )
protected

Registers the plugin's routes provided in the plugin config file.

Returns
void

Definition at line 1046 of file ElggPlugin.php.

ElggPlugin::registerViewExtensions ( )
protected

Registers the plugin's view extensions provided in the plugin config file.

Returns
void

Definition at line 1222 of file ElggPlugin.php.

ElggPlugin::registerViewOptions ( )
protected

Registers the plugin's view options provided in the plugin config file.

Returns
void

Definition at line 1276 of file ElggPlugin.php.

ElggPlugin::registerViews ( )
protected

Registers the plugin's views.

Returns
void
Exceptions

Definition at line 961 of file ElggPlugin.php.

ElggPlugin::registerWidgets ( )
protected

Registers the plugin's widgets provided in the plugin config file.

Returns
void

Definition at line 1064 of file ElggPlugin.php.

ElggPlugin::save ( )

{}

Definition at line 109 of file ElggPlugin.php.

ElggPlugin::setPath (   $path)

Set path.

Parameters
string$pathPath to plugin directory
Returns
void

Definition at line 164 of file ElggPlugin.php.

ElggPlugin::setPriority (   $priority)

Sets the priority of the plugin Returns the new priority or false on error.

Parameters
mixed$priorityThe 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
Returns
int|false

Definition at line 255 of file ElggPlugin.php.

ElggPlugin::setSetting ( string  $name,
  $value 
)

Set a plugin setting for the plugin.

Parameters
string$nameThe name to set
string$valueThe value to set
Returns
bool

Definition at line 340 of file ElggPlugin.php.

ElggPlugin::setStatus ( bool  $active)
protected

Sets the plugin to active or inactive.

Parameters
bool$activeSet to active or inactive
Returns
bool

Definition at line 1389 of file ElggPlugin.php.

ElggPlugin::setUserSetting ( string  $name,
  $value,
int  $user_guid = 0 
)

Sets a user setting for a plugin.

Parameters
string$nameThe setting name
mixed$valueThe setting value
int$user_guidThe user GUID
Returns
bool

Definition at line 422 of file ElggPlugin.php.

ElggPlugin::unsetAllEntityAndPluginSettings ( )

Remove all entity and plugin settings for this plugin.

Returns
bool
Since
4.0

Definition at line 460 of file ElggPlugin.php.

ElggPlugin::unsetAllSettings ( )

Removes all settings for this plugin.

Returns
bool

Definition at line 373 of file ElggPlugin.php.

ElggPlugin::unsetSetting ( string  $name)

Removes a plugin setting name and value.

Parameters
string$nameThe setting name to remove
Returns
bool

Definition at line 365 of file ElggPlugin.php.

ElggPlugin::unsetUserSetting ( string  $name,
int  $user_guid = 0 
)

Removes a user setting name and value.

Parameters
string$nameThe user setting name
int$user_guidThe user GUID
Returns
bool

Definition at line 443 of file ElggPlugin.php.

Member Data Documentation

ElggPlugin::$activated
protected

Definition at line 59 of file ElggPlugin.php.

ElggPlugin::$composer
protected

Definition at line 42 of file ElggPlugin.php.

ElggPlugin::$path
protected

Definition at line 47 of file ElggPlugin.php.

ElggPlugin::$static_config
protected

Definition at line 54 of file ElggPlugin.php.

const ElggPlugin::ADDITIONAL_TEXT_FILES
Initial value:
= [
'README.txt',
'CHANGES.txt',
'INSTALL.txt',
'COPYRIGHT.txt',
'LICENSE.txt',
'README',
'README.md',
'README.markdown',
]

Definition at line 28 of file ElggPlugin.php.

const ElggPlugin::PRIORITY_SETTING_NAME = 'elgg:internal:priority'

Definition at line 17 of file ElggPlugin.php.

const ElggPlugin::PUBLIC_SERVICES_FILENAME = 'elgg-services.php'

Definition at line 19 of file ElggPlugin.php.

const ElggPlugin::STATIC_CONFIG_FILENAME = 'elgg-plugin.php'

Definition at line 18 of file ElggPlugin.php.


The documentation for this class was generated from the following file: