ilPCFileListGUI Class Reference

Class ilPCListGUI. More...

Inheritance diagram for ilPCFileListGUI:

Collaboration diagram for ilPCFileListGUI:

Public Member Functions
	__construct (ilPageObject $a_pg_obj, ?ilPageContent $a_content_obj, string $a_hier_id, string $a_pc_id="")
	executeCommand ()
	execute command More...
	insert (?ilPropertyFormGUI $a_form=null)
	insert new file list form More...
	selectFile ()
	insertFromRepository (string $a_cmd="insert")
	Insert file from repository. More...
	insertFromWorkspace (string $a_cmd="insert")
	Insert file from personal workspace. More...
	create ()
	create new file list in dom and update page in db More...
	afterCreation ()
	edit ()
	editProperties ()
	edit properties form More...
	initEditForm (string $a_mode="edit")
	Init edit form. More...
	saveProperties ()
	save table properties in db and return to page edit screen More...
	setTabs (bool $a_create=true)
	Set Tabs. More...
	addFileItem ()
	Add file item. More...
	deleteFileItem ()
	Delete file items from list. More...
	confirmDeletionFileItem ()
	savePositions ()
	Save positions of file items. More...
	editStyleClass (string $id)
	savePositionsAndClasses ()
	Save positions of file items and style classes. More...
	checkStyleSelection ()
	Checks whether style selection shoudl be available or not. More...
	newFileItem ()
	New file item (called, if there is no file item in an existing) More...
	insertNewFileItem (int $a_file_ref_id=0)
	insert new file item after another item More...
	createFileItem ()
	insert new file item More...
	setItemTabs (string $a_cmd="")
	output tabs More...
Public Member Functions inherited from ilPageContentGUI
	__construct (ilPageObject $a_pg_obj, ?ilPageContent $a_content_obj, string $a_hier_id="", string $a_pc_id="0")
	setContentObject (ilPageContent $a_val)
	getContentObject ()
	setPage (ilPageObject $a_val)
	getPage ()
	setPageConfig (ilPageConfig $a_val)
	getPageConfig ()
	setStyleId (int $a_styleid)
	getStyleId ()
	getStyle ()
	getCharacteristicsOfCurrentStyle (array $a_type)
	Get characteristics of current style and call setCharacteristics, if style is given. More...
	setCharacteristics (array $a_chars)
	getCharacteristics ()
	getHierId ()
	setHierId (string $a_hier_id)
	set hierarchical id in dom object More...
	delete ()
	displayValidationError ()
	cancelCreate ()
	cancel creating page content More...
	cancelUpdate ()
	cancel update More...
	cancel ()
	Cancel. More...
	deactivate ()
	gui function set enabled if is not enabled and vice versa More...
	cut ()
	Cut single element. More...
	copy ()
	Copy single element. More...
	getTemplateOptions (string $a_type="")
	Get table templates. More...

Protected Member Functions
	getEditStyleForm (string $id)
	saveStyleClass ()
Protected Member Functions inherited from ilPageContentGUI
	redirectToParent (string $hier_id="")
	getParentReturn (string $hier_id="")
	updateAndReturn ()
	setCurrentTextLang (string $lang_key)
	getCurrentTextLang ()
	setEditorToolContext ()
	initEditor ()
	getEditorScriptTag (string $form_pc_id="", string $form_cname="")

Protected Attributes
ILIAS COPage InternalDomainService	$domain
string	$requested_file_ref_id
ilObjUser	$user
ilTabsGUI	$tabs
ilTree	$tree
ilToolbarGUI	$toolbar
ilSetting	$settings
Protected Attributes inherited from ilPageContentGUI
ILIAS COPage Editor GUIService	$editor_gui
ILIAS COPage InternalGUIService	$gui
EditSessionRepository	$edit_repo
string	$pc_id = ""
array	$chars
ilObjStyleSheet	$style = null
LOMServices	$lom_services
ilLogger	$log
int	$styleid = 0
EditGUIRequest	$request
string	$sub_command = ""
int	$requested_ref_id = 0
ILIAS GlobalScreen ScreenContext ContextServices	$tool_context
Style Content CharacteristicManager	$char_manager

