ILIAS
trunk Revision v11.0_alpha-3011-gc6b235a2e85
|
Abstract parent class for all test export plugin classes. More...
Public Member Functions | |
__construct (\ilDBInterface $db, \ilComponentRepositoryWrite $component_repository, string $id) | |
setTest (ilObjTest $test) | |
setTimestmap (int $timestmap) | |
getTimestmap () | |
getFormat () | |
write () | |
getFormatLabel () | |
This method should return a human readable label for your export. More... | |
![]() | |
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) | |
@deprecate ILIAS is moving towards UI components and plugins are expected to use these components. More... | |
getStyleSheetLocation (string $a_css_file) | |
@deprecate ILIAS is moving towards UI components and plugins are expected to use these components. More... | |
addBlockFile ($a_tpl, $a_var, $a_block, $a_tplname) | |
@deprecate 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... | |
![]() | |
deliver () | |
write () | |
Protected Member Functions | |
getTest () | |
buildExportFile (ExportFilename $export_path) | |
This method is called if the user wants to export a test of YOUR export type If you throw an exception of type ilException with a respective language variable, ILIAS presents a translated failure message. More... | |
getFormatIdentifier () | |
A unique identifier which describes your export type, e.g. More... | |
![]() | |
init () | |
Object initialization. More... | |
getPluginInfo () | |
getComponentInfo () | |
getPluginSlotInfo () | |
afterInstall () | |
@deprecate If you cannot get rid of the requirement to use this, adjust the install method in your subclass instead. More... | |
beforeUninstall () | |
@deprecate If you cannot get rid of the requirement to use this, adjust the uninstall method in your subclass instead. More... | |
afterUninstall () | |
@deprecate If you cannot get rid of the requirement to use this, adjust the uninstall method in your subclass instead. More... | |
beforeActivation () | |
@deprecate If you cannot get rid of the requirement to use this, adjust the activate method in your subclass instead. More... | |
afterActivation () | |
@deprecate If you cannot get rid of the requirement to use this, adjust the activate method in your subclass instead. More... | |
afterDeactivation () | |
@deprecate If you cannot get rid of the requirement to use this, adjust the activate method in your subclass instead. More... | |
updateDatabase () | |
beforeUpdate () | |
@deprecate If you cannot get rid of the requirement to use this, adjust the update method in your subclass instead. More... | |
afterUpdate () | |
getLanguageHandler () | |
buildLanguageHandler () | |
Protected Attributes | |
ilObjTest | $test = null |
int | $timestmap = -1 |
![]() | |
ilDBInterface | $db |
ilComponentRepositoryWrite | $component_repository |
string | $id |
ilPluginLanguage | $language_handler = null |
bool | $lang_initialised = false |
ProviderCollection | $provider_collection |
string | $message = '' |
Static Protected Attributes | |
static | $reserved_formats |
Private Member Functions | |
createExportFile (ilGlobalTemplateInterface $main_tpl) | |
Abstract parent class for all test export plugin classes.
Definition at line 28 of file class.ilTestExportPlugin.php.
ilTestExportPlugin::__construct | ( | \ilDBInterface | $db, |
\ilComponentRepositoryWrite | $component_repository, | ||
string | $id | ||
) |
Reimplemented from ilPlugin.
Definition at line 38 of file class.ilTestExportPlugin.php.
References ilPlugin\$component_repository, ilPlugin\$db, ilPlugin\$id, and ILIAS\GlobalScreen\Provider\__construct().
|
abstractprotected |
This method is called if the user wants to export a test of YOUR export type If you throw an exception of type ilException with a respective language variable, ILIAS presents a translated failure message.
ilException |
ExportFilename | $export_path | The path to store the export file |
Referenced by createExportFile().
|
private |
Definition at line 120 of file class.ilTestExportPlugin.php.
References Vendor\Package\$e, buildExportFile(), ilPlugin\getId(), getTest(), ILIAS\UICore\GlobalTemplate\setOnScreenMessage(), and ilPlugin\txt().
Referenced by write().
|
final |
ilException |
Definition at line 69 of file class.ilTestExportPlugin.php.
References getFormatIdentifier().
|
abstractprotected |
A unique identifier which describes your export type, e.g.
imsm There is currently no mapping implemented concerning the filename. Feel free to create csv, xml, zip files ....
Referenced by getFormat().
|
abstract |
This method should return a human readable label for your export.
|
finalprotected |
Definition at line 51 of file class.ilTestExportPlugin.php.
References $test.
Referenced by createExportFile().
ilTestExportPlugin::getTimestmap | ( | ) |
Definition at line 61 of file class.ilTestExportPlugin.php.
References $timestmap.
|
final |
Definition at line 46 of file class.ilTestExportPlugin.php.
References $test.
ilTestExportPlugin::setTimestmap | ( | int | $timestmap | ) |
Definition at line 56 of file class.ilTestExportPlugin.php.
References $timestmap.
|
final |
Implements ILIAS\Test\ExportImport\Exporter.
Definition at line 115 of file class.ilTestExportPlugin.php.
References createExportFile().
|
staticprotected |
Definition at line 33 of file class.ilTestExportPlugin.php.
|
protected |
Definition at line 30 of file class.ilTestExportPlugin.php.
|
protected |
Definition at line 31 of file class.ilTestExportPlugin.php.
Referenced by getTimestmap(), and setTimestmap().