ILIAS  release_4-3 Revision
 All Data Structures Namespaces Files Functions Variables Groups Pages
Public Member Functions | Protected Member Functions
ilObjItemGroupGUI Class Reference

User Interface class for item groups. More...

+ Inheritance diagram for ilObjItemGroupGUI:
+ Collaboration diagram for ilObjItemGroupGUI:

Public Member Functions

 getType ()
 Get type.
 executeCommand ()
 execute command
 addLocatorItems ()
 Add session locator.
 listMaterials ()
 show material assignment
 saveItemAssignment ()
 Save material assignment.
 getTemplate ()
 Get standard template.
 setTabs ()
 Set tabs.
 _goto ($a_target)
 Goto item group.
 gotoParent ()
 Goto item group.
 afterSaveCallback (ilObject $a_obj)
 Custom callback after object is created (in parent containert.
- Public Member Functions inherited from ilObject2GUI
 __construct ($a_id=0, $a_id_type=self::REPOSITORY_NODE_ID, $a_parent_node_id=0)
 Constructor.
 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 ()
 view ()
 view object content (repository/workspace switch)
 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
 confirmedDeleteObject ()
 confirmed deletion of object -> objects are moved to trash or deleted immediately, if trash is disabled
 cancelDeleteObject ()
 cancel deletion of object
 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.
 cloneAllObject ()
 Clone single (not container object) Method is overwritten in ilContainerGUI.

Protected Member Functions

 afterConstructor ()
 Initialisation.
 initCreationForms ($a_new_type)
 Init creation froms.
 afterSave (ilObject $a_new_object)
 After save.
- Protected Member Functions inherited from ilObject2GUI
 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)
 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)
 initCreateForm ($a_new_type)
 Init object creation form.
 initDidacticTemplate (ilPropertyFormGUI $form)
 Show didactic template types.
 addDidacticTemplateOptions (array &$a_options)
 Add custom templates.
 getDidacticTemplateVar ($a_type)
 Get didactic template setting from creation screen.
 initEditForm ()
 Init object edit form.
 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.
 initImportForm ($a_new_type)
 Init object import form.
 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
 getTemplateFile ($a_cmd, $a_type="")
 get a template blockfile format: tpl.
 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.

Additional Inherited Members

- Static Public Member Functions inherited from ilObjectGUI
static _gotoRepositoryRoot ($a_raise_error=false)
 Goto repository root.
static _gotoRepositoryNode ($a_ref_id, $a_cmd="frameset")
 Goto repository root.
- 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

User Interface class for item groups.

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

$Id$

ilObjItemGroupGUI: ilPermissionGUI ilObjItemGroupGUI: ilCommonActionDispatcherGUI, ilObjectCopyGUI ilObjItemGroupGUI: ilRepositoryGUI, ilAdministrationGUI

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

Member Function Documentation

ilObjItemGroupGUI::_goto (   $a_target)

Goto item group.

Definition at line 261 of file class.ilObjItemGroupGUI.php.

References $ilErr, ilObjectGUI\$lng, ilObjectGUI\$ref_id, ilObject2GUI\$tree, ilLink\_getLink(), ilObjectGUI\_gotoRepositoryRoot(), ilObject\_lookupObjId(), ilObject\_lookupTitle(), exit, ilUtil\redirect(), and ilUtil\sendFailure().

{
global $ilAccess, $ilErr, $lng, $tree;
$targets = explode('_',$a_target);
$ref_id = $targets[0];
$par_id = $tree->getParentId($ref_id);
if ($ilAccess->checkAccess("read", "", $par_id))
{
include_once("./Services/Link/classes/class.ilLink.php");
ilUtil::redirect(ilLink::_getLink($par_id));
exit;
}
else if ($ilAccess->checkAccess("read", "", ROOT_FOLDER_ID))
{
ilUtil::sendFailure(sprintf($lng->txt("msg_no_perm_read_item"),
ilObject::_lookupTitle(ilObject::_lookupObjId($a_target))), true);
ilObjectGUI::_gotoRepositoryRoot();
}
$ilErr->raiseError($lng->txt("msg_no_perm_read"), $ilErr->FATAL);
}

+ Here is the call graph for this function:

ilObjItemGroupGUI::addLocatorItems ( )

Add session locator.

public

Reimplemented from ilObject2GUI.

Definition at line 90 of file class.ilObjItemGroupGUI.php.

References $_GET.

{
global $ilLocator, $ilAccess;
if (is_object($this->object) && $ilAccess->checkAccess("write", "", $this->object->getRefId()))
{
$ilLocator->addItem($this->object->getTitle(), $this->ctrl->getLinkTarget($this, "listMaterials"), "", $_GET["ref_id"]);
}
}
ilObjItemGroupGUI::afterConstructor ( )
protected