Additional Inherited Members
Static Public Member Functions inherited from ilPageContentGUI
static	_getCommonBBButtons ()
Data Fields inherited from ilPageContentGUI
ilPageContent	$content_obj
ilGlobalTemplateInterface	$tpl
ilLanguage	$lng
ilCtrl	$ctrl
ilPageObject	$pg_obj
string	$hier_id = ""
DOMDocument	$dom
array bool null	$updated = null
string	$target_script = ""
string	$return_location = ""
ilPageConfig	$page_config = null
Static Public Attributes inherited from ilPageContentGUI
static string	$style_selector_reset = "margin-top:2px; margin-bottom:2px; text-indent:0px; position:static; float:none; width: auto;"
Static Protected Attributes inherited from ilPageContentGUI
static array	$common_bb_buttons

Detailed Description

Class ilPCListGUI.

User Interface for LM List Editing

Author

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

Definition at line 28 of file class.ilPCFileListGUI.php.

Constructor & Destructor Documentation

__construct()

ilPCFileListGUI::__construct	(	ilPageObject	$a_pg_obj,
		?ilPageContent	$a_content_obj,
		string	$a_hier_id,
		string	$a_pc_id = ""
	)

Reimplemented from ilPageContentGUI.

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

      {
        global $DIC;
 
        $this->user = $DIC->user();
        $this->tabs = $DIC->tabs();
        $this->ctrl = $DIC->ctrl();
        $this->tpl = $DIC["tpl"];
        $this->tree = $DIC->repositoryTree();
        $this->lng = $DIC->language();
        $this->toolbar = $DIC->toolbar();
        $this->settings = $DIC->settings();
        $this->domain = $DIC->copage()->internal()->domain();
        parent::__construct($a_pg_obj, $a_content_obj, $a_hier_id, $a_pc_id);
        $this->setCharacteristics(array("FileListItem" => $this->lng->txt("cont_FileListItem")));
        $this->requested_file_ref_id = $this->request->getString("file_ref_id");
    }

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ilPageContentGUI\setCharacteristics(), ILIAS\Repository\settings(), ILIAS\Repository\tabs(), ILIAS\Repository\toolbar(), and ILIAS\Repository\user().

Here is the call graph for this function:

Member Function Documentation

addFileItem()

ilPCFileListGUI::addFileItem

(

)

Add file item.

This function is called from file list table and calls newItemAfter function.

Definition at line 519 of file class.ilPCFileListGUI.php.

                                 : void
    {
        $ilCtrl = $this->ctrl;
 
        $files = $this->content_obj->getFileList();
 
        if (count($files) >= 1) {
            $ilCtrl->setParameterByClass(
                "ilpcfileitemgui",
                "hier_id",
                $files[count($files) - 1]["hier_id"]
            );
            $ilCtrl->setParameterByClass(
                "ilpcfileitemgui",
                "pc_id",
                $files[count($files) - 1]["pc_id"]
            );
            $ilCtrl->redirectByClass("ilpcfileitemgui", "newItemAfter");
        } else {
            $ilCtrl->redirect($this, "newFileItem");
        }
    }

afterCreation()

ilPCFileListGUI::afterCreation

(

)

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

                                   : void
    {
        $this->pg_obj->stripHierIDs();
        $this->pg_obj->addHierIDs();
        $this->ctrl->setParameter($this, "hier_id", $this->content_obj->readHierId());
        $this->ctrl->setParameter($this, "pc_id", $this->content_obj->readPCId());
        $this->ctrl->redirect($this, "editFiles");
    }

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

checkStyleSelection()

ilPCFileListGUI::checkStyleSelection

(

)

Checks whether style selection shoudl be available or not.

Definition at line 663 of file class.ilPCFileListGUI.php.

                                         : bool
    {
        // check whether there is more than one style class
        $chars = $this->getCharacteristics();
 
        $classes = $this->content_obj->getAllClasses();
        if (count($chars) > 1) {
            return true;
        }
        foreach ($classes as $class) {
            if ($class != "" && $class != "FileListItem") {
                return true;
            }
        }
        return false;
    }

confirmDeletionFileItem()

ilPCFileListGUI::confirmDeletionFileItem

(

)

