ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
ilRepositoryObjectPlugin Class Reference

Abstract parent class for all repository object plugin classes. More...

+ Inheritance diagram for ilRepositoryObjectPlugin:
+ Collaboration diagram for ilRepositoryObjectPlugin:

Public Member Functions

 getComponentType ()
 Get Component Type. More...
 
 getComponentName ()
 Get Component Name. More...
 
 getSlot ()
 Get Slot Name. More...
 
 getSlotId ()
 Get Slot ID. More...
 
 _getName ($a_id)
 Get class name. 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 _getIcon ($a_type, $a_size)
 Get Icon. 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...
 
 beforeActivation ()
 Before activation processing. More...
 
 beforeUninstallCustom ()
 
 uninstallCustom ()
 
 beforeUninstall ()
 
- 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...
 

Additional Inherited Members

- Protected Attributes inherited from ilPlugin
 $lang_initialised = false
 
 $id = ''
 

Detailed Description

Abstract parent class for all repository object plugin classes.

Author
Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e
Version
$Id$

Definition at line 13 of file class.ilRepositoryObjectPlugin.php.

Member Function Documentation

◆ _getIcon()

static ilRepositoryObjectPlugin::_getIcon (   $a_type,
  $a_size 
)
static

Get Icon.

Definition at line 66 of file class.ilRepositoryObjectPlugin.php.

67 {
68 /*
69 switch($a_size)
70 {
71 case "small": $suff = ""; break;
72 case "tiny": $suff = "_s"; break;
73 default: $suff = "_b"; break;
74 }
75 */
76 return ilPlugin::_getImagePath(IL_COMP_SERVICE, "Repository", "robj",
77 ilPlugin::lookupNameForId(IL_COMP_SERVICE, "Repository", "robj",$a_type),
78 "icon_".$a_type/*.$suff*/.".svg");
79 }
const IL_COMP_SERVICE
static _getImagePath($a_ctype, $a_cname, $a_slot_id, $a_pname, $a_img)
Get image path.
lookupNameForId($a_ctype, $a_cname, $a_slot_id, $a_plugin_id)
Lookup name for id.

References ilPlugin\_getImagePath(), IL_COMP_SERVICE, and ilPlugin\lookupNameForId().

+ Here is the call graph for this function:

◆ _getName()

ilRepositoryObjectPlugin::_getName (   $a_id)

Get class name.

Definition at line 84 of file class.ilRepositoryObjectPlugin.php.

85 {
86 $name = ilPlugin::lookupNameForId(IL_COMP_SERVICE, "Repository", "robj",$a_id);
87 if ($name != "")
88 {
89 return $name;
90 }
91 }

References IL_COMP_SERVICE, and ilPlugin\lookupNameForId().

+ Here is the call graph for this function:

◆ beforeActivation()

ilRepositoryObjectPlugin::beforeActivation ( )
protected

Before activation processing.

Reimplemented from ilPlugin.

Definition at line 96 of file class.ilRepositoryObjectPlugin.php.

97 {
98 global $lng, $ilDB;
99
100 // before activating, we ensure, that the type exists in the ILIAS
101 // object database and that all permissions exist
102 $type = $this->getId();
103
104 if (substr($type, 0, 1) != "x")
105 {
106 throw new ilPluginException("Object plugin type must start with an x. Current type is ".$type.".");
107 }
108
109 // check whether type exists in object data, if not, create the type
110 $set = $ilDB->query("SELECT * FROM object_data ".
111 " WHERE type = ".$ilDB->quote("typ", "text").
112 " AND title = ".$ilDB->quote($type, "text")
113 );
114 if ($rec = $ilDB->fetchAssoc($set))
115 {
116 $t_id = $rec["obj_id"];
117 }
118 else
119 {
120 $t_id = $ilDB->nextId("object_data");
121 $ilDB->manipulate("INSERT INTO object_data ".
122 "(obj_id, type, title, description, owner, create_date, last_update) VALUES (".
123 $ilDB->quote($t_id, "integer").",".
124 $ilDB->quote("typ", "text").",".
125 $ilDB->quote($type, "text").",".
126 $ilDB->quote("Plugin ".$this->getPluginName(), "text").",".
127 $ilDB->quote(-1, "integer").",".
128 $ilDB->quote(ilUtil::now(), "timestamp").",".
129 $ilDB->quote(ilUtil::now(), "timestamp").
130 ")");
131 }
132
133 // add rbac operations
134 // 1: edit_permissions, 2: visible, 3: read, 4:write, 6:delete
135 $ops = array(1, 2, 3, 4, 6);
136 foreach ($ops as $op)
137 {
138 // check whether type exists in object data, if not, create the type
139 $set = $ilDB->query("SELECT * FROM rbac_ta ".
140 " WHERE typ_id = ".$ilDB->quote($t_id, "integer").
141 " AND ops_id = ".$ilDB->quote($op, "integer")
142 );
143 if (!$ilDB->fetchAssoc($set))
144 {
145 $ilDB->manipulate("INSERT INTO rbac_ta ".
146 "(typ_id, ops_id) VALUES (".
147 $ilDB->quote($t_id, "integer").",".
148 $ilDB->quote($op, "integer").
149 ")");
150 }
151 }
152
153 // now add creation permission, if not existing
154 $set = $ilDB->query("SELECT * FROM rbac_operations ".
155 " WHERE class = ".$ilDB->quote("create", "text").
156 " AND operation = ".$ilDB->quote("create_".$type, "text")
157 );
158 if ($rec = $ilDB->fetchAssoc($set))
159 {
160 $create_ops_id = $rec["ops_id"];
161 }
162 else
163 {
164 $create_ops_id = $ilDB->nextId(rbac_operations);
165 $ilDB->manipulate("INSERT INTO rbac_operations ".
166 "(ops_id, operation, description, class) VALUES (".
167 $ilDB->quote($create_ops_id, "integer").",".
168 $ilDB->quote("create_".$type, "text").",".
169 $ilDB->quote("create ".$type, "text").",".
170 $ilDB->quote("create", "text").
171 ")");
172 }
173
174 // assign creation operation to root, cat, crs, grp and fold
175 $par_types = array("root", "cat", "crs", "grp", "fold");
176 foreach ($par_types as $par_type)
177 {
178 $set = $ilDB->query("SELECT obj_id FROM object_data ".
179 " WHERE type = ".$ilDB->quote("typ", "text").
180 " AND title = ".$ilDB->quote($par_type, "text")
181 );
182 if ($rec = $ilDB->fetchAssoc($set))
183 {
184 if ($rec["obj_id"] > 0)
185 {
186 $set = $ilDB->query("SELECT * FROM rbac_ta ".
187 " WHERE typ_id = ".$ilDB->quote($rec["obj_id"], "integer").
188 " AND ops_id = ".$ilDB->quote($create_ops_id, "integer")
189 );
190 if (!$ilDB->fetchAssoc($set))
191 {
192 $ilDB->manipulate("INSERT INTO rbac_ta ".
193 "(typ_id, ops_id) VALUES (".
194 $ilDB->quote($rec["obj_id"], "integer").",".
195 $ilDB->quote($create_ops_id, "integer").
196 ")");
197 }
198 }
199 }
200 }
201
202 return true;
203 }
getId()
Get Id.
static now()
Return current timestamp in Y-m-d H:i:s format.
global $lng
Definition: privfeed.php:40
global $ilDB

