ILIAS  Release_4_4_x_branch Revision 61816
 All Data Structures Namespaces Files Functions Variables Groups Pages
Public Member Functions | Data Fields | Protected Member Functions
ilObjFolderGUI Class Reference

Class ilObjFolderGUI. More...

+ Inheritance diagram for ilObjFolderGUI:
+ Collaboration diagram for ilObjFolderGUI:

Public Member Functions

 ilObjFolderGUI ($a_data, $a_id=0, $a_call_by_reference=true, $a_prepare_output=false)
 Constructor public.
 viewObject ()
 View folder.
 renderObject ()
 Render folder.
& executeCommand ()
 execute command note: this method is overwritten in all container objects
 setFolderTree ($a_tree)
 set tree
 importFileObject ()
 Import object.
 showSummaryObject ()
 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
 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 information screen
 getTabs (&$tabs_gui)
 Get tabs.
 _goto ($a_target)
 goto target group
 downloadFolderObject ()
 modifyItemGUI ($a_item_list_gui, $a_item_data, $a_show_path)
 Modify Item ListGUI for presentation in container.
 editObject ()
 Edit.
 setSubTabs ($a_tab)
 Set sub tabs.
 editIconsObject ($a_form=null)
 Edit folder icons.
 initIconsForm ()
 updateIconsObject ()
 update container icons
- 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 ()
 confirmedDeleteObject ()
 confirmed deletion of object -> objects are moved to trash or deleted immediately, if trash is disabled
 cancelDeleteObject ()
 cancel deletion of object
 cancelObject ($in_rep=false)
 cancel action and go back to previous page public
 createObject ()
 create new object form
 cancelCreation ()
 cancel create action and go back to repository parent
 saveObject ()
 save 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)
 deleteObject ($a_error=false)
 Display deletion confirmation screen.
- Public Member Functions inherited from ilContainerGUI
 ilContainerGUI ($a_data, $a_id, $a_call_by_reference=true, $a_prepare_output=true)
 Constructor public.
 forwardToStyleSheet ()
 Forward to style object.
& forwardToPageObject ()
 forward command to page object
 addPageTabs ()
 Add page tabs.
 getContainerPageHTML ()
 Get container page HTML.
 prepareOutput ($a_show_subobjects=true)
 prepare output
 showTreeFlatIcon ()
 setTitleAndDescription ()
 called by prepare output
 showPossibleSubObjects ()
 show possible sub objects selection list
 getContentGUI ()
 Get content gui object.
 setContentSubTabs ()
 Set content sub tabs.
 showAdministrationPanel (&$tpl)
 show administration panel
 __showTimingsButton (&$tpl)
 showPermanentLink (&$tpl)
 show permanent link
 switchToStdEditorObject ()
 Switch to standard page editor.
 switchToOldEditorObject ()
 Switch to old page editor.
 useNewEditorObject ()
 Use new editor (-> delete xhtml content page)
 editPageFrameObject ()
 show page editor frameset
 editPageContentObject ()
 edit page content (for repository root node and categories)
 savePageContentObject ()
 cancelPageContentObject ()
 renderItemList ($a_type="all")
 showLinkListObject ()
 clearAdminCommandsDetermination ()
 cleaer administration commands determination
