ilPCFileItemGUI Class Reference

Class ilPCFileItemGUI. More...

Inheritance diagram for ilPCFileItemGUI:

Collaboration diagram for ilPCFileItemGUI:

Public Member Functions
	ilPCFileItemGUI (&$a_pg_obj, &$a_content_obj, $a_hier_id, $a_pc_id="")
	Constructor public.
&	executeCommand ()
	execute command
	newFileItem ()
	insert new file item
	newItemAfter ()
	insert new list item after current one
	insertFromRepository ($a_cmd)
	Insert file from repository.
	insertNewItemAfter ($a_file_ref_id=0)
	insert new file item after another item
	newItemBefore ()
	insert new list item before current one
	insertNewItemBefore ($a_file_ref_id=0)
	insert new list item before current one
	deleteItem ()
	delete a list item
	setTabs ($a_cmd="")
	output tabs
	moveItemDown ()
	move list item down
	moveItemUp ()
	move list item up
Public Member Functions inherited from ilPageContentGUI
	ilPageContentGUI (&$a_pg_obj, &$a_content_obj, $a_hier_id=0, $a_pc_id="")
	Constructor public.
	setStyleId ($a_styleid)
	Set Style Id.
	getStyleId ()
	Get Style Id.
	setEnableInternalLinks ($a_val)
	Set enable internal links.
	getEnableInternalLinks ()
	Get enable internal links.
	setEnableKeywords ($a_val)
	Set enable keywords handling.
	getEnableKeywords ()
	Get enable keywords handling.
	setEnableAnchors ($a_val)
	Set enable anchors.
	getEnableAnchors ()
	Get enable anchors.
	getStyle ()
	Get style object.
	setCharacteristics ($a_chars)
	Set Characteristics.
	getCharacteristics ()
	Get characteristics.
	getHierId ()
	get hierarchical id in dom object
	setHierId ($a_hier_id)
	get hierarchical id in dom object
	getBBMenu ($a_ta_name="par_content")
	Get the bb menu incl.
	delete ()
	delete content element
	moveAfter ()
	move content element after another element
	moveBefore ()
	move content element before another element
	splitPage ()
	split page to new page at specified position
	splitPageNext ()
	split page to next page at specified position
	displayValidationError ()
	display validation errors
	cancelCreate ()
	cancel creating page content
	cancelUpdate ()
	cancel update
	deactivate ()
	gui function set enabled if is not enabled and vice versa
	getTemplateOptions ($a_type)
	Get table templates.

Additional Inherited Members
Static Public Member Functions inherited from ilPageContentGUI
static	_getCommonBBButtons ()
	Get common bb buttons.
Data Fields inherited from ilPageContentGUI
	$content_obj
	$ilias
	$tpl
	$lng
	$ctrl
	$pg_obj
	$hier_id
	$dom
	$updated
	$target_script
	$return_location
Protected Member Functions inherited from ilPageContentGUI
	getCharacteristicsOfCurrentStyle ($a_type)
	Get characteristics of current style.
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.

Member Function Documentation

ilPCFileItemGUI::deleteItem

(

)

delete a list item

Definition at line 324 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);
        }

& 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;
        }

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

Constructor public.

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

References ilPageContentGUI\ilPageContentGUI().

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

Here is the call graph for this function:

ilPCFileItemGUI::insertFromRepository

(

$a_cmd

)

Insert file from repository.

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

References $_GET, $ilCtrl, ilPageContentGUI\$tpl, 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:

ilPCFileItemGUI::insertNewItemAfter

(

$a_file_ref_id = 0

)

insert new file item after another item

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

References $_GET, $res, newFileItem(), and newItemAfter().

Referenced by newItemAfter().

        {
                $res = true;
                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:

ilPCFileItemGUI::insertNewItemBefore

(

$a_file_ref_id = 0

)

insert new list item before current one

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

References $_GET, $res, newFileItem(), and newItemBefore().

Referenced by newItemBefore().

        {
                $res = true;
                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:

ilPCFileItemGUI::moveItemDown

(

)

move list item down

Definition at line 358 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);
        }

ilPCFileItemGUI::moveItemUp

(

)

move list item up

Definition at line 368 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);
        }

ilPCFileItemGUI::newFileItem

(

)

insert new file item

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

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

Referenced by insertNewItemAfter(), and insertNewItemBefore().

        {
                global $lng;
                
                if ($_FILES["Fobject"]["name"]["file"] == "")
                {
                        $_GET["subCmd"] = "-";
                        ilUtil::sendFailure($lng->txt("upload_error_file_not_found"));
                        return false;
                }
                include_once("./Modules/File/classes/class.ilObjFile.php");
                $fileObj = new ilObjFile();
                $fileObj->setType("file");
                $fileObj->setTitle($_FILES["Fobject"]["name"]["file"]);
                $fileObj->setDescription("");
                $fileObj->setFileName($_FILES["Fobject"]["name"]["file"]);
                $fileObj->setFileType($_FILES["Fobject"]["type"]["file"]);
                $fileObj->setFileSize($_FILES["Fobject"]["size"]["file"]);
                $fileObj->setMode("filelist");
                $fileObj->create();
                $fileObj->raiseUploadError(false);
                // upload file to filesystem
                $fileObj->createDirectory();
                $fileObj->getUploadFile($_FILES["Fobject"]["tmp_name"]["file"],
                        $_FILES["Fobject"]["name"]["file"]);

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

Here is the call graph for this function:

Here is the caller graph for this function:

ilPCFileItemGUI::newItemAfter

(

)

insert new list item after current one

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

References $_GET, $_SESSION, ilPageContentGUI\displayValidationError(), insertFromRepository(), 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"] == "") && $_SESSION["cont_file_insert"] != "")
                {
                        $_GET["subCmd"] = $_SESSION["cont_file_insert"];
                }

                switch ($_GET["subCmd"])
                {
                        case "insertFromRepository":
                                $this->insertFromRepository("newItemAfter");
                                break;
                                
                        case "selectFile":
                                $this->insertNewItemAfter($_GET["file_ref_id"]);
                                break;
                                
                        default:
                                $this->setTabs("newItemAfter");
                                $ilTabs->setSubTabActive("cont_new_file");
                
                                // 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:

ilPCFileItemGUI::newItemBefore

(

)

insert new list item before current one

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

References $_GET, $_SESSION, ilPageContentGUI\displayValidationError(), insertFromRepository(), 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"] == "") && $_SESSION["cont_file_insert"] != "")
                {
                        $_GET["subCmd"] = $_SESSION["cont_file_insert"];
                }

                switch ($_GET["subCmd"])
                {
                        case "insertFromRepository":
                                $this->insertFromRepository("newItemBefore");
                                break;
                                
                        case "selectFile":
                                $this->insertNewItemBefore($_GET["file_ref_id"]);
                                break;
                                
                        default:
                                $this->setTabs("newItemBefore");
                                $ilTabs->setSubTabActive("cont_new_file");
                
                                // 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:

ilPCFileItemGUI::setTabs

(

$a_cmd = ""

)

output tabs

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

References $ilCtrl.

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

        {
                global $ilTabs, $ilCtrl;

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

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