ILIAS  Release_4_2_x_branch Revision 61807
 All Data Structures Namespaces Files Functions Variables Groups Pages
Public Member Functions | Protected Member Functions | Private Member Functions
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.
& executeCommand ()
 execute command
 addLocatorItems ()
 Add object to locator.
 initCreateForm ($a_new_type)
 Init object creation form.
 initEditForm ()
 Init object update form.
 afterSave ($newObj)
 After saving public.
 getAfterCreationCmd ()
 Cmd that will be redirected to after creation of a new object.
 getStandardCmd ()
 addInfoTab ()
 Add info screen tab.
 addPermissionTab ()
 Add permission tab.
 infoScreen ()
 show information screen
 addInfoItems ($info)
 Add items to info screen.
 _goto ($a_target)
 Goto redirection.
- Public Member Functions inherited from ilObject2GUI
 delete ()
 Display delete confirmation form (repository/workspace switch)
 confirmedDelete ()
 Delete objects (repository/workspace switch)
 getHTML ()
 withReferences ()
 Final/Private declaration of unchanged parent methods.
 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
 getCreationMode ()
 get creation mode
 isVisible ()
 trash ()
 undelete ()
 cancelDelete ()
 removeFromSystem ()
 cloneAll ()
 getAdminTabs ($a)
 view ()
 view object content (repository/workspace switch)
 getTemplateFile ()
 copyWizardHasOptions ($a_mode)
 Check if there is any modules specific option.
 getType ()
 Functions that must be overwritten.
 create ()
 Deleted in ilObject.
 save ()
 edit ()
 update ()
 cancel ()
 importFile ()
 Import.