& newBlockTemplate ()
 determin admin commands
 addHeaderRow (&$a_tpl, $a_type, $a_show_image=true)
 adds a header row to a block template
 addStandardRow (&$a_tpl, $a_html, $a_item_ref_id="", $a_item_obj_id="", $a_image_type="")
 adds a standard row to a block template
 addMessageRow (&$a_tpl, $a_message, $a_type)
 add message row
 resetRowType ()
 setPageEditorTabs ()
 Add page editor tabs.
 addStandardContainerSubTabs ($a_include_view=true)
 Add standar container subtabs for view, manage, oderdering and text/media editor link.
 enableAdministrationPanelObject ()
 enable administration panel
 disableAdministrationPanelObject ()
 enable administration panel
 editOrderObject ()
 Edit order.
 isActiveOrdering ()
 Check if ordering is enabled.
 addToDeskObject ()
 removeFromDeskObject ()
 enableMultiDownloadObject ()
 isMultiDownloadEnabled ()
 lockObject ()
 cutObject ()
 cut object(s) out from a container and write the information to clipboard
 copyObject ()
 Copy object(s) out from a container and write the information to clipboard It is not possible to copy multiple objects at once.
 downloadObject ()
 linkObject ()
 create an new reference of an object in tree it's like a hard link of unix
 clearObject ()
 clear clipboard and go back to last object
 performPasteIntoMultipleObjectsObject ()
 initAndDisplayLinkIntoMultipleObjectsObject ()
 showPasteTreeObject ()
 Show paste tree.
 cancelMoveLinkObject ()
 Cancel move|link empty clipboard and return to parent.
 keepObjectsInClipboardObject ()
 Keep objects in the clipboard.
 initAndDisplayCopyIntoMultipleObjectsObject ()
 initAndDisplayMoveIntoObjectObject ()
 pasteObject ()
 paste object from clipboard to current place Depending on the chosen command the object(s) are linked, copied or moved
 clipboardObject ()
 Copy object(s) out from a container and write the information to clipboard It is not possible to copy multiple objects at once.
 showCustomIconsEditing ($a_input_colspan=1, ilPropertyFormGUI $a_form=null, $a_as_section=true)
 show edit section of custom icons for container
 isActiveAdministrationPanel ()
 setColumnSettings ($column_gui)
 May be overwritten in subclasses.
 allowBlocksMoving ()
 Standard is to allow blocks moving.
 allowBlocksConfigure ()
 Standard is to allow blocks configuration.
 cloneWizardPageTreeObject ()
 public
 cloneWizardPageListObject ()
 public
 cloneWizardPageObject ($a_tree_view=true)
 Show clone wizard page for container objects.
 cloneAllObject ()
 Clone all object Overwritten method for copying container objects.
 saveSortingObject ()
 Save Sorting.
 cloneNodes ($srcRef, $dstRef, &$mapping, $newName=null)
 Recursively clones all nodes of the RBAC tree.
 modifyItemGUI (&$a_item_list_gui, $a_item_data, $a_show_path)
 Modify Item ListGUI for presentation in container.
 editStylePropertiesObject ()
 Edit style properties.
 initStylePropertiesForm ()
 Init style properties form.
 createStyleObject ()
 Create Style.
 editStyleObject ()
 Edit Style.
 deleteStyleObject ()
 Delete Style.
 saveStyleSettingsObject ()
 Save style settings.
 getAsynchItemListObject ()
 Get item list command drop down asynchronously.
 redrawListItemObject ()
 Redraw a list item (ajax)
 showRepTree ($a_initial_call=false)
 Show tree.
 trashObject ()
 Show trash content of object.
 removeFromSystemObject ()
 remove objects from trash bin and all entries therefore every object needs a specific deleteObject() method
 undeleteObject ()
 Get objects back from trash.
 confirmRemoveFromSystemObject ()
 confirmation screen remove from system

Data Fields

 $folder_tree
- 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
const CFORM_NEW = 1
const CFORM_IMPORT = 2
const CFORM_CLONE = 3
- Data Fields inherited from ilContainerGUI
 $bl_cnt = 1
 $multi_download_enabled = false

Protected Member Functions

 initEditCustomForm (ilPropertyFormGUI $a_form)
 Add custom fields to update form.
 getEditFormCustomValues (array &$a_values)
 Add values to custom edit fields.
 updateCustom (ilPropertyFormGUI $a_form)
 Insert custom update form values into object.
 afterSave (ilObject $a_new_object)
 Post (successful) object creation hook.
 forwardToTimingsView ()
