ilPCFileItemGUI Class Reference

Class ilPCFileItemGUI. More...

Inheritance diagram for ilPCFileItemGUI:

Collaboration diagram for ilPCFileItemGUI:

Public Member Functions
	__construct (&$a_pg_obj, &$a_content_obj, $a_hier_id, $a_pc_id="")
	Constructor public. More...
	executeCommand ()
	execute command More...
	newFileItem ()
	insert new file item More...
	newItemAfter ()
	insert new list item after current one More...
	initAddFileForm ($a_before=true)
	Init add file form. More...
	insertFromRepository ($a_cmd)
	Insert file from repository. More...
	insertFromWorkspace ($a_cmd="insert")
	Insert file from personal workspace. More...
	insertNewItemAfter ($a_file_ref_id=0)
	insert new file item after another item More...
	newItemBefore ()
	insert new list item before current one More...
	insertNewItemBefore ($a_file_ref_id=0)
	insert new list item before current one More...
	deleteItem ()
	delete a list item More...
	setTabs ($a_cmd="")
	output tabs More...
	moveItemDown ()
	move list item down More...
	moveItemUp ()
	move list item up More...
	cancelAddFile ()
	Cancel adding a file. More...
Public Member Functions inherited from ilPageContentGUI
	__construct ($a_pg_obj, $a_content_obj, $a_hier_id=0, $a_pc_id="")
	Constructor public. More...
	setContentObject ($a_val)
	Set content object. More...
	getContentObject ()
	Get content object. More...
	setPage ($a_val)
	Set page. More...
	getPage ()
	Get page. More...
	setPageConfig ($a_val)
	Set Page Config. More...
	getPageConfig ()
	Get Page Config. More...
	setStyleId ($a_styleid)
	Set Style Id. More...
	getStyleId ()
	Get Style Id. More...
	getStyle ()
	Get style object. More...
	setCharacteristics ($a_chars)
	Set Characteristics. More...
	getCharacteristics ()
	Get characteristics. More...
	getHierId ()
	get hierarchical id in dom object More...
	setHierId ($a_hier_id)
	get hierarchical id in dom object More...
	getBBMenu ($a_ta_name="par_content")
	Get the bb menu incl. More...
	delete ()
	delete content element More...
	moveAfter ()
	move content element after another element More...
	moveBefore ()
	move content element before another element More...
	splitPage ()
	split page to new page at specified position More...
	splitPageNext ()
	split page to next page at specified position More...
	displayValidationError ()
	display validation errors More...
	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 ($a_type)
	Get table templates. More...

Protected Attributes
	$tabs
	$user
	$tree
	$settings
Protected Attributes inherited from ilPageContentGUI
	$error
	$log

Additional Inherited Members
Static Public Member Functions inherited from ilPageContentGUI
static	_getCommonBBButtons ()
	Get common bb buttons. More...
Data Fields inherited from ilPageContentGUI
	$content_obj
	$tpl
	$lng
	$ctrl
	$pg_obj
	$hier_id
	$dom
	$updated
	$target_script
	$return_location
	$page_config = null
Static Public Attributes inherited from ilPageContentGUI
static	$style_selector_reset = "margin-top:2px; margin-bottom:2px; text-indent:0px; position:static; float:none; width: auto;"
Protected Member Functions inherited from ilPageContentGUI
	getCharacteristicsOfCurrentStyle ($a_type)
	Get characteristics of current style. More...
Static Protected Attributes inherited from ilPageContentGUI
static	$common_bb_buttons

Detailed Description

Class ilPCFileItemGUI.

Handles user commands on items of file lists

Author

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version

$I$

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

Constructor & Destructor Documentation

__construct()

ilPCFileItemGUI::__construct	(	&	$a_pg_obj,
		&	$a_content_obj,
			$a_hier_id,
			$a_pc_id = ""
	)

Constructor public.

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

References $DIC, settings(), and 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 506 of file class.ilPCFileItemGUI.php.

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

deleteItem()

ilPCFileItemGUI::deleteItem

(

)

delete a list item

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

References $_SESSION.

    {
        $this->content_obj->deleteItem();
        $_SESSION["il_pg_error"] = $this->pg_obj->update();
        $this->ctrl->returnToParent($this, "jump" . $this->hier_id);
    }

executeCommand()

ilPCFileItemGUI::executeCommand

(

)

execute command

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

References $ret.

    {
        // 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:
                $ret = $this->$cmd();
                break;
        }

        return $ret;
    }

initAddFileForm()

ilPCFileItemGUI::initAddFileForm

(

$a_before = true

)

Init add file form.

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

References ilPageContentGUI\$ctrl, $form, $ilCtrl, $ilUser, ilPageContentGUI\$lng, $user, and ilFormPropertyGUI\setRequired().

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

    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
        $ilUser = $this->user;
    
        include_once("Services/Form/classes/class.ilPropertyFormGUI.php");
        $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

(

$a_cmd

)

Insert file from repository.

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

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

Referenced by newItemAfter(), and newItemBefore().

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

        $this->setTabs($a_cmd);
        $ilTabs->setSubTabActive("cont_file_from_repository");
        $ilCtrl->setParameter($this, "subCmd", "insertFromRepository");

        include_once("./Services/COPage/classes/class.ilPCFileItemFileSelectorGUI.php");
        $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

(

$a_cmd = "insert"

)

Insert file from personal workspace.

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

References ilPageContentGUI\$ctrl, $ilCtrl, $ilUser, $tabs, ilPageContentGUI\$tpl, $tree, $user, setTabs(), and user().

Referenced by newItemAfter(), and newItemBefore().

    {
        $ilTabs = $this->tabs;
        $tree = $this->tree;
        $ilCtrl = $this->ctrl;
        $tpl = $this->tpl;
        $ilUser = $this->user;

        $this->setTabs($a_cmd);
        $ilTabs->setSubTabActive("cont_file_from_workspace");
        
        include_once("./Services/PersonalWorkspace/classes/class.ilWorkspaceExplorerGUI.php");
        $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

(

$a_file_ref_id = 0

)

insert new file item after another item

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

References $_GET, $ilUser, $res, $tree, $user, newFileItem(), and newItemAfter().

Referenced by newItemAfter().

    {
        $ilUser = $this->user;
        
        $res = true;
        if (isset($_GET["fl_wsp_id"])) {
            // we need the object id for the instance
            include_once "Services/PersonalWorkspace/classes/class.ilWorkspaceTree.php";
            $tree = new ilWorkspaceTree($ilUser->getId());
            $node = $tree->getNodeData($_GET["fl_wsp_id"]);
            
            include_once("./Modules/File/classes/class.ilObjFile.php");
            $this->file_object = new ilObjFile($node["obj_id"], false);
        } elseif ($a_file_ref_id == 0) {
            $res = $this->newFileItem();
        } else {
            include_once("./Modules/File/classes/class.ilObjFile.php");
            $this->file_object = new ilObjFile($a_file_ref_id);
        }
        if ($res) {
            $this->content_obj->newItemAfter(
                $this->file_object->getId(),
                $this->file_object->getTitle(),
                $this->file_object->getFileType()
            );
            $this->updated = $this->pg_obj->update();
            if ($this->updated === true) {
                $this->ctrl->returnToParent($this, "jump" . $this->hier_id);
            }
        }
        
        $_GET["subCmd"] = "-";
        $this->newItemAfter();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

insertNewItemBefore()

ilPCFileItemGUI::insertNewItemBefore

(

$a_file_ref_id = 0

)

insert new list item before current one

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

References $_GET, $ilUser, $res, $tree, $user, newFileItem(), and newItemBefore().

Referenced by newItemBefore().

    {
        $ilUser = $this->user;
        
        $res = true;
        if (isset($_GET["fl_wsp_id"])) {
            // we need the object id for the instance
            include_once "Services/PersonalWorkspace/classes/class.ilWorkspaceTree.php";
            $tree = new ilWorkspaceTree($ilUser->getId());
            $node = $tree->getNodeData($_GET["fl_wsp_id"]);
            
            include_once("./Modules/File/classes/class.ilObjFile.php");
            $this->file_object = new ilObjFile($node["obj_id"], false);
        } elseif ($a_file_ref_id == 0) {
            $res = $this->newFileItem();
        } else {
            include_once("./Modules/File/classes/class.ilObjFile.php");
            $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->ctrl->returnToParent($this, "jump" . $this->hier_id);
            }
        }

        $_GET["subCmd"] = "-";
        $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 486 of file class.ilPCFileItemGUI.php.

References $_SESSION.

    {
        $this->content_obj->moveItemDown();
        $_SESSION["il_pg_error"] = $this->pg_obj->update();
        $this->ctrl->returnToParent($this, "jump" . $this->hier_id);
    }

moveItemUp()

ilPCFileItemGUI::moveItemUp

(

)

move list item up

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

References $_SESSION.

    {
        $this->content_obj->moveItemUp();
        $_SESSION["il_pg_error"] = $this->pg_obj->update();
        $this->ctrl->returnToParent($this, "jump" . $this->hier_id);
    }

newFileItem()

ilPCFileItemGUI::newFileItem

(

)

insert new file item

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

References $_GET, $DIC, $form, ilPageContentGUI\$lng, initAddFileForm(), and ilUtil\sendFailure().

Referenced by insertNewItemAfter(), and insertNewItemBefore().

    {
        $lng = $this->lng;
        
        if ($_FILES["file"]["name"] == "") {
            $_GET["subCmd"] = "-";
            ilUtil::sendFailure($lng->txt("upload_error_file_not_found"));
            return false;
        }

        $form = $this->initAddFileForm();
        $form->checkInput();

        include_once("./Modules/File/classes/class.ilObjFile.php");
        $fileObj = new ilObjFile();
        $fileObj->setType("file");
        $fileObj->setTitle($_FILES["file"]["name"]);
        $fileObj->setDescription("");
        $fileObj->setFileName($_FILES["file"]["name"]);
        $fileObj->setFileType($_FILES["file"]["type"]);
        $fileObj->setFileSize($_FILES["file"]["size"]);
        $fileObj->setMode("filelist");
        $fileObj->create();
        $fileObj->raiseUploadError(false);
        // upload file to filesystem
        $fileObj->createDirectory();
        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 144 of file class.ilPCFileItemGUI.php.

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

Referenced by insertNewItemAfter().

    {
        $ilTabs = $this->tabs;
        
        if ($_GET["subCmd"] == "insertNew") {
            $_SESSION["cont_file_insert"] = "insertNew";
        }
        if ($_GET["subCmd"] == "insertFromRepository") {
            $_SESSION["cont_file_insert"] = "insertFromRepository";
        }
        if ($_GET["subCmd"] == "insertFromWorkspace") {
            $_SESSION["cont_file_insert"] = "insertFromWorkspace";
        }
        if (($_GET["subCmd"] == "") && $_SESSION["cont_file_insert"] != "") {
            $_GET["subCmd"] = $_SESSION["cont_file_insert"];
        }

        switch ($_GET["subCmd"]) {
            case "insertFromWorkspace":
                $this->insertFromWorkspace("newItemAfter");
                break;
            
            case "insertFromRepository":
                $this->insertFromRepository("newItemAfter");
                break;
                
            case "selectFile":
                $this->insertNewItemAfter($_GET["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;

                // new file list form
                $this->tpl->addBlockFile("ADM_CONTENT", "adm_content", "tpl.file_item_edit.html", "Services/COPage");
                $this->tpl->setVariable("TXT_ACTION", $this->lng->txt("cont_insert_file_item"));
                $this->tpl->setVariable("FORMACTION", $this->ctrl->getFormAction($this));
        
                $this->displayValidationError();
        
                // file
                $this->tpl->setVariable("TXT_FILE", $this->lng->txt("file"));
        
                $this->tpl->parseCurrentBlock();
        
                // operations
                $this->tpl->setCurrentBlock("commands");
                $this->tpl->setVariable("BTN_NAME", "insertNewItemAfter");
                $this->tpl->setVariable("BTN_TEXT", $this->lng->txt("save"));
                $this->tpl->parseCurrentBlock();
                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 330 of file class.ilPCFileItemGUI.php.

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

Referenced by insertNewItemBefore().

    {
        $ilTabs = $this->tabs;
        
        if ($_GET["subCmd"] == "insertNew") {
            $_SESSION["cont_file_insert"] = "insertNew";
        }
        if ($_GET["subCmd"] == "insertFromRepository") {
            $_SESSION["cont_file_insert"] = "insertFromRepository";
        }
        if ($_GET["subCmd"] == "insertFromWorkspace") {
            $_SESSION["cont_file_insert"] = "insertFromWorkspace";
        }
        if (($_GET["subCmd"] == "") && $_SESSION["cont_file_insert"] != "") {
            $_GET["subCmd"] = $_SESSION["cont_file_insert"];
        }

        switch ($_GET["subCmd"]) {
            case "insertFromWorkspace":
                $this->insertFromWorkspace("newItemBefore");
                break;
            
            case "insertFromRepository":
                $this->insertFromRepository("newItemBefore");
                break;
                
            case "selectFile":
                $this->insertNewItemBefore($_GET["file_ref_id"]);
                break;
                
            default:
                $this->setTabs("newItemBefore");
                $ilTabs->setSubTabActive("cont_new_file");
        
                $this->displayValidationError();
                $form = $this->initAddFileForm(true);
                $this->tpl->setContent($form->getHTML());
break;
                
                // new file list form
                $this->tpl->addBlockFile("ADM_CONTENT", "adm_content", "tpl.file_item_edit.html", "Services/COPage");
                $this->tpl->setVariable("TXT_ACTION", $this->lng->txt("cont_insert_file_item"));
                $this->tpl->setVariable("FORMACTION", $this->ctrl->getFormAction($this));
        
                $this->displayValidationError();
        
                // file
                $this->tpl->setVariable("TXT_FILE", $this->lng->txt("file"));
        
                $this->tpl->parseCurrentBlock();
        
                // operations
                $this->tpl->setCurrentBlock("commands");
                $this->tpl->setVariable("BTN_NAME", "insertNewItemBefore");
                $this->tpl->setVariable("BTN_TEXT", $this->lng->txt("save"));
                $this->tpl->parseCurrentBlock();
                break;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setTabs()

ilPCFileItemGUI::setTabs

(

$a_cmd = ""

)

output tabs

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

References ilPageContentGUI\$ctrl, $ilCtrl, $ilSetting, $settings, and $tabs.

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

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

Here is the caller graph for this function:

Field Documentation

$settings

ilPCFileItemGUI::$settings

protected

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

Referenced by setTabs().

$tabs

ilPCFileItemGUI::$tabs

protected

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

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

$tree

ilPCFileItemGUI::$tree

protected

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

Referenced by insertFromWorkspace(), insertNewItemAfter(), and insertNewItemBefore().

$user

ilPCFileItemGUI::$user

protected

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

Referenced by initAddFileForm(), insertFromWorkspace(), insertNewItemAfter(), and insertNewItemBefore().

---

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

• Services/COPage/classes/class.ilPCFileItemGUI.php