ilObjRemoteCourseGUI Class Reference

Inheritance diagram for ilObjRemoteCourseGUI:

Collaboration diagram for ilObjRemoteCourseGUI:

Public Member Functions
	__construct ($a_data, $a_id, $a_call_by_reference=true, $a_prepare_output=true)
	Contructor.
	executeCommand ()
	Execute command.
	showObject ()
	show remote course
	getTabs ($tabs_gui)
	get tabs
	callObject ()
	call remote course
	infoScreenObject ()
	this one is called from the info button in the repository not very nice to set cmdClass/Cmd manually, if everything works through ilCtrl in the future this may be changed
	infoScreen ()
	show info screen
	editObject ()
	Edit object.
	updateObject ()
	update object
	availabilityToString ()
	public
Public Member Functions inherited from ilObjectGUI
	ilObjectGUI ($a_data, $a_id=0, $a_call_by_reference=true, $a_prepare_output=true)
	Constructor public.
	withReferences ()
	determines wether objects are referenced or not (got ref ids or not)
	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
	assignObject ()
	prepareOutput ()
	prepare output
	setTitleAndDescription ()
	called by prepare output
	showUpperIcon ()
	showMountWebfolderIcon ()
	setTabs ()
	set admin tabs public
	setAdminTabs ()
	set admin tabs public
	getAdminTabs (&$tabs_gui)
	administration tabs show only permissions and trash folder
	getHTML ()
	setActions ($a_actions="")
	set possible actions for objects in list.
	setSubObjects ($a_sub_objects="")
	set possible subobjects for this object.
	setLocator ()
	set Locator
	addLocatorItems ()
	should be overwritten to add object specific items (repository items are preloaded)
	omitLocator ($a_omit=true)
	addAdminLocatorItems ()
	should be overwritten to add object specific items (repository items are preloaded)
	undeleteObject ()
	get object back from trash
	insertSavedNodes ($a_source_id, $a_dest_id, $a_tree_id, &$a_affected_ids)
	recursive method to insert all saved nodes of the clipboard (maybe this function could be moved to a rbac class ?)
	confirmedDeleteObject ()
	confirmed deletion if object -> objects are moved to trash
	cancelDeleteObject ()
	cancel deletion of object
	removeFromSystemObject ()
	remove objects from trash bin and all entries therefore every object needs a specific deleteObject() method
	removeDeletedNodes ($a_node_id, $a_checked, $a_delete_objects, &$a_affected_ids)
	remove already deleted objects within the objects in trash recursive function
	createObject ()
	create new object form
	cancelObject ($in_rep=false)
	cancel action and go back to previous page public
	saveObject ()
	save object
	importObject ()
	import new object form
	displayEditForm ($fields)
	display edit form (usually called by editObject)
	afterUpdate ()
	permObject ()
	show permissions of current node
	getFormAction ($a_cmd, $a_formaction="")
	get form action for command (command is method name without "Object", e.g.
	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
	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
	permSaveObject ()
	save permissions
	isVisible ($a_ref_id, $a_type)
	displayList ()
	display object list
	viewObject ()
	list childs of current object
	deleteObject ($a_error=false)
	display deletion confirmation screen only for referenced objects.
	trashObject ()
	show trash content of object
	addRoleObject ()
	adds a local role This method is only called when choose the option 'you may add local roles'.
	showActions ($with_subobjects=false)
	show possible action (form buttons)
	getActions ()
	Get Actions.
	showPossibleSubObjects ()
	show possible subobjects (pulldown menu)
	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= '')
	hitsperpageObject ()
&	__initTableGUI ()
	__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="")
	infoObject ()
	__buildRoleFilterSelect ()
	__filterRoles ($a_roles, $a_filter)
	ownerObject ()
	changeOwnerObject ()
	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
	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)
	Add an object search in case the number of existing objects is too big to offer a selection list.
	cloneAllObject ()
	Clone single (not container object) Method is overwritten in ilContainerGUI.
	copyWizardHasOptions ($a_mode)
	Check if there is any modules specific option.
	getCenterColumnHTML ()
	Get center column.
	getRightColumnHTML ()
	Display right column.
	setColumnSettings ($column_gui)
	May be overwritten in subclasses.
	checkPermission ($a_perm, $a_cmd="")