- Protected Member Functions inherited from ilObjectGUI
 assignObject ()
 prepareOutput ()
 prepare output
 insertHeaderAction ($a_list_gui)
 Insert header action into main template.
 addHeaderAction ()
 Add header action menu.
 redrawHeaderActionObject ()
 Ajax call: redraw action header only.
 showMountWebfolderIcon ()
 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 ($a_do_not_add_object=false)
 should be overwritten to add object specific items (repository items are preloaded)
 initCreationForms ($a_new_type)
 Init creation froms.
 getCreationFormsHTML (array $a_forms)
 Get HTML for creation forms (accordion)
 initCreateForm ($a_new_type)
 Init object creation form.
 initDidacticTemplate (ilPropertyFormGUI $form)
 Show didactic template types.
 addDidacticTemplateOptions (array &$a_options)
 Add custom templates.
 getDidacticTemplateVar ($a_type)
 Get didactic template setting from creation screen.
 putObjectInTree (ilObject $a_obj, $a_parent_node_id=null)
 Add object to tree at given position.
 initEditForm ()
 Init object edit form.
 initImportForm ($a_new_type)
 Init object import form.
 importFileObject ($parent_id=null)
 Import.
 afterImport (ilObject $a_new_object)
 Post (successful) object import hook.
 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
 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
 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.
 getCenterColumnHTML ()
 Get center column.
 getRightColumnHTML ()
 Display right column.
 checkPermission ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
 Check permission and redirect on error.
 checkPermissionBool ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
 Check permission.
 enableDragDropFileUpload ()
 Enables the file upload into this object by dropping files.
 handleAutoRating (ilObject $a_new_obj)
 Activate rating automatically if parent container setting.
- Protected Member Functions inherited from ilContainerGUI
 getEditFormValues ()
 Get values for edit form.
 afterUpdate ()
 Post (successful) object update hook.
 showPasswordInstructionObject ($a_init=true)
 Show webdav password instruction.
 initFormPasswordInstruction ()
 Init password form.
 savePasswordObject ()
 Save password.
 initHeaderAction ($a_sub_type=null, $a_sub_id=null)
 Add file manager link.
 fileManagerLaunchObject ()
 Launch jnlp.

Additional Inherited Members

- Static Public Member Functions inherited from ilObjectGUI
static _gotoRepositoryRoot ($a_raise_error=false)
 Goto repository root.
static _gotoRepositoryNode ($a_ref_id, $a_cmd="frameset")
 Goto repository root.
- Static Public Member Functions inherited from ilContainerGUI
static _buildPath ($a_ref_id, $a_course_ref_id)
 build path

Detailed Description

Class ilObjFolderGUI.

Author
Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e
Id:
class.ilObjFolderGUI.php 52337 2014-08-15 11:08:37Z smeyer

ilObjFolderGUI: ilPermissionGUI ilObjFolderGUI: ilCourseContentGUI, ilLearningProgressGUI ilObjFolderGUI: ilInfoScreenGUI, ilContainerPageGUI, ilColumnGUI ilObjFolderGUI: ilObjectCopyGUI, ilObjStyleSheetGUI ilObjFolderGUI: ilExportGUI, ilCommonActionDispatcherGUI, ilDidacticTemplateGUI

Definition at line 22 of file class.ilObjFolderGUI.php.

Member Function Documentation

ilObjFolderGUI::_goto (   $a_target)

goto target group

Definition at line 412 of file class.ilObjFolderGUI.php.

References $ilErr, ilObjectGUI\$lng, and ilObjectGUI\_gotoRepositoryNode().

{
global $ilAccess, $ilErr, $lng;
if ($ilAccess->checkAccess("read", "", $a_target))
{
ilObjectGUI::_gotoRepositoryNode($a_target);
}
$ilErr->raiseError($lng->txt("msg_no_perm_read"), $ilErr->FATAL);
}

+ Here is the call graph for this function:

ilObjFolderGUI::afterSave ( ilObject  $a_new_object)
protected

Post (successful) object creation hook.

Parameters
ilObject$a_new_object

Reimplemented from ilObjectGUI.

Definition at line 267 of file class.ilObjFolderGUI.php.

References ilObject\getId(), ilObject\getRefId(), ilObjectGUI\redirectToRefId(), ilUtil\sendSuccess(), ilContainerSortingSettings\setSortMode(), and ilContainer\SORT_INHERIT.

{
include_once './Services/Container/classes/class.ilContainerSortingSettings.php';
$sort = new ilContainerSortingSettings($a_new_object->getId());
$sort->setSortMode(ilContainer::SORT_INHERIT);
$sort->update();
// always send a message
ilUtil::sendSuccess($this->lng->txt("fold_added"),true);
$this->ctrl->setParameter($this, "ref_id", $a_new_object->getRefId());
$this->redirectToRefId($a_new_object->getRefId(), "");
}

+ Here is the call graph for this function:

ilObjFolderGUI::downloadFolderObject ( )

Definition at line 424 of file class.ilObjFolderGUI.php.

References $filename, $ilErr, ilObjectGUI\$lng, ilUtil\deliverFile(), and ilUtil\getASCIIFilename().

{
global $ilAccess, $ilErr, $lng;
if (!$ilAccess->checkAccess("read", "", $this->ref_id))
{
$this->ilias->raiseError($this->lng->txt("msg_no_perm_read"),$this->ilias->error_obj->MESSAGE);
}
$filename = $this->object->downloadFolder();
ilUtil::deliverFile($filename, ilUtil::getASCIIFilename($this->object->getTitle().".zip"));
}

+ Here is the call graph for this function:

ilObjFolderGUI::editIconsObject (   $a_form = null)

Edit folder icons.

Definition at line 526 of file class.ilObjFolderGUI.php.

References ilObjectGUI\$tpl, ilObjectGUI\checkPermission(), and initIconsForm().

Referenced by updateIconsObject().

{
global $tpl;
$this->checkPermission('write');
$this->tabs_gui->setTabActive('settings');
if(!$a_form)
{
$a_form = $this->initIconsForm();
}
$tpl->setContent($a_form->getHTML());
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilObjFolderGUI::editObject ( )

Edit.

Parameters
@return

Reimplemented from ilObjectGUI.

Definition at line 488 of file class.ilObjFolderGUI.php.

References setSubTabs().

{
$this->setSubTabs("settings");
parent::editObject();
}

+ Here is the call graph for this function:

& ilObjFolderGUI::executeCommand ( )

execute command note: this method is overwritten in all container objects

Reimplemented from ilContainerGUI.

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

References $_GET, $cmd, $ilCtrl, $ilUser, $ret, ilObjectGUI\addHeaderAction(), ilObjectGUI\checkPermission(), ilContainerGUI\forwardToPageObject(), ilContainerGUI\forwardToStyleSheet(), forwardToTimingsView(), ilCommonActionDispatcherGUI\getInstanceFromAjaxCall(), infoScreen(), ilLearningProgressBaseGUI\LP_CONTEXT_REPOSITORY, ilObjectGUI\prepareOutput(), and ilContainerGUI\showRepTree().

{
global $ilUser,$ilCtrl;
$next_class = $this->ctrl->getNextClass($this);
$cmd = $this->ctrl->getCmd();
// show repository tree
$this->showRepTree(true);
switch ($next_class)
{
case 'ilpermissiongui':
$this->prepareOutput();
$this->tabs_gui->setTabActive('perm_settings');
include_once("Services/AccessControl/classes/class.ilPermissionGUI.php");
$perm_gui =& new ilPermissionGUI($this);
$ret =& $this->ctrl->forwardCommand($perm_gui);
break;
case 'ilcoursecontentgui':
$this->prepareOutput();
include_once './Modules/Course/classes/class.ilCourseContentGUI.php';
$course_content_obj = new ilCourseContentGUI($this);
$this->ctrl->forwardCommand($course_content_obj);
break;
case "illearningprogressgui":
$this->prepareOutput();
include_once './Services/Tracking/classes/class.ilLearningProgressGUI.php';
$new_gui =& new ilLearningProgressGUI(ilLearningProgressGUI::LP_CONTEXT_REPOSITORY,
$this->object->getRefId(),
$_GET['user_id'] ? $_GET['user_id'] : $ilUser->getId());
$this->ctrl->forwardCommand($new_gui);
$this->tabs_gui->setTabActive('learning_progress');
break;
// container page editing
case "ilcontainerpagegui":
$this->prepareOutput(false);
$this->checkPermission("write");
$ret = $this->forwardToPageObject();
if ($ret != "")
{
$this->tpl->setContent($ret);
}
break;
case 'ilinfoscreengui':
$this->prepareOutput();
$this->infoScreen();
break;
case 'ilobjectcopygui':
$this->prepareOutput();
include_once './Services/Object/classes/class.ilObjectCopyGUI.php';
$cp = new ilObjectCopyGUI($this);
$cp->setType('fold');
$this->ctrl->forwardCommand($cp);
break;
case "ilobjstylesheetgui":
$this->forwardToStyleSheet();
break;
case 'ilexportgui':
$this->prepareOutput();
$this->tabs_gui->setTabActive('export');
include_once './Services/Export/classes/class.ilExportGUI.php';
$exp = new ilExportGUI($this);
$exp->addFormat('xml');
$this->ctrl->forwardCommand($exp);
break;
case "ilcommonactiondispatchergui":
include_once("Services/Object/classes/class.ilCommonActionDispatcherGUI.php");
$gui = ilCommonActionDispatcherGUI::getInstanceFromAjaxCall();
$this->ctrl->forwardCommand($gui);
break;
case 'ildidactictemplategui':
$this->ctrl->setReturn($this,'edit');
include_once './Services/DidacticTemplate/classes/class.ilDidacticTemplateGUI.php';
$did = new ilDidacticTemplateGUI($this);
$this->ctrl->forwardCommand($did);
break;
default:
$this->prepareOutput();
// Dirty hack for course timings view
if($this->forwardToTimingsView())
{
break;
}
if (empty($cmd))
{
$cmd = "view";
}
$cmd .= "Object";
$this->$cmd();
break;
}
$this->addHeaderAction();
}

+ Here is the call graph for this function:

ilObjFolderGUI::forwardToTimingsView ( )
protected

Definition at line 454 of file class.ilObjFolderGUI.php.

References $_SESSION, ilObjectGUI\$tree, ilObject\_lookupObjId(), ilObjCourse\_lookupViewMode(), and ilContainer\VIEW_TIMING.

Referenced by executeCommand().

{
global $tree;
if(!$crs_ref = $tree->checkForParentType($this->ref_id, 'crs'))
{
return false;
}
include_once './Modules/Course/classes/class.ilObjCourse.php';
if(!$this->ctrl->getCmd() and ilObjCourse::_lookupViewMode(ilObject::_lookupObjId($crs_ref)) == ilContainer::VIEW_TIMING)
{
if(!isset($_SESSION['crs_timings'])) {
$_SESSION['crs_timings'] = true;
}
if($_SESSION['crs_timings'] == true) {
include_once './Modules/Course/classes/class.ilCourseContentGUI.php';
$course_content_obj = new ilCourseContentGUI($this);
$this->ctrl->setCmdClass(get_class($course_content_obj));
$this->ctrl->setCmd('editUserTimings');
$this->ctrl->forwardCommand($course_content_obj);
return true;
}
}
$_SESSION['crs_timings'] = false;
return false;
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilObjFolderGUI::getEditFormCustomValues ( array &  $a_values)
protected

Add values to custom edit fields.

Parameters
array$a_values

Reimplemented from ilObjectGUI.

Definition at line 236 of file class.ilObjFolderGUI.php.

References ilContainerSortingSettings\getSortMode().

{
// we cannot use $this->object->getOrderType()
// if set to inherit it will be translated to parent setting
include_once './Services/Container/classes/class.ilContainerSortingSettings.php';
$sort = new ilContainerSortingSettings($this->object->getId());
$a_values["sor"] = $sort->getSortMode();
}

+ Here is the call graph for this function:

ilObjFolderGUI::getTabs ( &  $tabs_gui)

Get tabs.

Reimplemented from ilContainerGUI.

Definition at line 340 of file class.ilObjFolderGUI.php.

References $_GET, $_SESSION, $ilCtrl, $ilUser, ilObjectGUI\$lng, and ilLearningProgressAccess\checkAccess().

{
global $rbacsystem, $ilUser, $lng, $ilCtrl,$ilAccess, $ilHelp;
$this->ctrl->setParameter($this,"ref_id",$this->ref_id);
$ilHelp->setScreenIdComponent("fold");
$tabs_gui->setTabActive("");
if ($rbacsystem->checkAccess('read',$this->ref_id))
{
$tabs_gui->addTab("view_content", $lng->txt("content"),
$this->ctrl->getLinkTarget($this, ""));
//BEGIN ChangeEvent add info tab to category object
$force_active = ($this->ctrl->getNextClass() == "ilinfoscreengui"
|| strtolower($_GET["cmdClass"]) == "ilnotegui")
? true
: false;
$tabs_gui->addTarget("info_short",
$this->ctrl->getLinkTargetByClass(
array("ilobjfoldergui", "ilinfoscreengui"), "showSummary"),
array("showSummary","", "infoScreen"),
"", "", $force_active);
//END ChangeEvent add info tab to category object
}
if ($rbacsystem->checkAccess('write',$this->ref_id))
{
$tabs_gui->addTarget("settings",
$this->ctrl->getLinkTarget($this, "edit"), "edit", "", "", ($ilCtrl->getCmd() == "edit"));
}
// 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('ilobjfoldergui','illearningprogressgui'),''),
'',
array('illplistofobjectsgui','illplistofsettingsgui','illearningprogressgui','illplistofprogressgui'));
}
if($ilAccess->checkAccess('write','',$this->object->getRefId()))
{
$tabs_gui->addTarget(
'export',
$this->ctrl->getLinkTargetByClass('ilexportgui',''),
'export',
'ilexportgui'
);
}
if ($rbacsystem->checkAccess('edit_permission',$this->ref_id))
{
$tabs_gui->addTarget("perm_settings",
$this->ctrl->getLinkTargetByClass(array(get_class($this),'ilpermissiongui'), "perm"), array("perm","info","owner"), 'ilpermissiongui');
}
// show clipboard in repository
if ($_GET["baseClass"] == "ilRepositoryGUI" and !empty($_SESSION['il_rep_clipboard']))
{
$tabs_gui->addTarget("clipboard",
$this->ctrl->getLinkTarget($this, "clipboard"), "clipboard", get_class($this));
}
}

