Abstract parent class for all signature plugin classes. More...

Inheritance diagram for ilTestSignaturePlugin:

Collaboration diagram for ilTestSignaturePlugin:

Public Member Functions
	setGUIObject ($GUIObject)
	getGUIObject ()
	getComponentType ()
	Get Component Type.
	getComponentName ()
	Get Component Name.
	getSlot ()
	Get Slot Name.
	getSlotId ()
	Get Slot ID.
	invoke ($cmd=null)
	Method all commands are forwarded to.
Public Member Functions inherited from ilPlugin
	__construct ()
	Constructor.
	getPluginName ()
	Get Plugin Name.
	getId ()
	Get Id.
	getLastUpdateVersion ()
	Get Version of last update.
	getVersion ()
	Get Current Version (from plugin.php file).
	getIliasMinVersion ()
	Get Required ILIAS min.
	getIliasMaxVersion ()
	Get Required ILIAS max.
	getActive ()
	Get Active.
	setDBVersion ($a_dbversion)
	Set DB Version.
	getDBVersion ()
	Get DB Version.
	writeDBVersion ($a_dbversion)
	Write DB version to database.
	getDirectory ()
	Get Plugin Directory.
	includeClass ($a_class_file_name)
	Include (once) a class file.
	getPrefix ()
	Get plugin prefix, used for lang vars.
	getTablePrefix ()
	Get db table plugin prefix.
	updateLanguages ()
	Update all languages.
	updateDatabase ()
	Update database.
	loadLanguageModule ()
	Load language module for plugin.
	txt ($a_var)
	Get Language Variable (prefix will be prepended automatically)
	getTemplate ($a_template, $a_par1=true, $a_par2=true)
	Get template from plugin.
	getImagePath ($a_img)
	Get image path.
	getStyleSheetLocation ($a_css_file)
	Get css file location.
	addBlockFile ($a_tpl, $a_var, $a_block, $a_tplname)
	Add template content to placeholder variable.
	isActive ()
	Check whether plugin is active.
	needsUpdate ()
	Check whether update is needed.
	activate ()
	Activate.
	deactivate ()
	Deactivate.
	update ()
	Update plugin.
	lookupNameForId ($a_ctype, $a_cname, $a_slot_id, $a_plugin_id)
	Lookup name for id.
	lookupIdForName ($a_ctype, $a_cname, $a_slot_id, $a_plugin_name)
	Lookup id for name.

Protected Member Functions
	slotInit ()
	Object initialization done by slot.
	handInFileForArchiving ($active_fi, $pass, $filename, $filepath)
	Hands in a file from the signature process associated with a given user and pass for archiving.
	redirectToTest ($success)
Protected Member Functions inherited from ilPlugin
	setSlotObject ($a_slot)
	Set Plugin Slot.
	getSlotObject ()
	Get Plugin Slot.
	getClassesDirectory ()
	Get Plugin's classes Directory.
	getLanguageDirectory ()
	Get Plugin's language Directory.
	init ()
	Object initialization.
	beforeActivation ()
	Before activation processing.
	afterActivation ()
	After activation processing.
	afterDeactivation ()
	After deactivation processing.
	beforeUpdate ()
	Before update processing.
	afterUpdate ()
	After update processing.

Protected Attributes
	$GUIObject
Protected Attributes inherited from ilPlugin
	$lang_initialised = false

Additional Inherited Members
Static Public Member Functions inherited from ilPlugin
static	_getDirectory ($a_ctype, $a_cname, $a_slot_id, $a_pname)
	Get plugin directory.
static	getAvailableLangFiles ($a_lang_directory)
	Get array of all language files in the plugin.
static	hasConfigureClass ($a_slot_dir, $a_name)
	Has the plugin a configure class?
static	getConfigureClassName ($a_name)
	Get plugin configure class name.
static	getDBUpdateScriptName ($a_ctype, $a_cname, $a_slot_name, $a_pname)
	Get DB update script filename (full path)
static	lookupTxt ($a_mod_prefix, $a_pl_id, $a_lang_var)
	Lookup language text.
static	_getImagePath ($a_ctype, $a_cname, $a_slot_id, $a_pname, $a_img)
	Get image path.
static	createPluginRecord ($a_ctype, $a_cname, $a_slot_id, $a_pname)
	Create plugin record, if not existing.
static	getPluginRecord ($a_ctype, $a_cname, $a_slot_id, $a_pname)
	Get record from il_plugin table.
static	getPluginObject ($a_ctype, $a_cname, $a_slot_id, $a_pname)
	Get plugin object.
static	lookupStoredData ($a_ctype, $a_cname, $a_slot_id, $a_pname)
	Lookup information data in il_plugin.
