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...

Additional Inherited Members
Static Public Member Functions inherited from ilPageContentGUI
static	_getCommonBBButtons ()
	Get common bb buttons. More...
Data Fields inherited from ilPageContentGUI
	$content_obj
	$ilias
	$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...
Protected Attributes inherited from ilPageContentGUI
	$log
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 44 of file class.ilPCFileItemGUI.php.

        {
                parent::__construct($a_pg_obj, $a_content_obj, $a_hier_id, $a_pc_id);
        }

Member Function Documentation

cancelAddFile()

ilPCFileItemGUI::cancelAddFile

(

)

Cancel adding a file.

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

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

deleteItem()

ilPCFileItemGUI::deleteItem

(

)

delete a list item

Definition at line 467 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 52 of file class.ilPCFileItemGUI.php.

References $cmd, and $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 178 of file class.ilPCFileItemGUI.php.

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

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

        {
                global $lng, $ilCtrl, $ilUser;
        
                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 211 of file class.ilPCFileItemGUI.php.

References $_GET, $ilCtrl, ilPageContentGUI\$tpl, array, IL_FM_POSITIVE, and setTabs().

Referenced by newItemAfter(), and newItemBefore().

        {
                global $ilTabs, $tree, $ilCtrl, $tpl;
                
                $this->setTabs($a_cmd);
                $ilTabs->setSubTabActive("cont_file_from_repository");
                
                include_once "./Services/COPage/classes/class.ilFileSelectorGUI.php";

                $exp = new ilFileSelectorGUI($this->ctrl->getLinkTarget($this, $a_cmd),
                        "ilpcfileitemgui");

                if ($_GET["expand"] == "")
                {
                        $expanded = $tree->readRootId();
                }
                else
                {
                        $expanded = $_GET["expand"];
                }
                $exp->setExpand($expanded);

                $exp->setTargetGet("sel_id");
                //$this->ctrl->setParameter($this, "target_type", $a_type);
                $ilCtrl->setParameter($this, "subCmd", "insertFromRepository");
                $exp->setParamsGet($this->ctrl->getParameterArray($this, $a_cmd));
                
                // filter
                $exp->setFiltered(true);
                $exp->setFilterMode(IL_FM_POSITIVE);
                $exp->addFilter("root");
                $exp->addFilter("cat");
                $exp->addFilter("grp");
                $exp->addFilter("fold");
                $exp->addFilter("crs");
                $exp->addFilter("file");

                $sel_types = array('file');

                $exp->setOutput(0);

                $tpl->setContent($exp->getOutput());
        }

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 258 of file class.ilPCFileItemGUI.php.

References $_GET, $ilCtrl, $ilUser, ilPageContentGUI\$tpl, IL_FM_POSITIVE, ilWorkspaceExplorer\SEL_TYPE_RADIO, and setTabs().

Referenced by newItemAfter(), and newItemBefore().

        {
                global $ilTabs, $tree, $ilCtrl, $tpl, $ilUser;

                $this->setTabs($a_cmd);
                $ilTabs->setSubTabActive("cont_file_from_workspace");
                
                // get ws tree
                include_once "Services/PersonalWorkspace/classes/class.ilWorkspaceTree.php";
                $tree = new ilWorkspaceTree($ilUser->getId());
                
                // get access handler
                include_once("./Services/PersonalWorkspace/classes/class.ilWorkspaceAccessHandler.php");
                $acc_handler = new ilWorkspaceAccessHandler($tree);
                
                // get es explorer
                include_once("./Services/PersonalWorkspace/classes/class.ilWorkspaceExplorer.php");
                $exp = new ilWorkspaceExplorer(ilWorkspaceExplorer::SEL_TYPE_RADIO, '', 
                        'filelist_wspexpand', $tree, $acc_handler);
                $exp->setTargetGet('fl_wsp_id');
                $exp->setFiltered(false);
                $exp->removeAllFormItemTypes();
                
                // select link 
                $exp->setTypeClickable("file");
                $ilCtrl->setParameter($this, "subCmd", "selectFile");
                $exp->setCustomLinkTarget($ilCtrl->getLinkTarget($this, $a_cmd));
                
                // filter
                $exp->setFiltered(true);
                $exp->setFilterMode(IL_FM_POSITIVE);
                $exp->addFilter("wsrt");
                $exp->addFilter("wfld");
                $exp->addFilter("file");
        
                // expand link
                $ilCtrl->setParameter($this, "subCmd", "insertFromWorkspace");
                $exp->setParamsGet($ilCtrl->getParameterArray($this, $a_cmd));          

                if($_GET['filelist_wspexpand'] == '')
                {
                        $expanded = $tree->readRootId();
                }
                else
                {
                        $expanded = $_GET['filelist_wspexpand'];
                }
                $exp->setExpand($expanded);
                $exp->setOutput(0);
                
                $tpl->setContent($exp->getOutput());
        }

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 314 of file class.ilPCFileItemGUI.php.

References $_GET, $ilUser, $res, ilTree\getNodeData(), newFileItem(), and newItemAfter().

Referenced by newItemAfter().

        {
                global $ilUser;
                
                $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);
                }
                else if ($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 425 of file class.ilPCFileItemGUI.php.

References $_GET, $ilUser, $res, ilTree\getNodeData(), newFileItem(), and newItemBefore().

Referenced by newItemBefore().

        {
                global $ilUser;
                
                $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);
                }
                else if ($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 510 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 520 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 72 of file class.ilPCFileItemGUI.php.

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

Referenced by insertNewItemAfter(), and insertNewItemBefore().

        {
                global $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();
                $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 110 of file class.ilPCFileItemGUI.php.

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

Referenced by insertNewItemAfter().

        {
                global $ilTabs;
                
                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 356 of file class.ilPCFileItemGUI.php.

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

Referenced by insertNewItemBefore().

        {
                global $ilTabs;
                
                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 477 of file class.ilPCFileItemGUI.php.

References $ilCtrl, and $ilSetting.

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

        {
                global $ilTabs, $ilCtrl, $ilSetting;

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

---

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

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