+ Here is the call graph for this function:

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

Constructor public.

Definition at line 30 of file class.ilObjFolderGUI.php.

{
$this->type = "fold";
parent::__construct($a_data, $a_id, $a_call_by_reference, $a_prepare_output, false);
}
ilObjFolderGUI::importFileObject ( )

Import object.

Returns

Definition at line 193 of file class.ilObjFolderGUI.php.

References ilObjectGUI\$lng, and ilUtil\sendSuccess().

{
global $lng;
if(parent::importFileObject())
{
ilUtil::sendSuccess($lng->txt("msg_obj_modified"), true);
$this->ctrl->returnToParent($this);
}
}

+ Here is the call graph for this function:

ilObjFolderGUI::infoScreen ( )

show information screen

Definition at line 295 of file class.ilObjFolderGUI.php.

References $_GET.

Referenced by executeCommand(), infoScreenObject(), and showSummaryObject().

{
global $ilAccess;
if (!$ilAccess->checkAccess("visible", "", $this->ref_id))
{
$this->ilias->raiseError($this->lng->txt("msg_no_perm_read"),$this->ilias->error_obj->MESSAGE);
}
include_once("./Services/InfoScreen/classes/class.ilInfoScreenGUI.php");
$info = new ilInfoScreenGUI($this);
$info->enablePrivateNotes();
if ($ilAccess->checkAccess("read", "", $_GET["ref_id"]))
{
$info->enableNews();
}
// no news editing for files, just notifications
$info->enableNewsEditing(false);
if ($ilAccess->checkAccess("write", "", $_GET["ref_id"]))
{
$news_set = new ilSetting("news");
$enable_internal_rss = $news_set->get("enable_rss_for_internal");
if ($enable_internal_rss)
{
$info->setBlockProperty("news", "settings", true);
$info->setBlockProperty("news", "public_notifications_option", true);
}
}
// standard meta data
$info->addMetaDataSections($this->object->getId(),0, $this->object->getType());
// forward the command
$this->ctrl->forwardCommand($info);
}

+ Here is the caller graph for this function:

ilObjFolderGUI::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 285 of file class.ilObjFolderGUI.php.

References infoScreen().

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

+ Here is the call graph for this function:

ilObjFolderGUI::initEditCustomForm ( ilPropertyFormGUI  $a_form)
protected

Add custom fields to update form.

Parameters
ilPropertyFormGUI$a_form

Reimplemented from ilObjectGUI.

Definition at line 204 of file class.ilObjFolderGUI.php.

References ilPropertyFormGUI\addItem(), ilObjectGUI\initDidacticTemplate(), ilContainerSortingSettings\lookupSortModeFromParentContainer(), ilFormPropertyGUI\setRequired(), ilContainer\SORT_INHERIT, ilContainer\SORT_MANUAL, ilContainer\SORT_TITLE, and ilContainerSortingSettings\sortModeToString().

{
// Show didactic template type
$this->initDidacticTemplate($a_form);
// Sorting
$sog = new ilRadioGroupInputGUI($this->lng->txt('sorting_header'),'sor');
$sog->setRequired(true);
// implicit: there is always a group or course in the path
$sde = new ilRadioOption();
$sde->setValue(ilContainer::SORT_INHERIT);
$sde->setTitle($this->lng->txt('sort_inherit_prefix').' ('.
ilContainerSortingSettings::sortModeToString(ilContainerSortingSettings::lookupSortModeFromParentContainer($this->object->getId())).') ');
$sde->setInfo($this->lng->txt('sorting_info_inherit'));
$sog->addOption($sde);
$sma = new ilRadioOption();
$sma->setValue(ilContainer::SORT_TITLE);
$sma->setTitle($this->lng->txt('sorting_title_header'));
$sma->setInfo($this->lng->txt('sorting_info_title'));
$sog->addOption($sma);
$sti = new ilRadioOption();
$sti->setValue(ilContainer::SORT_MANUAL);
$sti->setTitle($this->lng->txt('sorting_manual_header'));
$sti->setInfo($this->lng->txt('sorting_info_manual'));
$sog->addOption($sti);
$a_form->addItem($sog);
}

+ Here is the call graph for this function:

ilObjFolderGUI::initIconsForm ( )

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

References setSubTabs(), and ilContainerGUI\showCustomIconsEditing().

Referenced by editIconsObject(), and updateIconsObject().

