ilPDFRendererPlugin Class Reference
Abstract parent class for all pdf renderer plugin classes. More...
Inheritance diagram for ilPDFRendererPlugin:
Collaboration diagram for ilPDFRendererPlugin:
Public Member Functions | |
| getComponentType () | |
| — ilPlugin – More... | |
| getComponentName () | |
| Get Component Name. More... | |
| getSlot () | |
| Get Slot Name. More... | |
| getSlotId () | |
| Get Slot ID. More... | |
| Public Member Functions inherited from ilPlugin | |
| __construct () | |
| getComponentType () | |
| Get Component Type. More... | |
| getComponentName () | |
| Get Component Name. More... | |
| getSlot () | |
| Get Slot Name. More... | |
| getSlotId () | |
| Get Slot ID. More... | |
| getPluginName () | |
| Get Plugin Name. More... | |
| getId () | |
| getLastUpdateVersion () | |
| Get Version of last update. More... | |
| getVersion () | |
| getIliasMinVersion () | |
| getIliasMaxVersion () | |
| Get Required ILIAS max. More... | |
| getActive () | |
| setDBVersion (int $a_dbversion) | |
| getDBVersion () | |
| writeDBVersion (int $a_dbversion) | |
| getDirectory () | |
| Get Plugin Directory. More... | |
| includeClass ($a_class_file_name) | |
| Include (once) a class file. More... | |
| getPrefix () | |
| Get plugin prefix, used for lang vars. More... | |
| getTablePrefix () | |
| Get db table plugin prefix. More... | |
| updateLanguages ($a_lang_keys=null) | |
| updateDatabase () | |
| Update database. More... | |
| 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) | |
| gets a ilTemplate instance of a html-file in the plugin /templates More... | |
| getImagePath (string $a_img) | |
| Get image path. More... | |
| getStyleSheetLocation (string $a_css_file) | |
| addBlockFile ($a_tpl, $a_var, $a_block, $a_tplname) | |
| Add template content to placeholder variable. More... | |
| isActive () | |
| Check whether plugin is active. More... | |
| needsUpdate () | |
| Check whether update is needed. More... | |
| install () | |
| activate () | |
| Activate. More... | |
| deactivate () | |
| Deactivate. More... | |
| uninstall () | |
| update () | |
| Update plugin. More... | |
| promoteGlobalScreenProvider () | |
| Public Member Functions inherited from ilRendererConfig | |
| addConfigElementsToForm (\ilPropertyFormGUI $form, $service, $purpose) | |
| populateConfigElementsInForm (\ilPropertyFormGUI $form, $service, $purpose, $config) | |
| validateConfigInForm (\ilPropertyFormGUI $form, $service, $purpose) | |
| getConfigFromForm (\ilPropertyFormGUI $form, $service, $purpose) | |
| getDefaultConfig ($service, $purpose) | |
| Public Member Functions inherited from ilPDFRenderer | |
| generatePDF ($service, $purpose, $config, $job) | |
| prepareGenerationRequest ($service, $purpose) | |
| Prepare the content processing at the beginning of a PDF generation request Should be used to initialize the processing of latex code The PDF renderers require different image formats generated by the MathJax service. More... | |
Protected Member Functions | |
| slotInit () | |
| Object initialization done by slot. More... | |
| Protected Member Functions inherited from ilPlugin | |
| setSlotObject (ilPluginSlot $a_slot) | |
| getSlotObject () | |
| getClassesDirectory () | |
| getLanguageDirectory () | |
| slotInit () | |
| Object initialization done by slot. More... | |
| init () | |
| Object initialization. More... | |
| afterInstall () | |
| After install processing. More... | |
| beforeActivation () | |
| Before activation processing. More... | |
| afterActivation () | |
| After activation processing. More... | |
| afterDeactivation () | |
| After deactivation processing. More... | |
| beforeUninstall () | |
| afterUninstall () | |
| This is Plugin-Specific and is triggered after the uninstall command of a plugin. More... | |
| readEventListening () | |
| Read the event listening definitions from the plugin.xml (if file exists) More... | |
| clearEventListening () | |
| Clear the entries of this plugin in the event handling table. More... | |
| beforeUpdate () | |
| Before update processing. More... | |
| afterUpdate () | |
| After update processing. More... | |
Additional Inherited Members | |
| Static Public Member Functions inherited from ilPlugin | |
| static | _getDirectory (string $a_ctype, string $a_cname, string $a_slot_id, string $a_pname) |
| Get plugin directory. More... | |
| static | getAvailableLangFiles (string $a_lang_directory) |
| Get array of all language files in the plugin. More... | |
| static | hasConfigureClass (string $a_slot_dir, array $plugin_data, array $plugin_db_data) |
| Has the plugin a configure class? More... | |
| static | getConfigureClassName (array $plugin_data) |
| Get plugin configure class name. More... | |
| static | getDBUpdateScriptName (string $a_ctype, string $a_cname, string $a_slot_name, string $a_pname) |
| static | lookupTxt (string $a_mod_prefix, string $a_pl_id, string $a_lang_var) |
| static | langExitsById (string $pluginId, string $langVar) |
| Is searched lang var available in plugin lang files. More... | |
| static | _getImagePath (string $a_ctype, string $a_cname, string $a_slot_id, string $a_pname, string $a_img) |
| static | createPluginRecord (string $a_ctype, string $a_cname, string $a_slot_id, string $a_pname) |
| static | getPluginRecord (string $a_ctype, string $a_cname, string $a_slot_id, string $a_pname) |
| static | getPluginObject (string $a_ctype, string $a_cname, string $a_slot_id, string $a_pname) |
| static | lookupStoredData (string $a_ctype, string $a_cname, string $a_slot_id, string $a_pname) |
| Lookup information data in il_plugin. More... | |
| static | getActivePluginsForSlot (string $a_ctype, string $a_cname, string $a_slot_id) |
| static | getActivePluginIdsForSlot (string $a_ctype, string $a_cname, string $a_slot_id) |
| Get All active plugin ids for a slot. More... | |
| static | lookupNameForId (string $a_ctype, string $a_cname, string $a_slot_id, string $a_plugin_id) |
| static | lookupIdForName (string $a_ctype, string $a_cname, string $a_slot_id, string $a_plugin_name) |
| static | lookupTypeInformationsForId (string $id) |
| Protected Attributes inherited from ilPlugin | |
| $slot | |
| $active = false | |
| $iliasmaxversion = "" | |
| $iliasminversion = "" | |
| $version = "" | |
| $lastupdateversion = "" | |
| $dbversion = 0 | |
| $lang_initialised = false | |
| $id = '' | |
Detailed Description
Abstract parent class for all pdf renderer plugin classes.
- Version
- $Id$
Definition at line 16 of file class.ilPDFRendererPlugin.php.
Member Function Documentation
◆ getComponentName()
|
final |
Get Component Name.
- Returns
- string Component Name
Definition at line 35 of file class.ilPDFRendererPlugin.php.
◆ getComponentType()
|
final |
— ilPlugin –
Get Component Type
- Returns
- string Component Type
Definition at line 25 of file class.ilPDFRendererPlugin.php.
References IL_COMP_SERVICE.
◆ getSlot()
|
final |
◆ getSlotId()
|
final |
◆ slotInit()
|
finalprotected |
Object initialization done by slot.
Definition at line 63 of file class.ilPDFRendererPlugin.php.
The documentation for this class was generated from the following file:
- Services/PDFGeneration/classes/class.ilPDFRendererPlugin.php
