Inheritance diagram for ilContainerReferenceGUI:

Collaboration diagram for ilContainerReferenceGUI:

Public Member Functions
	__construct ($a_data, $a_id, $a_call_by_reference=true, $a_prepare_output=true)
	Constructor. More...

	executeCommand ()
	Execute command. More...

	redirectObject ()
	redirect to target More...

	createObject ()
	Create object. More...

	saveObject ()
	save object More...

	editReferenceObject ()

	editObject (ilPropertyFormGUI $form=null)
	edit title More...

	updateObject ()
	update title More...

	getTargetType ()
	get target type More...

	getReferenceType ()
	get reference type More...

	getTabs ()
	get tabs More...

	getId ()

Public Member Functions inherited from ilObjectGUI
	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...

	prepareOutput ($a_show_subobjects=true)
	prepare output More...

	getAdminTabs ()
	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 ()
	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...

	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...

	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 ()
	viewObject container presentation for "administration -> repository, trash, permissions" More...

	deleteObject ($a_error=false)
	Display deletion confirmation screen. More...

	cloneAllObject ()
	Clone single (not container object) Method is overwritten in ilContainerGUI. More...

	redirectAfterCreation ()
	Redirect after creation, see https://docu.ilias.de/goto_docu_wiki_wpage_5035_1357.html. More...

	addToDeskObject ()

	removeFromDeskObject ()

Data Fields
const	MAX_SELECTION_ENTRIES = 50

const	MODE_CREATE = 1

const	MODE_EDIT = 2

Data Fields inherited from ilObjectGUI
const	COPY_WIZARD_NEEDS_PAGE = 1

	$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 Member Functions
	addLocatorItems ()
	Add locator item. More...

	initCreateForm ($a_new_type)

	afterSave (ilObject $a_new_object)

	firstEditObject ()
	show edit screen without info message More...

	initForm ($a_mode=self::MODE_EDIT)
	Init title form. More...

	loadPropertiesFromSettingsForm (\ilPropertyFormGUI $form)

