ilObjItemGroupGUI Class Reference

User Interface class for item groups. More...

Inheritance diagram for ilObjItemGroupGUI:

Collaboration diagram for ilObjItemGroupGUI:

Public Member Functions
	getType ()
	Get type. More...
	executeCommand ()
	execute command More...
	addLocatorItems ()
	Add session locator. More...
	initEditCustomForm ($a_form)
	Init edit form, custom part. More...
	listMaterials ()
	show material assignment More...
	saveItemAssignment ()
	Save material assignment. More...
	getTemplate ()
	Get standard template. More...
	setTabs ()
	Set tabs. More...
	gotoParent ()
	Goto item group. More...
	afterSaveCallback (ilObject $a_obj)
	Custom callback after object is created (in parent containert. More...
	getEditFormCustomValues (&$a_values)
	Get edit form values (custom part) More...
	updateCustom (ilPropertyFormGUI $a_form)
	Update (custom part) 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)
	getCreationMode ()
	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 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 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 item group. 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
	afterConstructor ()
	Initialisation. More...
	initCreationForms ($a_new_type)
	afterSave (ilObject $a_new_object)
	After save. More...
	initCreateForm ($a_new_type)
	Init object creation 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 ()
	setTitleAndDescription ()
	showUpperIcon ()
	omitLocator ($a_omit=true)
	getTargetFrame ($a_cmd, $a_target_frame="")
	setTargetFrame ($a_cmd, $a_target_frame)
	getCenterColumnHTML ()
	getRightColumnHTML ()
	setColumnSettings ($column_gui)
	checkPermission ($a_perm, $a_cmd="")
	showPossibleSubObjects ()
	redirectToRefId ()
	fillCloneTemplate ($a_tpl_varname, $a_type)
	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)
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 public More...
	setAdminTabs ()
	set admin tabs 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...

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

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

_goto()

static ilObjItemGroupGUI::_goto (   $a_target )

static

Goto item group.

Definition at line 246 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:

addLocatorItems()

ilObjItemGroupGUI::addLocatorItems

(

)

Add session locator.

public

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"]);
                }
        }

afterConstructor()

ilObjItemGroupGUI::afterConstructor ( )

protected

Initialisation.

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

References ilObjectGUI\$lng.

        {
                global $lng;
                
                $lng->loadLanguageModule("itgr");
                
                $this->ctrl->saveParameter($this, array("ref_id"));
        }

afterSave()

ilObjItemGroupGUI::afterSave ( ilObject  $a_new_object )

protected

After save.

Definition at line 135 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:

afterSaveCallback()

ilObjItemGroupGUI::afterSaveCallback

(

ilObject

$a_obj

)

Custom callback after object is created (in parent containert.

Parameters

ilObject

$a_obj

Definition at line 293 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:

executeCommand()

ilObjItemGroupGUI::executeCommand

(

)

execute command

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:

getEditFormCustomValues()

ilObjItemGroupGUI::getEditFormCustomValues

(

&

$a_values

)

Get edit form values (custom part)

Parameters

array

$a_values

form values

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

        {
                $a_values["hide_title"] = $this->object->getHideTitle();
        }

getTemplate()

ilObjItemGroupGUI::getTemplate

(

)

Get standard template.

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

        {
                $this->tpl->getStandardTemplate();
        }

getType()

ilObjItemGroupGUI::getType ( )

final

Get type.

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

        {
                return "itgr";
        }

gotoParent()

ilObjItemGroupGUI::gotoParent

(

)

Goto item group.

Definition at line 273 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:

initCreateForm()

ilObjItemGroupGUI::initCreateForm (   $a_new_type )

protected

Init object creation form.

Parameters

string

$a_new_type

Returns

ilPropertyFormGUI

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

Referenced by initCreationForms().

        {
                $form = parent::initCreateForm($a_new_type);
                $ta = $form->getItemByPostVar("desc");
                $ta->setInfo($this->lng->txt("itgr_desc_info"));
                return $form;
        }

Here is the caller graph for this function:

initCreationForms()

ilObjItemGroupGUI::initCreationForms (   $a_new_type )

protected

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

References initCreateForm().

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

                return $forms;
        }

Here is the call graph for this function:

initEditCustomForm()

ilObjItemGroupGUI::initEditCustomForm

(

$a_form

)

Init edit form, custom part.

Parameters

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

References ilFormPropertyGUI\setInfo(), and ilTextAreaInputGUI\setRows().

        {
                $a_form->removeItemByPostVar("desc");

                // description
                $ta = new ilTextAreaInputGUI($this->lng->txt("description"), "desc");
                $ta->setRows(2);
                $ta->setInfo($this->lng->txt("itgr_desc_info"));
                $a_form->addItem($ta);

                // hide title
                $cb = new ilCheckboxInputGUI($this->lng->txt("itgr_hide_title"), "hide_title");
                $cb->setInfo($this->lng->txt("itgr_hide_title_info"));
                $a_form->addItem($cb);

        }

Here is the call graph for this function:

listMaterials()

ilObjItemGroupGUI::listMaterials

(

)

show material assignment

protected

Parameters

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

References $tab, ilObjectGUI\$tpl, ilObject2GUI\$tree, and ilObject2GUI\checkPermission().

        {
                global $tree, $ilTabs, $tpl;
                
                $this->checkPermission("write");
                
                $ilTabs->activateTab("materials");
                                
                $parent_ref_id = $tree->getParentId($this->object->getRefId());
                
                include_once "Services/Object/classes/class.ilObjectAddNewItemGUI.php";
                $gui = new ilObjectAddNewItemGUI($parent_ref_id);
                $gui->setDisabledObjectTypes(array("itgr", "sess"));
                $gui->setAfterCreationCallback($this->object->getRefId());
                $gui->render();         
                
                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:

saveItemAssignment()

ilObjItemGroupGUI::saveItemAssignment

(

)

Save material assignment.

Definition at line 174 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:

setTabs()

ilObjItemGroupGUI::setTabs

(

)

Set tabs.

Definition at line 207 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:

updateCustom()

ilObjItemGroupGUI::updateCustom

(

ilPropertyFormGUI

$a_form

)

Update (custom part)

Parameters

ilPropertyFormGUI

$a_form

form

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

References ilPropertyFormGUI\getInput().

        {
                $this->object->setHideTitle($a_form->getInput("hide_title"));
        }

Here is the call graph for this function:

---

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

• Modules/ItemGroup/classes/class.ilObjItemGroupGUI.php