static	getActivePluginsForSlot ($a_ctype, $a_cname, $a_slot_id)
	Get all active plugins for a slot.

Detailed Description

Abstract parent class for all signature plugin classes.

Author: Maximilian Becker mbeck.nosp@m.er@d.nosp@m.ataba.nosp@m.y.de

Version: $Id$

Definition at line 15 of file class.ilTestSignaturePlugin.php.

Member Function Documentation

ilTestSignaturePlugin::getComponentName ( )

final

Get Component Name.

Returns: string Component Name

Reimplemented from ilPlugin.

Definition at line 49 of file class.ilTestSignaturePlugin.php.

        {
                return "Test";
        }

ilTestSignaturePlugin::getComponentType ( )

final

Get Component Type.

Returns: string Component Type

Reimplemented from ilPlugin.

Definition at line 40 of file class.ilTestSignaturePlugin.php.

References IL_COMP_MODULE.

        {
                return IL_COMP_MODULE;
        }

ilTestSignaturePlugin::getGUIObject ( )

Returns

Definition at line 31 of file class.ilTestSignaturePlugin.php.

References $GUIObject.

Referenced by handInFileForArchiving(), and redirectToTest().

        {
                return $this->GUIObject;
        }

Here is the caller graph for this function:

ilTestSignaturePlugin::getSlot ( )

final

Get Slot Name.

Returns: string Slot Name

Reimplemented from ilPlugin.

Definition at line 58 of file class.ilTestSignaturePlugin.php.

        {
                return "Signature";
        }

ilTestSignaturePlugin::getSlotId ( )

final

Get Slot ID.

Returns: string Slot Id

Reimplemented from ilPlugin.

Definition at line 67 of file class.ilTestSignaturePlugin.php.

        {
                return "tsig";
        }

ilTestSignaturePlugin::handInFileForArchiving	(	$active_fi,
		$pass,
		$filename,
		$filepath
	)

protected

Hands in a file from the signature process associated with a given user and pass for archiving.

(See docs, pls.)

Please note: This method checks if archiving is enabled. The test needs to be set to archive data in order to do something meaningful with the signed files. Still, the plugin will work properly if the signed materials are not used afterwards. Since the processing in an archive is in fact not the only option to deal with the files, this possibility of a corrupt settings constellation will not be closed. If your plugin wants to post the files away to a non-ILIAS-DMS, or the like, you still want to sign files, even if archiving in ILIAS is switched off.

Parameters

$active_fi	integer Active-Id of the user.
$pass	integer Pass-number of the tests submission.
$filename	string Filename that is going to be saved.
$filepath	string Path with the current location of the file.

Returns: void

Definition at line 151 of file class.ilTestSignaturePlugin.php.

References $filename, $pass, getGUIObject(), and ilPlugin\getId().

        {
                if ( $this->getGUIObject()->getTest()->getEnableArchiving() )
                {
                        require_once './Modules/Test/classes/class.ilTestArchiver.php';
                        $archiver = new ilTestArchiver($this->getGUIObject()->getTest()->getId());
                        $archiver->handInParticipantMisc($active_fi, $pass, $filename, $filepath);
                }
        }

Here is the call graph for this function:

ilTestSignaturePlugin::invoke ( $cmd = null )

abstract

Method all commands are forwarded to.

This splits the control flow between the ilTestSignatureGUI, which is the command-class at the end of the command-forwarding process, and the actual command-execution-class, which is the plugin instance. The plugin will be called with an eventual command as parameter on this invoke-method and ... makes sense out of it. Whatever that will be.

What you see here is called "The Arab Pattern". You will agree, that "Command-Class-Execution-Separation" would have be to bulky as a name.

Parameters

mixed | null $cmd Optional command for the plugin

Returns: void

ilTestSignaturePlugin::redirectToTest ( $success )

protected

Definition at line 161 of file class.ilTestSignaturePlugin.php.

References $success, and getGUIObject().

        {
                $this->getGUIObject()->redirectToTest($success);
        }

Here is the call graph for this function:

ilTestSignaturePlugin::setGUIObject ( $GUIObject )

Parameters

\ilTestSignatureGUI $GUIObject

Definition at line 23 of file class.ilTestSignaturePlugin.php.

References $GUIObject.

        {
                $this->GUIObject = $GUIObject;
        }

ilTestSignaturePlugin::slotInit ( )

finalprotected

Object initialization done by slot.

Reimplemented from ilPlugin.

Definition at line 75 of file class.ilTestSignaturePlugin.php.

{

}

Field Documentation

ilTestSignaturePlugin::$GUIObject

protected

Definition at line 18 of file class.ilTestSignaturePlugin.php.

Referenced by getGUIObject(), and setGUIObject().

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

Modules/Test/classes/class.ilTestSignaturePlugin.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

Field Documentation