ILIAS  Release_4_0_x_branch Revision 61816
 All Data Structures Namespaces Files Functions Variables Groups Pages
Public Member Functions | Protected Member Functions | Private Attributes
ilObjiLincClassroomGUI Class Reference

Class ilObjiLincClassroomGUI. More...

+ Inheritance diagram for ilObjiLincClassroomGUI:
+ Collaboration diagram for ilObjiLincClassroomGUI:

Public Member Functions

 ilObjiLincClassroomGUI ($a_icla_id, $a_icrs_id, $a_call_by_reference=false, $a_prepare_output=false)
 Constructor public 2 last parameters actually not used.
 assignObject ()
 create ()
 save ()
 save object public
 joinClassroom ()
 editClassroom ()
 getTabs (&$tabs_gui)
 get tabs public
 removeClassroom ($a_error=false)
 display deletion confirmation screen only for referenced objects.
 updateClassroom ()
 updates class room on ilinc server
& executeCommand ()
 execute command
 cancelDeleteClassroom ()
 cancel deletion of classroom object
 confirmedDeleteClassroom ()
 public
 getResultMsg ()
 cancel ()
 cancel is called when an operation is canceled, method links back 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
 getAdminTabs (&$tabs_gui)
 administration tabs show only permissions and trash folder
 getHTML ()
 undeleteObject ()
 Get objects back from trash.
 confirmedDeleteObject ()
 confirmed deletion of object -> objects are moved to trash or deleted immediately, if trash is disabled
 cancelDeleteObject ()
 cancel deletion of object
 removeFromSystemObject ()
 remove objects from trash bin and all entries therefore every object needs a specific deleteObject() method
 createObject ()
 create new object form
 cancelObject ($in_rep=false)
 cancel action and go back to previous page public
 saveObject ()
 save object
 editObject ()
 edit object
 updateObject ()
 updates object entry in object_data
 getFormAction ($a_cmd, $a_formaction="")
 get form action for command (command is method name without "Object", e.g.
 isVisible ($a_ref_id, $a_type)
 viewObject ()
 list childs of current object
 deleteObject ($a_error=false)
 Display deletion confirmation screen.
 trashObject ()
 Show trash content of object.
 getTemplateFile ($a_cmd, $a_type="")
 get a template blockfile format: tpl.
 cloneAllObject ()
 Clone single (not container object) Method is overwritten in ilContainerGUI.
 copyWizardHasOptions ($a_mode)
 Check if there is any modules specific option.

Protected Member Functions

 getDefaultValues ()
 getObjectValues ()
 initSettingsForm ($a_mode= 'create')
- Protected Member Functions inherited from ilObjectGUI
 prepareOutput ()
 prepare output
 setTitleAndDescription ()
 called by prepare output
 showUpperIcon ()
 setTabs ()
 set admin tabs public
 setAdminTabs ()
 set admin tabs public
 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)
 displayEditForm ($fields)
 display edit form (usually called by editObject)
 afterUpdate ()
 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
 showPossibleSubObjects ()
 show possible subobjects (pulldown menu)
 getTitlesByRefId ($a_ref_ids)
 get Titles of objects this method is used for error messages in methods cut/copy/paste
 __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="")
 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.
 searchCloneSourceObject ()
 Search clone source by title.
 buildCloneSelect ($existing_objs)
 Build a select box for clonable objects (permission write)
 getCenterColumnHTML ()
 Get center column.
 getRightColumnHTML ()
 Display right column.
 setColumnSettings ($column_gui)
 May be overwritten in subclasses.
 checkPermission ($a_perm, $a_cmd="")

Private Attributes

 $form_gui = null

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

Class ilObjiLincClassroomGUI.

Author
Sascha Hofmann sasch.nosp@m.ahof.nosp@m.mann@.nosp@m.gmx..nosp@m.de
Version
Id:
class.ilObjiLincClassroomGUI.php 18686 2009-01-22 09:31:49Z mjansen

ilObjiLincClassroomGUI:

Definition at line 38 of file class.ilObjiLincClassroomGUI.php.

Member Function Documentation

ilObjiLincClassroomGUI::assignObject ( )

Reimplemented from ilObjectGUI.

Definition at line 82 of file class.ilObjiLincClassroomGUI.php.

Referenced by ilObjiLincClassroomGUI().

{
$this->object = new ilObjiLincClassroom($this->id, $this->parent);
}

+ Here is the caller graph for this function:

ilObjiLincClassroomGUI::cancel ( )

cancel is called when an operation is canceled, method links back public