Definition at line 556 of file class.ilPCFileListGUI.php.

                                             : void
    {
        $table = $this->getFileListTable();
        $ids = $table->getItemIds();
 
        if (count($ids) === 0) {
            $this->ctrl->redirect($this, "editFiles");
        }
 
        $retrieval = $this->domain->pc()->fileListRetrieval($this->content_obj);
        $data = $retrieval->getData([]);
        foreach ($data as $row) {
            if (in_array($row["id"], $ids)) {
                $items[$row["id"]] = $row["file_name"];
            }
        }
 
        $table->renderDeletionConfirmation(
            $this->lng->txt("delete"),
            $this->lng->txt("cont_delete_file_item_confirm"),
            "deleteFileItem",
            $items
        );
    }

References $data, ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Here is the call graph for this function:

create()

ilPCFileListGUI::create

(

)

create new file list in dom and update page in db

Definition at line 201 of file class.ilPCFileListGUI.php.

                            : void
    {
        global $DIC;
 
        $mode = ($this->requested_file_ref_id != "")
            ? "select_file"
            : "create";
        $form = $this->initEditForm($mode);
        if (!$form->checkInput()) {
            $form->setValuesByPost();
            $this->insert($form);
            return;
        }
 
        // from personal workspace
        if (substr($this->requested_file_ref_id, 0, 4) == "wsp_") {
            $fileObj = new ilObjFile(substr($this->requested_file_ref_id, 4), false);
        }
        // upload
        elseif ($this->requested_file_ref_id == "") {
            $fileObj = new ilObjFile();
            $fileObj->setType("file");
            $fileObj->setTitle($_FILES["file"]["name"]);
            $fileObj->setDescription("");
            $fileObj->setFileName($_FILES["file"]["name"]);
            $fileObj->setMode("filelist");
            $fileObj->create();
            // upload file to filesystem
 
            $upload = $DIC->upload();
            if ($upload->hasBeenProcessed() !== true) {
                $upload->process();
            }
 
            $fileObj->getUploadFile(
                $_FILES["file"]["tmp_name"],
                $_FILES["file"]["name"]
            );
        }
        // from repository
        else {
            $fileObj = new ilObjFile($this->requested_file_ref_id);
        }
        $this->setCurrentTextLang($form->getInput("flst_language"));
 
        //echo "::".is_object($this->dom).":";
        $this->content_obj = new ilPCFileList($this->getPage());
        $this->content_obj->create($this->pg_obj, $this->hier_id, $this->pc_id);
        $this->content_obj->setListTitle(
            $form->getInput("flst_title"),
            $form->getInput("flst_language")
        );
        $this->content_obj->appendItem(
            $fileObj->getId(),
            $fileObj->getFileName(),
            $fileObj->getFileType()
        );
 
        $this->updated = $this->pg_obj->update();
        if ($this->updated === true) {
            $this->afterCreation();
        } else {
            $this->insert();
        }
    }

References $DIC.

createFileItem()

ilPCFileListGUI::createFileItem

(

)

insert new file item

Definition at line 771 of file class.ilPCFileListGUI.php.

                                    : ?ilObjFile
    {
        global $DIC;
 
        $lng = $this->lng;
 
        if ($_FILES["file"]["name"] == "") {
            throw new ilCOPageFileHandlingException($lng->txt("upload_error_file_not_found"));
        }
 
        $form = $this->initEditForm();
        // see #22541
        //              $form->checkInput();
 
        $fileObj = new ilObjFile();
        $fileObj->setType("file");
        $fileObj->setTitle($_FILES["file"]["name"]);
        $fileObj->setDescription("");
        $fileObj->setFileName($_FILES["file"]["name"]);
        $fileObj->setMode("filelist");
        $fileObj->create();
        // upload file to filesystem
 
        $upload = $DIC->upload();
        if ($upload->hasBeenProcessed() !== true) {
            $upload->process();
        }
 
        $fileObj->getUploadFile(
            $_FILES["file"]["tmp_name"],
            $_FILES["file"]["name"]
        );
 
        return $fileObj;
    }

References $DIC, and $lng.

deleteFileItem()

ilPCFileListGUI::deleteFileItem

(

)

Delete file items from list.

Definition at line 545 of file class.ilPCFileListGUI.php.

                                    : void
    {
        $table = $this->getFileListTable();
        $ids = $table->getItemIds();
        if (count($ids) > 0) {
            $this->content_obj->deleteFileItems($ids);
        }
        $this->updated = $this->pg_obj->update();
        $this->ctrl->redirect($this, "editFiles");
    }

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

edit()

ilPCFileListGUI::edit

(

)

Definition at line 276 of file class.ilPCFileListGUI.php.

                          : void
    {
        $this->editFiles();
    }

editProperties()

ilPCFileListGUI::editProperties

(

)

edit properties form

Definition at line 284 of file class.ilPCFileListGUI.php.

                                    : void
    {
        $this->setTabs(false);
 
        $form = $this->initEditForm();
        $this->tpl->setContent($form->getHTML());
    }

editStyleClass()

ilPCFileListGUI::editStyleClass

(

string

$id

)

Definition at line 596 of file class.ilPCFileListGUI.php.

    {
        $form = $this->getEditStyleForm($id);
        $lng = $this->lng;
        $this->gui->modal($lng->txt("copg_edit_style_class"))
            ->form($form)
            ->send();
    }

References $id, and $lng.

executeCommand()

ilPCFileListGUI::executeCommand

(

)

execute command

Definition at line 63 of file class.ilPCFileListGUI.php.

                                    : void
    {
        // get next class that processes or forwards current command
        $next_class = $this->ctrl->getNextClass($this);
 
        $this->getCharacteristicsOfCurrentStyle(["flist_li"]);  // scorm-2004
 
        // get current command
        $cmd = $this->ctrl->getCmd();
 
        switch ($next_class) {
            default:
                $this->$cmd();
                break;
        }
    }

References ILIAS\Repository\ctrl(), and ilPageContentGUI\getCharacteristicsOfCurrentStyle().

Here is the call graph for this function:

getEditStyleForm()

ilPCFileListGUI::getEditStyleForm ( string  $id )

protected

Definition at line 605 of file class.ilPCFileListGUI.php.

                                                   : FormAdapterGUI
    {
        $lng = $this->lng;
        $lng->loadLanguageModule("style");
        $lng->loadLanguageModule("copg");
 
        $this->ctrl->setParameterByClass(self::class, "file_item_id", $id);
        $retrieval = $this->domain->pc()->fileListRetrieval($this->content_obj);
        $options = $this->getCharacteristics();
        $data = $retrieval->getData([]);
        $value = null;
        foreach ($data as $row) {
            if ($row["id"] == $id && isset($options[$row["class"]])) {
                $value = $row["class"];
            }
        }
        return $this->gui->form([self::class], "saveStyleClass")
            ->select("class", $lng->txt("sty_class"), $options, "", $value)
            ->required();
    }

References $data, $id, $lng, ILIAS\UI\Implementation\Component\Input\Field\$options, and ILIAS\Repository\ctrl().

Here is the call graph for this function:

initEditForm()

ilPCFileListGUI::initEditForm

(

string

$a_mode = "edit"

)