Protected Member Functions inherited from ilObjectGUI
	getObjectService ()
	Get object service. More...

	assignObject ()

	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...

	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...

	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...

	getTabs ()
	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 (ilColumnGUI $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...

Protected Attributes
	$tabs

	$locator

	$user

	$access

	$error

	$settings

	$existing_objects = array()

	$target_type

	$reference_type

	$form

Protected Attributes inherited from ilObjectGUI
	$ilErr

	$locator

	$user

	$access

	$rbacsystem

	$settings

	$rbacreview

	$toolbar

	$tmp_import_dir

	$tabs_gui = null

	$ctrl

	$object_service

	$favourites

Additional Inherited Members
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...

Detailed Description

Author: Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Version: $Id$

Definition at line 35 of file class.ilContainerReferenceGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilContainerReferenceGUI::__construct	(	$a_data,
		$a_id,
		$a_call_by_reference = `true`,
		$a_prepare_output = `true`
	)

Constructor.

Parameters

Definition at line 93 of file class.ilContainerReferenceGUI.php.

References $DIC, ilObjectGUI\$lng, ILIAS\GlobalScreen\Provider\__construct(), settings(), and user().

     {
         global $DIC;
 
         $this->lng = $DIC->language();
         $this->ctrl = $DIC->ctrl();
         $this->tabs = $DIC->tabs();
         $this->locator = $DIC["ilLocator"];
         $this->user = $DIC->user();
         $this->access = $DIC->access();
         $this->error = $DIC["ilErr"];
         $this->settings = $DIC->settings();
         $lng = $DIC->language();
         parent::__construct($a_data, $a_id, $a_call_by_reference, $a_prepare_output);
 
         $lng->loadLanguageModule('objref');
     }

Here is the call graph for this function:

Member Function Documentation

◆ addLocatorItems()

ilContainerReferenceGUI::addLocatorItems ( )

protected

Add locator item.

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

References $locator.

     {
         $ilLocator = $this->locator;
         
         if ($this->object instanceof ilObject) {
             $ilLocator->addItem($this->object->getPresentationTitle(), $this->ctrl->getLinkTarget($this));
         }
     }

◆ afterSave()

ilContainerReferenceGUI::afterSave ( ilObject $a_new_object )

protected

Parameters

ilObject $a_new_object

Definition at line 234 of file class.ilContainerReferenceGUI.php.

References ilObject\_lookupObjId(), ilObject\getRefId(), ilObject\setTitle(), ilContainerReference\TITLE_TYPE_CUSTOM, and ilObject\update().

     {
         $target_obj_id = ilObject::_lookupObjId((int) $this->form->getInput('target_id'));
         $a_new_object->setTargetId($target_obj_id);
 
         $a_new_object->setTitleType($this->form->getInput('title_type'));
         if ($this->form->getInput('title_type') == ilContainerReference::TITLE_TYPE_CUSTOM) {
             $a_new_object->setTitle($this->form->getInput('title'));
         }
 
         $a_new_object->update();
         
         ilUtil::sendSuccess($this->lng->txt("object_added"), true);
         $this->ctrl->setParameter($this, 'ref_id', $a_new_object->getRefId());
         $this->ctrl->setParameter($this, 'creation_mode', 0);
         $this->ctrl->redirect($this, 'firstEdit');
     }

Here is the call graph for this function:

◆ createObject()

ilContainerReferenceGUI::createObject ( )

Create object.

Returns: void

Definition at line 185 of file class.ilContainerReferenceGUI.php.

References $_GET, $access, $error, $form, ilObjectGUI\$ilErr, $ilSetting, $ilUser, $settings, $user, and initForm().

Referenced by ilObjStudyProgrammeReferenceGUI\saveObject(), and saveObject().

     {
         $ilUser = $this->user;
         $ilAccess = $this->access;
         $ilErr = $this->error;
         $ilSetting = $this->settings;
         
         $new_type = $_REQUEST["new_type"];
         if (!$ilAccess->checkAccess("create_" . $this->getReferenceType(), '', $_GET["ref_id"], $new_type)) {
             $ilErr->raiseError($this->lng->txt("permission_denied"), $ilErr->MESSAGE);
         }
         $form = $this->initForm(self::MODE_CREATE);
         $this->tpl->setContent($form->getHTML());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ editObject()

ilContainerReferenceGUI::editObject ( ilPropertyFormGUI $form = null )

edit title

Parameters

ilPropertyFormGUI $form

Definition at line 270 of file class.ilContainerReferenceGUI.php.

References $DIC, $form, $tabs, and initForm().

     {
         global $DIC;
 
         $main_tpl = $DIC->ui()->mainTemplate();
 
         $ilTabs = $this->tabs;
 
         $ilTabs->setTabActive('settings');
         
         if (!$form instanceof ilPropertyFormGUI) {
             $form = $this->initForm();
         }
         $main_tpl->setContent($form->getHTML());
     }

Here is the call graph for this function:

◆ editReferenceObject()

ilContainerReferenceGUI::editReferenceObject ( )

Definition at line 260 of file class.ilContainerReferenceGUI.php.

References ilObjectGUI\editObject().

     {
         $this->editObject();
     }

Here is the call graph for this function:

◆ executeCommand()

ilContainerReferenceGUI::executeCommand ( )

Execute command.

public

Returns: bool|mixed

Exceptions

ilCtrlException

Definition at line 119 of file class.ilContainerReferenceGUI.php.

References $_GET, ilObjectGUI\$ctrl, $form, $ilCtrl, $tabs, initForm(), ilObjectGUI\prepareOutput(), and ilObjectGUI\setCreationMode().

     {
         $ilCtrl = $this->ctrl;
         $ilTabs = $this->tabs;
 
 
         if (isset($_GET['creation_mode']) && $_GET['creation_mode'] == self::MODE_CREATE) {
             $this->setCreationMode(true);
         }
 
         $next_class = $ilCtrl->getNextClass($this);
         $cmd = $ilCtrl->getCmd();
 
         $this->prepareOutput();
 
         switch ($next_class) {
             case "ilpropertyformgui":
                 $form = $this->initForm($this->creation_mode ? self::MODE_CREATE : self::MODE_EDIT);
                 $this->ctrl->forwardCommand($form);
                 break;
 
             case 'ilpermissiongui':
                 $ilTabs->setTabActive('perm_settings');
                 include_once("Services/AccessControl/classes/class.ilPermissionGUI.php");
                 $ilCtrl->forwardCommand(new ilPermissionGUI($this));
                 break;
 
             default:
                 if (!$cmd || $cmd == 'view') {
                     $cmd = "edit";
                 }
                 $cmd .= "Object";
                 $this->$cmd();
                 break;
         }
         return true;
     }

Here is the call graph for this function:

◆ firstEditObject()

ilContainerReferenceGUI::firstEditObject ( )

protected

show edit screen without info message

Definition at line 255 of file class.ilContainerReferenceGUI.php.

References ilObjectGUI\editObject().

     {
         $this->editObject();
     }

Here is the call graph for this function:

◆ getId()

ilContainerReferenceGUI::getId ( )

Returns: int

Definition at line 487 of file class.ilContainerReferenceGUI.php.

References ilObjectGUI\$obj_id.

     {
         return $this->obj_id;
     }

◆ getReferenceType()

ilContainerReferenceGUI::getReferenceType ( )

get reference type

public

Returns: string

Definition at line 448 of file class.ilContainerReferenceGUI.php.

References $reference_type.

Referenced by ilObjCourseReferenceGUI\getTabs(), and getTabs().

     {
         return $this->reference_type;
     }

Here is the caller graph for this function:

◆ getTabs()

ilContainerReferenceGUI::getTabs ( )

get tabs

public

Parameters

object tabs gui object

Definition at line 459 of file class.ilContainerReferenceGUI.php.

References $DIC, and getReferenceType().

     {
         global $DIC;
 
         $ilHelp = $DIC['ilHelp'];
         $ilHelp->setScreenIdComponent($this->getReferenceType());
 
         if ($this->access->checkAccess('write', '', $this->object->getRefId())) {
             $this->tabs_gui->addTarget(
                 "settings",
                 $this->ctrl->getLinkTarget($this, "edit"),
                 array(),
                 ""
             );
         }
         if ($this->access->checkAccess('edit_permission', '', $this->object->getRefId())) {
             $this->tabs_gui->addTarget(
                 "perm_settings",
                 $this->ctrl->getLinkTargetByClass(array(get_class($this),'ilpermissiongui'), "perm"),
                 array("perm","info","owner"),
                 'ilpermissiongui'
             );
         }
     }

Here is the call graph for this function:

◆ getTargetType()

ilContainerReferenceGUI::getTargetType ( )

get target type

public

Returns: string

Definition at line 437 of file class.ilContainerReferenceGUI.php.

References $target_type.

Referenced by initForm().

     {
         return $this->target_type;
     }

Here is the caller graph for this function:

◆ initCreateForm()

ilContainerReferenceGUI::initCreateForm ( $a_new_type )

protected

Definition at line 226 of file class.ilContainerReferenceGUI.php.

References initForm().

     {
         return $this->initForm(self::MODE_CREATE);
     }

Here is the call graph for this function:

◆ initForm()

ilContainerReferenceGUI::initForm ( $a_mode = self::MODE_EDIT )

protected

Init title form.

Parameters

int $a_mode

Returns: ilPropertyFormGUI

Definition at line 291 of file class.ilContainerReferenceGUI.php.

References $form, getTargetType(), ilFormPropertyGUI\setRequired(), ilRadioGroupInputGUI\setValue(), ilRadioOption\setValue(), ilObject\TITLE_LENGTH, ilContainerReference\TITLE_TYPE_CUSTOM, and ilContainerReference\TITLE_TYPE_REUSE.

Referenced by createObject(), editObject(), executeCommand(), initCreateForm(), and updateObject().

     {
         include_once './Services/Form/classes/class.ilPropertyFormGUI.php';
         include_once './Services/ContainerReference/classes/class.ilContainerReference.php';
         $form = new ilPropertyFormGUI();
 
         if ($a_mode == self::MODE_CREATE) {
             $form->setTitle($this->lng->txt($this->getReferenceType() . '_new'));
 
             $this->ctrl->setParameter($this, 'creation_mode', $a_mode);
             $this->ctrl->setParameter($this, 'new_type', $_REQUEST['new_type']);
         } else {
             $form->setTitle($this->lng->txt('edit'));
         }
 
         $form->setFormAction($this->ctrl->getFormAction($this));
         if ($a_mode == self::MODE_CREATE) {
             $form->addCommandButton('save', $this->lng->txt('create'));
             $form->addCommandButton('cancel', $this->lng->txt('cancel'));
         } else {
             $form->addCommandButton('update', $this->lng->txt('save'));
         }
 
         // title type
         $ttype = new ilRadioGroupInputGUI($this->lng->txt('title'), 'title_type');
         if ($a_mode == self::MODE_EDIT) {
             $ttype->setValue($this->object->getTitleType());
         } else {
             $ttype->setValue(ilContainerReference::TITLE_TYPE_REUSE);
         }
 
         $reuse = new ilRadioOption($this->lng->txt('objref_reuse_title'));
         $reuse->setValue(ilContainerReference::TITLE_TYPE_REUSE);
         $ttype->addOption($reuse);
         
         $custom = new ilRadioOption($this->lng->txt('objref_custom_title'));
         $custom->setValue(ilContainerReference::TITLE_TYPE_CUSTOM);
         
         // title
         $title = new ilTextInputGUI($this->lng->txt('title'), 'title');
         $title->setSize(min(40, ilObject::TITLE_LENGTH));
         $title->setMaxLength(ilObject::TITLE_LENGTH);
         $title->setRequired(true);
 
         if ($a_mode == self::MODE_EDIT) {
             $title->setValue($this->object->getTitle());
         }
 
         $custom->addSubItem($title);
         $ttype->addOption($custom);
         $form->addItem($ttype);
 
         include_once("./Services/Form/classes/class.ilRepositorySelector2InputGUI.php");
         $repo = new ilRepositorySelector2InputGUI($this->lng->txt("objref_edit_ref"), "target_id");
         //$repo->setParent($this);
         $repo->setRequired(true);
         $repo->getExplorerGUI()->setSelectableTypes(array($this->getTargetType()));
         $repo->getExplorerGUI()->setTypeWhiteList(
             array_merge(
                 array($this->getTargetType()),
                 array("root", "cat", "grp", "fold", "crs")
         )
         );
         $repo->setInfo($this->lng->txt($this->getReferenceType() . '_edit_info'));
 
         if ($a_mode == self::MODE_EDIT) {
             $repo->getExplorerGUI()->setPathOpen($this->object->getTargetRefId());
             $repo->setValue($this->object->getTargetRefId());
         }
 
         $form->addItem($repo);
         $this->form = $form;
         return $form;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ loadPropertiesFromSettingsForm()

ilContainerReferenceGUI::loadPropertiesFromSettingsForm ( \ilPropertyFormGUI $form )

protected

Parameters

\ilPropertyFormGUI $form

Returns: bool

Definition at line 371 of file class.ilContainerReferenceGUI.php.

References $access, $DIC, $ok, ilObject\_lookupObjId(), ilObject\_lookupType(), ilPropertyFormGUI\getInput(), ilPropertyFormGUI\getItemByPostVar(), and ilContainerReference\TITLE_TYPE_CUSTOM.

Referenced by updateObject().

                                                                                 : bool
     {
         global $DIC;
 
         $ok = true;
         $access = $DIC->access();
 
         $this->object->setTitleType($form->getInput('title_type'));
         if ($form->getInput('title_type') == ilContainerReference::TITLE_TYPE_CUSTOM) {
             $this->object->setTitle($form->getInput('title'));
         }
 
         // check access
         if (
             !$access->checkAccess('visible', '', (int) $form->getInput('target_id'))
         ) {
             $ok = false;
             $form->getItemByPostVar('target_id')->setAlert($this->lng->txt('permission_denied'));
         }
         // check target type
         if (ilObject::_lookupType($form->getInput('target_id'), true) != $this->target_type) {
             $ok = false;
             $form->getItemByPostVar('target_id')->setAlert(
                 $this->lng->txt('objref_failure_target_type') .
                 ': ' .
                 $this->lng->txt('obj_' . $this->target_type)
             );
         }
 
         $this->object->setTargetId(
             \ilObject::_lookupObjId((int) $form->getInput('target_id'))
         );
 
         return $ok;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ redirectObject()

ilContainerReferenceGUI::redirectObject ( )

redirect to target

Parameters

Definition at line 172 of file class.ilContainerReferenceGUI.php.

References ilObjectGUI\$ctrl, and $ilCtrl.

     {
         $ilCtrl = $this->ctrl;
         
         $ilCtrl->setParameterByClass("ilrepositorygui", "ref_id", $this->object->getTargetRefId());
         $ilCtrl->redirectByClass("ilrepositorygui", "");
     }

◆ saveObject()

ilContainerReferenceGUI::saveObject ( )

save object

public

Parameters

Definition at line 208 of file class.ilContainerReferenceGUI.php.

References $access, createObject(), and ilUtil\sendFailure().

     {
         $ilAccess = $this->access;
         
         if (!(int) $_REQUEST['target_id']) {
             ilUtil::sendFailure($this->lng->txt('select_one'));
             $this->createObject();
             return false;
         }
         if (!$ilAccess->checkAccess('visible', '', (int) $_REQUEST['target_id'])) {
             ilUtil::sendFailure($this->lng->txt('permission_denied'));
             $this->createObject();
             return false;
         }
         
         parent::saveObject();
     }

Here is the call graph for this function:

◆ updateObject()

ilContainerReferenceGUI::updateObject ( )

update title

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

References $access, $form, ilObjectGUI\checkPermission(), ilObjectGUI\editObject(), initForm(), loadPropertiesFromSettingsForm(), and ilUtil\sendFailure().

     {
         $this->checkPermission('write');
 
         $ilAccess = $this->access;
         $form = $this->initForm();
         if (
             $form->checkInput() &&
             $this->loadPropertiesFromSettingsForm($form)
         ) {
             $this->object->update();
             ilUtil::sendSuccess($this->lng->txt('settings_saved'), true);
             $this->ctrl->redirect($this, 'edit');
         }
         $form->setValuesByPost();
         ilUtil::sendFailure($this->lng->txt('err_check_input'));
         $this->editObject($form);
         return true;
     }