Stud.IP  5.4
 All Data Structures Namespaces Files Functions Variables Groups
Public Member Functions | Static Public Member Functions | Protected Attributes
CorePlugin Class Reference
Inheritance diagram for CorePlugin:
ActivityFeed Blubber ConsultationModule ContentsWidget CoreAdmin CoreCalendar CoreDocuments CoreElearningInterface CoreForum CoreOverview CoreParticipants CorePersonal CoreSchedule CoreScm CoreStudygroupAdmin CoreStudygroupParticipants CoreWiki CoursewareModule EvaluationsWidget FeedbackModule GradebookModule IliasInterfaceModule LtiToolModule MyCoursesWidget NewsWidget QuickSelection ScheduleWidget TerminWidget

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 ( )

plugin constructor TODO bindtextdomain()

Member Function Documentation

static checkActivation (   $range_id)
static
Parameters
$range_idstring
Returns
bool
getDescriptionMode ( )
getHighlightText ( )
getPluginDescription ( )
getPluginId ( )

Return the ID of this plugin.

getPluginName ( )

Return the name of this plugin.

getPluginURL ( )
getPluginVersion ( )

Returns the version of this plugin as defined in manifest.

Returns
string
isActivatableForContext ( Range  $context)

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

Parameters
Range$context
Returns
bool
isActivated (   $context = null)

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

Parameters
$contextcontext range id (optional)
isCorePlugin ( )

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

Returns
boolean
isEnabled ( )
isHighlighted ( )
static onActivation (   $plugin_id,
  $range_id 
)
static

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

Parameters
$plugin_idstring The ID of the plugin just enabled.
static onDeactivation (   $plugin_id,
  $range_id 
)
static

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

Parameters
$plugin_idstring The ID of the plugin just disabled.
static onDisable (   $plugin_id)
static

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

Parameters
$plugin_idstring The ID of the plugin just disabled.
static onEnable (   $plugin_id)
static

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

Parameters
$plugin_idstring The ID of the plugin just enabled.

Field Documentation

$plugin_info
protected

plugin meta data

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