Definition at line 490 of file class.ilObjiLincClassroomGUI.php.

References ilUtil\sendInfo().

{
ilUtil::sendInfo($this->lng->txt("msg_cancel"),true);
$this->ctrl->redirectByClass("ilobjilinccoursegui");
}

+ Here is the call graph for this function:

ilObjiLincClassroomGUI::cancelDeleteClassroom ( )

cancel deletion of classroom object

public

Definition at line 452 of file class.ilObjiLincClassroomGUI.php.

References ilUtil\sendInfo().

{
session_unregister("saved_post");
ilUtil::sendInfo($this->lng->txt("msg_cancel"),true);
$this->ctrl->redirectByClass("ilobjilinccoursegui");
}

+ Here is the call graph for this function:

ilObjiLincClassroomGUI::confirmedDeleteClassroom ( )

public

Definition at line 464 of file class.ilObjiLincClassroomGUI.php.

References ilUtil\sendInfo().

{
if (!$this->object->delete())
{
$msg = $this->object->getErrorMsg();
}
else
{
$msg = $this->lng->txt('icla_deleted');
}
// Feedback
ilUtil::sendInfo($msg,true);
$this->ctrl->redirectByClass("ilobjilinccoursegui");
}

+ Here is the call graph for this function:

ilObjiLincClassroomGUI::create ( )

Definition at line 87 of file class.ilObjiLincClassroomGUI.php.

References getDefaultValues(), initSettingsForm(), and ilObjectGUI\prepareOutput().

{
$this->prepareOutput();
$this->initSettingsForm('create');
$this->getDefaultValues();
return $this->tpl->setVariable('ADM_CONTENT', $this->form_gui->getHtml());
}

+ Here is the call graph for this function:

ilObjiLincClassroomGUI::editClassroom ( )

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

References getObjectValues(), and initSettingsForm().

{
$this->initSettingsForm('edit');
$this->getObjectValues();
return $this->tpl->setVariable('ADM_CONTENT', $this->form_gui->getHtml());
}

+ Here is the call graph for this function:

& ilObjiLincClassroomGUI::executeCommand ( )

execute command

Reimplemented from ilObjectGUI.

Definition at line 432 of file class.ilObjiLincClassroomGUI.php.

References $cmd.

{
$next_class = $this->ctrl->getNextClass($this);
$cmd = $this->ctrl->getCmd();
switch($next_class)
{
default:
$this->$cmd();
break;
}
return true;
}
ilObjiLincClassroomGUI::getDefaultValues ( )
protected

Definition at line 96 of file class.ilObjiLincClassroomGUI.php.

References ilObjectGUI\$data, ilObjiLincCourse\_getAKClassValues(), and ilObject\_lookupObjectId().

Referenced by create().

{
$data = array(
'title' => '',
'desc' => '',
'instructoruserid' => 0,
'alwaysopen' => 1
);
$icrs_obj_id = ilObject::_lookupObjectId( $this->parent );
include_once 'Modules/ILinc/classes/class.ilObjiLincCourse.php';
$akclassvalues = ilObjiLincCourse::_getAKClassValues( $icrs_obj_id );
$data['akclassvalue1'] = $akclassvalues[0];
$data['akclassvalue2'] = $akclassvalues[1];
$this->form_gui->setValuesByArray( $data );
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilObjiLincClassroomGUI::getObjectValues ( )
protected

Definition at line 192 of file class.ilObjiLincClassroomGUI.php.

References ilObjectGUI\$data, ilObjiLincCourse\_getAKClassValues(), and ilObject\_lookupObjectId().

Referenced by editClassroom().

{
$data = array(
'title' => $this->object->getTitle(),
'desc' => $this->object->getDescription(),
'alwaysopen' => $this->object->getStatus(),
'instructoruserid' => $this->object->getDocentId()
);
$icrs_obj_id = ilObject::_lookupObjectId( $this->parent );
include_once 'Modules/ILinc/classes/class.ilObjiLincCourse.php';
$akclassvalues = ilObjiLincCourse::_getAKClassValues( $icrs_obj_id );
$data['akclassvalue1'] = $akclassvalues[0];
$data['akclassvalue2'] = $akclassvalues[1];
$this->form_gui->setValuesByArray( $data );
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilObjiLincClassroomGUI::getResultMsg ( )

Definition at line 481 of file class.ilObjiLincClassroomGUI.php.

Referenced by updateClassroom().

{
return $this->object->result_msg;
}

+ Here is the caller graph for this function:

ilObjiLincClassroomGUI::getTabs ( &  $tabs_gui)

get tabs public

Parameters
objecttabs gui object

Reimplemented from ilObjectGUI.

Definition at line 293 of file class.ilObjiLincClassroomGUI.php.

{
// tabs are defined manually here. The autogeneration via objects.xml will be deprecated in future
// for usage examples see ilObjGroupGUI or ilObjSystemFolderGUI
}
ilObjiLincClassroomGUI::ilObjiLincClassroomGUI (   $a_icla_id,
  $a_icrs_id,
  $a_call_by_reference = false,
  $a_prepare_output = false 
)

Constructor public 2 last parameters actually not used.

Definition at line 47 of file class.ilObjiLincClassroomGUI.php.

References $ilCtrl, $ilErr, ilObjectGUI\$ilias, ilObjectGUI\$lng, ilObjectGUI\$objDefinition, ilObjectGUI\$tpl, ilObjectGUI\$tree, assignObject(), and ilObjectGUI\prepareOutput().

{
global $ilCtrl,$lng,$ilias,$objDefinition,$tpl,$tree,$ilErr;
$this->type = "icla";
$this->id = $a_icla_id;
$this->parent = $a_icrs_id;
$this->ilias =& $ilias;
$this->objDefinition =& $objDefinition;
$this->tpl =& $tpl;
$this->html = "";
$this->ctrl =& $ilCtrl;
$this->lng =& $lng;
$this->tree =& $tree;
$this->ilErr =& $ilErr;
//$this->ctrl->saveParameter($this,'parent');
$this->lng->loadLanguageModule('ilinc');
$this->formaction = array();
$this->return_location = array();
$this->target_frame = array();
//$this->tab_target_script = "adm_object.php";
$this->actions = "";
$this->sub_objects = "";
//prepare output
if (false)
{
$this->prepareOutput();
}
$this->assignObject();
}

+ Here is the call graph for this function:

ilObjiLincClassroomGUI::initSettingsForm (   $a_mode = 'create')
protected

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

References ilObjectGUI\$data, ilUtil\getTypeIconPath(), ilFormPropertyGUI\setDisabled(), ilFormPropertyGUI\setRequired(), and ilRadioGroupInputGUI\setValue().

Referenced by create(), editClassroom(), save(), and updateClassroom().

{
include_once 'Services/Form/classes/class.ilPropertyFormGUI.php';
$this->form_gui = new ilPropertyFormGUI();
$this->form_gui->setTableWidth('600');
if($a_mode == 'create')
{
$this->form_gui->setTitle($this->lng->txt('icla_add'));
}
else
{
$this->form_gui->setTitle($this->lng->txt('icla_edit'));
}
$this->form_gui->setTitleIcon(ilUtil::getTypeIconPath('icla', 0));
// Title
$text_input = new ilTextInputGUI($this->lng->txt('title'), 'title');
$text_input->setRequired(true);
$this->form_gui->addItem($text_input);
// Description
$text_area = new ilTextAreaInputGUI($this->lng->txt('desc'), 'desc');
$this->form_gui->addItem($text_area);
// Docentselection
$sel = new ilSelectInputGUI($this->lng->txt(ILINC_MEMBER_DOCENT), 'instructoruserid');
$docentlist = $this->object->getDocentList();
$docent_options = array();
$docent_options[0] = $this->lng->txt('please_choose');
foreach((array)$docentlist as $id => $data)
{
$docent_options[$id] = $data['fullname'];
}
$sel->setOptions($docent_options);
$this->form_gui->addItem($sel);
// Open
$rg = new ilRadioGroupInputGUI($this->lng->txt('access'), 'alwaysopen');
$rg->setValue(0);
$ro = new ilRadioOption($this->lng->txt('ilinc_classroom_open'), 1);
$rg->addOption($ro);
$ro = new ilRadioOption($this->lng->txt('ilinc_classroom_closed'), 0);
$rg->addOption($ro);
$this->form_gui->addItem($rg);
// Display akclassvalues
if($this->ilias->getSetting('ilinc_akclassvalues_active'))
{
$text_input = new ilTextInputGUI($this->lng->txt('akclassvalue1'), 'akclassvalue1');
$text_input->setDisabled(true);
$this->form_gui->addItem($text_input);
$text_input = new ilTextInputGUI($this->lng->txt('akclassvalue2'), 'akclassvalue2');
$text_input->setDisabled(true);
$this->form_gui->addItem($text_input);
}
// save and cancel commands
if($a_mode == 'create')
{
$this->ctrl->setParameter($this, 'mode', 'create');
$this->ctrl->setParameter($this, 'new_type', 'icla');
$this->form_gui->addCommandButton('save', $this->lng->txt('icla_add'));
$this->form_gui->addCommandButton('cancel', $this->lng->txt('cancel'));
$this->form_gui->setFormAction($this->ctrl->getFormAction($this, 'save'));
}
else
{
$this->ctrl->setParameter($this, 'class_id', $this->object->id);
$this->form_gui->addCommandButton('updateClassroom', $this->lng->txt('save'));
$this->form_gui->addCommandButton('cancel', $this->lng->txt('cancel'));
$this->form_gui->setFormAction($this->ctrl->getFormAction($this, 'updateClassroom'));
}
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilObjiLincClassroomGUI::joinClassroom ( )

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

References $_GET, and ilUtil\redirect().

{
// join class
$url = $this->object->joinClass($this->ilias->account,$_GET['class_id']);
if (!$url)
{
$this->ilias->raiseError($this->object->getErrorMsg(),$this->ilias->error_obj->FATAL);
}
ilUtil::redirect(trim($url));
}

+ Here is the call graph for this function:

ilObjiLincClassroomGUI::removeClassroom (   $a_error = false)

display deletion confirmation screen only for referenced objects.

For user,role & rolt overwrite this function in the appropriate Object folders classes (ilObjUserFolderGUI,ilObjRoleFolderGUI)

public

Definition at line 306 of file class.ilObjiLincClassroomGUI.php.

References $_GET, $key, $name, elseif(), ilObjectGUI\getFormAction(), ilUtil\getImagePath(), ilUtil\getImageTagByType(), ilObjectGUI\getTemplateFile(), ilUtil\sendInfo(), and ilUtil\switchColor().

{
unset($this->data);
$this->data["cols"] = array("type", "title", "last_change");
$this->data["data"][$_GET['class_id']] = array(
"type" => $this->object->getType(),
"title" => $this->object->getTitle()."#separator#".$this->object->getDescription()." ", // workaround for empty desc
"last_update" => "n/a"
);
$this->data["buttons"] = array( "confirmedDeleteClassroom" => $this->lng->txt("confirm"),
"cancelDeleteClassroom" => $this->lng->txt("cancel"));
$this->getTemplateFile("confirm");
if(!$a_error)
{
ilUtil::sendInfo($this->lng->txt("info_delete_sure"));
}
$obj_str = "&class_id=".$this->object->id;
$this->tpl->setVariable("FORMACTION", $this->getFormAction("delete",$this->ctrl->getFormAction($this).$obj_str));
// BEGIN TABLE HEADER
foreach ($this->data["cols"] as $key)
{
$this->tpl->setCurrentBlock("table_header");
$this->tpl->setVariable("TEXT",$this->lng->txt($key));
$this->tpl->parseCurrentBlock();
}
// END TABLE HEADER
// BEGIN TABLE DATA
$counter = 0;
foreach ($this->data["data"] as $key => $value)
{
// BEGIN TABLE CELL
foreach ($value as $key => $cell_data)
{
$this->tpl->setCurrentBlock("table_cell");
// CREATE TEXT STRING
if ($key == "type")
{
$this->tpl->setVariable("TEXT_CONTENT",ilUtil::getImageTagByType($cell_data,$this->tpl->tplPath));
}
elseif ($key == "title")
{
$name_field = explode("#separator#",$cell_data);
$this->tpl->setVariable("TEXT_CONTENT", "<b>".$name_field[0]."</b>");
$this->tpl->setCurrentBlock("subtitle");
$this->tpl->setVariable("DESC", $name_field[1]);
$this->tpl->parseCurrentBlock();
$this->tpl->setCurrentBlock("table_cell");
}
else
{
$this->tpl->setVariable("TEXT_CONTENT",$cell_data);
}
$this->tpl->parseCurrentBlock();
}
$this->tpl->setCurrentBlock("table_row");
$this->tpl->setVariable("CSS_ROW",ilUtil::switchColor(++$counter,"tblrow1","tblrow2"));
$this->tpl->parseCurrentBlock();
// END TABLE CELL
}
// END TABLE DATA
// BEGIN OPERATION_BTN
foreach ($this->data["buttons"] as $name => $value)
{
$this->tpl->setCurrentBlock("operation_btn");
$this->tpl->setVariable("IMG_ARROW",ilUtil::getImagePath("arrow_downright.gif"));
$this->tpl->setVariable("BTN_NAME",$name);
$this->tpl->setVariable("BTN_VALUE",$value);
$this->tpl->parseCurrentBlock();
}
}

+ Here is the call graph for this function:

ilObjiLincClassroomGUI::save ( )

save object public

Definition at line 118 of file class.ilObjiLincClassroomGUI.php.

References $_POST, ilObjiLincCourse\_getAKClassValues(), ilObjiLincClassroom\_lookupiCourseId(), ilObject\_lookupObjectId(), initSettingsForm(), ilObjectGUI\prepareOutput(), and ilUtil\sendInfo().

{
$this->prepareOutput();
$this->initSettingsForm('create');
if($this->form_gui->checkInput())
{
$_POST['Fobject']['title'] = $this->form_gui->getInput('title');
$_POST['Fobject']['desc'] = $this->form_gui->getInput('desc');
$_POST['Fobject']['instructoruserid'] = $this->form_gui->getInput('instructoruserid');
$_POST['Fobject']['alwaysopen'] = $this->form_gui->getInput('alwaysopen');
// Akclassvalues
if($this->ilias->getSetting('ilinc_akclassvalues_active'))
{
$icrs_obj_id = ilObject::_lookupObjectId( $this->parent );
include_once 'Modules/ILinc/classes/class.ilObjiLincCourse.php';
$akclassvalues = ilObjiLincCourse::_getAKClassValues( $icrs_obj_id );
$_POST['Fobject']['akclassvalue1'] = $akclassvalues[0];
$_POST['Fobject']['akclassvalue2'] = $akclassvalues[1];
}
$ilinc_course_id = ilObjiLincClassroom::_lookupiCourseId( $this->parent );
$this->object->ilincAPI->addClass($ilinc_course_id, $_POST['Fobject']);
$response = $this->object->ilincAPI->sendRequest('addClass');
if($response->isError())
{
$this->ilErr->raiseError($response->getErrorMsg(), $this->ilErr->MESSAGE);
}
// Always send a message
ilUtil::sendInfo($response->getResultMsg(), true);
$this->ctrl->redirectByClass('ilobjilinccoursegui');
}
else
{
if($this->ilias->getSetting('ilinc_akclassvalues_active'))
{
$icrs_obj_id = ilObject::_lookupObjectId( $this->parent );
include_once 'Modules/ILinc/classes/class.ilObjiLincCourse.php';
$akclassvalues = ilObjiLincCourse::_getAKClassValues( $icrs_obj_id );
$_POST['akclassvalue1'] = $akclassvalues[0];
$_POST['akclassvalue2'] = $akclassvalues[1];
}
$this->form_gui->setValuesByPost();
return $this->tpl->setVariable('ADM_CONTENT', $this->form_gui->getHtml());
}
}

+ Here is the call graph for this function:

ilObjiLincClassroomGUI::updateClassroom ( )

updates class room on ilinc server

public

Definition at line 396 of file class.ilObjiLincClassroomGUI.php.

References $_POST, ilObjiLincCourse\_getAKClassValues(), ilObject\_lookupObjectId(), getResultMsg(), initSettingsForm(), and ilUtil\sendInfo().

{
$this->initSettingsForm('edit');
if($this->form_gui->checkInput())
{
$this->object->setTitle( $this->form_gui->getInput('title' ));
$this->object->setDescription( $this->form_gui->getInput('desc') );
$this->object->setDocentId( $this->form_gui->getInput('instructoruserid') );
$this->object->setStatus( $this->form_gui->getInput('alwaysopen') );
if(!$this->object->update())
{
$this->ilErr->raiseError($this->object->getErrorMsg(), $this->ilErr->MESSAGE);
}
ilUtil::sendInfo($this->getResultMsg(), true);
$this->ctrl->redirectByClass('ilobjilinccoursegui');
}
else
{
if($this->ilias->getSetting('ilinc_akclassvalues_active'))
{
$icrs_obj_id = ilObject::_lookupObjectId( $this->parent );
include_once 'Modules/ILinc/classes/class.ilObjiLincCourse.php';
$akclassvalues = ilObjiLincCourse::_getAKClassValues( $icrs_obj_id );
$_POST['akclassvalue1'] = $akclassvalues[0];
$_POST['akclassvalue2'] = $akclassvalues[1];
}
$this->form_gui->setValuesByPost();
return $this->tpl->setVariable('ADM_CONTENT', $this->form_gui->getHtml());
}
}

+ Here is the call graph for this function:

Field Documentation

ilObjiLincClassroomGUI::$form_gui = null
private

Definition at line 40 of file class.ilObjiLincClassroomGUI.php.

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