ILIAS
release_5-3 Revision v5.3.23-19-g915713cf615
|
Abstract parent class for all advanced md claiming plugin classes. More...
Public Member Functions | |
getComponentType () | |
getComponentName () | |
getSlot () | |
getSlotId () | |
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... | |
install () | |
Install. More... | |
activate () | |
Activate. More... | |
deactivate () | |
Deactivate. More... | |
uninstall () | |
update () | |
Update plugin. 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 | langExitsById ($pluginId, $langVar) |
Is searched lang var available in plugin lang files. 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 plugin names for a slot. More... | |
static | getActivePluginIdsForSlot ($a_ctype, $a_cname, $a_slot_id) |
Get All active plugin ids for a slot. More... | |
static | lookupNameForId ($a_ctype, $a_cname, $a_slot_id, $a_plugin_id) |
Lookup name for id. More... | |
static | lookupIdForName ($a_ctype, $a_cname, $a_slot_id, $a_plugin_name) |
Lookup id for name. More... | |
Protected Member Functions | |
slotInit () | |
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... | |
afterInstall () | |
After install processing. More... | |
beforeActivation () | |
Before activation processing. More... | |
afterActivation () | |
After activation processing. More... | |
afterDeactivation () | |
After deactivation processing. More... | |
beforeUninstall () | |
afterUninstall () | |
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... | |
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 |
Referenced by slotInit().
|
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 268 of file class.ilAdvancedMDClaimingPlugin.php.
References $a_type, $ilDB, and array.
|
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.
|
static |
Delete field db entry.
int | $a_field_id |
Definition at line 345 of file class.ilAdvancedMDClaimingPlugin.php.
References $ilDB.
|
static |
Delete record db entry.
int | $a_record_id |
Definition at line 205 of file class.ilAdvancedMDClaimingPlugin.php.
References $ilDB.
|
final |
Definition at line 26 of file class.ilAdvancedMDClaimingPlugin.php.
|
final |
|
staticprotected |
Get last position of record.
int | $a_record_id |
Definition at line 241 of file class.ilAdvancedMDClaimingPlugin.php.
References $ilDB.
|
staticprotected |
Get substitution DB data for object type.
string | $a_obj_type | |
bool | $a_include_field_data |
Definition at line 365 of file class.ilAdvancedMDClaimingPlugin.php.
References $ilDB, $res, and array.
|
final |
Definition at line 31 of file class.ilAdvancedMDClaimingPlugin.php.
|
final |
Definition at line 36 of file class.ilAdvancedMDClaimingPlugin.php.
|
static |
Check if field has db entry.
int | $a_field_id |
Definition at line 224 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 433 of file class.ilAdvancedMDClaimingPlugin.php.
|
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.
|
static |
Remove field substitution entry in DB.
string | $a_obj_type | |
int | $a_field_id |
Definition at line 503 of file class.ilAdvancedMDClaimingPlugin.php.
|
staticprotected |
Save object type assignments for record.
int | $a_record_id | |
array | $a_obj_types |
Definition at line 138 of file class.ilAdvancedMDClaimingPlugin.php.
References $ilDB, $type, and array.
|
static |
Update field substitution entry in DB.
string | $a_obj_type | |
int | $a_field_id | |
bool | $a_bold | |
bool | $a_newline |
Definition at line 456 of file class.ilAdvancedMDClaimingPlugin.php.
|
static |
Set substitution DB entry (for object type)
string | $a_obj_type | |
bool | $a_show_description | |
bool | $a_show_field_names |
Definition at line 395 of file class.ilAdvancedMDClaimingPlugin.php.
|
finalprotected |
Definition at line 41 of file class.ilAdvancedMDClaimingPlugin.php.
References $a_context_id, $a_context_type, and checkPermission().
|
static |
Update field db entry.
int | $a_field_id | |
string | $a_title | |
string | $a_description | |
bool | $a_searchable | |
array | $a_definition |
Definition at line 314 of file class.ilAdvancedMDClaimingPlugin.php.
|
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 172 of file class.ilAdvancedMDClaimingPlugin.php.