References $ilDB, $lng, ilPlugin\getId(), and ilUtil\now().

+ Here is the call graph for this function:

◆ beforeUninstall()

ilRepositoryObjectPlugin::beforeUninstall ( )
finalprotected

Reimplemented from ilPlugin.

Definition at line 214 of file class.ilRepositoryObjectPlugin.php.

215 {
216 if($this->beforeUninstallCustom())
217 {
218 include_once "Services/Repository/classes/class.ilRepUtil.php";
219 $rep_util = new ilRepUtil();
220 $rep_util->deleteObjectType($this->getId());
221
222 // custom database tables may be needed by plugin repository object
223 $this->uninstallCustom();
224
225 return true;
226 }
227 return false;
228 }
Repository Utilities (application layer, put GUI related stuff into ilRepUtilGUI)

References beforeUninstallCustom(), ilPlugin\getId(), and uninstallCustom().

+ Here is the call graph for this function:

◆ beforeUninstallCustom()

ilRepositoryObjectPlugin::beforeUninstallCustom ( )
protected

Definition at line 205 of file class.ilRepositoryObjectPlugin.php.

206 {
207 // plugin-specific
208 // false would indicate that anything went wrong
209 return true;
210 }

Referenced by beforeUninstall().

+ Here is the caller graph for this function:

◆ getComponentName()

ilRepositoryObjectPlugin::getComponentName ( )
final

Get Component Name.

Returns
string Component Name

Reimplemented from ilPlugin.

Definition at line 30 of file class.ilRepositoryObjectPlugin.php.

31 {
32 return "Repository";
33 }

◆ getComponentType()

ilRepositoryObjectPlugin::getComponentType ( )
final

Get Component Type.

Returns
string Component Type

Reimplemented from ilPlugin.

Definition at line 20 of file class.ilRepositoryObjectPlugin.php.

21 {
22 return IL_COMP_SERVICE;
23 }

References IL_COMP_SERVICE.

◆ getSlot()

ilRepositoryObjectPlugin::getSlot ( )
final

Get Slot Name.

Returns
string Slot Name

Reimplemented from ilPlugin.

Definition at line 40 of file class.ilRepositoryObjectPlugin.php.

41 {
42 return "RepositoryObject";
43 }

◆ getSlotId()

ilRepositoryObjectPlugin::getSlotId ( )
final

Get Slot ID.

Returns
string Slot Id

Reimplemented from ilPlugin.

Definition at line 50 of file class.ilRepositoryObjectPlugin.php.

51 {
52 return "robj";
53 }

◆ slotInit()

ilRepositoryObjectPlugin::slotInit ( )
finalprotected

Object initialization done by slot.

Reimplemented from ilPlugin.

Definition at line 58 of file class.ilRepositoryObjectPlugin.php.

59 {
60 // nothing to do here
61 }

◆ uninstallCustom()

ilRepositoryObjectPlugin::uninstallCustom ( )
abstractprotected

Referenced by beforeUninstall().

+ Here is the caller graph for this function:

The documentation for this class was generated from the following file: