ILIAS  Release_3_10_x_branch Revision 61812
 All Data Structures Namespaces Files Functions Variables Groups Pages
Public Member Functions | Data Fields
ilObjFileBasedLMGUI Class Reference

User Interface class for file based learning modules (HTML) More...

+ Inheritance diagram for ilObjFileBasedLMGUI:
+ Collaboration diagram for ilObjFileBasedLMGUI:

Public Member Functions

 ilObjFileBasedLMGUI ($a_data, $a_id=0, $a_call_by_reference=true, $a_prepare_output=true)
 Constructor.
& executeCommand ()
 execute command
 createObject ()
 create new object form
 properties ()
 edit properties of object (admin form)
 saveProperties ()
 save properties
 saveObject ()
 save object public
 editObject ()
 edit properties of object (admin form)
 edit ()
 edit properties of object (module form)
 cancel ()
 cancel editing
 cancelObject ($in_rep=false)
 cancel action and go back to previous page public
 update ()
 update properties
 setStartFile ($a_file)
 perm ()
 permission form
 saveBibItemObject ($a_target="")
 save bib item (admin call)
 saveBibItem ()
 save bib item (module call)
 editBibItemObject ($a_target="")
 edit bib items (admin call)
 editBibItem ()
 edit bib items (module call)
 deleteBibItemObject ($a_target="")
 delete bib item (admin call)
 deleteBibItem ()
 delete bib item (module call)
 addBibItemObject ($a_target="")
 add bib item (admin call)
 addBibItem ()
 add bib item (module call)
 frameset ()
 output main frameset of media pool left frame: explorer tree of folders right frame: media pool content
 explorer ()
 directory explorer
 getTemplate ()
 output main header (title and locator)
 showLearningModule ()
 infoScreen ()
 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
 showInfoScreen ()
 info screen call from inside learning module
 outputInfoScreen ($a_standard_locator=true)
 info screen
 setTabs ()
 output tabs
 getTabs (&$tabs_gui)
 adds tabs to tab gui object
 _goto ($a_target)
 redirect script
 addLocatorItems ()
 should be overwritten to add object specific items (repository items are preloaded)
- 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 ()
 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
 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
 importObject ()
 import new object form
 displayEditForm ($fields)
 display edit form (usually called by editObject)
 updateObject ()
 updates object entry in object_data
 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
 __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="")

Data Fields

 $output_prepared
- 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

Additional Inherited Members

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

Detailed Description

User Interface class for file based learning modules (HTML)

Author
Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e
Id:
class.ilObjFileBasedLMGUI.php 18549 2009-01-19 09:24:38Z smeyer

ilObjFileBasedLMGUI: ilFileSystemGUI, ilMDEditorGUI, ilPermissionGUI, ilLearningProgressGUI, ilInfoScreenGUI ilObjFileBasedLMGUI: ilShopPurchaseGUI

Definition at line 42 of file class.ilObjFileBasedLMGUI.php.

Member Function Documentation

ilObjFileBasedLMGUI::_goto (   $a_target)

redirect script

Parameters
string$a_target

Definition at line 758 of file class.ilObjFileBasedLMGUI.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["ref_id"] = $a_target;
$_GET["cmd"] = "infoScreen";
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_lm"), $ilErr->FATAL);
}

+ Here is the call graph for this function:

ilObjFileBasedLMGUI::addBibItem ( )

add bib item (module call)

Definition at line 542 of file class.ilObjFileBasedLMGUI.php.

References addBibItemObject().

{
//$this->setTabs();
$this->addBibItemObject($this->ctrl->getLinkTarget($this));
}

+ Here is the call graph for this function:

ilObjFileBasedLMGUI::addBibItemObject (   $a_target = "")

add bib item (admin call)

Definition at line 500 of file class.ilObjFileBasedLMGUI.php.

References $_GET, ilObjectGUI\$data, and ilUtil\sendInfo().

Referenced by addBibItem().

{
$bibItemName = $_POST["bibItemName"] ? $_POST["bibItemName"] : $_GET["bibItemName"];
$bibItemIndex = $_POST["bibItemIndex"] ? $_POST["bibItemIndex"] : $_GET["bibItemIndex"];
if ($bibItemName == "BibItem")
{
include_once "./Modules/LearningModule/classes/class.ilBibItem.php";
$bib_item =& new ilBibItem();
$bib_item->setId($this->object->getId());
$bib_item->setType($this->object->getType());
$bib_item->read();
}
include_once "./Modules/LearningModule/classes/class.ilBibItemGUI.php";
$bib_gui =& new ilBibItemGUI();
$bib_gui->setObject($this->object);
if ($bibItemIndex == "")
$bibItemIndex = 0;
$bibItemPath = $_POST["bibItemPath"] ? $_POST["bibItemPath"] : $_GET["bibItemPath"];
//if ($bibItemName != "" && $bibItemName != "BibItem")
if ($bibItemName != "")
{
$bib_gui->bib_obj->add($bibItemName, $bibItemPath, $bibItemIndex);
$data = $bib_gui->bib_obj->getElement("BibItem");
$bibItemIndex = (count($data) - 1);
}
else
{
ilUtil::sendInfo($this->lng->txt("bibitem_choose_element"), true);
}
if ($a_target == "")
{
$a_target = "adm_object.php?ref_id=" . $this->object->getRefId();
}
$bib_gui->edit("ADM_CONTENT", "adm_content", $a_target, $bibItemIndex);
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilObjFileBasedLMGUI::addLocatorItems ( )

should be overwritten to add object specific items (repository items are preloaded)

Reimplemented from ilObjectGUI.

Definition at line 783 of file class.ilObjFileBasedLMGUI.php.

References $_GET.

{
global $ilLocator;
if (is_object($this->object))
{
$ilLocator->addItem($this->object->getTitle(),
$this->ctrl->getLinkTargetByClass("ilinfoscreengui", "showSummary"), "", $_GET["ref_id"]);
}
}
ilObjFileBasedLMGUI::cancel ( )

cancel editing

Definition at line 353 of file class.ilObjFileBasedLMGUI.php.

References cancelObject().

{
//$this->setReturnLocation("cancel","fblm_edit.php?cmd=listFiles&ref_id=".$_GET["ref_id"]);
$this->cancelObject();
}

+ Here is the call graph for this function:

ilObjFileBasedLMGUI::cancelObject (   $in_rep = false)

cancel action and go back to previous page public

Reimplemented from ilObjectGUI.

Definition at line 364 of file class.ilObjFileBasedLMGUI.php.

References $_GET, ilUtil\redirect(), and ilUtil\sendInfo().

Referenced by cancel().

{
ilUtil::sendInfo($this->lng->txt("msg_cancel"),true);
ilUtil::redirect("repository.php?cmd=frameset&ref_id=".$_GET["ref_id"]);
//$this->ctrl->redirectByClass("ilrepositorygui", "frameset");
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilObjFileBasedLMGUI::createObject ( )

create new object form

public

Reimplemented from ilObjectGUI.

Definition at line 169 of file class.ilObjFileBasedLMGUI.php.

References $_GET, $_SESSION, ilObjectGUI\$data, ilFrameTargetInfo\_getFrame(), ilUtil\getImagePath(), ilObjectGUI\getTemplateFile(), ilUtil\prepareFormOutput(), and ilUtil\stripSlashes().

{
global $rbacsystem;
$new_type = $_POST["new_type"] ? $_POST["new_type"] : $_GET["new_type"];
if (!$rbacsystem->checkAccess("create", $_GET["ref_id"], $new_type))
{
$this->ilias->raiseError($this->lng->txt("permission_denied"),$this->ilias->error_obj->MESSAGE);
}
else
{
// fill in saved values in case of error
$data = array();
$data["fields"] = array();
$data["fields"]["title"] = ilUtil::prepareFormOutput($_SESSION["error_post_vars"]["Fobject"]["title"],true);
$data["fields"]["desc"] = ilUtil::stripSlashes($_SESSION["error_post_vars"]["Fobject"]["desc"]);
$this->getTemplateFile("edit",$new_type);
$this->tpl->setCurrentBlock("img");
$this->tpl->setVariable("TYPE_IMG",
ilUtil::getImagePath("icon_".$new_type.".gif"));
$this->tpl->setVariable("ALT_IMG",
$this->lng->txt("obj_".$new_type));
$this->tpl->parseCurrentBlock();
foreach ($data["fields"] as $key => $val)
{
$this->tpl->setVariable("TXT_".strtoupper($key), $this->lng->txt($key));
$this->tpl->setVariable(strtoupper($key), $val);
if ($this->prepare_output)
{
$this->tpl->parseCurrentBlock();
}
}
$this->ctrl->setParameter($this, "new_type", $new_type);
$this->tpl->setVariable("FORMACTION", $this->ctrl->getFormAction($this, "save"));
//$this->tpl->setVariable("FORMACTION", $this->getFormAction("save","adm_object.php?cmd=gateway&ref_id=".
// $_GET["ref_id"]."&new_type=".$new_type));
$this->tpl->setVariable("TXT_HEADER", $this->lng->txt($new_type."_new"));
$this->tpl->setVariable("TXT_CANCEL", $this->lng->txt("cancel"));
$this->tpl->setVariable("TXT_SUBMIT", $this->lng->txt($new_type."_add"));
$this->tpl->setVariable("CMD_SUBMIT", "save");
$this->tpl->setVariable("TARGET", ' target="'.
ilFrameTargetInfo::_getFrame("MainContent").'" ');
$this->tpl->setVariable("TXT_REQUIRED_FLD", $this->lng->txt("required_field"));
}
}

+ Here is the call graph for this function:

ilObjFileBasedLMGUI::deleteBibItem ( )

delete bib item (module call)

Definition at line 491 of file class.ilObjFileBasedLMGUI.php.

References deleteBibItemObject().

{
//$this->setTabs();
$this->deleteBibItemObject($this->ctrl->getLinkTarget($this));
}

+ Here is the call graph for this function:

ilObjFileBasedLMGUI::deleteBibItemObject (   $a_target = "")

delete bib item (admin call)

Definition at line 469 of file class.ilObjFileBasedLMGUI.php.

References $_GET.

Referenced by deleteBibItem().

{
include_once "./Modules/LearningModule/classes/class.ilBibItemGUI.php";
$bib_gui =& new ilBibItemGUI();
$bib_gui->setObject($this->object);
$bibItemIndex = $_POST["bibItemIndex"] ? $_POST["bibItemIndex"] : $_GET["bibItemIndex"];
$bib_gui->bib_obj->delete($_GET["bibItemName"], $_GET["bibItemPath"], $bibItemIndex);
if (strpos($bibItemIndex, ",") > 0)
{
$bibItemIndex = substr($bibItemIndex, 0, strpos($bibItemIndex, ","));
}
if ($a_target == "")
{
$a_target = "adm_object.php?ref_id=" . $this->object->getRefId();
}
$bib_gui->edit("ADM_CONTENT", "adm_content", $a_target, $bibItemIndex);
}

+ Here is the caller graph for this function:

ilObjFileBasedLMGUI::edit ( )

edit properties of object (module form)

Definition at line 344 of file class.ilObjFileBasedLMGUI.php.

References editObject(), and ilObjectGUI\prepareOutput().

{
$this->prepareOutput();
$this->editObject();
}

+ Here is the call graph for this function:

ilObjFileBasedLMGUI::editBibItem ( )

edit bib items (module call)

Definition at line 460 of file class.ilObjFileBasedLMGUI.php.

References editBibItemObject().

{
//$this->setTabs();
$this->editBibItemObject($this->ctrl->getLinkTarget($this));
}

+ Here is the call graph for this function:

ilObjFileBasedLMGUI::editBibItemObject (   $a_target = "")

edit bib items (admin call)

Definition at line 438 of file class.ilObjFileBasedLMGUI.php.

References $_GET.

Referenced by editBibItem().

{
include_once "./Modules/LearningModule/classes/class.ilBibItemGUI.php";
$bib_gui =& new ilBibItemGUI();
$bib_gui->setObject($this->object);
$bibItemIndex = $_POST["bibItemIndex"] ? $_POST["bibItemIndex"] : $_GET["bibItemIndex"];
$bibItemIndex *= 1;
if ($bibItemIndex < 0)
{
$bibItemIndex = 0;
}
if ($a_target == "")
{
$a_target = "adm_object.php?ref_id=" . $this->object->getRefId();
}
$bib_gui->edit("ADM_CONTENT", "adm_content", $a_target, $bibItemIndex);
}

+ Here is the caller graph for this function:

ilObjFileBasedLMGUI::editObject ( )

edit properties of object (admin form)

public

Reimplemented from ilObjectGUI.

Definition at line 327 of file class.ilObjFileBasedLMGUI.php.

References ilObjectGUI\$tpl, and ilObjectGUI\$tree.

Referenced by edit().

{
global $rbacsystem, $tree, $tpl;
if (!$rbacsystem->checkAccess("visible,write",$this->object->getRefId()))
{
$this->ilias->raiseError($this->lng->txt("permission_denied"),$this->ilias->error_obj->MESSAGE);
}
// edit button
$this->tpl->addBlockfile("BUTTONS", "buttons", "tpl.buttons.html");
}

+ Here is the caller graph for this function:

& ilObjFileBasedLMGUI::executeCommand ( )

execute command

Reimplemented from ilObjectGUI.

Definition at line 73 of file class.ilObjFileBasedLMGUI.php.

References $_GET, $cmd, $ret, ilPaymentObject\_hasAccess(), ilPaymentObject\_isBuyable(), ilFileSystemGUI\activateLabels(), ilMDEditorGUI\addObserver(), ilObjectGUI\getCreationMode(), getTemplate(), LP_MODE_REPOSITORY, outputInfoScreen(), ilObjectGUI\prepareOutput(), ilObjectGUI\setLocator(), and setTabs().

{
global $ilUser, $ilLocator;
if (strtolower($_GET["baseClass"]) == "iladministrationgui" ||
$this->getCreationMode() == true)
{
$this->prepareOutput();
}
else
{
$this->getTemplate();
$this->setLocator();
$this->setTabs();
}
$next_class = $this->ctrl->getNextClass($this);
$cmd = $this->ctrl->getCmd();
if(!$this->getCreationMode())
{
include_once 'payment/classes/class.ilPaymentObject.php';
if(ilPaymentObject::_isBuyable($_GET['ref_id']) &&
!ilPaymentObject::_hasAccess($_GET['ref_id']))
{
$this->tpl->getStandardTemplate();
include_once 'Services/Payment/classes/class.ilShopPurchaseGUI.php';
$pp = new ilShopPurchaseGUI((int)$_GET['ref_id']);
$ret = $this->ctrl->forwardCommand($pp);
return true;
}
}
switch($next_class)
{
case 'ilmdeditorgui':
include_once 'Services/MetaData/classes/class.ilMDEditorGUI.php';
$md_gui =& new ilMDEditorGUI($this->object->getId(), 0, $this->object->getType());
$md_gui->addObserver($this->object,'MDUpdateListener','General');
$this->ctrl->forwardCommand($md_gui);
break;
case "ilfilesystemgui":
$fs_gui =& new ilFileSystemGUI($this->object->getDataDirectory());
$fs_gui->activateLabels(true, $this->lng->txt("cont_purpose"));
if ($this->object->getStartFile() != "")
{
$fs_gui->labelFile($this->object->getStartFile(),
$this->lng->txt("cont_startfile"));
}
$fs_gui->addCommand($this, "setStartFile", $this->lng->txt("cont_set_start_file"));
$ret =& $this->ctrl->forwardCommand($fs_gui);
break;
case "ilinfoscreengui":
$ret =& $this->outputInfoScreen();
break;
case "illearningprogressgui":
include_once './Services/Tracking/classes/class.ilLearningProgressGUI.php';
$new_gui =& new ilLearningProgressGUI(LP_MODE_REPOSITORY,
$this->object->getRefId(),
$_GET['user_id'] ? $_GET['user_id'] : $ilUser->getId());
$this->ctrl->forwardCommand($new_gui);
$this->tabs_gui->setTabActive('learning_progress');
break;
case 'ilpermissiongui':
include_once("./classes/class.ilPermissionGUI.php");
$perm_gui =& new ilPermissionGUI($this);
$ret =& $this->ctrl->forwardCommand($perm_gui);
break;
default:
$cmd = $this->ctrl->getCmd("frameset");
if (strtolower($_GET["baseClass"]) == "iladministrationgui" ||
$this->getCreationMode() == true)
{
$cmd.= "Object";
}
$ret =& $this->$cmd();
break;
}
//$this->tpl->show();
}

+ Here is the call graph for this function:

ilObjFileBasedLMGUI::explorer ( )

directory explorer

Definition at line 566 of file class.ilObjFileBasedLMGUI.php.

References ilUtil\getStyleSheetLocation().

{
$this->tpl = new ilTemplate("tpl.main.html", true, true);
$this->tpl->setVariable("LOCATION_STYLESHEET", ilUtil::getStyleSheetLocation());
$this->tpl->addBlockFile("CONTENT", "content", "tpl.explorer.html");
require_once ("./Modules/HTMLLearningModule/classes/class.ilFileExplorer.php");
$exp = new ilFileExplorer($this->lm->getDataDirectory());
}

+ Here is the call graph for this function:

ilObjFileBasedLMGUI::frameset ( )

output main frameset of media pool left frame: explorer tree of folders right frame: media pool content

Definition at line 553 of file class.ilObjFileBasedLMGUI.php.

References exit.

{
$this->tpl = new ilTemplate("tpl.fblm_edit_frameset.html", false, false,
"Modules/HTMLLearningModule");
$this->tpl->setVariable("HREF_FILES",$this->ctrl->getLinkTargetByClass(
"ilfilesystemgui", "listFiles"));
$this->tpl->show();
exit;
}
ilObjFileBasedLMGUI::getTabs ( &  $tabs_gui)

adds tabs to tab gui object

Parameters
object$tabs_guiilTabsGUI object

Reimplemented from ilObjectGUI.

Definition at line 693 of file class.ilObjFileBasedLMGUI.php.

References $_GET, and ilLearningProgressAccess\checkAccess().

Referenced by setTabs().

{
global $rbacsystem,$ilUser;
if($rbacsystem->checkAccess('write',$this->ref_id))
{
// properties
$tabs_gui->addTarget("cont_list_files",
$this->ctrl->getLinkTargetByClass("ilfilesystemgui", "listFiles"), "",
"ilfilesystemgui");
// info screen
$force_active = (strtolower($_GET["cmdClass"]) == "ilinfoscreengui"
|| strtolower($_GET["cmdClass"]) == "ilnotegui")
? true
: false;
$tabs_gui->addTarget("info_short",
$this->ctrl->getLinkTargetByClass(array("ilobjfilebasedlmgui",
"ilinfoscreengui"),
"showSummary"),
"infoScreen",
"",
"",
$force_active);
// properties
$tabs_gui->addTarget("properties",
$this->ctrl->getLinkTarget($this, "properties"), "properties",
get_class($this));
$tabs_gui->addTarget("meta_data",
$this->ctrl->getLinkTargetByClass('ilmdeditorgui',''),
"", "ilmdeditorgui");
// edit bib item information
$tabs_gui->addTarget("bib_data",
$this->ctrl->getLinkTarget($this, "editBibItem"),
array("editBibItem", "saveBibItem", "deleteBibItem", "addBibItem"),
get_class($this));
}
// learning progress
include_once './Services/Tracking/classes/class.ilLearningProgressAccess.php';
if(ilLearningProgressAccess::checkAccess($this->object->getRefId()))
{
$tabs_gui->addTarget('learning_progress',
$this->ctrl->getLinkTargetByClass(array('ilobjfilebasedlmgui','illearningprogressgui'),''),
'',
array('illplistofobjectsgui','illplistofsettingsgui','illearningprogressgui','illplistofprogressgui'));
}
// perm
if ($rbacsystem->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');
}
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilObjFileBasedLMGUI::getTemplate ( )

output main header (title and locator)

Definition at line 582 of file class.ilObjFileBasedLMGUI.php.

References ilObjectGUI\$lng.

Referenced by executeCommand().

{
global $lng;
$this->tpl->addBlockFile("CONTENT", "content", "tpl.adm_content.html");
//$this->tpl->setVariable("HEADER", $a_header_title);
$this->tpl->addBlockFile("STATUSLINE", "statusline", "tpl.statusline.html");
//$this->tpl->setVariable("TXT_LOCATOR",$this->lng->txt("locator"));
}

+ Here is the caller graph for this function:

ilObjFileBasedLMGUI::ilObjFileBasedLMGUI (   $a_data,
  $a_id = 0,
  $a_call_by_reference = true,
  $a_prepare_output = true 
)

Constructor.

public

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

References $ilCtrl, ilObjectGUI\$lng, and ilObjectGUI\ilObjectGUI().

{
global $lng, $ilCtrl;
$this->ctrl =& $ilCtrl;
$this->ctrl->saveParameter($this, array("ref_id"));
#include_once("classes/class.ilTabsGUI.php");
#$this->tabs_gui =& new ilTabsGUI();
$this->type = "htlm";
$lng->loadLanguageModule("content");
parent::ilObjectGUI($a_data, $a_id, $a_call_by_reference, false);
//$this->actions = $this->objDefinition->getActions("mep");
$this->output_prepared = $a_prepare_output;
}

+ Here is the call graph for this function:

ilObjFileBasedLMGUI::infoScreen ( )

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 612 of file class.ilObjFileBasedLMGUI.php.

References outputInfoScreen().

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

+ Here is the call graph for this function:

ilObjFileBasedLMGUI::outputInfoScreen (   $a_standard_locator = true)

info screen

Definition at line 630 of file class.ilObjFileBasedLMGUI.php.

References $_GET, and $ilBench.

Referenced by executeCommand(), infoScreen(), and showInfoScreen().

{
global $ilBench, $ilLocator, $ilAccess;
$this->tabs_gui->setTabActive('info_short');
$this->lng->loadLanguageModule("meta");
include_once("./Services/InfoScreen/classes/class.ilInfoScreenGUI.php");
$info = new ilInfoScreenGUI($this);
$info->enablePrivateNotes();
$info->enableLearningProgress();
$info->enableNews();
if ($ilAccess->checkAccess("write", "", $_GET["ref_id"]))
{
$info->enableNewsEditing();
$news_set = new ilSetting("news");
$enable_internal_rss = $news_set->get("enable_rss_for_internal");
if ($enable_internal_rss)
{
$info->setBlockProperty("news", "settings", true);
}
}
// add read / back button
if ($ilAccess->checkAccess("read", "", $_GET["ref_id"]))
{
$info->addButton($this->lng->txt("view"),
"ilias.php?baseClass=ilHTLMPresentationGUI&ref_id=".$this->object->getRefID(),
' target="ilContObj'.$this->object->getId().'" ');
}
// show standard meta data section
$info->addMetaDataSections($this->object->getId(),0, $this->object->getType());
// forward the command
$this->ctrl->forwardCommand($info);
}

+ Here is the caller graph for this function:

ilObjFileBasedLMGUI::perm ( )

permission form

Definition at line 393 of file class.ilObjFileBasedLMGUI.php.

References $_GET, ilObjectGUI\permObject(), and ilObjectGUI\setFormAction().

{
$this->setFormAction("permSave", "fblm_edit.php?cmd=permSave&ref_id=".$_GET["ref_id"].
"&obj_id=".$_GET["obj_id"]);
$this->setFormAction("addRole", "fblm_edit.php?ref_id=".$_GET["ref_id"].
"&obj_id=".$_GET["obj_id"]."&cmd=addRole");
$this->permObject();
}

+ Here is the call graph for this function:

ilObjFileBasedLMGUI::properties ( )

edit properties of object (admin form)

public

Definition at line 227 of file class.ilObjFileBasedLMGUI.php.

References ilObjectGUI\$tpl, ilObjectGUI\$tree, and ilObjFileBasedLMAccess\_determineStartUrl().

{
global $rbacsystem, $tree, $tpl;
// edit button
$this->tpl->addBlockfile("BUTTONS", "buttons", "tpl.buttons.html");
// view link
require_once("./Modules/HTMLLearningModule/classes/class.ilObjFileBasedLMAccess.php");
$startfile = ilObjFileBasedLMAccess::_determineStartUrl($this->object->getId());
if ($startfile != "")
{
$this->tpl->setCurrentBlock("btn_cell");
$this->tpl->setVariable("BTN_LINK",
"ilias.php?baseClass=ilHTLMPresentationGUI&ref_id=".$this->object->getRefID());
$this->tpl->setVariable("BTN_TARGET"," target=\"ilContObj".$this->object->getID()."\" ");
$this->tpl->setVariable("BTN_TXT",$this->lng->txt("view"));
$this->tpl->parseCurrentBlock();
}
// lm properties
$this->tpl->addBlockFile("ADM_CONTENT", "adm_content", "tpl.fblm_properties.html",
'Modules/HTMLLearningModule');
$this->tpl->setVariable("FORMACTION", $this->ctrl->getFormAction($this));
$this->tpl->setVariable("TXT_PROPERTIES", $this->lng->txt("cont_lm_properties"));
// online
$this->tpl->setVariable("TXT_ONLINE", $this->lng->txt("cont_online"));
$this->tpl->setVariable("CBOX_ONLINE", "cobj_online");
$this->tpl->setVariable("VAL_ONLINE", "y");
if ($this->object->getOnline())
{
$this->tpl->setVariable("CHK_ONLINE", "checked");
}
// start file
$this->tpl->setVariable("TXT_START_FILE", $this->lng->txt("cont_startfile"));
if ($startfile != "")
{
$this->tpl->setVariable("VAL_START_FILE", basename($startfile));
}
else
{
$this->tpl->setVariable("VAL_START_FILE", $this->lng->txt("no_start_file"));
}
$this->tpl->setVariable("TXT_SET_START_FILE", $this->lng->txt("cont_set_start_file"));
$this->tpl->setVariable("LINK_SET_START_FILE",
$this->ctrl->getLinkTargetByClass("ilfilesystemgui", "listFiles"));
$this->tpl->setCurrentBlock("commands");
$this->tpl->setVariable("BTN_NAME", "saveProperties");
$this->tpl->setVariable("BTN_TEXT", $this->lng->txt("save"));
$this->tpl->parseCurrentBlock();
}

+ Here is the call graph for this function:

ilObjFileBasedLMGUI::saveBibItem ( )

save bib item (module call)

Definition at line 429 of file class.ilObjFileBasedLMGUI.php.

References saveBibItemObject().

{
//$this->setTabs();
$this->saveBibItemObject($this->ctrl->getLinkTarget($this));
}

+ Here is the call graph for this function:

ilObjFileBasedLMGUI::saveBibItemObject (   $a_target = "")

save bib item (admin call)

Definition at line 405 of file class.ilObjFileBasedLMGUI.php.

References $_GET.

Referenced by saveBibItem().

{
include_once "./Modules/LearningModule/classes/class.ilBibItemGUI.php";
$bib_gui =& new ilBibItemGUI();
$bib_gui->setObject($this->object);
$bibItemIndex = $_POST["bibItemIndex"] ? $_POST["bibItemIndex"] : $_GET["bibItemIndex"];
$bibItemIndex *= 1;
if ($bibItemIndex < 0)
{
$bibItemIndex = 0;
}
$bibItemIndex = $bib_gui->save($bibItemIndex);
if ($a_target == "")
{
$a_target = "adm_object.php?ref_id=" . $this->object->getRefId();
}
$bib_gui->edit("ADM_CONTENT", "adm_content", $a_target, $bibItemIndex);
}

+ Here is the caller graph for this function:

ilObjFileBasedLMGUI::saveObject ( )

save object public

Reimplemented from ilObjectGUI.

Definition at line 300 of file class.ilObjFileBasedLMGUI.php.

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

{
global $rbacadmin;
// create and insert forum in objecttree
$newObj = parent::saveObject();
// setup rolefolder & default local roles
//$roles = $newObj->initDefaultRoles();
// ...finally assign role to creator of object
//$rbacadmin->assignUser($roles[0], $newObj->getOwner(), "y");
// put here object specific stuff
// always send a message
ilUtil::sendInfo($this->lng->txt("object_added"),true);
ilUtil::redirect("ilias.php?baseClass=ilHTLMEditorGUI&ref_id=".$newObj->getRefId());
//ilUtil::redirect($this->getReturnLocation("save","adm_object.php?".$this->link_params));
}

+ Here is the call graph for this function:

ilObjFileBasedLMGUI::saveProperties ( )

save properties

Definition at line 287 of file class.ilObjFileBasedLMGUI.php.

References ilUtil\sendInfo(), and ilUtil\yn2tf().

{
$this->object->setOnline(ilUtil::yn2tf($_POST["cobj_online"]));
$this->object->update();
ilUtil::sendInfo($this->lng->txt("msg_obj_modified"), true);
$this->ctrl->redirect($this, "properties");
}

+ Here is the call graph for this function:

ilObjFileBasedLMGUI::setStartFile (   $a_file)

Definition at line 383 of file class.ilObjFileBasedLMGUI.php.

{
$this->object->setStartFile($a_file);
$this->object->update();
$this->ctrl->redirectByClass("ilfilesystemgui", "listFiles");
}
ilObjFileBasedLMGUI::setTabs ( )

output tabs

Reimplemented from ilObjectGUI.

Definition at line 677 of file class.ilObjFileBasedLMGUI.php.

References ilUtil\getImagePath(), and getTabs().

Referenced by executeCommand().

{
$this->tpl->setCurrentBlock("header_image");
$this->tpl->setVariable("IMG_HEADER", ilUtil::getImagePath("icon_lm_b.gif"));
$this->tpl->parseCurrentBlock();
$this->getTabs($this->tabs_gui);
#$this->tpl->setVariable("TABS", $this->tabs_gui->getHTML());
$this->tpl->setVariable("HEADER", $this->object->getTitle());
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilObjFileBasedLMGUI::showInfoScreen ( )

info screen call from inside learning module

Definition at line 622 of file class.ilObjFileBasedLMGUI.php.

References outputInfoScreen().

{
$this->outputInfoScreen(true);
}

+ Here is the call graph for this function:

ilObjFileBasedLMGUI::showLearningModule ( )

Definition at line 592 of file class.ilObjFileBasedLMGUI.php.

References ilObjFileBasedLMAccess\_determineStartUrl(), ilTracking\_trackAccess(), and ilUtil\redirect().

{
// Track access
include_once "Services/Tracking/classes/class.ilTracking.php";
ilTracking::_trackAccess($this->object->getId(),'htlm');
require_once("./Modules/HTMLLearningModule/classes/class.ilObjFileBasedLMAccess.php");
$startfile = ilObjFileBasedLMAccess::_determineStartUrl($this->object->getId());
if ($startfile != "")
{
ilUtil::redirect($startfile);
}
}

+ Here is the call graph for this function:

ilObjFileBasedLMGUI::update ( )

update properties

Definition at line 375 of file class.ilObjFileBasedLMGUI.php.

References ilObjectGUI\updateObject().

{
//$this->setReturnLocation("update", "fblm_edit.php?cmd=listFiles&ref_id=".$_GET["ref_id"].
// "&obj_id=".$_GET["obj_id"]);
$this->updateObject();
}

+ Here is the call graph for this function:

Field Documentation

ilObjFileBasedLMGUI::$output_prepared

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

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