|
ILIAS
release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
|
Abstract parent class for all advanced md claiming plugin classes. More...
Inheritance diagram for ilAdvancedMDClaimingPlugin:
Collaboration diagram for ilAdvancedMDClaimingPlugin:Public Member Functions | |
| getComponentType () | |
| Get Component Type. More... | |
| getComponentName () | |
| Get Component Name. More... | |
| getSlot () | |
| Get Slot Name. More... | |
| getSlotId () | |
| Get Slot ID. More... | |
| checkPermission ($a_user_id, $a_context_type, $a_context_id, $a_action_id, $a_action_sub_id) | |
| Check permission. 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 () | |
| Get Id. More... | |
| getLastUpdateVersion () | |
| Get Version of last update. More... | |
| getVersion () | |
| Get Current Version (from plugin.php file). More... | |
| getIliasMinVersion () | |
| Get Required ILIAS min. More... | |
| getIliasMaxVersion () | |
| Get Required ILIAS max. More... | |
| getActive () | |
| Get Active. More... | |
| setDBVersion ($a_dbversion) | |
| Set DB Version. More... | |
| getDBVersion () | |
| Get DB Version. More... | |
| writeDBVersion ($a_dbversion) | |
| Write DB version to database. More... | |
| 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 ($a_var) | |
| Get Language Variable (prefix will be prepended automatically) More... | |
| getTemplate ($a_template, $a_par1=true, $a_par2=true) | |
| Get template from plugin. More... | |
| getImagePath ($a_img) | |
| Get image path. More... | |
| getStyleSheetLocation ($a_css_file) | |
| Get css file location. More... | |
| 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... | |
| activate () | |
| Activate. More... | |
| deactivate () | |
| Deactivate. More... | |
| uninstall () | |
| update () | |
| Update plugin. More... | |
| lookupNameForId ($a_ctype, $a_cname, $a_slot_id, $a_plugin_id) | |
| Lookup name for id. More... | |
| lookupIdForName ($a_ctype, $a_cname, $a_slot_id, $a_plugin_name) | |
| Lookup id for name. More... | |
Static Public Member Functions | |
| static | hasDBRecord ($a_record_id) |
| Check if record has db entry. More... | |
| static | createDBRecord ($a_title, $a_description, $a_active, array $a_obj_types) |
| Create record db entry. More... | |
| static | updateDBRecord ($a_record_id, $a_title, $a_description, $a_active, array $a_obj_types) |
| Update record db entry. More... | |
| static | deleteDBRecord ($a_record_id) |
| Delete record db entry. More... | |
| static | hasDBField ($a_field_id) |
| Check if field has db entry. More... | |
| static | createDBField ($a_record_id, $a_type, $a_title, $a_description=null, $a_searchable=false, array $a_definition=null) |
| Create field db entry. More... | |
| static | updateDBField ($a_field_id, $a_title, $a_description=null, $a_searchable=false, array $a_definition=null) |
| Update field db entry. More... | |
| static | deleteDBField ($a_field_id) |
| Delete field db entry. More... | |
| static | setDBSubstitution ($a_obj_type, $a_show_description, $a_show_field_names) |
| Set substitution DB entry (for object type) More... | |
| static | hasDBFieldSubstitution ($a_obj_type, $a_field_id) |
| Is substitution active for field in object type. More... | |
| static | setDBFieldSubstitution ($a_obj_type, $a_field_id, $a_bold=false, $a_newline=false) |
| Update field substitution entry in DB. More... | |
| static | removeDBFieldSubstitution ($a_obj_type, $a_field_id) |
| Remove field substitution entry in DB. More... | |
Static Public Member Functions inherited from ilPlugin | |
| static | _getDirectory ($a_ctype, $a_cname, $a_slot_id, $a_pname) |
| Get plugin directory. More... | |
| static | getAvailableLangFiles ($a_lang_directory) |
| Get array of all language files in the plugin. More... | |
| static | hasConfigureClass ($a_slot_dir, $a_name) |
| Has the plugin a configure class? More... | |
| static | getConfigureClassName ($a_name) |
| Get plugin configure class name. More... | |
| static | getDBUpdateScriptName ($a_ctype, $a_cname, $a_slot_name, $a_pname) |
| Get DB update script filename (full path) More... | |
| static | lookupTxt ($a_mod_prefix, $a_pl_id, $a_lang_var) |
| Lookup language text. More... | |
| static | _getImagePath ($a_ctype, $a_cname, $a_slot_id, $a_pname, $a_img) |
| Get image path. More... | |
| static | createPluginRecord ($a_ctype, $a_cname, $a_slot_id, $a_pname) |
| static | getPluginRecord ($a_ctype, $a_cname, $a_slot_id, $a_pname) |
| Get record from il_plugin table. More... | |
| static | getPluginObject ($a_ctype, $a_cname, $a_slot_id, $a_pname) |
| Get plugin object. More... | |
| static | lookupStoredData ($a_ctype, $a_cname, $a_slot_id, $a_pname) |
| Lookup information data in il_plugin. More... | |
| static | getActivePluginsForSlot ($a_ctype, $a_cname, $a_slot_id) |
| Get all active plugins for a slot. More... | |
Protected Member Functions | |
| slotInit () | |
| Object initialization done by slot. More... | |
Protected Member Functions inherited from ilPlugin | |
| setSlotObject ($a_slot) | |
| Set Plugin Slot. More... | |
| getSlotObject () | |
| Get Plugin Slot. More... | |
| getClassesDirectory () | |
| Get Plugin's classes Directory. More... | |
| getLanguageDirectory () | |
| Get Plugin's language Directory. More... | |
| slotInit () | |
| Object initialization done by slot. More... | |
| init () | |
| Object initialization. More... | |
| beforeActivation () | |
| Before activation processing. More... | |
| afterActivation () | |
| After activation processing. More... | |
| afterDeactivation () | |
| After deactivation processing. More... | |
| beforeUninstall () | |
| afterUninstall () | |
| beforeUpdate () | |
| Before update processing. More... | |
| afterUpdate () | |
| After update processing. More... | |
Static Protected Member Functions | |
| static | isValidObjType ($a_obj_type, $a_is_substitution=false) |
| Validate object type. More... | |
| static | saveRecordObjTypes ($a_record_id, array $a_obj_types) |
| Save object type assignments for record. More... | |
| static | getDBFieldLastPosition ($a_record_id) |
| Get last position of record. More... | |
| static | getDBSubstitution ($a_obj_type, $a_include_field_data=false) |
| Get substitution DB data for object type. More... | |
Additional Inherited Members | |
Protected Attributes inherited from ilPlugin | |
| $lang_initialised = false | |
| $id = '' | |
Abstract parent class for all advanced md claiming plugin classes.
Definition at line 15 of file class.ilAdvancedMDClaimingPlugin.php.
|
abstract |
Check permission.
| int | $a_user_id | |
| int | $a_context_type | |
| int | $a_context_id | |
| int | $a_action_id | |
| int | $a_action_sub_id |
|
static |
Create field db entry.
| int | $a_record_id | |
| int | $a_type | |
| string | $a_title | |
| string | $a_description | |
| bool | $a_searchable | |
| array | $a_definition |
Definition at line 274 of file class.ilAdvancedMDClaimingPlugin.php.
References $ilDB, and getDBFieldLastPosition().
Here is the call graph for this function:
|
static |
Create record db entry.
| string | $a_title | |
| string | $a_description | |
| bool | $a_active | |
| array | $a_obj_types |
Definition at line 92 of file class.ilAdvancedMDClaimingPlugin.php.
References $ilDB, and saveRecordObjTypes().
Here is the call graph for this function:
|
static |
Delete field db entry.
| int | $a_field_id |
Definition at line 353 of file class.ilAdvancedMDClaimingPlugin.php.
References $ilDB.
|
static |
Delete record db entry.
| int | $a_record_id |
Definition at line 209 of file class.ilAdvancedMDClaimingPlugin.php.
References $ilDB.
|
final |
Get Component Name.
Must be overwritten in plugin class of plugin slot.
Reimplemented from ilPlugin.
Definition at line 26 of file class.ilAdvancedMDClaimingPlugin.php.
|
final |
Get Component Type.
Must be overwritten in plugin class of plugin slot.
Reimplemented from ilPlugin.
Definition at line 21 of file class.ilAdvancedMDClaimingPlugin.php.
References IL_COMP_SERVICE.
|
staticprotected |
Get last position of record.
| int | $a_record_id |
Definition at line 246 of file class.ilAdvancedMDClaimingPlugin.php.
References $ilDB.
Referenced by createDBField().
Here is the caller graph for this function:
|
staticprotected |
Get substitution DB data for object type.
| string | $a_obj_type | |
| bool | $a_include_field_data |
Definition at line 374 of file class.ilAdvancedMDClaimingPlugin.php.
Referenced by hasDBFieldSubstitution(), removeDBFieldSubstitution(), setDBFieldSubstitution(), and setDBSubstitution().
Here is the caller graph for this function:
|
final |
Get Slot Name.
Must be overwritten in plugin class of plugin slot.
Reimplemented from ilPlugin.
Definition at line 31 of file class.ilAdvancedMDClaimingPlugin.php.
|
final |
Get Slot ID.
Must be overwritten in plugin class of plugin slot.
Reimplemented from ilPlugin.
Definition at line 36 of file class.ilAdvancedMDClaimingPlugin.php.
|
static |
Check if field has db entry.
| int | $a_field_id |
Definition at line 229 of file class.ilAdvancedMDClaimingPlugin.php.
References $ilDB.
|
static |
Is substitution active for field in object type.
| string | $a_obj_type | |
| int | $a_field_id |
Definition at line 448 of file class.ilAdvancedMDClaimingPlugin.php.
References getDBSubstitution().
Here is the call graph for this function:
|
static |
Check if record has db entry.
| int | $a_record_id |
Definition at line 74 of file class.ilAdvancedMDClaimingPlugin.php.
References $ilDB.
|
staticprotected |
Validate object type.
| string | $a_obj_type | |
| bool | $a_is_substitution |
Definition at line 119 of file class.ilAdvancedMDClaimingPlugin.php.
References $valid.
|
static |
Remove field substitution entry in DB.
| string | $a_obj_type | |
| int | $a_field_id |
Definition at line 525 of file class.ilAdvancedMDClaimingPlugin.php.
References $ilDB, and getDBSubstitution().
Here is the call graph for this function:
|
staticprotected |
Save object type assignments for record.
| int | $a_record_id | |
| array | $a_obj_types |
Definition at line 139 of file class.ilAdvancedMDClaimingPlugin.php.
References $ilDB.
Referenced by createDBRecord(), and updateDBRecord().
Here is the caller graph for this function:
|
static |
Update field substitution entry in DB.
| string | $a_obj_type | |
| int | $a_field_id | |
| bool | $a_bold | |
| bool | $a_newline |
Definition at line 474 of file class.ilAdvancedMDClaimingPlugin.php.
References $ilDB, getDBSubstitution(), and setDBSubstitution().
Here is the call graph for this function:
|
static |
Set substitution DB entry (for object type)
| string | $a_obj_type | |
| bool | $a_show_description | |
| bool | $a_show_field_names |
Definition at line 408 of file class.ilAdvancedMDClaimingPlugin.php.
References $ilDB, and getDBSubstitution().
Referenced by setDBFieldSubstitution().
Here is the call graph for this function:
Here is the caller graph for this function:
|
finalprotected |
Object initialization done by slot.
Must be overwritten in plugin class of plugin slot.
(and should be made protected)
Reimplemented from ilPlugin.
Definition at line 41 of file class.ilAdvancedMDClaimingPlugin.php.
|
static |
Update field db entry.
| int | $a_field_id | |
| string | $a_title | |
| string | $a_description | |
| bool | $a_searchable | |
| array | $a_definition |
Definition at line 323 of file class.ilAdvancedMDClaimingPlugin.php.
References $ilDB.
|
static |
Update record db entry.
| int | $a_record_id | |
| string | $a_title | |
| string | $a_description | |
| bool | $a_active | |
| array | $a_obj_types |
Definition at line 178 of file class.ilAdvancedMDClaimingPlugin.php.
References $ilDB, and saveRecordObjTypes().
Here is the call graph for this function: