ilPCFileItemGUI Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilPCFileItemGUI:

Collaboration diagram for ilPCFileItemGUI:

Public Member Functions
	__construct (ilPageObject $a_pg_obj, ?ilPageContent $a_content_obj, string $a_hier_id, string $a_pc_id="")
	executeCommand ()
	newFileItem ()
	insert new file item More...
	newItemAfter ()
	insert new list item after current one More...
	initAddFileForm (bool $a_before=true)
	Init add file form. More...
	insertFromRepository (string $a_cmd)
	Insert file from repository. More...
	insertFromWorkspace (string $a_cmd="insert")
	Insert file from personal workspace. More...
	insertNewItemAfter (int $a_file_ref_id=0)
	insert new file item after another item More...
	newItemBefore ()
	insert new list item before current one More...
	insertNewItemBefore (int $a_file_ref_id=0)
	insert new list item before current one More...
	deleteItem ()
	delete a list item More...
	setTabs (string $a_cmd="")
	output tabs More...
	moveItemDown ()
	move list item down More...
	moveItemUp ()
	move list item up More...
	cancelAddFile ()
	Cancel adding a file. More...
	redirectToFileList ()
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 Attributes
ilObjFile	$file_object
ilTabsGUI	$tabs
ilObjUser	$user
ilTree	$tree
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
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
	$updated
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;"
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="")
Static Protected Attributes inherited from ilPageContentGUI
static array	$common_bb_buttons

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Class ilPCFileItemGUI Handles user commands on items of file lists

Author

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

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

Constructor & Destructor Documentation

__construct()

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

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

References $DIC, ILIAS\MetaData\Repository\Validation\Data\__construct(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ILIAS\Repository\settings(), ILIAS\Repository\tabs(), and ILIAS\Repository\user().

      {
        global $DIC;

        $this->lng = $DIC->language();
        $this->tabs = $DIC->tabs();
        $this->ctrl = $DIC->ctrl();
        $this->user = $DIC->user();
        $this->tpl = $DIC["tpl"];
        $this->tree = $DIC->repositoryTree();
        $this->settings = $DIC->settings();
        parent::__construct($a_pg_obj, $a_content_obj, $a_hier_id, $a_pc_id);
    }

Here is the call graph for this function:

Member Function Documentation

cancelAddFile()

ilPCFileItemGUI::cancelAddFile

(

)

Cancel adding a file.

Definition at line 411 of file class.ilPCFileItemGUI.php.

References ILIAS\Repository\ctrl().

                                   : void
    {
        $this->ctrl->returnToParent($this, "jump" . $this->hier_id);
    }

Here is the call graph for this function:

deleteItem()

ilPCFileItemGUI::deleteItem

(

)

delete a list item

Definition at line 341 of file class.ilPCFileItemGUI.php.

References ilPageContentGUI\updateAndReturn().

                                : void
    {
        $this->content_obj->deleteItem();
        $this->updateAndReturn();
    }

Here is the call graph for this function:

executeCommand()

ilPCFileItemGUI::executeCommand

(

)

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

References ILIAS\Repository\ctrl().

                                    : void
    {
        // get next class that processes or forwards current command
        $next_class = $this->ctrl->getNextClass($this);

        // get current command
        $cmd = $this->ctrl->getCmd();
        switch ($next_class) {
            default:
                $this->$cmd();
                break;
        }
    }

Here is the call graph for this function:

initAddFileForm()

ilPCFileItemGUI::initAddFileForm

(

bool

$a_before = true

)

Init add file form.

Definition at line 148 of file class.ilPCFileItemGUI.php.

References ilPageContentGUI\$ctrl, ilPageContentGUI\$lng, ilFormPropertyGUI\setRequired(), and ilLanguage\txt().

Referenced by newFileItem(), newItemAfter(), and newItemBefore().

                                                          : ilPropertyFormGUI
    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;

        $form = new ilPropertyFormGUI();

        // file
        $fi = new ilFileInputGUI($lng->txt("file"), "file");
        $fi->setRequired(true);
        $form->addItem($fi);

        if ($a_before) {
            $form->addCommandButton("insertNewItemBefore", $lng->txt("save"));
        } else {
            $form->addCommandButton("insertNewItemAfter", $lng->txt("save"));
        }
        $form->addCommandButton("cancelAddFile", $lng->txt("cancel"));

        $form->setTitle($lng->txt("cont_insert_file_item"));

        $form->setFormAction($ilCtrl->getFormAction($this));

        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

insertFromRepository()

ilPCFileItemGUI::insertFromRepository

(

string

$a_cmd

)

Insert file from repository.

Definition at line 178 of file class.ilPCFileItemGUI.php.

References ilPageContentGUI\$ctrl, $tabs, ilPageContentGUI\$tpl, ilGlobalTemplateInterface\setContent(), and setTabs().

Referenced by newItemAfter(), and newItemBefore().

                                                       : void
    {
        $ilTabs = $this->tabs;
        $ilCtrl = $this->ctrl;
        $tpl = $this->tpl;

        $this->setTabs($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());
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

insertFromWorkspace()

ilPCFileItemGUI::insertFromWorkspace

(

string

$a_cmd = "insert"

)

Insert file from personal workspace.

Definition at line 203 of file class.ilPCFileItemGUI.php.

References ilPageContentGUI\$ctrl, $tabs, ilPageContentGUI\$tpl, ilGlobalTemplateInterface\setContent(), ilWorkspaceExplorerGUI\setCustomLinkTarget(), setTabs(), and ILIAS\Repository\user().

Referenced by newItemAfter(), and newItemBefore().

                                                                 : void
    {
        $ilTabs = $this->tabs;
        $ilCtrl = $this->ctrl;
        $tpl = $this->tpl;

        $this->setTabs($a_cmd);
        $ilTabs->setSubTabActive("cont_file_from_workspace");

        $exp = new ilWorkspaceExplorerGUI($this->user->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());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

insertNewItemAfter()

ilPCFileItemGUI::insertNewItemAfter

(

int

$a_file_ref_id = 0

)

insert new file item after another item

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

References $res, $user, ilTree\getNodeData(), newFileItem(), newItemAfter(), and redirectToFileList().

Referenced by newItemAfter().

                                                              : void
    {
        $ilUser = $this->user;

        $fl_wsp_id = $this->request->getInt("fl_wsp_id");

        $res = true;
        if ($fl_wsp_id > 0) {
            // we need the object id for the instance
            $tree = new ilWorkspaceTree($ilUser->getId());
            $node = $tree->getNodeData($fl_wsp_id);

            $this->file_object = new ilObjFile($node["obj_id"], false);
        } elseif ($a_file_ref_id == 0) {
            $res = $this->newFileItem();
        } else {
            $this->file_object = new ilObjFile($a_file_ref_id);
        }
        if ($res) {
            $this->content_obj->newItemAfter(
                $this->file_object->getId(),
                $this->file_object->getFileName(),
                $this->file_object->getFileType()
            );
            $this->updated = $this->pg_obj->update();
            if ($this->updated === true) {
                $this->redirectToFileList();
            }
        }

        $this->newItemAfter();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

insertNewItemBefore()

ilPCFileItemGUI::insertNewItemBefore

(

int

$a_file_ref_id = 0

)

insert new list item before current one

Definition at line 305 of file class.ilPCFileItemGUI.php.

References $res, $user, ilTree\getNodeData(), newFileItem(), newItemBefore(), and redirectToFileList().

Referenced by newItemBefore().

                                                               : void
    {
        $ilUser = $this->user;

        $res = true;

        $fl_wsp_id = $this->request->getInt("fl_wsp_id");
        if ($fl_wsp_id > 0) {
            // we need the object id for the instance
            $tree = new ilWorkspaceTree($ilUser->getId());
            $node = $tree->getNodeData($fl_wsp_id);

            $this->file_object = new ilObjFile($node["obj_id"], false);
        } elseif ($a_file_ref_id == 0) {
            $res = $this->newFileItem();
        } else {
            $this->file_object = new ilObjFile($a_file_ref_id);
        }
        if ($res) {
            $this->content_obj->newItemBefore(
                $this->file_object->getId(),
                $this->file_object->getTitle(),
                $this->file_object->getFileType()
            );
            $this->updated = $this->pg_obj->update();
            if ($this->updated === true) {
                $this->redirectToFileList();
            }
        }

        $this->newItemBefore();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

moveItemDown()

ilPCFileItemGUI::moveItemDown

(

)

move list item down

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

References ilPageContentGUI\updateAndReturn().

                                  : void
    {
        $this->content_obj->moveItemDown();
        $this->updateAndReturn();
    }

Here is the call graph for this function:

moveItemUp()

ilPCFileItemGUI::moveItemUp

(

)

move list item up

Definition at line 402 of file class.ilPCFileItemGUI.php.

References ilPageContentGUI\updateAndReturn().

                                : void
    {
        $this->content_obj->moveItemUp();
        $this->updateAndReturn();
    }

Here is the call graph for this function:

newFileItem()

ilPCFileItemGUI::newFileItem

(

)

insert new file item

Definition at line 68 of file class.ilPCFileItemGUI.php.

References $DIC, ilPageContentGUI\$lng, initAddFileForm(), and ilLanguage\txt().

Referenced by insertNewItemAfter(), and insertNewItemBefore().

                                 : bool
    {
        $lng = $this->lng;

        if ($_FILES["file"]["name"] == "") {
            throw new ilCOPageFileHandlingException($lng->txt("upload_error_file_not_found"));
        }

        $form = $this->initAddFileForm();
        $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
        global $DIC;
        $upload = $DIC->upload();
        if ($upload->hasBeenProcessed() !== true) {
            $upload->process();
        }
        $fileObj->getUploadFile(
            $_FILES["file"]["tmp_name"],
            $_FILES["file"]["name"]
        );

        $this->file_object = $fileObj;
        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

newItemAfter()

ilPCFileItemGUI::newItemAfter

(

)

insert new list item after current one

Definition at line 105 of file class.ilPCFileItemGUI.php.

References ilPageContentGUI\$sub_command, $tabs, ilPageContentGUI\displayValidationError(), initAddFileForm(), insertFromRepository(), insertFromWorkspace(), insertNewItemAfter(), and setTabs().

Referenced by insertNewItemAfter().

                                  : 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("newItemAfter");
                break;

            case "insertFromRepository":
                $this->insertFromRepository("newItemAfter");
                break;

            case "selectFile":
                $this->insertNewItemAfter(
                    $this->request->getInt("file_ref_id")
                );
                break;

            default:
                $this->setTabs("newItemAfter");
                $ilTabs->setSubTabActive("cont_new_file");

                $this->displayValidationError();
                $form = $this->initAddFileForm(false);
                $this->tpl->setContent($form->getHTML());
                break;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

newItemBefore()

ilPCFileItemGUI::newItemBefore

(

)

insert new list item before current one

Definition at line 263 of file class.ilPCFileItemGUI.php.

References ilPageContentGUI\$sub_command, $tabs, ilPageContentGUI\displayValidationError(), initAddFileForm(), insertFromRepository(), insertFromWorkspace(), insertNewItemBefore(), and setTabs().

Referenced by insertNewItemBefore().

                                   : 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("newItemBefore");
                break;

            case "insertFromRepository":
                $this->insertFromRepository("newItemBefore");
                break;

            case "selectFile":
                $this->insertNewItemBefore(
                    $this->request->getInt("file_ref_id")
                );
                break;

            default:
                $this->setTabs("newItemBefore");
                $ilTabs->setSubTabActive("cont_new_file");

                $this->displayValidationError();
                $form = $this->initAddFileForm(true);
                $this->tpl->setContent($form->getHTML());
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

redirectToFileList()

ilPCFileItemGUI::redirectToFileList

(

)

Definition at line 416 of file class.ilPCFileItemGUI.php.

References ILIAS\Repository\ctrl().

Referenced by insertNewItemAfter(), and insertNewItemBefore().

                                        : void
    {
        $this->pg_obj->stripHierIDs();
        $this->pg_obj->addHierIDs();
        $this->ctrl->setParameterByClass(ilPCFileListGUI::class, "pc_id", $this->content_obj->getListPCId());
        $this->ctrl->redirectByClass(ilPCFileListGUI::class, "editFiles");
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setTabs()

ilPCFileItemGUI::setTabs

(

string

$a_cmd = ""

)

output tabs

Definition at line 350 of file class.ilPCFileItemGUI.php.

References ilPageContentGUI\$ctrl, $ilSetting, $settings, $tabs, ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Referenced by insertFromRepository(), insertFromWorkspace(), newItemAfter(), and newItemBefore().

                                               : void
    {
        $ilTabs = $this->tabs;
        $ilCtrl = $this->ctrl;
        $ilSetting = $this->settings;

        $ilTabs->setBackTarget(
            $this->lng->txt("back"),
            $this->ctrl->getLinkTarget($this, "redirectToFileList")
        );

        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", "");
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$file_object

ilObjFile ilPCFileItemGUI::$file_object

protected

Definition at line 26 of file class.ilPCFileItemGUI.php.

$settings

ilSetting ilPCFileItemGUI::$settings

protected

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

Referenced by setTabs().

$tabs

ilTabsGUI ilPCFileItemGUI::$tabs

protected

Definition at line 27 of file class.ilPCFileItemGUI.php.

Referenced by insertFromRepository(), insertFromWorkspace(), newItemAfter(), newItemBefore(), and setTabs().

$tree

ilTree ilPCFileItemGUI::$tree

protected

Definition at line 29 of file class.ilPCFileItemGUI.php.

$user

ilObjUser ilPCFileItemGUI::$user

protected

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

Referenced by insertNewItemAfter(), and insertNewItemBefore().

---

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

• Services/COPage/PC/FileList/class.ilPCFileItemGUI.php