ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
ilObjectPluginGUI Class Reference
+ Inheritance diagram for ilObjectPluginGUI:
+ Collaboration diagram for ilObjectPluginGUI:

Public Member Functions

 __construct ($a_ref_id=0, $a_id_type=self::REPOSITORY_NODE_ID, $a_parent_node_id=0)
 Constructor. More...
 
executeCommand ()
 execute command More...
 
 addLocatorItems ()
 Add object to locator. More...
 
 initCreateForm ($a_new_type)
 Init object creation form. More...
 
 initEditForm ()
 Init object update form. More...
 
 afterSave ($newObj)
 After saving @access public. More...
 
 getAfterCreationCmd ()
 Cmd that will be redirected to after creation of a new object. More...
 
 getStandardCmd ()
 
 addInfoTab ()
 Add info screen tab. More...
 
 addPermissionTab ()
 Add permission tab. More...
 
 infoScreen ()
 show information screen More...
 
 addInfoItems ($info)
 Add items to info screen. More...
 
- Public Member Functions inherited from ilObject2GUI
 __construct ($a_id=0, $a_id_type=self::REPOSITORY_NODE_ID, $a_parent_node_id=0)
 Constructor. More...
 
executeCommand ()
 execute command More...
 
 delete ()
 Display delete confirmation form (repository/workspace switch) More...
 
 confirmedDelete ()
 Delete objects (repository/workspace switch) More...
 
 getHTML ()
 
 withReferences ()
 Final/Private declaration of unchanged parent methods. More...
 
 setCreationMode ($a_mode=true)
 if true, a creation screen is displayed the current $_GET[ref_id] don't belong to the current class! the mode is determined in ilrepositorygui More...
 
 getCreationMode ()
 get creation mode More...
 
 isVisible ()
 
 trash ()
 
 undelete ()
 
 cancelDelete ()
 
 removeFromSystem ()
 
 cloneAll ()
 
 view ()
 view object content (repository/workspace switch) More...
 
 getType ()
 Functions that must be overwritten. More...
 
 create ()
 Deleted in ilObject. More...
 
 save ()
 
 edit ()
 
 update ()
 
 cancel ()
 
 importFile ()
 Import. More...
 
- Public Member Functions inherited from ilObjectGUI
 ilObjectGUI ($a_data, $a_id=0, $a_call_by_reference=true, $a_prepare_output=true)
 Constructor @access public. More...
 