Init edit form.

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

                                                         : ilPropertyFormGUI
    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
        $ilUser = $this->user;
 
        $ti = null;
        $si = null;
        $form = new ilPropertyFormGUI();
 
        if ($a_mode != "add_file") {
            // title
            $ti = new ilTextInputGUI($lng->txt("title"), "flst_title");
            $ti->setMaxLength(80);
            $ti->setSize(40);
            $form->addItem($ti);
 
            // language
            $languages = [];
            foreach ($this->lom_services->dataHelper()->getAllLanguages() as $language) {
                $languages[$language->value()] = $language->presentableLabel();
            }
            $si = new ilSelectInputGUI($lng->txt("language"), "flst_language");
            $si->setOptions($languages);
            $form->addItem($si);
        }
 
        if (in_array($a_mode, array("create", "add_file"))) {
            // file
            $fi = new ilFileInputGUI($lng->txt("file"), "file");
            $fi->setRequired(true);
            $form->addItem($fi);
        } elseif (in_array($a_mode, array("select_file"))) {
            // file
            $ne = new ilNonEditableValueGUI($lng->txt("file"), "");
 
            $file_ref_id = (int) $this->requested_file_ref_id;
            $fl_wsp_id = $this->request->getInt("fl_wsp_id");
 
            if ($file_ref_id > 0) {
                $file_obj = new ilObjFile($file_ref_id);
                if (is_object($file_obj)) {
                    // ref id as hidden input
                    $hi = new ilHiddenInputGUI("file_ref_id");
                    $hi->setValue($file_ref_id);
                    $form->addItem($hi);
 
                    $ne->setValue($file_obj->getTitle());
                }
            } elseif ($fl_wsp_id > 0) {
                // we need the object id for the instance
                $tree = new ilWorkspaceTree($ilUser->getId());
                $node = $tree->getNodeData($fl_wsp_id);
 
                $file_obj = new ilObjFile($node["obj_id"], false);
                if (is_object($file_obj)) {
                    // ref id as hidden input
                    $hi = new ilHiddenInputGUI("file_ref_id");
                    $hi->setValue("wsp_" . (int) $node["obj_id"]);
                    $form->addItem($hi);
 
                    $ne->setValue($file_obj->getTitle());
                }
                $this->tpl->parseCurrentBlock();
            }
 
            $form->addItem($ne);
        }
 
 
        switch ($a_mode) {
            case "edit":
                $ti->setValue($this->content_obj->getListTitle());
                $si->setValue($this->content_obj->getLanguage());
                $form->addCommandButton("saveProperties", $lng->txt("save"));
                $form->addCommandButton("cancelUpdate", $lng->txt("cancel"));
                $form->setTitle($lng->txt("cont_edit_file_list_properties"));
                break;
 
            case "create":
            case "select_file":
                if ($this->getCurrentTextLang() != "") {
                    $s_lang = $this->getCurrentTextLang();
                } else {
                    $s_lang = $ilUser->getLanguage();
                }
                $si->setValue($s_lang);
                $form->addCommandButton("create", $lng->txt("save"));
                $form->addCommandButton("cancelCreate", $lng->txt("cancel"));
                $form->setTitle($lng->txt("cont_insert_file_list"));
                break;
 
            case "add_file":
                $form->addCommandButton("insertNewFileItem", $lng->txt("save"));
                $form->addCommandButton("editFiles", $lng->txt("cancel"));
                $form->setTitle($lng->txt("cont_insert_file_item"));
                break;
        }
 
        $form->setFormAction($ilCtrl->getFormAction($this));
 
        return $form;
    }

References $lng, ilTree\getNodeData(), and ILIAS\Repository\int().

Referenced by insert(), and selectFile().

Here is the call graph for this function:

Here is the caller graph for this function:

insert()

ilPCFileListGUI::insert

(

?ilPropertyFormGUI

$a_form = null

)

insert new file list form

Definition at line 83 of file class.ilPCFileListGUI.php.

                                                             : void
    {
        $ilTabs = $this->tabs;
        $sub_command = $this->sub_command;
 
        if (in_array($sub_command, ["insertNew", "insertFromRepository", "insertFromWorkspace"])) {
            $this->edit_repo->setSubCmd($sub_command);
        }
 
        if (($sub_command == "") && $this->edit_repo->getSubCmd() != "") {
            $sub_command = $this->edit_repo->getSubCmd();
        }
 
        switch ($sub_command) {
            case "insertFromWorkspace":
                $this->insertFromWorkspace();
                break;
 
            case "insertFromRepository":
                $this->insertFromRepository();
                break;
 
            case "selectFile":
                $this->selectFile();
                break;
 
            default:
                $this->setTabs();
                $ilTabs->setSubTabActive("cont_new_file");
 
                $this->displayValidationError();
 
                if ($a_form != null) {
                    $form = $a_form;
                } else {
                    $form = $this->initEditForm("create");
                }
                $this->tpl->setContent($form->getHTML());
                break;
        }
    }

References ilPageContentGUI\$sub_command, $tabs, ilPageContentGUI\displayValidationError(), initEditForm(), insertFromRepository(), insertFromWorkspace(), selectFile(), and setTabs().

Here is the call graph for this function:

insertFromRepository()

ilPCFileListGUI::insertFromRepository

(

string

$a_cmd = "insert"

)

Insert file from repository.

