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

Stores site-side plugin settings as private data. More...

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

Public Member Functions

 save ()
 {} More...
 
 getID ()
 Returns the ID (dir name) of this plugin. More...
 
 getDisplayName ()
 Returns the manifest's name if available, otherwise the ID. More...
 
 setPath ($path)
 Set path. More...
 
 getPath ()
 Returns the plugin's full path with trailing slash. More...
 
 getLanguagesPath ()
 Returns the plugin's languages directory full path with trailing slash. More...
 
 getStaticConfig ($key, $default=null)
 Get a value from the plugins's static config file. More...
 
 getAvailableTextFiles ()
 Returns an array of available markdown files for this plugin. 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...
 
 normalizePriority ($priority)
 Normalize and validate new priority. 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=0)
 Removes all plugin settings for a given user. More...
 
 isValid ()
 Returns if the plugin is complete, meaning has all required files and Elgg can read them and they make sense. More...
 
 isActive ()
 Is this plugin active? More...
 
 canActivate ()
 Checks if this plugin can be activated on the current Elgg installation. More...
 
 activate ()
 Actives the plugin for the current site. More...
 
 canDeactivate ()
 Checks if this plugin can be deactivated on the current Elgg installation. 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...
 
 getError ()
 Returns the last error message registered. More...
 
 getManifest ()
 Returns this plugin's object. More...
 
 getPackage ()
 Returns this plugin's object. More...
 
 isCacheable ()
 {} More...
 
 cache ($persist=true)
 {} More...
 
 invalidateCache ()
 {} More...
 
- Public Member Functions inherited from ElggObject
 getType ()
 {} More...
 
 getDisplayName ()
 {} More...
 
 setDisplayName ($display_name)
 {} More...
 
 canComment ($user_guid=0, $default=null)
 Can a user comment on this object? 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...
 
 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...
 
 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 ()
 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 (array $params=[])
 Export an entity. 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...
 
 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...
 
- 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 ()
 {} More...
 
 unserialize ($serialized)
 {} 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...
 
static addActionsFromStaticConfig (array $spec, $root_path)
 Register a plugin's actions provided in the config file. More...
 

Protected Member Functions

 initializeAttributes ()
 {} 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...
 
 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...
 
- 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

 $package
 
 $manifest
 
 $path
 
 $static_config
 
 $errorMsg = ''
 
 $activated
 
- Protected Attributes inherited from ElggEntity
 $temp_metadata = []
 
 $temp_annotations = []
 
 $temp_private_settings = []
 
 $volatile = []
 
 $orig_attributes = []
 
 $_is_cacheable = true
 
 $_cached_metadata
 
- Protected Attributes inherited from ElggData
 $attributes = []
 The main attributes of an entity. More...
 
 $valid = false
 

Additional Inherited Members

- Static Public Attributes inherited from ElggEntity
static $primary_attr_names
 
- Static Protected Attributes inherited from ElggEntity
static $integer_attr_names
 

Detailed Description

Stores site-side plugin settings as private data.

This class is currently a stub, allowing a plugin to save settings in an object's private settings for each site.

Definition at line 12 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
Exceptions
DatabaseException

Definition at line 1180 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 1211 of file ElggPlugin.php.

ElggPlugin::activate ( )

Actives the plugin for the current site.

Returns
bool
Exceptions
InvalidParameterException
PluginException

Definition at line 600 of file ElggPlugin.php.

ElggPlugin::activateEntities ( )
protected

Activates the plugin's entities.

Returns
void

Definition at line 1141 of file ElggPlugin.php.

static ElggPlugin::addActionsFromStaticConfig ( array  $spec,
  $root_path 
)
static

Register a plugin's actions provided in the config file.

Parameters
array$spec'actions' section of static config
string$root_pathPlugin path
Returns
void

Definition at line 1025 of file ElggPlugin.php.

ElggPlugin::autoload ( )

Register plugin classes and require composer autoloader.

Returns
void
Exceptions
PluginException

Definition at line 799 of file ElggPlugin.php.

ElggPlugin::boot ( )

Boot the plugin.

Exceptions
PluginException
Returns
|null

Definition at line 845 of file ElggPlugin.php.

ElggPlugin::cache (   $persist = true)

{}

Definition at line 1330 of file ElggPlugin.php.

ElggPlugin::canActivate ( )

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

Returns
bool

Definition at line 573 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 678 of file ElggPlugin.php.

ElggPlugin::canReadFile (   $filename)
protected

Checks whether a plugin file with the given name exists.

Parameters
string$filenameThe name of the file
Returns
bool

Definition at line 913 of file ElggPlugin.php.

ElggPlugin::deactivate ( )

Deactivates the plugin.

Returns
bool
Exceptions
PluginException

Definition at line 727 of file ElggPlugin.php.

ElggPlugin::deactivateEntities ( )
protected

Deactivates the plugin's entities.

Returns
void

Definition at line 1159 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
PluginException

Definition at line 65 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 321 of file ElggPlugin.php.

ElggPlugin::getAllUserSettings (   $user_guid = 0)

Returns an array of all user settings saved for this plugin for the user.

Note
Plugin settings are saved with a prefix. This removes that prefix.
Parameters
int$user_guidThe user GUID. Defaults to logged in.
Returns
array An array of key/value pairs
Exceptions
DatabaseException

Definition at line 429 of file ElggPlugin.php.

ElggPlugin::getAvailableTextFiles ( )

Returns an array of available markdown files for this plugin.

Returns
array

Definition at line 219 of file ElggPlugin.php.

ElggPlugin::getBootstrap ( )