executeCommand ()
 execute command More...
 
 withReferences ()
 determines wether objects are referenced or not (got ref ids or not) More...
 
 setCreationMode ($a_mode=true)
 if true, a creation screen is displayed the current $_GET[ref_id] don't belong to the current class! the mode is determined in ilrepositorygui More...
 
 getCreationMode ()
 get creation mode More...
 
 getAdminTabs (&$tabs_gui)
 administration tabs show only permissions and trash folder More...
 
 getHTML ()
 
 confirmedDeleteObject ()
 confirmed deletion of object -> objects are moved to trash or deleted immediately, if trash is disabled More...
 
 cancelDeleteObject ()
 cancel deletion of object More...
 
 cancelObject ($in_rep=false)
 cancel action and go back to previous page @access public More...
 
 createObject ()
 create new object form More...
 
 cancelCreation ()
 cancel create action and go back to repository parent More...
 
 saveObject ()
 save object More...
 
 editObject ()
 edit object More...
 
 addExternalEditFormCustom (ilPropertyFormGUI $a_form)
 
 updateObject ()
 updates object entry in object_data More...
 
 getFormAction ($a_cmd, $a_formaction="")
 get form action for command (command is method name without "Object", e.g. More...
 
 isVisible ($a_ref_id, $a_type)
 
 viewObject ()
 list childs of current object More...
 
 deleteObject ($a_error=false)
 Display deletion confirmation screen. More...
 
 cloneAllObject ()
 Clone single (not container object) Method is overwritten in ilContainerGUI. More...
 

Static Public Member Functions

static _goto ($a_target)
 Goto redirection. More...
 
- Static Public Member Functions inherited from ilObject2GUI
static handleAfterSaveCallback (ilObject $a_obj, $a_callback_ref_id)
 After creation callback. More...
 
- Static Public Member Functions inherited from ilObjectGUI
static _gotoRepositoryRoot ($a_raise_error=false)
 Goto repository root. More...
 
static _gotoRepositoryNode ($a_ref_id, $a_cmd="frameset")
 Goto repository root. More...
 

Protected Member Functions

 txt ($a_var)
 Wrapper for txt function. More...
 
 getCreationFormTitle ($a_form_type)
 Use custom creation form titles. More...
 
 initCreationForms ($a_new_type)
 Init creation froms. More...
 
 initImportForm ($a_new_type)
 Init object import form. More...
 
- Protected Member Functions inherited from ilObject2GUI
 afterConstructor ()
 Do anything that should be done after constructor in here. More...
 
 assignObject ()
 create object instance as internal property (repository/workspace switch) More...
 
 getAccessHandler ()
 Get access handler. More...
 
 setLocator ()
 set Locator More...
 
 deleteConfirmation ()
 Display delete confirmation form (workspace specific) More...
 
 deleteConfirmedObjects ()
 Delete objects (workspace specific) More...
 
 prepareOutput ()
 prepare output More...
 
 setTitleAndDescription ()
 called by prepare output More...
 
 showUpperIcon ()
 
 omitLocator ($a_omit=true)
 
 getTargetFrame ($a_cmd, $a_target_frame="")
 get target frame for command (command is method name without "Object", e.g. More...
 
 setTargetFrame ($a_cmd, $a_target_frame)
 set specific target frame for command More...
 
 getCenterColumnHTML ()
 Get center column. More...
 
 getRightColumnHTML ()
 Display right column. More...
 
 setColumnSettings ($column_gui)
 May be overwritten in subclasses. More...
 
 checkPermission ($a_perm, $a_cmd="")
 
 showPossibleSubObjects ()
 show possible subobjects (pulldown menu) More...
 
 redirectToRefId ()
 
 fillCloneTemplate ($a_tpl_varname, $a_type)
 Fill object clone template This method can be called from any object GUI class that wants to offer object cloning. More...
 
 fillCloneSearchTemplate ($a_tpl_varname, $a_type)
 
 searchCloneSource ()
 
 buildCloneSelect ($existing_objs)
 
 addAdminLocatorItems ()
 
 setTabs ()
 create tabs (repository/workspace switch) More...
 
 getReturnLocation ()
 Deprecated functions. More...
 
 setReturnLocation ()
 
 showActions ()
 
 getTitlesByRefId ()
 
 getTabs ()
 
 __showButton ()
 
 hitsperpageObject ()
 
 __initTableGUI ()
 
 __setTableGUIBasicData ()
 
 addLocatorItems ()
 Functions to be overwritten. More...
 
 initCreationForms ($a_new_type)
 Init creation froms. More...
 
 putObjectInTree (ilObject $a_obj, $a_parent_node_id=null)
 Add object to tree at given position. More...
 
 checkPermissionBool ($a_perm, $a_cmd="", $a_type="", $a_node_id=null)
 Check permission. More...
 
 initHeaderAction ($a_sub_type=null, $a_sub_id=null)
 Add header action menu. More...
 
 redrawHeaderAction ()
 Updating icons after ajax call. More...
 
 getPermanentLinkWidget ($a_append=null, $a_center=false)
 
 handleAutoRating (ilObject $a_new_obj)
 Activate rating automatically if parent container setting. More...
 
- Protected Member Functions inherited from ilObjectGUI
 assignObject ()
 
 prepareOutput ()
 prepare output More...
 
 setTitleAndDescription ()
 called by prepare output More...
 
 initHeaderAction ($a_sub_type=null, $a_sub_id=null)
 Add header action menu. More...
 
 insertHeaderAction ($a_list_gui)
 Insert header action into main template. More...
 
 addHeaderAction ()
 Add header action menu. More...
 
 redrawHeaderActionObject ()
 Ajax call: redraw action header only. More...
 
 showMountWebfolderIcon ()
 
 setTabs ()
 set admin tabs @access public More...
 
 setAdminTabs ()
 set admin tabs @access public More...
 
 setLocator ()
 set Locator More...
 
 addLocatorItems ()
 should be overwritten to add object specific items (repository items are preloaded) More...
 
 omitLocator ($a_omit=true)
 
 addAdminLocatorItems ($a_do_not_add_object=false)
 should be overwritten to add object specific items (repository items are preloaded) More...
 
 initCreationForms ($a_new_type)
 Init creation froms. More...
 
 getCreationFormsHTML (array $a_forms)
 Get HTML for creation forms (accordion) More...
 
 initCreateForm ($a_new_type)
 Init object creation form. More...
 
 initDidacticTemplate (ilPropertyFormGUI $form)
 Show didactic template types. More...
 
 addDidacticTemplateOptions (array &$a_options)
 Add custom templates. More...
 
 getDidacticTemplateVar ($a_type)
 Get didactic template setting from creation screen. More...
 
 putObjectInTree (ilObject $a_obj, $a_parent_node_id=null)
 Add object to tree at given position. More...
 
 afterSave (ilObject $a_new_object)
 Post (successful) object creation hook. More...
 
 initEditForm ()
 Init object edit form. More...
 
 initEditCustomForm (ilPropertyFormGUI $a_form)
 Add custom fields to update form. More...
 
 getEditFormValues ()
 Get values for edit form. More...
 
 getEditFormCustomValues (array &$a_values)
 Add values to custom edit fields. More...
 
 validateCustom (ilPropertyFormGUI $a_form)
 Validate custom values (if not possible with checkInput()) More...
 
 updateCustom (ilPropertyFormGUI $a_form)
 Insert custom update form values into object. More...
 
 afterUpdate ()
 Post (successful) object update hook. More...
 
 initImportForm ($a_new_type)
 Init object import form. More...
 
 importFileObject ($parent_id=null, $a_catch_errors=true)
 Import. More...
 
 afterImport (ilObject $a_new_object)
 Post (successful) object import hook. More...
 
 setFormAction ($a_cmd, $a_formaction)
 set specific form action for command More...
 
 getReturnLocation ($a_cmd, $a_location="")
 get return location for command (command is method name without "Object", e.g. More...
 
 setReturnLocation ($a_cmd, $a_location)
 set specific return location for command More...
 
 getTargetFrame ($a_cmd, $a_target_frame="")
 get target frame for command (command is method name without "Object", e.g. More...
 
 setTargetFrame ($a_cmd, $a_target_frame)
 set specific target frame for command More...
 
 showPossibleSubObjects ()
 show possible subobjects (pulldown menu) More...
 
 getTemplateFile ($a_cmd, $a_type="")
 get a template blockfile format: tpl. More...
 
 getTitlesByRefId ($a_ref_ids)
 get Titles of objects this method is used for error messages in methods cut/copy/paste More...
 
 getTabs (&$tabs_gui)
 get tabs abstract method. More...
 
 __showButton ($a_cmd, $a_text, $a_target='')
 
 hitsperpageObject ()
 
__initTableGUI ()
 
 __setTableGUIBasicData (&$tbl, &$result_set, $a_from="")
 standard implementation for tables use 'from' variable use different initial setting of table More...
 
 redirectToRefId ($a_ref_id, $a_cmd="")
 redirects to (repository) view per ref id usually to a container and usually used at the end of a save/import method where the object gui type (of the new object) doesn't match with the type of the current $_GET["ref_id"] value More...
 
 fillCloneTemplate ($a_tpl_varname, $a_type)
 Fill object clone template This method can be called from any object GUI class that wants to offer object cloning. More...
 
 getCenterColumnHTML ()
 Get center column. More...
 
 getRightColumnHTML ()
 Display right column. More...
 
 setColumnSettings ($column_gui)
 May be overwritten in subclasses. More...
 
 checkPermission ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
 Check permission and redirect on error. More...
 
 checkPermissionBool ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
 Check permission. More...
 
 enableDragDropFileUpload ()
 Enables the file upload into this object by dropping files. More...
 
 handleAutoRating (ilObject $a_new_obj)
 Activate rating automatically if parent container setting. More...
 

Private Member Functions

 getPlugin ()
 Get plugin object. More...
 

Additional Inherited Members

- Data Fields inherited from ilObject2GUI
 $tree
 
const OBJECT_ID = 0
 
const REPOSITORY_NODE_ID = 1
 
const WORKSPACE_NODE_ID = 2
 
const REPOSITORY_OBJECT_ID = 3
 
const WORKSPACE_OBJECT_ID = 4
 
const PORTFOLIO_OBJECT_ID = 5
 
- Data Fields inherited from ilObjectGUI
const COPY_WIZARD_NEEDS_PAGE = 1
 
 $ilias
 
 $objDefinition
 
 $tpl
 
 $tree
 
 $lng
 
 $data
 
 $object
 
 $ref_id
 
 $obj_id
 
 $maxcount
 
 $formaction
 
 $return_location
 
 $target_frame
 
 $tab_target_script
 
 $actions
 
 $sub_objects
 
 $omit_locator = false
 
const CFORM_NEW = 1
 
const CFORM_IMPORT = 2
 
const CFORM_CLONE = 3
 
- Protected Attributes inherited from ilObject2GUI
 $object_id
 
 $node_id
 
 $creation_forms = array()
 
 $id_type = array()
 
 $parent_id
 
 $access_handler
 
- Protected Attributes inherited from ilObjectGUI
 $tmp_import_dir
 

Detailed Description

Definition at line 14 of file class.ilObjectPluginGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilObjectPluginGUI::__construct (   $a_ref_id = 0,
  $a_id_type = self::REPOSITORY_NODE_ID,
  $a_parent_node_id = 0 
)

Constructor.

Reimplemented from ilObject2GUI.

Definition at line 19 of file class.ilObjectPluginGUI.php.

20 {
21 parent::__construct($a_ref_id, $a_id_type, $a_parent_node_id);
22 $this->plugin =
23 ilPlugin::getPluginObject(IL_COMP_SERVICE, "Repository", "robj",
24 ilPlugin::lookupNameForId(IL_COMP_SERVICE, "Repository", "robj", $this->getType()));
25 if (!is_object($this->plugin))
26 {
27 die("ilObjectPluginGUI: Could not instantiate plugin object for type ".$this->getType().".");
28 }
29 }
const IL_COMP_SERVICE
getType()
Functions that must be overwritten.
static getPluginObject($a_ctype, $a_cname, $a_slot_id, $a_pname)
Get plugin object.
lookupNameForId($a_ctype, $a_cname, $a_slot_id, $a_plugin_id)
Lookup name for id.

References ilPlugin\getPluginObject(), ilObject2GUI\getType(), IL_COMP_SERVICE, and ilPlugin\lookupNameForId().

+ Here is the call graph for this function:

Member Function Documentation

◆ _goto()

static ilObjectPluginGUI::_goto (   $a_target)
static

Goto redirection.

Definition at line 418 of file class.ilObjectPluginGUI.php.

419 {
420 global $ilCtrl, $ilAccess, $lng;
421
422 $t = explode("_", $a_target[0]);
423 $ref_id = (int) $t[0];
424 $class_name = $a_target[1];
425
426 if ($ilAccess->checkAccess("read", "", $ref_id))
427 {
428 $ilCtrl->initBaseClass("ilObjPluginDispatchGUI");
429 $ilCtrl->setTargetScript("ilias.php");
430 $ilCtrl->getCallStructure(strtolower("ilObjPluginDispatchGUI"));
431 $ilCtrl->setParameterByClass($class_name, "ref_id", $ref_id);
432 $ilCtrl->redirectByClass(array("ilobjplugindispatchgui", $class_name), "");
433 }
434 else if($ilAccess->checkAccess("visible", "", $ref_id))
435 {
436 $ilCtrl->initBaseClass("ilObjPluginDispatchGUI");
437 $ilCtrl->setTargetScript("ilias.php");
438 $ilCtrl->getCallStructure(strtolower("ilObjPluginDispatchGUI"));
439 $ilCtrl->setParameterByClass($class_name, "ref_id", $ref_id);
440 $ilCtrl->redirectByClass(array("ilobjplugindispatchgui", $class_name), "infoScreen");
441 }
442 else if ($ilAccess->checkAccess("read", "", ROOT_FOLDER_ID))
443 {
444 ilUtil::sendFailure(sprintf($lng->txt("msg_no_perm_read_item"),
446 include_once("./Services/Object/classes/class.ilObjectGUI.php");
448 }
449 }
static _gotoRepositoryRoot($a_raise_error=false)
Goto repository root.
static _lookupObjId($a_id)
static _lookupTitle($a_id)
lookup object title
static sendFailure($a_info="", $a_keep=false)
Send Failure Message to Screen.
global $ilCtrl
Definition: ilias.php:18

References $ilCtrl, ilObjectGUI\$lng, ilObjectGUI\$ref_id, $t, ilObjectGUI\_gotoRepositoryRoot(), ilObject\_lookupObjId(), ilObject\_lookupTitle(), and ilUtil\sendFailure().

+ Here is the call graph for this function:

◆ addInfoItems()

ilObjectPluginGUI::addInfoItems (   $info)

Add items to info screen.

Definition at line 411 of file class.ilObjectPluginGUI.php.

412 {
413 }

Referenced by infoScreen().

+ Here is the caller graph for this function:

◆ addInfoTab()

ilObjectPluginGUI::addInfoTab ( )

Add info screen tab.

Definition at line 352 of file class.ilObjectPluginGUI.php.

353 {
354 global $ilAccess, $ilTabs;
355
356 // info screen
357 if ($ilAccess->checkAccess('visible', "", $this->object->getRefId()))
358 {
359 $ilTabs->addTarget("info_short",
360 $this->ctrl->getLinkTargetByClass(
361 "ilinfoscreengui", "showSummary"),
362 "showSummary");
363 }
364 }

◆ addLocatorItems()

ilObjectPluginGUI::addLocatorItems ( )

Add object to locator.

Reimplemented from ilObject2GUI.

Definition at line 155 of file class.ilObjectPluginGUI.php.

156 {
157 global $ilLocator;
158
159 if (!$this->getCreationMode())
160 {
161 $ilLocator->addItem($this->object->getTitle(),
162 $this->ctrl->getLinkTarget($this, $this->getStandardCmd()), "", $_GET["ref_id"]);
163 }
164 }
$_GET["client_id"]
getCreationMode()
get creation mode

References $_GET, and ilObject2GUI\getCreationMode().

+ Here is the call graph for this function:

◆ addPermissionTab()

ilObjectPluginGUI::addPermissionTab ( )

Add permission tab.

Definition at line 369 of file class.ilObjectPluginGUI.php.

370 {
371 global $ilAccess, $ilTabs, $ilCtrl;
372
373 // edit permissions
374 if($ilAccess->checkAccess('edit_permission', "", $this->object->getRefId()))
375 {
376 $ilTabs->addTarget("perm_settings",
377 $ilCtrl->getLinkTargetByClass("ilpermissiongui", "perm"),
378 array("perm","info","owner"), 'ilpermissiongui');
379 }
380 }

References $ilCtrl.

◆ afterSave()

ilObjectPluginGUI::afterSave (   $newObj)

After saving @access public.

Definition at line 321 of file class.ilObjectPluginGUI.php.

322 {
323 global $ilCtrl;
324 // always send a message
325 ilUtil::sendSuccess($this->lng->txt("object_added"),true);
326
327 $ilCtrl->initBaseClass("ilObjPluginDispatchGUI");
328 $ilCtrl->setTargetScript("ilias.php");
329 $ilCtrl->getCallStructure(strtolower("ilObjPluginDispatchGUI"));
330
331//var_dump($ilCtrl->call_node);
332//var_dump($ilCtrl->forward);
333//var_dump($ilCtrl->parent);
334//var_dump($ilCtrl->root_class);
335
336 $ilCtrl->setParameterByClass(get_class($this), "ref_id", $newObj->getRefId());
337 $ilCtrl->redirectByClass(array("ilobjplugindispatchgui", get_class($this)), $this->getAfterCreationCmd());
338 }
getAfterCreationCmd()
Cmd that will be redirected to after creation of a new object.
static sendSuccess($a_info="", $a_keep=false)
Send Success Message to Screen.

References $ilCtrl, getAfterCreationCmd(), and ilUtil\sendSuccess().

+ Here is the call graph for this function:

◆ executeCommand()

& ilObjectPluginGUI::executeCommand ( )

execute command

Reimplemented from ilObject2GUI.

Definition at line 34 of file class.ilObjectPluginGUI.php.

35 {
36 global $ilCtrl, $tpl, $ilAccess, $lng, $ilNavigationHistory, $ilTabs;
37
38 // get standard template (includes main menu and general layout)
39 $tpl->getStandardTemplate();
40
41 // set title
42 if (!$this->getCreationMode())
43 {
44 $tpl->setTitle($this->object->getTitle());
45 $tpl->setTitleIcon(ilObject::_getIcon($this->object->getId()));
46
47 // set tabs
48 if (strtolower($_GET["baseClass"]) != "iladministrationgui")
49 {
50 $this->setTabs();
51 $this->setLocator();
52 }
53 else
54 {
55 $this->addAdminLocatorItems();
56 $tpl->setLocator();
57 $this->setAdminTabs();
58 }
59
60 // add entry to navigation history
61 if ($ilAccess->checkAccess("read", "", $_GET["ref_id"]))
62 {
63 $ilNavigationHistory->addItem($_GET["ref_id"],
64 $ilCtrl->getLinkTarget($this, $this->getStandardCmd()), $this->getType());
65 }
66
67 }
68 else
69 {
70 // show info of parent
72 $tpl->setTitleIcon(
74 $lng->txt("obj_".ilObject::_lookupType($_GET["ref_id"], true)));
75 $this->setLocator();
76
77 }
78
79 $next_class = $this->ctrl->getNextClass($this);
80 $cmd = $this->ctrl->getCmd();
81
82 switch($next_class)
83 {
84 case "ilinfoscreengui":
85 $this->checkPermission("visible");
86 $this->infoScreen(); // forwards command
87 break;
88
89 case 'ilpermissiongui':
90 include_once("Services/AccessControl/classes/class.ilPermissionGUI.php");
91 $perm_gui = new ilPermissionGUI($this);
92 $ilTabs->setTabActive("perm_settings");
93 $ret = $ilCtrl->forwardCommand($perm_gui);
94 break;
95
96 case 'ilobjectcopygui':
97 include_once './Services/Object/classes/class.ilObjectCopyGUI.php';
98 $cp = new ilObjectCopyGUI($this);
99 $cp->setType($this->getType());
100 $this->ctrl->forwardCommand($cp);
101 break;
102
103 case 'illearningprogressgui':
104 $ilTabs->setTabActive("learning_progress");
105 include_once './Services/Tracking/classes/class.ilLearningProgressGUI.php';
107 $this->object->getRefId(),
108 $_GET['user_id'] ? $_GET['user_id'] : $GLOBALS['ilUser']->getId());
109 $this->ctrl->forwardCommand($new_gui);
110 break;
111 case 'ilcommonactiondispatchergui':
112 include_once("Services/Object/classes/class.ilCommonActionDispatcherGUI.php");
114 $this->ctrl->forwardCommand($gui);
115 break;
116 default:
117 if (strtolower($_GET["baseClass"]) == "iladministrationgui")
118 {
119 $this->viewObject();
120 return;
121 }
122 if(!$cmd)
123 {
124 $cmd = $this->getStandardCmd();
125 }
126 if ($cmd == "infoScreen")
127 {
128 $ilCtrl->setCmd("showSummary");
129 $ilCtrl->setCmdClass("ilinfoscreengui");
130 $this->infoScreen();
131 }
132 else
133 {
134 if ($this->getCreationMode())
135 {
136 $this->$cmd();
137 }
138 else
139 {
140 $this->performCommand($cmd);
141 }
142 }
143 break;
144 }
145
146 if (!$this->getCreationMode())
147 {
148 $tpl->show();
149 }
150 }
static getInstanceFromAjaxCall()
(Re-)Build instance from ajax call
Class ilObjUserTrackingGUI.
setTabs()
create tabs (repository/workspace switch)
checkPermission($a_perm, $a_cmd="")
setLocator()
set Locator
GUI class for the workflow of copying objects.
setAdminTabs()
set admin tabs @access public
viewObject()
list childs of current object
infoScreen()
show information screen
static _getIcon($a_obj_id="", $a_size="big", $a_type="", $a_offline=false)
Get icon for repository item.
New PermissionGUI (extends from old ilPermission2GUI) RBAC related output.
$GLOBALS['PHPCAS_CLIENT']
This global variable is used by the interface class phpCAS.
Definition: CAS.php:276
$cmd
Definition: sahs_server.php:35

References $_GET, $cmd, $GLOBALS, $ilCtrl, ilObjectGUI\$lng, $ret, ilObjectGUI\$tpl, ilObject\_getIcon(), ilObject\_lookupObjId(), ilObject\_lookupTitle(), ilObject2GUI\addAdminLocatorItems(), ilObject2GUI\checkPermission(), ilObject2GUI\getCreationMode(), ilCommonActionDispatcherGUI\getInstanceFromAjaxCall(), getStandardCmd(), ilObject2GUI\getType(), infoScreen(), ilLearningProgressBaseGUI\LP_CONTEXT_REPOSITORY, ilObjectGUI\setAdminTabs(), ilObject2GUI\setLocator(), ilObject2GUI\setTabs(), and ilObjectGUI\viewObject().

+ Here is the call graph for this function:

◆ getAfterCreationCmd()

ilObjectPluginGUI::getAfterCreationCmd ( )
abstract

Cmd that will be redirected to after creation of a new object.

Referenced by afterSave().

+ Here is the caller graph for this function:

◆ getCreationFormTitle()

ilObjectPluginGUI::getCreationFormTitle (   $a_form_type)
protected

Use custom creation form titles.

Parameters
string$a_form_type
Returns
string

Definition at line 190 of file class.ilObjectPluginGUI.php.

191 {
192 switch($a_form_type)
193 {
194 case self::CFORM_NEW:
195 return $this->txt($this->getType()."_new");
196
198 return $this->lng->txt("import");
199
201 return $this->txt("objs_".$this->getType()."_duplicate");
202 }
203 }
txt($a_var)
Wrapper for txt function.

References ilObjectGUI\CFORM_CLONE, ilObjectGUI\CFORM_IMPORT, ilObjectGUI\CFORM_NEW, ilObject2GUI\getType(), and txt().

+ Here is the call graph for this function:

◆ getPlugin()

ilObjectPluginGUI::getPlugin ( )
finalprivate

Get plugin object.

Returns
object plugin object

Definition at line 171 of file class.ilObjectPluginGUI.php.

172 {
173 return $this->plugin;
174 }

Referenced by txt().

+ Here is the caller graph for this function:

◆ getStandardCmd()

ilObjectPluginGUI::getStandardCmd ( )
abstract

Referenced by executeCommand().

+ Here is the caller graph for this function:

◆ infoScreen()

ilObjectPluginGUI::infoScreen ( )

show information screen

Definition at line 386 of file class.ilObjectPluginGUI.php.

387 {
388 global $ilAccess, $ilUser, $lng, $ilCtrl, $tpl, $ilTabs;
389
390 $ilTabs->setTabActive("info_short");
391
392 $this->checkPermission("visible");
393
394 include_once("./Services/InfoScreen/classes/class.ilInfoScreenGUI.php");
395 $info = new ilInfoScreenGUI($this);
396 $info->enablePrivateNotes();
397
398 // general information
399 $lng->loadLanguageModule("meta");
400
401 $this->addInfoItems($info);
402
403 // forward the command
404 $ret = $ilCtrl->forwardCommand($info);
405 //$tpl->setContent($ret);
406 }
Class ilInfoScreenGUI.
addInfoItems($info)
Add items to info screen.
$info
Definition: example_052.php:80
global $ilUser
Definition: imgupload.php:15

References $ilCtrl, $ilUser, $info, ilObjectGUI\$lng, $ret, ilObjectGUI\$tpl, addInfoItems(), and ilObject2GUI\checkPermission().

Referenced by executeCommand().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ initCreateForm()

ilObjectPluginGUI::initCreateForm (   $a_new_type)

Init object creation form.

Parameters
string$a_new_type
Returns
ilPropertyFormGUI

Reimplemented from ilObjectGUI.

Definition at line 230 of file class.ilObjectPluginGUI.php.

231 {
232 include_once("Services/Form/classes/class.ilPropertyFormGUI.php");
233 $form = new ilPropertyFormGUI();
234 $form->setTarget("_top");
235 $form->setFormAction($this->ctrl->getFormAction($this, "save"));
236 $form->setTitle($this->txt($a_new_type."_new"));
237
238 // title
239 $ti = new ilTextInputGUI($this->lng->txt("title"), "title");
240 $ti->setSize(min(40, ilObject::TITLE_LENGTH));
241 $ti->setMaxLength(ilObject::TITLE_LENGTH);
242 $ti->setRequired(true);
243 $form->addItem($ti);
244
245 // description
246 $ta = new ilTextAreaInputGUI($this->lng->txt("description"), "desc");
247 $ta->setCols(40);
248 $ta->setRows(2);
249 $form->addItem($ta);
250
251 $form->addCommandButton("save", $this->txt($a_new_type."_add"));
252 $form->addCommandButton("cancel", $this->lng->txt("cancel"));
253
254 return $form;
255 }
const TITLE_LENGTH
max length of object title
This class represents a property form user interface.
This class represents a text area property in a property form.
This class represents a text property in a property form.

References ilObject\TITLE_LENGTH, and txt().

Referenced by initCreationForms().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ initCreationForms()

ilObjectPluginGUI::initCreationForms (   $a_new_type)
protected

Init creation froms.

this will create the default creation forms: new, import, clone

Parameters
string$a_new_type
Returns
array

Reimplemented from ilObject2GUI.

Definition at line 213 of file class.ilObjectPluginGUI.php.

214 {
215 $forms = array(
216 self::CFORM_NEW => $this->initCreateForm($a_new_type),
217 // self::CFORM_IMPORT => $this->initImportForm($a_new_type),
218 self::CFORM_CLONE => $this->fillCloneTemplate(null, $a_new_type)
219 );
220
221 return $forms;
222 }
fillCloneTemplate($a_tpl_varname, $a_type)
Fill object clone template This method can be called from any object GUI class that wants to offer ob...
initCreateForm($a_new_type)
Init object creation form.

References ilObject2GUI\fillCloneTemplate(), and initCreateForm().

+ Here is the call graph for this function:

◆ initEditForm()

ilObjectPluginGUI::initEditForm ( )

Init object update form.

Returns
ilPropertyFormGUI

Reimplemented from ilObjectGUI.

Definition at line 262 of file class.ilObjectPluginGUI.php.

263 {
264 global $lng, $ilCtrl;
265
266 include_once("Services/Form/classes/class.ilPropertyFormGUI.php");
267 $form = new ilPropertyFormGUI();
268 $form->setTarget("_top");
269 $form->setFormAction($ilCtrl->getFormAction($this, "update"));
270 $form->setTitle($lng->txt("edit"));
271
272 // title
273 $ti = new ilTextInputGUI($lng->txt("title"), "title");
274 $ti->setSize(min(40, ilObject::TITLE_LENGTH));
275 $ti->setMaxLength(ilObject::TITLE_LENGTH);
276 $ti->setRequired(true);
277 $form->addItem($ti);
278
279 // description
280 $ta = new ilTextAreaInputGUI($lng->txt("description"), "desc");
281 $ta->setCols(40);
282 $ta->setRows(2);
283 $form->addItem($ta);
284
285 $form->addCommandButton("update", $lng->txt("save"));
286 // $this->form->addCommandButton("cancelUpdate", $lng->txt("cancel"));
287
288 return $form;
289 }

References $ilCtrl, ilObjectGUI\$lng, and ilObject\TITLE_LENGTH.

◆ initImportForm()

ilObjectPluginGUI::initImportForm (   $a_new_type)
protected

Init object import form.

Parameters
stringnew type
Returns
ilPropertyFormGUI

Reimplemented from ilObjectGUI.

Definition at line 297 of file class.ilObjectPluginGUI.php.

298 {
299 include_once("Services/Form/classes/class.ilPropertyFormGUI.php");
300 $form = new ilPropertyFormGUI();
301 $form->setTarget("_top");
302 $form->setFormAction($this->ctrl->getFormAction($this, "importFile"));
303 $form->setTitle($this->lng->txt("import"));
304
305 include_once("./Services/Form/classes/class.ilFileInputGUI.php");
306 $fi = new ilFileInputGUI($this->lng->txt("import_file"), "importfile");
307 $fi->setSuffixes(array("zip"));
308 $fi->setRequired(true);
309 $form->addItem($fi);
310
311 $form->addCommandButton("importFile", $this->lng->txt("import"));
312 $form->addCommandButton("cancel", $this->lng->txt("cancel"));
313
314 return $form;
315 }
This class represents a file property in a property form.

◆ txt()

ilObjectPluginGUI::txt (   $a_var)
finalprotected

Wrapper for txt function.

Definition at line 179 of file class.ilObjectPluginGUI.php.

180 {
181 return $this->getPlugin()->txt($a_var);
182 }
getPlugin()
Get plugin object.

References getPlugin().

Referenced by getCreationFormTitle(), and initCreateForm().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

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