ilObjCourseReferenceGUI Class Reference

Inheritance diagram for ilObjCourseReferenceGUI:

Collaboration diagram for ilObjCourseReferenceGUI:

Public Member Functions
	__construct ($a_data, $a_id, $a_call_by_reference=true, $a_prepare_output=true)
	Constructor. More...
	executeCommand ()
	Execute command. More...
	getTabs ()
	Add tabs. More...
	initForm ($a_mode=self::MODE_EDIT)
Public Member Functions inherited from ilContainerReferenceGUI
	__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 ()

Static Public Member Functions
static	_goto ($a_target)
	Support for goto php. 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
	loadPropertiesFromSettingsForm (ilPropertyFormGUI $form)
Protected Member Functions inherited from ilContainerReferenceGUI
	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
	$target_type = 'crs'
	$reference_type = 'crsr'
Protected Attributes inherited from ilContainerReferenceGUI
	$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

Private Attributes
	$logger = null

Additional Inherited Members
Data Fields inherited from ilContainerReferenceGUI
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

Detailed Description

Author

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

Version

$Id$

ilObjCourseReferenceGUI: ilPermissionGUI, ilInfoScreenGUI, ilPropertyFormGUI ilObjCourseReferenceGUI: ilCommonActionDispatcherGUI, ilLearningProgressGUI

Definition at line 36 of file class.ilObjCourseReferenceGUI.php.

Constructor & Destructor Documentation

__construct()

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

Constructor.

Parameters

Definition at line 51 of file class.ilObjCourseReferenceGUI.php.

References $DIC, and ILIAS\GlobalScreen\Provider\__construct().

    {
        global $DIC;

        $this->logger = $DIC->logger()->crsr();

        parent::__construct($a_data, $a_id, true, false);

        $this->lng->loadLanguageModule('crs');
    }

Here is the call graph for this function:

Member Function Documentation

_goto()

static ilObjCourseReferenceGUI::_goto (   $a_target )

static

Support for goto php.

Returns

void

Definition at line 203 of file class.ilObjCourseReferenceGUI.php.

References ilContainerReferenceGUI\$access, ilObjectGUI\$ctrl, $DIC, $logger, ilObject\_lookupObjId(), and ilContainerReference\_lookupTargetRefId().

    {
        global $DIC;

        $access = $DIC->access();
        $ctrl = $DIC->ctrl();
        $logger = $DIC->logger()->crsr();

        $target_ref_id = $a_target;
        $write_access = $access->checkAccess('write', '', (int) $target_ref_id);


        if ($write_access) {
            $target_class = \ilObjCourseReferenceGUI::class;
        } else {
            $target_ref_id = \ilContainerReference::_lookupTargetRefId(\ilObject::_lookupObjId($target_ref_id));
            $target_class = \ilObjCourseGUI::class;
        }

        $ctrl->initBaseClass(ilRepositoryGUI::class);
        $ctrl->setParameterByClass($target_class, 'ref_id', $target_ref_id);
        $ctrl->redirectByClass(
            [
                \ilRepositoryGUI::class,
                $target_class
            ],
            'edit'
        );
    }

Here is the call graph for this function:

executeCommand()

ilObjCourseReferenceGUI::executeCommand

(

)

Execute command.

public

Definition at line 68 of file class.ilObjCourseReferenceGUI.php.

References $DIC, ilContainerReferenceGUI\$user, ilLearningProgressBaseGUI\LP_CONTEXT_REPOSITORY, and ilObjectGUI\prepareOutput().

    {
        global $DIC;

        $user = $DIC->user();

        $next_class = $this->ctrl->getNextClass($this);
        switch ($next_class) {
            case 'illearningprogressgui':
                $this->prepareOutput();
                $this->tabs_gui->activateTab('learning_progress');
                $lp_gui = new \ilLearningProgressGUI(
                    ilLearningProgressGUI::LP_CONTEXT_REPOSITORY,
                    $this->object->getRefId(),
                    $user->getId()
                );
                $this->ctrl->forwardCommand($lp_gui);
                return;
        }
        parent::executeCommand();
    }

Here is the call graph for this function:

getTabs()

ilObjCourseReferenceGUI::getTabs

(

)

Add tabs.

public

Definition at line 95 of file class.ilObjCourseReferenceGUI.php.

