ilTestSignaturePlugin Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilTestSignaturePlugin:

Collaboration diagram for ilTestSignaturePlugin:

Public Member Functions
	setGUIObject ($GUIObject)
	getGUIObject ()
	invoke ($cmd=null)
	Method all commands are forwarded to. More...
Public Member Functions inherited from ilPlugin
	getMessage ()
	__construct (\ilDBInterface $db, \ilComponentRepositoryWrite $component_repository, string $id)
	getPluginName ()
	getId ()
	getVersion ()
	Only very little classes seem to care about this: More...
	getDirectory ()
	Only very little classes seem to care about this: More...
	isActive ()
	Only very little classes seem to care about this: More...
	needsUpdate ()
	install ()
	uninstall ()
	activate ()
	This will update (if required) and activate the plugin. More...
	deactivate ()
	update ()
	loadLanguageModule ()
	Load language module for plugin. More...
	txt (string $a_var)
	Get Language Variable (prefix will be prepended automatically) More...
	getTemplate (string $a_template, bool $a_par1=true, bool $a_par2=true)
	ILIAS is moving towards UI components and plugins are expected to use these components. More...
	getStyleSheetLocation (string $a_css_file)
	ILIAS is moving towards UI components and plugins are expected to use these components. More...
	addBlockFile ($a_tpl, $a_var, $a_block, $a_tplname)
	ILIAS is moving towards UI components and plugins are expected to use these components. More...
	getGlobalScreenProviderCollection ()
	exchangeUIRendererAfterInitialization (\ILIAS\DI\Container $dic)
	This methods allows to replace the UI Renderer (see src/UI) of ILIAS after initialization by returning a closure returning a custom renderer. More...
	exchangeUIFactoryAfterInitialization (string $dic_key, \ILIAS\DI\Container $dic)
	This methods allows to replace some factory for UI Components (see src/UI) of ILIAS after initialization by returning a closure returning a custom factory. More...

Protected Member Functions
	handInFileForArchiving ($active_fi, $pass, $filename, $filepath)
	Hands in a file from the signature process associated with a given user and pass for archiving. More...
	redirectToTest ($success)
Protected Member Functions inherited from ilPlugin
	init ()
	Object initialization. More...
	getPluginInfo ()
	getComponentInfo ()
	getPluginSlotInfo ()
	afterInstall ()
	If you cannot get rid of the requirement to use this, adjust the install method in your subclass instead. More...
	beforeUninstall ()
	If you cannot get rid of the requirement to use this, adjust the uninstall method in your subclass instead. More...
	afterUninstall ()
	If you cannot get rid of the requirement to use this, adjust the uninstall method in your subclass instead. More...
	beforeActivation ()
	If you cannot get rid of the requirement to use this, adjust the activate method in your subclass instead. More...
	afterActivation ()
	If you cannot get rid of the requirement to use this, adjust the activate method in your subclass instead. More...
	afterDeactivation ()
	If you cannot get rid of the requirement to use this, adjust the activate method in your subclass instead. More...
	updateDatabase ()
	beforeUpdate ()
	If you cannot get rid of the requirement to use this, adjust the update method in your subclass instead. More...
	afterUpdate ()
	getLanguageHandler ()
	buildLanguageHandler ()
	readEventListening ()
	clearEventListening ()

Protected Attributes
	$GUIObject
Protected Attributes inherited from ilPlugin
ilDBInterface	$db
ilComponentRepositoryWrite	$component_repository
string	$id
ilPluginLanguage	$language_handler = null
bool	$lang_initialised = false
ProviderCollection	$provider_collection
string	$message = ''

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning 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 28 of file class.ilTestSignaturePlugin.php.

Member Function Documentation

getGUIObject()

ilTestSignaturePlugin::getGUIObject

(

)

Returns

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

References $_SERVER, $DIC, $GUIObject, and $tpl.

Referenced by handInFileForArchiving(), and redirectToTest().

                                  : ilTestSignatureGUI
    {
        return $this->GUIObject;
    }

Here is the caller graph for this function:

handInFileForArchiving()

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 125 of file class.ilTestSignaturePlugin.php.

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

    {
        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:

invoke()

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

Referenced by redirectToTest().

Here is the caller graph for this function:

redirectToTest()

ilTestSignaturePlugin::redirectToTest (   $success )

protected

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

References getGUIObject(), and invoke().

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

Here is the call graph for this function:

setGUIObject()

ilTestSignaturePlugin::setGUIObject

(

$GUIObject

)

Parameters

\ilTestSignatureGUI

$GUIObject

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

References $GUIObject.

    {
        $this->GUIObject = $GUIObject;
    }

Field Documentation

$GUIObject

ilTestSignaturePlugin::$GUIObject

protected

Definition at line 31 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