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

Public Member Functions

 __construct ($plugin, $validate=true)
 Load a plugin package from mod/$id or by full path. More...
 
 isValid ()
 Checks if this is a valid Elgg plugin. More...
 
 getManifest ()
 Returns a parsed manifest file. More...
 
 getTextFilenames ()
 Returns an array of present and readable text files. More...
 
 checkDependencies ($full_report=false)
 Returns if the Elgg system meets the plugin's dependency requirements. More...
 
 getID ()
 Returns the Plugin ID. More...
 
 getError ()
 Returns the last error message. More...
 

Public Attributes

const STATIC_CONFIG_FILENAME = 'elgg-plugin.php'
 

Protected Attributes

 $manifest
 
 $path
 
 $valid = null
 
 $id
 

Detailed Description

Definition at line 20 of file ElggPluginPackage.php.

Constructor & Destructor Documentation

ElggPluginPackage::__construct (   $plugin,
  $validate = true 
)

Load a plugin package from mod/$id or by full path.

Parameters
string$pluginThe ID (directory name) or full path of the plugin.
bool$validateAutomatically run isValid()?
Exceptions
PluginException

Definition at line 113 of file ElggPluginPackage.php.

Member Function Documentation

ElggPluginPackage::checkDependencies (   $full_report = false)

Returns if the Elgg system meets the plugin's dependency requirements.

This includes both requires and conflicts.

Full reports can be requested. The results are returned as an array of arrays in the form array( 'type' => requires|conflicts, 'dep' => array( dependency array ), 'status' => bool if depedency is met, 'comment' => optional comment to display to the user. )

Parameters
bool$full_reportReturn a full report.
Returns
bool|array

Definition at line 402 of file ElggPluginPackage.php.

ElggPluginPackage::getError ( )

Returns the last error message.

Returns
string

Definition at line 763 of file ElggPluginPackage.php.

ElggPluginPackage::getID ( )

Returns the Plugin ID.

Returns
string

Definition at line 754 of file ElggPluginPackage.php.

ElggPluginPackage::getManifest ( )

Returns a parsed manifest file.

Returns
|false

Definition at line 331 of file ElggPluginPackage.php.

ElggPluginPackage::getTextFilenames ( )

Returns an array of present and readable text files.

Returns
array

Definition at line 378 of file ElggPluginPackage.php.

ElggPluginPackage::isValid ( )

Checks if this is a valid Elgg plugin.

Checks for requires files as defined at the start of this class. Will check require manifest fields via for Elgg 1.8 plugins.

Note
This doesn't check dependencies or conflicts. Use ElggPluginPackage::canActivate()or@link\ElggPluginPackage::checkDependencies()forthat.@returnbool

Definition at line 172 of file ElggPluginPackage.php.

Member Data Documentation

ElggPluginPackage::$id
protected

Definition at line 103 of file ElggPluginPackage.php.

ElggPluginPackage::$manifest
protected

Definition at line 82 of file ElggPluginPackage.php.

ElggPluginPackage::$path
protected

Definition at line 89 of file ElggPluginPackage.php.

ElggPluginPackage::$valid = null
protected

Definition at line 96 of file ElggPluginPackage.php.

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

Definition at line 22 of file ElggPluginPackage.php.


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