ilObjStudyProgrammeReferenceGUI Class Reference

ilObjStudyProgrammeReferenceGUI: ilPermissionGUI, ilInfoScreenGUI, ilPropertyFormGUI More...

Inheritance diagram for ilObjStudyProgrammeReferenceGUI:

Collaboration diagram for ilObjStudyProgrammeReferenceGUI:

Public Member Functions
	__construct ($a_data, $a_id, $a_call_by_reference=true, $a_prepare_output=false)
	ilObjGroupReferenceGUI constructor. More...
	saveObject ()
	save object More...
	putObjectInTree (ilObject $a_obj, $a_parent_node_id=null)
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 ()
Public Member Functions inherited from ILIAS\Object\ImplementsCreationCallback
	callCreationCallback (\ilObject $object, \ilObjectDefinition $obj_definition, int $requested_crtcb)

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
	tryingToCreateCircularReference ($obj_to_be_referenced, $reference_position)
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...

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	ALLOWED_TAGS_IN_TITLE_AND_DESCRIPTION
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 Attributes inherited from ilContainerReferenceGUI
	$tabs
	$locator
	$user
	$access
	$error
	$settings
	$existing_objects = array()
	$target_type
	$reference_type
	$form
Protected Attributes inherited from ilObjectGUI
const	UPLOAD_TYPE_LOCAL = 1
const	UPLOAD_TYPE_UPLOAD_DIRECTORY = 2
	$ilErr
	$locator
	$user
	$access
	$rbacsystem
	$settings
	$rbacreview
	$toolbar
	$tmp_import_dir
	$tabs_gui = null
	$ctrl
	$object_service
	$favourites
	$request

Detailed Description

ilObjStudyProgrammeReferenceGUI: ilPermissionGUI, ilInfoScreenGUI, ilPropertyFormGUI

Definition at line 5 of file class.ilObjStudyProgrammeReferenceGUI.php.

Constructor & Destructor Documentation

__construct()

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

ilObjGroupReferenceGUI constructor.

Parameters

	$a_data
int	$a_id
bool	$a_call_by_reference
bool	$a_prepare_output

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

References ILIAS\GlobalScreen\Provider\__construct().

    {
        $this->target_type = 'prg';
        $this->reference_type = 'prgr';
        parent::__construct($a_data, $a_id, $a_call_by_reference, $a_prepare_output);
    }

Here is the call graph for this function:

Member Function Documentation

_goto()

static ilObjStudyProgrammeReferenceGUI::_goto (   $a_target )

static

Support for goto php.

Parameters

int

$a_target

Definition at line 26 of file class.ilObjStudyProgrammeReferenceGUI.php.

References ilObjStudyProgrammeGUI\_goto(), ilObject\_lookupObjId(), and ilContainerReference\_lookupTargetRefId().

    {
        $target_ref_id = ilContainerReference::_lookupTargetRefId(ilObject::_lookupObjId($a_target));
        ilObjStudyProgrammeGUI::_goto($target_ref_id);
    }

Here is the call graph for this function:

putObjectInTree()

ilObjStudyProgrammeReferenceGUI::putObjectInTree	(	ilObject	$a_obj,
			$a_parent_node_id = null
	)

Definition at line 61 of file class.ilObjStudyProgrammeReferenceGUI.php.

References ilObject\_lookupObjId(), and ilObject\update().

    {
        // when this is called, the target allready should be defined...
        $target_obj_id = ilObject::_lookupObjId((int) $this->form->getInput('target_id'));
        $a_obj->setTargetId($target_obj_id);
        $a_obj->update();
        parent::putObjectInTree($a_obj, $a_parent_node_id);
    }

Here is the call graph for this function:

saveObject()

ilObjStudyProgrammeReferenceGUI::saveObject

(

)

save object

public

Parameters

Definition at line 39 of file class.ilObjStudyProgrammeReferenceGUI.php.

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

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

Here is the call graph for this function:

tryingToCreateCircularReference()

ilObjStudyProgrammeReferenceGUI::tryingToCreateCircularReference (   $obj_to_be_referenced,   $reference_position  )

protected

Definition at line 70 of file class.ilObjStudyProgrammeReferenceGUI.php.

References ilObject\_getAllReferences(), ilObject\_lookupObjId(), ilContainerReference\_lookupSourceIds(), and ilObject\_lookupType().

Referenced by saveObject().

    {
        if ($reference_position === $obj_to_be_referenced) {
            return true;
        }
        $queque = [$reference_position];
        while ($parent = array_shift($queque)) {
            $p_parent = (int) $this->tree->getParentId($parent);
            if ($p_parent === $obj_to_be_referenced) {
                return true;
            }
            if (ilObject::_lookupType($p_parent, true) === 'prg') {
                array_push($queque, $p_parent);
            }
            foreach (ilContainerReference::_lookupSourceIds(ilObject::_lookupObjId($parent)) as $parent_ref_obj_id) {
                $parent_ref_ref_id = (int) array_shift(ilObject::_getAllReferences($parent_ref_obj_id));
                $parent_ref_loc = (int) $this->tree->getParentId($parent_ref_ref_id);
                if ($parent_ref_loc === $obj_to_be_referenced) {
                    return true;
                }
                if (ilObject::_lookupType($parent_ref_loc, true) === 'prg') {
                    array_push($queque, $parent_ref_loc);
                }
            }
        }
        return false;
    }

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:

• Modules/StudyProgrammeReference/classes/class.ilObjStudyProgrammeReferenceGUI.php