Overview

Packages

  • ClipIt
    • clipit
      • api
    • urjc
      • backend
  • Elgg
    • Core
      • Access
      • Authentication
      • Cache
      • Caches
      • Core
      • DataMode
        • Site
      • DataModel
        • Annotations
        • Entities
        • Extender
        • File
        • Importable
        • Loggable
        • Notable
        • Object
        • User
      • DataStorage
      • Exception
      • Exceptions
        • Stub
      • FileStore
        • Disk
      • Groups
      • Helpers
      • HMAC
      • Memcache
      • Metadata
      • Navigation
      • ODD
      • Output
      • Plugins
        • Settings
      • Sessions
      • SocialModel
        • Friendable
        • Locatable
      • WebServicesAPI
      • Widgets
      • XML
      • XMLRPC
    • Exceptions
      • Stub
  • None
  • PHP

Classes

  • ElggPluginManifest
  • ElggPluginManifestParser
  • ElggPluginManifestParser17
  • ElggPluginManifestParser18
  • ElggPluginPackage
  • Overview
  • Package
  • Class
  • Tree

Class ElggPluginPackage

Manages plugin packages under mod.

Package: Elgg\Core\Plugins
Since: 1.8
Located at ElggPluginPackage.php
Methods summary
public
# __construct( string $plugin, boolean $validate = true )

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

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

Parameters

$plugin
string
$plugin The ID (directory name) or full path of the plugin.
$validate
boolean
$validate Automatically run isValid()?

Throws

PluginException
public boolean
# isValid( )

Checks if this is a valid Elgg plugin.

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.

Returns

boolean

Note

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

Returns a parsed manifest file.

Returns a parsed manifest file.

Returns

ElggPluginManifest
public array
# getTextFilenames( )

Returns an array of present and readable text files

Returns an array of present and readable text files

Returns

array
public boolean|array
# checkDependencies( boolean $full_report = false )

Returns if the Elgg system meets the plugin's dependency requirements. This includes both requires and conflicts.

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

$full_report
boolean
$full_report Return a full report.

Returns

boolean|array
public string
# getID( )

Returns the Plugin ID

Returns the Plugin ID

Returns

string
public string
# getError( )

Returns the last error message.

Returns the last error message.

Returns

string
Properties summary
protected ElggPluginManifest $manifest
#

The plugin's manifest object

The plugin's manifest object

protected string $path
#

The plugin's full path

The plugin's full path

protected mixed $valid null
#

Is the plugin valid?

Is the plugin valid?

protected string $id
#

The plugin ID (dir name)

The plugin ID (dir name)

API documentation generated by ApiGen 2.8.0