References $DIC, ilLearningProgressAccess\checkAccess(), and ilContainerReferenceGUI\getReferenceType().

    {
        global $DIC;

        $help = $DIC->help();
        $help->setScreenIdComponent($this->getReferenceType());

        if ($this->access->checkAccess('write', '', $this->object->getRefId())) {
            $this->tabs_gui->addTab(
                'settings',
                $this->lng->txt('settings'),
                $this->ctrl->getLinkTarget($this, 'edit')
            );
        }

        if (ilLearningProgressAccess::checkAccess($this->object->getRefId(), false)) {
            $this->tabs_gui->addTab(
                'learning_progress',
                $this->lng->txt('learning_progress'),
                $this->ctrl->getLinkTargetByClass(
                    [
                        ilObjCourseReferenceGUI::class,
                        ilLearningProgressGUI::class
                    ],
                    ''
                )
            );
        }
        if ($this->access->checkAccess('edit_permission', '', $this->object->getRefId())) {
            $this->tabs_gui->addTab(
                'perm_settings',
                $this->lng->txt('perm_settings'),
                $this->ctrl->getLinkTargetByClass(
                    [
                        ilObjCourseReferenceGUI::class,
                        ilPermissionGUI::class
                    ],
                    'perm'
                )
            );
        }
    }

Here is the call graph for this function:

initForm()

ilObjCourseReferenceGUI::initForm

(

$a_mode = self::MODE_EDIT

)

Definition at line 142 of file class.ilObjCourseReferenceGUI.php.

References ilContainerReferenceGUI\$access, ilContainerReferenceGUI\$form, and ilCourseReferencePathInfo\getInstanceByRefId().

    {
        $form = parent::initForm($a_mode);

        if ($a_mode == self::MODE_CREATE) {
            return $form;
        }

        $path_info = \ilCourseReferencePathInfo::getInstanceByRefId($this->object->getRefId(), $this->object->getTargetRefId());


        // nothing todo if no parent course is in path
        if (!$path_info->hasParentCourse()) {
            return $form;
        }

        $access = $path_info->checkManagmentAccess();

        $auto_update = new \ilCheckboxInputGUI($this->lng->txt('crs_ref_member_update'), 'member_update');
        $auto_update->setChecked($this->object->isMemberUpdateEnabled());
        $auto_update->setInfo($this->lng->txt('crs_ref_member_update_info'));
        $auto_update->setDisabled(!$access);
        $form->addItem($auto_update);

        return $form;
    }

Here is the call graph for this function:

loadPropertiesFromSettingsForm()

ilObjCourseReferenceGUI::loadPropertiesFromSettingsForm ( ilPropertyFormGUI  $form )

protected

Parameters

\ilPropertyFormGUI

$form

Returns

bool

Definition at line 173 of file class.ilObjCourseReferenceGUI.php.

References $ok, ilPropertyFormGUI\getInput(), ilCourseReferencePathInfo\getInstanceByRefId(), and ilPropertyFormGUI\getItemByPostVar().

                                                                               : bool
    {
        $ok = true;
        $ok = parent::loadPropertiesFromSettingsForm($form);

        $path_info = ilCourseReferencePathInfo::getInstanceByRefId($this->object->getRefId(), $this->object->getTargetRefId());

        $auto_update = $form->getInput('member_update');
        if ($auto_update && !$path_info->hasParentCourse()) {
            $ok = false;
            $form->getItemByPostVar('member_update')->setAlert($this->lng->txt('crs_ref_missing_parent_crs'));
        }
        if ($auto_update && !$path_info->checkManagmentAccess()) {
            $ok = false;
            $form->getItemByPostVar('member_update')->setAlert($this->lng->txt('crs_ref_missing_access'));
        }

        // check manage members
        $this->object->enableMemberUpdate((bool) $form->getInput('member_update'));

        return $ok;
    }

Here is the call graph for this function:

Field Documentation

$logger

ilObjCourseReferenceGUI::$logger = null

private

Definition at line 41 of file class.ilObjCourseReferenceGUI.php.

Referenced by _goto().

$reference_type

ilObjCourseReferenceGUI::$reference_type = 'crsr'

protected

Definition at line 44 of file class.ilObjCourseReferenceGUI.php.

$target_type

ilObjCourseReferenceGUI::$target_type = 'crs'

protected

Definition at line 43 of file class.ilObjCourseReferenceGUI.php.

---

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

• Modules/CourseReference/classes/class.ilObjCourseReferenceGUI.php