ElggPluginPackage Class Reference

List of all members.

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

---

Detailed Description

Definition at line 19 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	$plugin The ID (directory name) or full path of the plugin.
	bool	$validate Automatically run isValid()?

Exceptions:

PluginException

Definition at line 105 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_report Return a full report.

Returns:

bool|array

Definition at line 332 of file ElggPluginPackage.php.

ElggPluginPackage::getError

(

)

Returns the last error message.

Returns:

string

Definition at line 636 of file ElggPluginPackage.php.

ElggPluginPackage::getID

(

)

Returns the Plugin ID.

Returns:

string

Definition at line 627 of file ElggPluginPackage.php.

ElggPluginPackage::getManifest

(

)

Returns a parsed manifest file.

Returns:

ElggPluginManifest

Definition at line 267 of file ElggPluginPackage.php.

ElggPluginPackage::getTextFilenames

(

)

Returns an array of present and readable text files.

Returns:

array

Definition at line 309 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 ElggPluginManifest for Elgg 1.8 plugins.

Note:

This doesn't check dependencies or conflicts. Use ElggPluginPackage::canActivate() or ElggPluginPackage::checkDependencies() for that.

Returns:

bool

Definition at line 163 of file ElggPluginPackage.php.

---

Member Data Documentation

ElggPluginPackage::$id [protected]

Definition at line 95 of file ElggPluginPackage.php.

ElggPluginPackage::$manifest [protected]

Definition at line 74 of file ElggPluginPackage.php.

ElggPluginPackage::$path [protected]

Definition at line 81 of file ElggPluginPackage.php.

ElggPluginPackage::$valid = null [protected]

Definition at line 88 of file ElggPluginPackage.php.

---

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

• engine/classes/ElggPluginPackage.php