CorePlugin Class Reference

Inheritance diagram for CorePlugin:

Public Member Functions
	__construct ()
	getPluginId ()
	isEnabled ()
	getPluginName ()
	getPluginURL ()
	getPluginVersion ()
	getPluginDescription ()
	getDescriptionMode ()
	isHighlighted ()
	getHighlightText ()
	isCorePlugin ()
	isActivated ($context=null)
	isActivatableForContext (Range $context)

Static Public Member Functions
static	onEnable ($plugin_id)
static	onDisable ($plugin_id)
static	onActivation ($plugin_id, $range_id)
static	onDeactivation ($plugin_id, $range_id)
static	checkActivation ($range_id)

Protected Attributes
	$plugin_info

Detailed Description

CorePlugin.class.php - base class

Author

André Noack noack.nosp@m.@dat.nosp@m.a-que.nosp@m.st.d.nosp@m.e

Copyright

2021 Authors GPL2 or any later version

Constructor & Destructor Documentation

__construct()

__construct

(

)

plugin constructor TODO bindtextdomain()

Member Function Documentation

checkActivation()

static checkActivation (   $range_id )

static

Parameters

$range_id

string

Returns

bool

getDescriptionMode()

getDescriptionMode

(

)

getHighlightText()

getHighlightText

(

)

getPluginDescription()

getPluginDescription

(

)

getPluginId()

getPluginId

(

)

Return the ID of this plugin.

getPluginName()

getPluginName

(

)

Return the name of this plugin.

getPluginURL()

getPluginURL

(

)

getPluginVersion()

getPluginVersion

(

)

Returns the version of this plugin as defined in manifest.

Returns

string

isActivatableForContext()

isActivatableForContext

(

Range

$context

)

Returns whether the plugin may be activated in a certain context.

Parameters

Range

$context

Returns

bool

isActivated()

isActivated

(

$context = null

)

Get the activation status of this plugin in the given context. This also checks the plugin default activations.

Parameters

$context

context range id (optional)

isCorePlugin()

isCorePlugin

(

)

Checks if the plugin is a core-plugin. Returns true if this is the case.

Returns

boolean

isEnabled()

isEnabled

(

)

isHighlighted()

isHighlighted

(

)

onActivation()

static onActivation (   $plugin_id,   $range_id  )

static

Callback function called after enabling a plugin. The plugin's ID is transmitted for convenience.

Parameters

$plugin_id

string The ID of the plugin just enabled.

onDeactivation()

static onDeactivation (   $plugin_id,   $range_id  )

static

Callback function called after disabling a plugin. The plugin's ID is transmitted for convenience.

Parameters

$plugin_id

string The ID of the plugin just disabled.

onDisable()

static onDisable (   $plugin_id )

static

Callback function called after disabling a plugin. The plugin's ID is transmitted for convenience.

Parameters

$plugin_id

string The ID of the plugin just disabled.

onEnable()

static onEnable (   $plugin_id )

static

Callback function called after enabling a plugin. The plugin's ID is transmitted for convenience.

Parameters

$plugin_id

string The ID of the plugin just enabled.

Field Documentation

$plugin_info

$plugin_info

protected

plugin meta data

---

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

• lib/plugins/core/CorePlugin.php