{
$this->setSubTabs("icons");
include_once "Services/Form/classes/class.ilPropertyFormGUI.php";
$form = new ilPropertyFormGUI();
$form->setFormAction($this->ctrl->getFormAction($this));
$this->showCustomIconsEditing(1, $form);
// $form->setTitle($this->lng->txt('edit_grouping'));
$form->addCommandButton('updateIcons', $this->lng->txt('save'));
return $form;
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilObjFolderGUI::modifyItemGUI (   $a_item_list_gui,
  $a_item_data,
  $a_show_path 
)

Modify Item ListGUI for presentation in container.

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

References ilObjectGUI\$tree, ilObjCourse\_lookupAboStatus(), ilObject\_lookupObjId(), and ilObjCourseGUI\_modifyItemGUI().

{
global $tree;
// if folder is in a course, modify item list gui according to course requirements
if ($course_ref_id = $tree->checkForParentType($this->object->getRefId(),'crs'))
{
include_once("./Modules/Course/classes/class.ilObjCourse.php");
include_once("./Modules/Course/classes/class.ilObjCourseGUI.php");
$course_obj_id = ilObject::_lookupObjId($course_ref_id);
ilObjCourseGUI::_modifyItemGUI($a_item_list_gui, 'ilcoursecontentgui', $a_item_data, $a_show_path,
ilObjCourse::_lookupAboStatus($course_obj_id), $course_ref_id, $course_obj_id,
$this->object->getRefId());
}
}

+ Here is the call graph for this function:

ilObjFolderGUI::renderObject ( )

Render folder.

Reimplemented from ilContainerGUI.

Definition at line 59 of file class.ilObjFolderGUI.php.

References $ret, and ilObjectGUI\checkPermission().

Referenced by viewObject().

{
global $ilTabs;
$this->checkPermission('read');
$ilTabs->activateTab("view_content");
$ret = parent::renderObject();
return $ret;
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilObjFolderGUI::setFolderTree (   $a_tree)

set tree

Definition at line 184 of file class.ilObjFolderGUI.php.

{
$this->folder_tree =& $a_tree;
}
ilObjFolderGUI::setSubTabs (   $a_tab)

Set sub tabs.

Definition at line 498 of file class.ilObjFolderGUI.php.

References ilObjectGUI\$lng.

Referenced by editObject(), and initIconsForm().

{
global $ilTabs, $lng;
$ilTabs->addSubTab("settings",
$lng->txt("fold_settings"),
$this->ctrl->getLinkTarget($this,'edit'));
// custom icon
if ($this->ilias->getSetting("custom_icons"))
{
$ilTabs->addSubTab("icons",
$lng->txt("icon_settings"),
$this->ctrl->getLinkTarget($this,'editIcons'));
}
$ilTabs->activateSubTab($a_tab);
$ilTabs->activateTab("settings");
}

+ Here is the caller graph for this function:

ilObjFolderGUI::showSummaryObject ( )

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 260 of file class.ilObjFolderGUI.php.

References infoScreen().

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

+ Here is the call graph for this function:

ilObjFolderGUI::updateCustom ( ilPropertyFormGUI  $a_form)
protected

Insert custom update form values into object.

Parameters
ilPropertyFormGUI$a_form

Reimplemented from ilObjectGUI.

Definition at line 245 of file class.ilObjFolderGUI.php.

References ilPropertyFormGUI\getInput(), and ilContainerSortingSettings\setSortMode().

{
// Save sorting
include_once './Services/Container/classes/class.ilContainerSortingSettings.php';
$sort = new ilContainerSortingSettings($this->object->getId());
$sort->setSortMode($a_form->getInput('sor'));
$sort->update();
}

+ Here is the call graph for this function:

ilObjFolderGUI::updateIconsObject ( )

update container icons

Definition at line 561 of file class.ilObjFolderGUI.php.

References $_POST, ilObjectGUI\checkPermission(), editIconsObject(), initIconsForm(), and ilUtil\sendSuccess().

{
$this->checkPermission('write');
$form = $this->initIconsForm();
if($form->checkInput())
{
//save custom icons
if ($this->ilias->getSetting("custom_icons"))
{
if($_POST["cont_big_icon_delete"])
{
$this->object->removeBigIcon();
}
if($_POST["cont_small_icon_delete"])
{
$this->object->removeSmallIcon();
}
if($_POST["cont_tiny_icon_delete"])
{
$this->object->removeTinyIcon();
}
$this->object->saveIcons($_FILES["cont_big_icon"]['tmp_name'],
$_FILES["cont_small_icon"]['tmp_name'], $_FILES["cont_tiny_icon"]['tmp_name']);
}
ilUtil::sendSuccess($this->lng->txt("msg_obj_modified"),true);
$this->ctrl->redirect($this,"editIcons");
}
$form->setValuesByPost();
$this->editIconsObject($form);
}

+ Here is the call graph for this function:

ilObjFolderGUI::viewObject ( )

View folder.

Reimplemented from ilObjectGUI.

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

References $_GET, ilObjectGUI\$tree, ilObjectGUI\checkPermission(), and renderObject().

{
global $tree;
$this->checkPermission('read');
if (strtolower($_GET["baseClass"]) == "iladministrationgui")
{
parent::viewObject();
return true;
}
$this->renderObject();
$this->tabs_gui->setTabActive('view_content');
return true;
}

+ Here is the call graph for this function:

Field Documentation

ilObjFolderGUI::$folder_tree

Definition at line 24 of file class.ilObjFolderGUI.php.

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