Bootstrap object.

Returns
Exceptions
PluginException

Definition at line 772 of file ElggPlugin.php.

ElggPlugin::getDisplayName ( )

Returns the manifest's name if available, otherwise the ID.

Returns
string
Since
3.0

Definition at line 133 of file ElggPlugin.php.

ElggPlugin::getError ( )

Returns the last error message registered.

Returns
string|null

Definition at line 1267 of file ElggPlugin.php.

ElggPlugin::getID ( )

Returns the ID (dir name) of this plugin.

Returns
string

Definition at line 123 of file ElggPlugin.php.

ElggPlugin::getLanguagesPath ( )

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

Returns false if directory does not exist

Returns
string|false

Definition at line 174 of file ElggPlugin.php.

ElggPlugin::getManifest ( )

Returns this plugin's object.

Returns
ElggPluginManifest|null

Definition at line 1276 of file ElggPlugin.php.

ElggPlugin::getPackage ( )

Returns this plugin's object.

Returns
ElggPluginPackage|null

Definition at line 1303 of file ElggPlugin.php.

ElggPlugin::getPath ( )

Returns the plugin's full path with trailing slash.

Returns
string

Definition at line 159 of file ElggPlugin.php.

ElggPlugin::getPriority ( )

Gets the plugin's load priority.

Returns
int|null

Implements Elgg\Collections\CollectionItemInterface.

Definition at line 239 of file ElggPlugin.php.

ElggPlugin::getSetting (   $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 309 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 194 of file ElggPlugin.php.

ElggPlugin::getUserSetting (   $name,
  $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, the default value or false if there is no user
Exceptions
DatabaseException

Definition at line 410 of file ElggPlugin.php.

ElggPlugin::includeFile (   $filename)
protected

Includes one of the plugins files.

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

Definition at line 880 of file ElggPlugin.php.

ElggPlugin::init ( )

Init the plugin.

Returns
void
Exceptions
InvalidParameterException
PluginException

Definition at line 863 of file ElggPlugin.php.

ElggPlugin::initializeAttributes ( )
protected

{}

Definition at line 49 of file ElggPlugin.php.

ElggPlugin::invalidateCache ( )

{}

Definition at line 1339 of file ElggPlugin.php.

ElggPlugin::isActive ( )

Is this plugin active?

Returns
bool

Definition at line 558 of file ElggPlugin.php.

ElggPlugin::isCacheable ( )

{}

Definition at line 1323 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 528 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 1116 of file ElggPlugin.php.

ElggPlugin::normalizePriority (   $priority)

Normalize and validate new priority.

Parameters
mixed$priorityPriority to normalize
Returns
int

Definition at line 276 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
Exceptions
PluginException

Definition at line 828 of file ElggPlugin.php.

ElggPlugin::registerActions ( )
protected

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

Returns
void

Definition at line 1010 of file ElggPlugin.php.

ElggPlugin::registerClasses ( )
protected

Registers the plugin's classes.

Returns
void

Definition at line 1130 of file ElggPlugin.php.

ElggPlugin::registerEntities ( )
protected

Registers the plugin's entities.

Returns
void

Definition at line 991 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 1098 of file ElggPlugin.php.

ElggPlugin::registerRoutes ( )
protected

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

Returns
void
Exceptions
InvalidParameterException

Definition at line 1053 of file ElggPlugin.php.

ElggPlugin::registerViews ( )
protected

Registers the plugin's views.

Exceptions
PluginException
Returns
void

Definition at line 955 of file ElggPlugin.php.

ElggPlugin::registerWidgets ( )
protected

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

Returns
void
Exceptions

Definition at line 1073 of file ElggPlugin.php.

ElggPlugin::save ( )

{}

Definition at line 94 of file ElggPlugin.php.

ElggPlugin::setPath (   $path)

Set path.

Parameters
string$pathPath to plugin directory
Returns
void

Definition at line 150 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
Exceptions
DatabaseException

Definition at line 262 of file ElggPlugin.php.

ElggPlugin::setSetting (   $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 351 of file ElggPlugin.php.

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

Sets a user setting for a plugin.

Parameters
string$nameThe setting name
string$valueThe setting value
int$user_guidThe user GUID
Returns
mixed The new setting ID or false

Definition at line 452 of file ElggPlugin.php.

ElggPlugin::unsetAllSettings ( )

Removes all settings for this plugin.

Returns
bool

Definition at line 384 of file ElggPlugin.php.

ElggPlugin::unsetAllUserSettings (   $user_guid = 0)

Removes all plugin settings for a given user.

Parameters
int$user_guidThe user GUID to remove user settings.
Returns
bool
Exceptions
DatabaseException

Definition at line 505 of file ElggPlugin.php.

ElggPlugin::unsetSetting (   $name)

Removes a plugin setting name and value.

Parameters
string$nameThe setting name to remove
Returns
bool

Definition at line 376 of file ElggPlugin.php.

ElggPlugin::unsetUserSetting (   $name,
  $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 485 of file ElggPlugin.php.

Member Data Documentation

ElggPlugin::$activated
protected

Definition at line 44 of file ElggPlugin.php.

ElggPlugin::$errorMsg = ''
protected

Definition at line 39 of file ElggPlugin.php.

ElggPlugin::$manifest
protected

Definition at line 22 of file ElggPlugin.php.

ElggPlugin::$package
protected

Definition at line 17 of file ElggPlugin.php.

ElggPlugin::$path
protected

Definition at line 27 of file ElggPlugin.php.

ElggPlugin::$static_config
protected

Definition at line 34 of file ElggPlugin.php.


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