Definition at line 140 of file class.ilPCFileListGUI.php.

                                                                  : void
    {
        $ilTabs = $this->tabs;
        $ilCtrl = $this->ctrl;
        $tpl = $this->tpl;
 
        if ($a_cmd == "insert") {
            $this->setTabs();
        } else {
            $this->setItemTabs($a_cmd);
        }
 
        $ilTabs->setSubTabActive("cont_file_from_repository");
        $ilCtrl->setParameter($this, "subCmd", "insertFromRepository");
 
        $exp = new ilPCFileItemFileSelectorGUI(
            $this,
            $a_cmd,
            $this,
            $a_cmd,
            "file_ref_id"
        );
        if (!$exp->handleCommand()) {
            $tpl->setContent($exp->getHTML());
        }
    }

References ilPageContentGUI\$ctrl, $tabs, ilPageContentGUI\$tpl, ILIAS\UICore\GlobalTemplate\setContent(), setItemTabs(), and setTabs().

Referenced by insert().

Here is the call graph for this function:

Here is the caller graph for this function:

insertFromWorkspace()

ilPCFileListGUI::insertFromWorkspace

(

string

$a_cmd = "insert"

)

Insert file from personal workspace.

Definition at line 170 of file class.ilPCFileListGUI.php.

     : void {
        $ilTabs = $this->tabs;
        $ilCtrl = $this->ctrl;
        $tpl = $this->tpl;
        $ilUser = $this->user;
 
        if ($a_cmd == "insert") {
            $this->setTabs();
        } else {
            $this->setItemTabs($a_cmd);
        }
 
        $ilTabs->setSubTabActive("cont_file_from_workspace");
 
        $exp = new ilWorkspaceExplorerGUI($ilUser->getId(), $this, $a_cmd, $this, $a_cmd, "fl_wsp_id");
        $ilCtrl->setParameter($this, "subCmd", "selectFile");
        $exp->setCustomLinkTarget($ilCtrl->getLinkTarget($this, $a_cmd));
        $ilCtrl->setParameter($this, "subCmd", "insertFromWorkspace");
        $exp->setTypeWhiteList(array("wsrt", "wfld", "file"));
        $exp->setSelectableTypes(array("file"));
        if ($exp->handleCommand()) {
            return;
        }
        $tpl->setContent($exp->getHTML());
    }

References setTabs().

Referenced by insert().

Here is the call graph for this function:

Here is the caller graph for this function:

insertNewFileItem()

ilPCFileListGUI::insertNewFileItem

(

int

$a_file_ref_id = 0

)

insert new file item after another item

Definition at line 730 of file class.ilPCFileListGUI.php.

                                                             : void
    {
        $ilUser = $this->user;
 
        $fl_wsp_id = $this->request->getInt("fl_wsp_id");
 
        // from personal workspace
        if ($fl_wsp_id > 0) {
            // we need the object id for the instance
            $tree = new ilWorkspaceTree($ilUser->getId());
            $node = $tree->getNodeData($fl_wsp_id);
 
            $file_obj = new ilObjFile($node["obj_id"], false);
        }
        // upload
        elseif ($a_file_ref_id == 0) {
            $file_obj = $this->createFileItem();
        }
        // from repository
        else {
            $file_obj = new ilObjFile($a_file_ref_id);
        }
        if (is_object($file_obj)) {
            $this->content_obj->appendItem(
                $file_obj->getId(),
                $file_obj->getTitle(),
                $file_obj->getFileType()
            );
            $this->updated = $this->pg_obj->update();
            if ($this->updated === true) {
                //$this->ctrl->returnToParent($this, "jump".$this->hier_id);
                $this->ctrl->redirect($this, "editFiles");
            }
        }
 
        $this->newFileItem();
    }

References ILIAS\Repository\ctrl(), and ilTree\getNodeData().

Here is the call graph for this function:

newFileItem()

ilPCFileListGUI::newFileItem

(

)

New file item (called, if there is no file item in an existing)

Definition at line 689 of file class.ilPCFileListGUI.php.

                                 : void
    {
        $ilTabs = $this->tabs;
 
        $sub_command = $this->sub_command;
        if (in_array($sub_command, ["insertNew", "insertFromRepository", "insertFromWorkspace"])) {
            $this->edit_repo->setSubCmd($sub_command);
        }
 
        if (($sub_command == "") && $this->edit_repo->getSubCmd() != "") {
            $sub_command = $this->edit_repo->getSubCmd();
        }
 
        switch ($sub_command) {
            case "insertFromWorkspace":
                $this->insertFromWorkspace("newFileItem");
                break;
 
            case "insertFromRepository":
                $this->insertFromRepository("newFileItem");
                break;
 
            case "selectFile":
                $this->insertNewFileItem($this->requested_file_ref_id);
                break;
 
            default:
                $this->setItemTabs("newFileItem");
                $ilTabs->setSubTabActive("cont_new_file");
 
                $this->displayValidationError();
 
                $form = $this->initEditForm("add_file");
                $this->tpl->setContent($form->getHTML());
                break;
        }
    }

savePositions()

ilPCFileListGUI::savePositions

(

)

Save positions of file items.

Definition at line 584 of file class.ilPCFileListGUI.php.

                                   : void
    {
        $ilCtrl = $this->ctrl;
        $table = $this->getFileListTable();
        $pos = $table->getData();
        if (is_array($pos) && count($pos) > 0) {
            $this->content_obj->savePositions($pos);
        }
        $this->updated = $this->pg_obj->update();
        $ilCtrl->redirect($this, "editFiles");
    }

savePositionsAndClasses()

ilPCFileListGUI::savePositionsAndClasses

(

)

Save positions of file items and style classes.

Definition at line 644 of file class.ilPCFileListGUI.php.

                                             : void
    {
        $ilCtrl = $this->ctrl;
 
        $pos = $this->request->getIntArray("position");
        $class = $this->request->getStringArray("class");
        if (count($pos) > 0) {
            $this->content_obj->savePositions($pos);
        }
        if (count($class) > 0) {
            $this->content_obj->saveStyleClasses($class);
        }
        $this->updated = $this->pg_obj->update();
        $ilCtrl->redirect($this, "editFiles");
    }

saveProperties()

ilPCFileListGUI::saveProperties

(

)

save table properties in db and return to page edit screen

Definition at line 403 of file class.ilPCFileListGUI.php.

                                    : void
    {
        $form = $this->initEditForm("edit");
        $form->checkInput();
        $this->content_obj->setListTitle(
            $form->getInput("flst_title"),
            $form->getInput("flst_language")
        );
        $this->updated = $this->pg_obj->update();
        if ($this->updated === true) {
            $this->tpl->setOnScreenMessage('success', $this->lng->txt("msg_obj_modified"), true);
            $this->ctrl->redirect($this, "editProperties");
        } else {
            $this->pg_obj->addHierIDs();
            $this->edit();
        }
    }

References ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Here is the call graph for this function:

saveStyleClass()

ilPCFileListGUI::saveStyleClass ( )

protected

Definition at line 626 of file class.ilPCFileListGUI.php.

                                       : void
    {
        $file_item_id = $this->request->getString("file_item_id");
        $form = $this->getEditStyleForm($file_item_id);
        if ($form->isValid()) {
            $class = $form->getData("class");
            $this->content_obj->saveStyleClass(
                $file_item_id,
                $class
            );
            $this->updated = $this->pg_obj->update();
            $this->ctrl->redirect($this, "editFiles");
        }
    }

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

selectFile()

ilPCFileListGUI::selectFile

(

)

Definition at line 125 of file class.ilPCFileListGUI.php.

                                : void
    {
        $ilTabs = $this->tabs;
        $this->setTabs();
        $ilTabs->setSubTabActive("cont_file_from_repository");
 
        $this->displayValidationError();
        $form = $this->initEditForm("select_file");
 
        $this->tpl->setContent($form->getHTML());
    }

References $tabs, ilPageContentGUI\displayValidationError(), initEditForm(), and setTabs().

Referenced by insert().

Here is the call graph for this function:

Here is the caller graph for this function:

setItemTabs()

ilPCFileListGUI::setItemTabs

(

string

$a_cmd = ""

)

output tabs

Definition at line 811 of file class.ilPCFileListGUI.php.

                                                   : void
    {
        $ilTabs = $this->tabs;
        $ilCtrl = $this->ctrl;
        $ilSetting = $this->settings;
 
        $ilTabs->addTarget(
            "cont_back",
            $this->ctrl->getParentReturn($this),
            "",
            ""
        );
 
        if ($a_cmd != "") {
            $ilCtrl->setParameter($this, "subCmd", "insertNew");
            $ilTabs->addSubTabTarget(
                "cont_new_file",
                $ilCtrl->getLinkTarget($this, $a_cmd),
                $a_cmd
            );
 
            $ilCtrl->setParameter($this, "subCmd", "insertFromRepository");
            $ilTabs->addSubTabTarget(
                "cont_file_from_repository",
                $ilCtrl->getLinkTarget($this, $a_cmd),
                $a_cmd
            );
            $ilCtrl->setParameter($this, "subCmd", "");
 
            if (!$ilSetting->get("disable_personal_workspace") &&
                !$ilSetting->get("disable_wsp_files")) {
                $ilCtrl->setParameter($this, "subCmd", "insertFromWorkspace");
                $ilTabs->addSubTabTarget(
                    "cont_file_from_workspace",
                    $ilCtrl->getLinkTarget($this, $a_cmd),
                    $a_cmd
                );
                $ilCtrl->setParameter($this, "subCmd", "");
            }
        }
    }

References $ilSetting, and ILIAS\Repository\ctrl().

Referenced by insertFromRepository().

Here is the call graph for this function:

Here is the caller graph for this function:

setTabs()

ilPCFileListGUI::setTabs

(

bool

$a_create = true

)

Set Tabs.

Definition at line 458 of file class.ilPCFileListGUI.php.

                                                  : void
    {
        $ilTabs = $this->tabs;
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
        $ilSetting = $this->settings;
 
        if ($a_create) {
            $cmd = "insert";
 
            $ilCtrl->setParameter($this, "subCmd", "insertNew");
            $ilTabs->addSubTabTarget(
                "cont_new_file",
                $ilCtrl->getLinkTarget($this, $cmd),
                $cmd
            );
 
            $ilCtrl->setParameter($this, "subCmd", "insertFromRepository");
            $ilTabs->addSubTabTarget(
                "cont_file_from_repository",
                $ilCtrl->getLinkTarget($this, $cmd),
                $cmd
            );
            $ilCtrl->setParameter($this, "subCmd", "");
 
            if (!$ilSetting->get("disable_personal_workspace") &&
                !$ilSetting->get("disable_wsp_files")) {
                $ilCtrl->setParameter($this, "subCmd", "insertFromWorkspace");
                $ilTabs->addSubTabTarget(
                    "cont_file_from_workspace",
                    $ilCtrl->getLinkTarget($this, $cmd),
                    $cmd
                );
                $ilCtrl->setParameter($this, "subCmd", "");
            }
        } else {
            $ilTabs->setBackTarget(
                $lng->txt("pg"),
                $this->ctrl->getParentReturn($this)
            );
 
            $ilTabs->addTarget(
                "cont_ed_edit_files",
                $ilCtrl->getLinkTarget($this, "editFiles"),
                "editFiles",
                get_class($this)
            );
 
            $ilTabs->addTarget(
                "cont_ed_edit_prop",
                $ilCtrl->getLinkTarget($this, "editProperties"),
                "editProperties",
                get_class($this)
            );
        }
    }

References $ilSetting, and $lng.

Referenced by insert(), insertFromRepository(), insertFromWorkspace(), and selectFile().

Here is the caller graph for this function:

Field Documentation

$domain

ILIAS COPage InternalDomainService ilPCFileListGUI::$domain

protected

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

$requested_file_ref_id

string ilPCFileListGUI::$requested_file_ref_id

protected

Definition at line 31 of file class.ilPCFileListGUI.php.

$settings

ilSetting ilPCFileListGUI::$settings

protected

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

$tabs

ilTabsGUI ilPCFileListGUI::$tabs

protected

Definition at line 33 of file class.ilPCFileListGUI.php.

Referenced by insert(), insertFromRepository(), and selectFile().

$toolbar

ilToolbarGUI ilPCFileListGUI::$toolbar

protected

Definition at line 35 of file class.ilPCFileListGUI.php.

$tree

ilTree ilPCFileListGUI::$tree

protected

Definition at line 34 of file class.ilPCFileListGUI.php.

$user

ilObjUser ilPCFileListGUI::$user

protected

Definition at line 32 of file class.ilPCFileListGUI.php.

---

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

• components/ILIAS/COPage/PC/FileList/class.ilPCFileListGUI.php