Initialisation.

Reimplemented from ilObject2GUI.

Definition at line 25 of file class.ilObjItemGroupGUI.php.

References ilObjectGUI\$lng.

{
global $lng;
$lng->loadLanguageModule("itgr");
$this->ctrl->saveParameter($this, array("ref_id"));
}
ilObjItemGroupGUI::afterSave ( ilObject  $a_new_object)
protected

After save.

Reimplemented from ilObjectGUI.

Definition at line 111 of file class.ilObjItemGroupGUI.php.

References $ilCtrl, and ilUtil\sendSuccess().

{
global $ilCtrl;
ilUtil::sendSuccess($this->lng->txt("object_added"), true);
$ilCtrl->redirect($this, "listMaterials");
}

+ Here is the call graph for this function:

ilObjItemGroupGUI::afterSaveCallback ( ilObject  $a_obj)

Custom callback after object is created (in parent containert.

Parameters
ilObject$a_obj

Definition at line 308 of file class.ilObjItemGroupGUI.php.

References ilItemGroupItems\addItem(), and ilObject\getRefId().

{
// add new object to materials
include_once './Modules/ItemGroup/classes/class.ilItemGroupItems.php';
$items = new ilItemGroupItems($this->object->getRefId());
$items->addItem($a_obj->getRefId());
$items->update();
}

+ Here is the call graph for this function:

ilObjItemGroupGUI::executeCommand ( )

execute command

Reimplemented from ilObject2GUI.

Definition at line 45 of file class.ilObjItemGroupGUI.php.

References $cmd, $ilCtrl, ilObjectGUI\$lng, $ret, ilObjectGUI\$tpl, ilObjectGUI\addHeaderAction(), ilCommonActionDispatcherGUI\getInstanceFromAjaxCall(), and ilObject2GUI\prepareOutput().

{
global $ilTabs, $lng, $ilAccess, $tpl, $ilCtrl, $ilLocator;
$next_class = $this->ctrl->getNextClass($this);
$cmd = $this->ctrl->getCmd();
switch($next_class)
{
case 'ilinfoscreengui':
$this->prepareOutput();
$this->addHeaderAction();
$this->infoScreen();
break;
case 'ilpermissiongui':
$this->prepareOutput();
$ilTabs->activateTab("perm_settings");
$this->addHeaderAction();
include_once("Services/AccessControl/classes/class.ilPermissionGUI.php");
$perm_gui =& new ilPermissionGUI($this);
$ret = $this->ctrl->forwardCommand($perm_gui);
break;
case "ilcommonactiondispatchergui":
include_once("Services/Object/classes/class.ilCommonActionDispatcherGUI.php");
$gui = ilCommonActionDispatcherGUI::getInstanceFromAjaxCall();
$this->ctrl->forwardCommand($gui);
break;
default:
$cmd = $this->ctrl->getCmd("listMaterials");
$this->prepareOutput();
$this->addHeaderAction();
$this->$cmd();
break;
}
}

+ Here is the call graph for this function:

ilObjItemGroupGUI::getTemplate ( )

Get standard template.

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

{
$this->tpl->getStandardTemplate();
}
ilObjItemGroupGUI::getType ( )
final

Get type.

Reimplemented from ilObject2GUI.

Definition at line 37 of file class.ilObjItemGroupGUI.php.

{
return "itgr";
}
ilObjItemGroupGUI::gotoParent ( )

Goto item group.

Definition at line 288 of file class.ilObjItemGroupGUI.php.

References $ilErr, ilObjectGUI\$lng, ilObjectGUI\$ref_id, ilObject2GUI\$tree, ilLink\_getLink(), exit, and ilUtil\redirect().

{
global $ilAccess, $ilErr, $lng, $tree;
$ref_id = $this->object->getRefId();
$par_id = $tree->getParentId($ref_id);
if ($ilAccess->checkAccess("read", "", $par_id))
{
include_once("./Services/Link/classes/class.ilLink.php");
ilUtil::redirect(ilLink::_getLink($par_id));
exit;
}
}

+ Here is the call graph for this function:

ilObjItemGroupGUI::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 100 of file class.ilObjItemGroupGUI.php.

References ilObjectGUI\initCreateForm().

{
$forms = array(self::CFORM_NEW => $this->initCreateForm($a_new_type)
);
return $forms;
}

+ Here is the call graph for this function:

ilObjItemGroupGUI::listMaterials ( )

show material assignment

protected

Parameters
@return

Definition at line 126 of file class.ilObjItemGroupGUI.php.

References ilObjectGUI\$objDefinition, $tab, $title, ilObjectGUI\$tpl, ilObject2GUI\$tree, ilObject\_getIcon(), ilObject2GUI\checkPermission(), ilPlugin\lookupTxt(), and ilObjectDefinition\MODE_REPOSITORY.

{
global $tree, $objDefinition, $ilTabs, $tpl, $ilAccess;
$this->checkPermission("write");
$ilTabs->activateTab("materials");
// add new item
$parent_node = $tree->getNodeData($tree->getParentId($this->object->getRefId()));
$subtypes = $objDefinition->getCreatableSubObjects($parent_node['type'], ilObjectDefinition::MODE_REPOSITORY);
if($subtypes)
{
$subobj = array();
foreach($subtypes as $type => $sub_item)
{
if (!in_array($type, array("itgr", "sess")))
{
// #9950
if ($ilAccess->checkAccess("create_".$type, "", $parent_node["child"], $parent_node["type"]))
{
// #10787
$title = $this->lng->txt('obj_'.$type);
if ($sub_item["plugin"])
{
include_once("./Services/Component/classes/class.ilPlugin.php");
$title = ilPlugin::lookupTxt("rep_robj", $type, "obj_".$type);
}
$subobj[] = array('value' => $type,
'title' => $title,
'img' => ilObject::_getIcon('', 'tiny', $type),
'alt' => $title);
}
}
}
if(sizeof($subobj))
{
// add new object to parent container instead
$this->ctrl->setParameter($this, 'ref_id', $parent_node["child"]);
// $this->ctrl->setParameter($this, 'crtptrefid', $parent_node["child"]);
// force after creation callback
$this->ctrl->setParameter($this, 'crtcb', $this->object->getRefId());
$this->lng->loadLanguageModule('cntr');
$this->tpl->setCreationSelector($this->ctrl->getFormAction($this),
$subobj, 'create', $this->lng->txt('add'));
$this->ctrl->setParameter($this, 'ref_id', $this->object->getRefId());
// $this->ctrl->setParameter($this, 'crtptrefid', '');
$this->ctrl->setParameter($this, 'crtcb', '');
}
}
include_once("./Modules/ItemGroup/classes/class.ilItemGroupItemsTableGUI.php");
$tab = new ilItemGroupItemsTableGUI($this, "listMaterials");
$tpl->setContent($tab->getHTML());
}

+ Here is the call graph for this function:

ilObjItemGroupGUI::saveItemAssignment ( )

Save material assignment.

Definition at line 189 of file class.ilObjItemGroupGUI.php.

References $_POST, $ilCtrl, ilObject2GUI\checkPermission(), ilUtil\sendSuccess(), and ilUtil\stripSlashesArray().

{
global $ilCtrl;
$this->checkPermission("write");
include_once './Modules/ItemGroup/classes/class.ilItemGroupItems.php';
$item_group_items = new ilItemGroupItems($this->object->getRefId());
$items = is_array($_POST['items'])
? $_POST['items']
: array();
$items = ilUtil::stripSlashesArray($items);
$item_group_items->setItems($items);
$item_group_items->update();
ilUtil::sendSuccess($this->lng->txt('msg_obj_modified'), true);
$ilCtrl->redirect($this, "listMaterials");
}

+ Here is the call graph for this function:

ilObjItemGroupGUI::setTabs ( )

Set tabs.

Reimplemented from ilObject2GUI.

Definition at line 222 of file class.ilObjItemGroupGUI.php.

References $ilCtrl, ilObjectGUI\$lng, ilObject2GUI\$tree, ilLink\_getLink(), ilObject\_lookupObjId(), and ilObject\_lookupType().

{
global $ilAccess, $ilTabs, $ilCtrl, $ilHelp, $lng, $tree;
$ilHelp->setScreenIdComponent("itgr");
$parent_ref_id = $tree->getParentId($this->object->getRefId());
$parent_obj_id = ilObject::_lookupObjId($parent_ref_id);
$parent_type = ilObject::_lookupType($parent_obj_id);
include_once("./Services/Link/classes/class.ilLink.php");
$ilTabs->setBackTarget(
$lng->txt('obj_'.$parent_type),
ilLink::_getLink($parent_ref_id), "_top");
if ($ilAccess->checkAccess("write", "", $this->object->getRefId()))
{
$ilTabs->addTab('materials',
$lng->txt('itgr_materials'),
$this->ctrl->getLinkTarget($this, 'listMaterials'));
$ilTabs->addTab('settings',
$lng->txt('settings'),
$this->ctrl->getLinkTarget($this, 'edit'));
}
if ($ilAccess->checkAccess("edit_permission", "", $this->object->getRefId()))
{
$ilTabs->addTab("perm_settings",
$lng->txt('perm_settings'),
$this->ctrl->getLinkTargetByClass(array(get_class($this),'ilpermissiongui'), "perm")
);
}
}

+ Here is the call graph for this function:

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