Static Public Member Functions
static	_goto ($a_target)
	redirect script

Protected Member Functions
	initEditTable ()
	Init edit settings table.
Protected Member Functions inherited from ilObjectGUI
	searchCloneSourceObject ()
	Search clone source by title.
	buildCloneSelect ($existing_objs)
	Build a select box for clonable objects (permission write)

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

Detailed Description

Author

Stefan Meyer smeye.nosp@m.r@da.nosp@m.tabay.nosp@m..de

Version

$Id$

ilObjRemoteCourseGUI: ilPermissionGUI, ilInfoScreenGUI

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

Constructor & Destructor Documentation

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

Contructor.

public

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

References ilObjectGUI\ilObjectGUI().

        {
                $this->type = 'rcrs';
                parent::ilObjectGUI($a_data, $a_id, $a_call_by_reference, $a_prepare_output);

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

Here is the call graph for this function:

Member Function Documentation

static ilObjRemoteCourseGUI::_goto (   $a_target )

static

redirect script

Parameters

string

$a_target

Definition at line 58 of file class.ilObjRemoteCourseGUI.php.

References $_GET, $ilErr, ilObjectGUI\$lng, ilObject\_lookupObjId(), ilObject\_lookupTitle(), exit, and ilUtil\sendInfo().

        {
                global $rbacsystem, $ilErr, $lng, $ilAccess;

                if ($ilAccess->checkAccess("visible", "", $a_target))
                {
                        $_GET["cmd"] = "infoScreen";
                        $_GET["ref_id"] = $a_target;
                        include("repository.php");
                        exit;
                }
                else if ($ilAccess->checkAccess("read", "", ROOT_FOLDER_ID))
                {
                        $_GET["cmd"] = "frameset";
                        $_GET["target"] = "";
                        $_GET["ref_id"] = ROOT_FOLDER_ID;
                        ilUtil::sendInfo(sprintf($lng->txt("msg_no_perm_read_item"),
                                ilObject::_lookupTitle(ilObject::_lookupObjId($a_target))), true);
                        include("repository.php");
                        exit;
                }
                
                $ilErr->raiseError($lng->txt("msg_no_perm_read"), $ilErr->FATAL);
        }               

Here is the call graph for this function:

ilObjRemoteCourseGUI::availabilityToString

(

)

public

Parameters

Definition at line 422 of file class.ilObjRemoteCourseGUI.php.

References ilObjRemoteCourse\ACTIVATION_LIMITED, ilObjRemoteCourse\ACTIVATION_OFFLINE, ilObjRemoteCourse\ACTIVATION_UNLIMITED, ilDatePresentation\formatPeriod(), and IL_CAL_UNIX.

Referenced by infoScreen().

        {
                switch($this->object->getAvailabilityType())
                {
                        case ilObjRemoteCourse::ACTIVATION_OFFLINE:
                                return $this->lng->txt('offline');
                        
                        case ilObjRemoteCourse::ACTIVATION_UNLIMITED:
                                return $this->lng->txt('crs_unlimited');
                        
                        case ilObjRemoteCourse::ACTIVATION_LIMITED:
                                return ilDatePresentation::formatPeriod(
                                        new ilDateTime($this->object->getStartingTime(),IL_CAL_UNIX),
                                        new ilDateTime($this->object->getEndingTime(),IL_CAL_UNIX));
                }
                return '';
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilObjRemoteCourseGUI::callObject

(

)

call remote course

public

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

References infoScreenObject(), ilUtil\redirect(), and ilUtil\sendInfo().

        {
                // check if the assigned course is hosted on the same installation
                if($this->object->createAuthResource())
                {
                        ilUtil::redirect($this->object->getFullRemoteLink());
                        return true;
                }
                else
                {
                        ilUtil::sendInfo('Cannot call remote course.');
                        $this->infoScreenObject();
                        return false;
                }
        }

Here is the call graph for this function:

ilObjRemoteCourseGUI::editObject

(

)

Edit object.

protected

Reimplemented from ilObjectGUI.

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

References $ilErr, and initEditTable().

Referenced by updateObject().

        {
                global $ilErr,$ilAccess;

                if(!$ilAccess->checkAccess('write','',$this->object->getRefId()))
                {
                        $ilErr->raiseError($this->lng->txt('msg_no_perm_read'),$ilErr->MESSAGE);
                }
                $this->tabs_gui->setTabActive('edit');
                
                $this->initEditTable();
                $this->tpl->addBlockFile('ADM_CONTENT','adm_content','tpl.edit.html','Modules/RemoteCourse');
                $this->tpl->setVariable('EDIT_TABLE',$this->form->getHTML());
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilObjRemoteCourseGUI::executeCommand

(

)

Execute command.

public

Reimplemented from ilObjectGUI.

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

References $cmd, $ilErr, infoScreen(), and ilObjectGUI\prepareOutput().

        {
                global $rbacsystem,$ilErr,$ilAccess;

                $next_class = $this->ctrl->getNextClass($this);
                $cmd = $this->ctrl->getCmd();

                $this->prepareOutput();

                switch($next_class)
                {
                        case 'ilinfoscreengui':
                                $this->infoScreen();    // forwards command
                                break;
                
                        case 'ilpermissiongui':
                                $this->tabs_gui->setTabActive('perm_settings');
                                include_once("./classes/class.ilPermissionGUI.php");
                                $this->ctrl->forwardCommand(new ilPermissionGUI($this));
                                break;

                        default:
                                if(!$cmd || $cmd == 'view')
                                {
                                        $cmd = "editSettings";
                                }
                                $cmd .= "Object";
                                $this->$cmd();
                                break;
                }
                return true;
        }

Here is the call graph for this function:

ilObjRemoteCourseGUI::getTabs

(

$tabs_gui

)

get tabs

@access public

Parameters

object

tabs gui object

Definition at line 158 of file class.ilObjRemoteCourseGUI.php.

        {
                global $ilAccess;

                if($ilAccess->checkAccess('visible','',$this->object->getRefId()))
                {
                        $tabs_gui->addTarget("info_short",
                                $this->ctrl->getLinkTarget($this, "infoScreen"));
                }

                if($ilAccess->checkAccess('write','',$this->object->getRefId()))
                {
                        $tabs_gui->addTarget("edit",
                                $this->ctrl->getLinkTarget($this, "edit"),
                                array(),
                                "");
                }
                if ($ilAccess->checkAccess('edit_permission','',$this->object->getRefId()))
                {
                        $tabs_gui->addTarget("perm_settings",
                                $this->ctrl->getLinkTargetByClass(array(get_class($this),'ilpermissiongui'), "perm"), 
                                array("perm","info","owner"), 'ilpermissiongui');
                }
        }

ilObjRemoteCourseGUI::infoScreen

(

)

show info screen

public

Parameters

Definition at line 225 of file class.ilObjRemoteCourseGUI.php.

References $ilErr, ilECSExport\_isRemote(), ilECSImport\_lookupEContentId(), availabilityToString(), ilAdvancedMDRecordGUI\MODE_INFO, and ilAdvancedMDRecordGUI\setInfoObject().

Referenced by executeCommand(), and infoScreenObject().

        {
                global $ilErr,$ilAccess,$ilUser;

                if(!$ilAccess->checkAccess('visible','',$this->object->getRefId()))
                {
                        $ilErr->raiseError($this->lng->txt('msg_no_perm_read'),$ilErr->MESSAGE);
                }

                include_once("./Services/InfoScreen/classes/class.ilInfoScreenGUI.php");
                $info = new ilInfoScreenGUI($this);
                
                include_once('./Services/WebServices/ECS/classes/class.ilECSImport.php');
                include_once('./Services/WebServices/ECS/classes/class.ilECSExport.php');

                if($ilUser->getId() == ANONYMOUS_USER_ID)
                {
                        $info->addButton($this->lng->txt('rcrs_call'),
                        $this->object->getRemoteLink(),
                        'target="_blank"');
                }
                elseif(ilECSExport::_isRemote(ilECSImport::_lookupEContentId($this->object->getId())))
                {
                        $info->addButton($this->lng->txt('rcrs_call'),
                                $this->ctrl->getLinkTarget($this,'call'),
                                'target="_blank"');
                }
                else
                {
                        $info->addButton($this->lng->txt('rcrs_call'),
                        $this->object->getRemoteLink());
                }               
                
                $info->addSection($this->lng->txt('crs_general_info'));
                $info->addProperty($this->lng->txt('title'),$this->object->getTitle());
                if(strlen($this->object->getOrganization()))
                {
                        $info->addProperty($this->lng->txt('organization'),$this->object->getOrganization());
                }
                if(strlen($this->object->getDescription()))
                {
                        $info->addProperty($this->lng->txt('description'),$this->object->getDescription());
                }
                if(strlen($loc = $this->object->getLocalInformation()))
                {
                        $info->addProperty($this->lng->txt('rcrs_local_informations'),$this->object->getLocalInformation());
                }
                
                // Access
                $info->addProperty($this->lng->txt('crs_visibility'),$this->availabilityToString());
                
                
                include_once('Services/AdvancedMetaData/classes/class.ilAdvancedMDRecordGUI.php');
                $record_gui = new ilAdvancedMDRecordGUI(ilAdvancedMDRecordGUI::MODE_INFO,
                        'rcrs',$this->object->getId());
                $record_gui->setInfoObject($info);
                $record_gui->parse();
                
                $this->ctrl->forwardCommand($info);
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilObjRemoteCourseGUI::infoScreenObject

(

)

this one is called from the info button in the repository not very nice to set cmdClass/Cmd manually, if everything works through ilCtrl in the future this may be changed

Definition at line 210 of file class.ilObjRemoteCourseGUI.php.

References infoScreen().

Referenced by callObject().

        {
                $this->ctrl->setCmd("showSummary");
                $this->ctrl->setCmdClass("ilinfoscreengui");
                $this->infoScreen();
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilObjRemoteCourseGUI::initEditTable ( )

protected

Init edit settings table.

protected

Definition at line 345 of file class.ilObjRemoteCourseGUI.php.

References ilObjRemoteCourse\ACTIVATION_LIMITED, ilObjRemoteCourse\ACTIVATION_OFFLINE, ilObjRemoteCourse\ACTIVATION_UNLIMITED, ilRadioOption\addSubItem(), IL_CAL_UNIX, ilAdvancedMDRecordGUI\MODE_EDITOR, ilDateTimeInputGUI\setDate(), ilAdvancedMDRecordGUI\setPropertyForm(), ilTextInputGUI\setValue(), ilRadioGroupInputGUI\setValue(), and ilTextAreaInputGUI\setValue().

Referenced by editObject().

        {
                if(is_object($this->form))
                {
                        return true;
                }
                
                $this->lng->loadLanguageModule('crs');
        
                include_once("./Services/Form/classes/class.ilPropertyFormGUI.php");
                $this->form = new ilPropertyFormGUI();
                $this->form->setFormAction($this->ctrl->getFormAction($this));
                $this->form->setTitle($this->lng->txt('rcrs_general_info'));
                $this->form->addCommandButton('update',$this->lng->txt('save'));
                $this->form->addCommandButton('edit',$this->lng->txt('cancel'));
                
                $text = new ilTextInputGUI($this->lng->txt('title'),'title');
                $text->setValue($this->object->getTitle());
                $text->setSize(40);
                $text->setMaxLength(128);
                $text->setDisabled(true);
                $this->form->addItem($text);
                
                
                /*
                $area = new ilTextAreaInputGUI($this->lng->txt('description'),'description');
                $area->setValue($this->object->getDescription());
                $area->setRows(3);
                $area->setCols(80);
                $area->setDisabled(true);
                $this->form->addItem($area);
                */
                $area = new ilTextAreaInputGUI($this->lng->txt('rcrs_local_informations'),'local_info');
                $area->setValue($this->object->getLocalInformation());
                $area->setRows(3);
                $area->setCols(80);
                $this->form->addItem($area);
                
                $radio_grp = new ilRadioGroupInputGUI($this->lng->txt('crs_visibility'),'activation_type');
                $radio_grp->setValue($this->object->getAvailabilityType());
                $radio_grp->setDisabled(true);

                $radio_opt = new ilRadioOption($this->lng->txt('crs_visibility_unvisible'),ilObjRemoteCourse::ACTIVATION_OFFLINE);
                $radio_grp->addOption($radio_opt);

                $radio_opt = new ilRadioOption($this->lng->txt('crs_visibility_limitless'),ilObjRemoteCourse::ACTIVATION_UNLIMITED);
                $radio_grp->addOption($radio_opt);      

                $radio_opt = new ilRadioOption($this->lng->txt('crs_visibility_until'),ilObjRemoteCourse::ACTIVATION_LIMITED);
                
                $start = new ilDateTimeInputGUI($this->lng->txt('crs_start'),'start');
                $start->setDate(new ilDateTime(time(),IL_CAL_UNIX));
                $start->setDisabled(true);
                $start->setShowTime(true);
                $radio_opt->addSubItem($start);
                $end = new ilDateTimeInputGUI($this->lng->txt('crs_end'),'end');
                $end->setDate(new ilDateTime(time(),IL_CAL_UNIX));
                $end->setDisabled(true);
                $end->setShowTime(true);
                $radio_opt->addSubItem($end);
                
                $radio_grp->addOption($radio_opt);
                $this->form->addItem($radio_grp);       

                include_once('Services/AdvancedMetaData/classes/class.ilAdvancedMDRecordGUI.php');
                $record_gui = new ilAdvancedMDRecordGUI(ilAdvancedMDRecordGUI::MODE_EDITOR,'rcrs',$this->object->getId());
                $record_gui->setPropertyForm($this->form);
                $record_gui->parse();
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilObjRemoteCourseGUI::showObject

(

)

show remote course

public

Parameters

@return

Definition at line 130 of file class.ilObjRemoteCourseGUI.php.

References ilECSExport\_isRemote(), ilECSImport\_lookupEContentId(), and ilUtil\redirect().

        {
                global $ilUser;

                include_once('./Services/WebServices/ECS/classes/class.ilECSExport.php');
                include_once('./Services/WebServices/ECS/classes/class.ilECSImport.php');

                if($ilUser->getId() == ANONYMOUS_USER_ID)
                {
                        ilUtil::redirect($this->object->getRemoteLink());
                }
                elseif(ilECSExport::_isRemote(ilECSImport::_lookupEContentId($this->object->getId())))
                {
                        $this->object->createAuthResource();
                        ilUtil::redirect($this->object->getFullRemoteLink());
                }
                else
                {
                        ilUtil::redirect($this->object->getRemoteLink());
                }               
        }

Here is the call graph for this function:

ilObjRemoteCourseGUI::updateObject

(

)

update object

public

Parameters

Reimplemented from ilObjectGUI.

Definition at line 313 of file class.ilObjRemoteCourseGUI.php.

References $ilErr, editObject(), ilAdvancedMDRecordGUI\loadFromPost(), ilAdvancedMDRecordGUI\MODE_EDITOR, ilUtil\sendInfo(), and ilUtil\stripSlashes().

        {
                global $ilErr,$ilAccess;

                if(!$ilAccess->checkAccess('write','',$this->object->getRefId()))
                {
                        $ilErr->raiseError($this->lng->txt('msg_no_perm_read'),$ilErr->MESSAGE);
                }
                
                $this->object->setLocalInformation(ilUtil::stripSlashes($_POST['local_info']));
                #$this->object->setAvailabilityType($_POST['activation_type']);
                #$this->object->setStartingTime($_POST['start']);
                #$this->object->setEndingTime($_POST['end']);
                $this->object->update();
                
                // Save advanced meta data
                include_once('Services/AdvancedMetaData/classes/class.ilAdvancedMDRecordGUI.php');
                $record_gui = new ilAdvancedMDRecordGUI(ilAdvancedMDRecordGUI::MODE_EDITOR,
                        'rcrs',$this->object->getId());
                $record_gui->loadFromPost();
                $record_gui->saveValues();

                ilUtil::sendInfo($this->lng->txt("settings_saved"));
                $this->editObject();
                return true;
        }

Here is the call graph for this function:

---

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

• Modules/RemoteCourse/classes/class.ilObjRemoteCourseGUI.php