- Public Member Functions inherited from ilObjectGUI
 ilObjectGUI ($a_data, $a_id=0, $a_call_by_reference=true, $a_prepare_output=true)
 Constructor public.
 getAdminTabs (&$tabs_gui)
 administration tabs show only permissions and trash folder
 undeleteObject ()
 Get objects back from trash.
 confirmedDeleteObject ()
 confirmed deletion of object -> objects are moved to trash or deleted immediately, if trash is disabled
 cancelDeleteObject ()
 cancel deletion of object
 removeFromSystemObject ()
 remove objects from trash bin and all entries therefore every object needs a specific deleteObject() method
 cancelObject ($in_rep=false)
 cancel action and go back to previous page public
 createObject ()
 create new object form
 cancelCreation ()
 cancel create action and go back to repository parent
 saveObject ()
 save object
 editObject ()
 edit object
 updateObject ()
 updates object entry in object_data
 getFormAction ($a_cmd, $a_formaction="")
 get form action for command (command is method name without "Object", e.g.
 isVisible ($a_ref_id, $a_type)
 viewObject ()
 list childs of current object
 deleteObject ($a_error=false)
 Display deletion confirmation screen.
 trashObject ()
 Show trash content of object.
 getTemplateFile ($a_cmd, $a_type="")
 get a template blockfile format: tpl.
 cloneAllObject ()
 Clone single (not container object) Method is overwritten in ilContainerGUI.

Protected Member Functions

 txt ($a_var)
 Wrapper for txt function.
 getCreationFormTitle ($a_form_type)
 Use custom creation form titles.
 initCreationForms ($a_new_type)
 Init creation froms.
 initImportForm ($a_new_type)
 Init object import form.
- Protected Member Functions inherited from ilObject2GUI
 afterConstructor ()
 Do anything that should be done after constructor in here.
 assignObject ()
 create object instance as internal property (repository/workspace switch)
 getAccessHandler ()
 Get access handler.
 setLocator ()
 set Locator
 deleteConfirmation ()
 Display delete confirmation form (workspace specific)
 deleteConfirmedObjects ()
 Delete objects (workspace specific)
 prepareOutput ()
 prepare output
 setTitleAndDescription ()
 called by prepare output
 showUpperIcon ()
 omitLocator ($a_omit=true)
 getTargetFrame ($a_cmd, $a_target_frame="")
 get target frame for command (command is method name without "Object", e.g.
 setTargetFrame ($a_cmd, $a_target_frame)
 set specific target frame for command
 getCenterColumnHTML ()
 Get center column.
 getRightColumnHTML ()
 Display right column.
 setColumnSettings ($column_gui)
 May be overwritten in subclasses.
 checkPermission ($a_perm, $a_cmd="")
 showPossibleSubObjects ()
 show possible subobjects (pulldown menu)
 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.
 fillCloneSearchTemplate ($a_tpl_varname, $a_type)
 searchCloneSource ()
 buildCloneSelect ($existing_objs)
 addAdminLocatorItems ()
 should be overwritten to add object specific items (repository items are preloaded)
 setTabs ()
 create tabs (repository/workspace switch)
 getReturnLocation ()
 Deprecated functions.
 setReturnLocation ()
 showActions ()
 getTitlesByRefId ()
 getTabs ()
 __showButton ()
 hitsperpageObject ()
 __initTableGUI ()
 __setTableGUIBasicData ()
 __showClipboardTable ()
 putObjectInTree (ilObject $a_obj, $a_parent_node_id=null)
 Add object to tree at given position.
 checkPermissionBool ($a_perm, $a_cmd="", $a_type="", $a_node_id=null)
 Check permission.
 initHeaderAction ($a_sub_type=null, $a_sub_id=null)
 Add header action menu.
 redrawHeaderAction ()
 Updating icons after ajax call.
 getPermanentLinkWidget ($a_append=null, $a_center=false)
- Protected Member Functions inherited from ilObjectGUI
 insertHeaderAction ($a_list_gui)
 Insert header action into main template.
 addHeaderAction ()
 Add header action menu.
 redrawHeaderActionObject ()
 Ajax call: redraw action header only.
 setAdminTabs ()
 set admin tabs public
 getCreationFormsHTML (array $a_forms)
 Get HTML for creation forms (accordion)
 initDidacticTemplate (ilPropertyFormGUI $form)
 Show didactic template types.
 addDidacticTemplateOptions (array &$a_options)
 Add custom templates.
 getDidacticTemplateVar ($a_type)
 Get didactic template setting from creation screen.
 afterSave (ilObject $a_new_object)
 Post (successful) object creation hook.
 initEditCustomForm (ilPropertyFormGUI $a_form)
 Add custom fields to update form.
 getEditFormValues ()
 Get values for edit form.
 getEditFormCustomValues (array &$a_values)
 Add values to custom edit fields.
 updateCustom (ilPropertyFormGUI $a_form)
 Insert custom update form values into object.
 afterUpdate ()
 Post (successful) object update hook.
 importFileObject ($parent_id=null)
 Import.
 afterImport (ilObject $a_new_object)
 Post (successful) object import hook.
 setFormAction ($a_cmd, $a_formaction)
 set specific form action for command
 getReturnLocation ($a_cmd, $a_location="")
 get return location for command (command is method name without "Object", e.g.
 setReturnLocation ($a_cmd, $a_location)
 set specific return location for command
 getTitlesByRefId ($a_ref_ids)
 get Titles of objects this method is used for error messages in methods cut/copy/paste
 getTabs (&$tabs_gui)
 get tabs abstract method.
 __showButton ($a_cmd, $a_text, $a_target= '')
 __setTableGUIBasicData (&$tbl, &$result_set, $a_from="")
 standard implementation for tables use 'from' variable use different initial setting of table
 __showClipboardTable ($a_result_set, $a_from="")
 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
 checkPermission ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
 Check permission and redirect on error.

Private Member Functions

 getPlugin ()
 Get plugin object.

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
- Protected Attributes inherited from ilObject2GUI
 $object_id
 $node_id
 $creation_forms = array()
 $id_type = array()
 $parent_id
 $access_handler

Detailed Description

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

Constructor & Destructor Documentation

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.

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

{
parent::__construct($a_ref_id, $a_id_type, $a_parent_node_id);
$this->plugin =
ilPlugin::getPluginObject(IL_COMP_SERVICE, "Repository", "robj",
ilPlugin::lookupNameForId(IL_COMP_SERVICE, "Repository", "robj", $this->getType()));
if (!is_object($this->plugin))
{
die("ilObjectPluginGUI: Could not instantiate plugin object for type ".$this->getType().".");
}
}

+ Here is the call graph for this function:

Member Function Documentation

ilObjectPluginGUI::_goto (   $a_target)

Goto redirection.

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

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

{
global $ilCtrl, $ilAccess, $lng;
$t = explode("_", $a_target[0]);
$ref_id = (int) $t[0];
$class_name = $a_target[1];
if ($ilAccess->checkAccess("read", "", $ref_id))
{
$ilCtrl->initBaseClass("ilObjPluginDispatchGUI");
$ilCtrl->setTargetScript("ilias.php");
$ilCtrl->getCallStructure(strtolower("ilObjPluginDispatchGUI"));
$ilCtrl->setParameterByClass($class_name, "ref_id", $ref_id);
$ilCtrl->redirectByClass(array("ilobjplugindispatchgui", $class_name), "");
}
else if($ilAccess->checkAccess("visible", "", $ref_id))
{
$ilCtrl->initBaseClass("ilObjPluginDispatchGUI");
$ilCtrl->setTargetScript("ilias.php");
$ilCtrl->getCallStructure(strtolower("ilObjPluginDispatchGUI"));
$ilCtrl->setParameterByClass($class_name, "ref_id", $ref_id);
$ilCtrl->redirectByClass(array("ilobjplugindispatchgui", $class_name), "infoScreen");
}
else if ($ilAccess->checkAccess("read", "", ROOT_FOLDER_ID))
{
$_GET["cmd"] = "frameset";
$_GET["target"] = "";
$_GET["ref_id"] = ROOT_FOLDER_ID;
ilUtil::sendFailure(sprintf($lng->txt("msg_no_perm_read_item"),
ilObject::_lookupTitle(ilObject::_lookupObjId($ref_id))));
include("repository.php");
exit;
}
}

+ Here is the call graph for this function:

ilObjectPluginGUI::addInfoItems (   $info)

Add items to info screen.

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

Referenced by infoScreen().

{
}

+ Here is the caller graph for this function:

ilObjectPluginGUI::addInfoTab ( )

Add info screen tab.

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

{
global $ilAccess, $ilTabs;
// info screen
if ($ilAccess->checkAccess('visible', "", $this->object->getRefId()))
{
$ilTabs->addTarget("info_short",
$this->ctrl->getLinkTargetByClass(
"ilinfoscreengui", "showSummary"),
"showSummary");
}
}
ilObjectPluginGUI::addLocatorItems ( )

Add object to locator.

Reimplemented from ilObject2GUI.

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

References $_GET, ilObject2GUI\getCreationMode(), and getStandardCmd().

{
global $ilLocator;
if (!$this->getCreationMode())
{
$ilLocator->addItem($this->object->getTitle(),
$this->ctrl->getLinkTarget($this, $this->getStandardCmd()), "", $_GET["ref_id"]);
}
}

+ Here is the call graph for this function:

ilObjectPluginGUI::addPermissionTab ( )

Add permission tab.

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

References $ilCtrl.

{
global $ilAccess, $ilTabs, $ilCtrl;
// edit permissions
if($ilAccess->checkAccess('edit_permission', "", $this->object->getRefId()))
{
$ilTabs->addTarget("perm_settings",
$ilCtrl->getLinkTargetByClass("ilpermissiongui", "perm"),
array("perm","info","owner"), 'ilpermissiongui');
}
}
ilObjectPluginGUI::afterSave (   $newObj)

After saving public.

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

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

{
global $ilCtrl;
// always send a message
ilUtil::sendSuccess($this->lng->txt("object_added"),true);
$ilCtrl->initBaseClass("ilObjPluginDispatchGUI");
$ilCtrl->setTargetScript("ilias.php");
$ilCtrl->getCallStructure(strtolower("ilObjPluginDispatchGUI"));
//var_dump($ilCtrl->call_node);
//var_dump($ilCtrl->forward);
//var_dump($ilCtrl->parent);
//var_dump($ilCtrl->root_class);
$ilCtrl->setParameterByClass(get_class($this), "ref_id", $newObj->getRefId());
$ilCtrl->redirectByClass(array("ilobjplugindispatchgui", get_class($this)), $this->getAfterCreationCmd());
}

+ Here is the call graph for this function:

& ilObjectPluginGUI::executeCommand ( )

execute command

Reimplemented from ilObject2GUI.

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

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

{
global $ilCtrl, $tpl, $ilAccess, $lng, $ilNavigationHistory, $ilTabs;
// get standard template (includes main menu and general layout)
$tpl->getStandardTemplate();
// set title
if (!$this->getCreationMode())
{
$tpl->setTitle($this->object->getTitle());
$tpl->setTitleIcon($this->plugin->getImagePath("icon_".$this->object->getType()."_b.gif"),
$lng->txt("icon")." ".$this->txt("obj_".$this->object->getType()));
// set tabs
if (strtolower($_GET["baseClass"]) != "iladministrationgui")
{
$this->setTabs();
$this->setLocator();
}
else
{
$this->addAdminLocatorItems();
$tpl->setLocator();
$this->setAdminTabs();
}
// add entry to navigation history
if ($ilAccess->checkAccess("read", "", $_GET["ref_id"]))
{
$ilNavigationHistory->addItem($_GET["ref_id"],
$ilCtrl->getLinkTarget($this, $this->getStandardCmd()), $this->getType());
}
}
else
{
// show info of parent
$tpl->setTitle(ilObject::_lookupTitle(ilObject::_lookupObjId($_GET["ref_id"])));
$tpl->setTitleIcon(
ilObject::_getIcon(ilObject::_lookupObjId($_GET["ref_id"]), "big"),
$lng->txt("obj_".ilObject::_lookupType($_GET["ref_id"], true)));
$this->setLocator();
}
$next_class = $this->ctrl->getNextClass($this);
$cmd = $this->ctrl->getCmd();
switch($next_class)
{
case "ilinfoscreengui":
$this->checkPermission("visible");
$this->infoScreen(); // forwards command
break;
case 'ilpermissiongui':
include_once("Services/AccessControl/classes/class.ilPermissionGUI.php");
$perm_gui = new ilPermissionGUI($this);
$ilTabs->setTabActive("perm_settings");
$ret = $ilCtrl->forwardCommand($perm_gui);
break;
case 'ilobjectcopygui':
include_once './Services/Object/classes/class.ilObjectCopyGUI.php';
$cp = new ilObjectCopyGUI($this);
$cp->setType($this->getType());
$this->ctrl->forwardCommand($cp);
break;
default:
if (strtolower($_GET["baseClass"]) == "iladministrationgui")
{
$this->viewObject();
return;
}
if(!$cmd)
{
$cmd = $this->getStandardCmd();
}
if ($cmd == "infoScreen")
{
$ilCtrl->setCmd("showSummary");
$ilCtrl->setCmdClass("ilinfoscreengui");
$this->infoScreen();
}
else
{
if ($this->getCreationMode())
{
$this->$cmd();
}
else
{
$this->performCommand($cmd);
}
}
break;
}
if (!$this->getCreationMode())
{
$tpl->show();
}
}

+ Here is the call graph for this function:

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:

ilObjectPluginGUI::getCreationFormTitle (   $a_form_type)
protected

Use custom creation form titles.

Parameters
string$a_form_type
Returns
string

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

References ilObject2GUI\getType(), and txt().

{
switch($a_form_type)
{
case self::CFORM_NEW:
return $this->txt($this->getType()."_new");
case self::CFORM_IMPORT:
return $this->lng->txt("import");
case self::CFORM_CLONE:
return $this->txt("objs_".$this->getType()."_duplicate");
}
}

+ Here is the call graph for this function:

ilObjectPluginGUI::getPlugin ( )
finalprivate

Get plugin object.

Returns
object plugin object

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

Referenced by txt().

{
return $this->plugin;
}

+ Here is the caller graph for this function:

ilObjectPluginGUI::getStandardCmd ( )
abstract

Referenced by addLocatorItems(), and executeCommand().

+ Here is the caller graph for this function:

ilObjectPluginGUI::infoScreen ( )

show information screen

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

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

Referenced by executeCommand().

{
global $ilAccess, $ilUser, $lng, $ilCtrl, $tpl, $ilTabs;
$ilTabs->setTabActive("info_short");
$this->checkPermission("visible");
include_once("./Services/InfoScreen/classes/class.ilInfoScreenGUI.php");
$info = new ilInfoScreenGUI($this);
$info->enablePrivateNotes();
// general information
$lng->loadLanguageModule("meta");
$this->addInfoItems($info);
// forward the command
$ret = $ilCtrl->forwardCommand($info);
//$tpl->setContent($ret);
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilObjectPluginGUI::initCreateForm (   $a_new_type)

Init object creation form.

Parameters
string$a_new_type
Returns
ilPropertyFormGUI

Reimplemented from ilObjectGUI.

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

References ilTextAreaInputGUI\setCols(), ilTextInputGUI\setMaxLength(), and txt().

Referenced by initCreationForms().

{
include_once("Services/Form/classes/class.ilPropertyFormGUI.php");
$form = new ilPropertyFormGUI();
$form->setTarget("_top");
$form->setFormAction($this->ctrl->getFormAction($this, "save"));
$form->setTitle($this->txt($a_new_type."_new"));
// title
$ti = new ilTextInputGUI($this->lng->txt("title"), "title");
$ti->setMaxLength(128);
$ti->setSize(40);
$ti->setRequired(true);
$form->addItem($ti);
// description
$ta = new ilTextAreaInputGUI($this->lng->txt("description"), "desc");
$ta->setCols(40);
$ta->setRows(2);
$form->addItem($ta);
$form->addCommandButton("save", $this->txt($a_new_type."_add"));
$form->addCommandButton("cancel", $this->lng->txt("cancel"));
return $form;
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

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 201 of file class.ilObjectPluginGUI.php.

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

{
$forms = array(
self::CFORM_NEW => $this->initCreateForm($a_new_type),
// self::CFORM_IMPORT => $this->initImportForm($a_new_type),
self::CFORM_CLONE => $this->fillCloneTemplate(null, $a_new_type)
);
return $forms;
}

+ Here is the call graph for this function:

ilObjectPluginGUI::initEditForm ( )

Init object update form.

Returns
ilPropertyFormGUI

Reimplemented from ilObjectGUI.

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

References $ilCtrl, ilObjectGUI\$lng, ilTextAreaInputGUI\setCols(), and ilTextInputGUI\setMaxLength().

{
global $lng, $ilCtrl;
include_once("Services/Form/classes/class.ilPropertyFormGUI.php");
$form = new ilPropertyFormGUI();
$form->setTarget("_top");
$form->setFormAction($ilCtrl->getFormAction($this, "update"));
$form->setTitle($lng->txt("edit"));
// title
$ti = new ilTextInputGUI($lng->txt("title"), "title");
$ti->setMaxLength(128);
$ti->setSize(40);
$ti->setRequired(true);
$form->addItem($ti);
// description
$ta = new ilTextAreaInputGUI($lng->txt("description"), "desc");
$ta->setCols(40);
$ta->setRows(2);
$form->addItem($ta);
$form->addCommandButton("update", $lng->txt("save"));
// $this->form->addCommandButton("cancelUpdate", $lng->txt("cancel"));
return $form;
}

+ Here is the call graph for this function:

ilObjectPluginGUI::initImportForm (   $a_new_type)
protected

Init object import form.

Parameters
stringnew type
Returns
ilPropertyFormGUI

Reimplemented from ilObjectGUI.

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

References ilFileInputGUI\setSuffixes().

{
include_once("Services/Form/classes/class.ilPropertyFormGUI.php");
$form = new ilPropertyFormGUI();
$form->setTarget("_top");
$form->setFormAction($this->ctrl->getFormAction($this, "importFile"));
$form->setTitle($this->lng->txt("import"));
include_once("./Services/Form/classes/class.ilFileInputGUI.php");
$fi = new ilFileInputGUI($this->lng->txt("import_file"), "importfile");
$fi->setSuffixes(array("zip"));
$fi->setRequired(true);
$form->addItem($fi);
$form->addCommandButton("importFile", $this->lng->txt("import"));
$form->addCommandButton("cancel", $this->lng->txt("cancel"));
return $form;
}

+ Here is the call graph for this function:

ilObjectPluginGUI::txt (   $a_var)
finalprotected

Wrapper for txt function.

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

References getPlugin().

Referenced by executeCommand(), getCreationFormTitle(), and initCreateForm().

{
return $this->getPlugin()->txt($a_var);
}

+ 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: