Public Member Functions

ilObjFileGUI Class Reference

Inheritance diagram for ilObjFileGUI:
Collaboration diagram for ilObjFileGUI:

Public Member Functions

 ilObjFileGUI ($a_data, $a_id, $a_call_by_reference=true, $a_prepare_output=true)
 Constructor public.
 _forwards ()
& executeCommand ()
 execute command
 createObject ()
 create new object form
 saveObject ()
 save object
 updateObject ()
 updates object entry in object_data
 editObject ()
 edit object
 sendFileObject ()
 versionsObject ()
 file versions/history
 getTabs (&$tabs_gui)
 get tabs abstract method.

Detailed Description

Definition at line 41 of file class.ilObjFileGUI.php.

Member Function Documentation

ilObjFileGUI::_forwards (  ) 

Definition at line 53 of file class.ilObjFileGUI.php.

        {
                return array();
        }

ilObjFileGUI::createObject (  ) 

create new object form

public

Reimplemented from ilObjectGUI.

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

References $_GET, $_POST, $_SESSION, ilObjectGUI::$data, $rbacsystem, ilObjectGUI::getFormAction(), ilObjectGUI::getTargetFrame(), ilObjectGUI::getTemplateFile(), ilUtil::prepareFormOutput(), and ilUtil::stripSlashes().

        {
                global $rbacsystem;

                $new_type = $_POST["new_type"] ? $_POST["new_type"] : $_GET["new_type"];

                if (!$rbacsystem->checkAccess("create", $_GET["ref_id"], $new_type))
                {
                        $this->ilErr->raiseError($this->lng->txt("permission_denied"),$this->ilErr->MESSAGE);
                }

                // fill in saved values in case of error
                $data = array();
                $data["fields"] = array();
                $data["fields"]["title"] = ilUtil::prepareFormOutput($_SESSION["error_post_vars"]["Fobject"]["title"],true);
                $data["fields"]["desc"] = ilUtil::stripSlashes($_SESSION["error_post_vars"]["Fobject"]["desc"]);
                $data["fields"]["file"] = $_SESSION["error_post_vars"]["Fobject"]["file"];

                $this->getTemplateFile("new",$this->type);

                foreach ($data["fields"] as $key => $val)
                {
                        $this->tpl->setVariable("TXT_".strtoupper($key), $this->lng->txt($key));
                        $this->tpl->setVariable(strtoupper($key), $val);
                        #$this->tpl->parseCurrentBlock();
                }

                $this->tpl->setVariable("FORMACTION", $this->getFormAction("save",$this->ctrl->getFormAction($this)."&new_type=".$new_type));
                //$this->tpl->setVariable("FORMACTION", $this->getFormAction("save","adm_object.php?cmd=gateway&ref_id=".$_GET["ref_id"]."&new_type=".$this->type));
                $this->tpl->setVariable("TXT_TITLE_NOTE", $this->lng->txt("if_no_title_then_filename"));
                $this->tpl->setVariable("TXT_HEADER", $this->lng->txt($this->type."_new"));
                $this->tpl->setVariable("TXT_CANCEL", $this->lng->txt("cancel"));
                $this->tpl->setVariable("TXT_SUBMIT", $this->lng->txt($this->type."_add"));
                $this->tpl->setVariable("CMD_SUBMIT", "save");
                $this->tpl->setVariable("TARGET", $this->getTargetFrame("save"));
                $this->tpl->setVariable("TXT_REQUIRED_FLD", $this->lng->txt("required_field"));
        }

Here is the call graph for this function:

ilObjFileGUI::editObject (  ) 

edit object

public

Reimplemented from ilObjectGUI.

Definition at line 219 of file class.ilObjFileGUI.php.

References $_SESSION, $fields, $rbacsystem, ilObjectGUI::getFormAction(), ilObjectGUI::getTargetFrame(), ilObjectGUI::getTemplateFile(), ilUtil::prepareFormOutput(), and ilUtil::stripSlashes().

        {
                global $rbacsystem;

                if (!$rbacsystem->checkAccess("write", $this->ref_id))
                {
                        $this->ilias->raiseError($this->lng->txt("msg_no_perm_write"),$this->ilias->error_obj->MESSAGE);
                }

                $fields = array();

                if ($_SESSION["error_post_vars"])
                {
                        // fill in saved values in case of error
                        $fields["title"] = ilUtil::prepareFormOutput($_SESSION["error_post_vars"]["Fobject"]["title"],true);
                        $fields["desc"] = ilUtil::stripSlashes($_SESSION["error_post_vars"]["Fobject"]["desc"]);
                }
                else
                {
                        $fields["title"] = ilUtil::prepareFormOutput($this->object->getTitle());
                        $fields["desc"] = ilUtil::stripSlashes($this->object->getDescription());
                }
                
                $this->getTemplateFile("edit");
                $this->tpl->setVariable("TXT_TITLE", $this->lng->txt("title"));
                $this->tpl->setVariable("TITLE", $fields["title"]);
                $this->tpl->setVariable("TXT_DESC", $this->lng->txt("desc"));
                $this->tpl->setVariable("DESC", $fields["desc"]);
                $this->tpl->setVariable("TXT_REPLACE_FILE", $this->lng->txt("replace_file"));
                //$this->tpl->parseCurrentBlock();

                $obj_str = ($this->call_by_reference) ? "" : "&obj_id=".$this->obj_id;

                $this->tpl->setVariable("FORMACTION", $this->getFormAction("update",$this->ctrl->getFormAction($this).$obj_str));
                //$this->tpl->setVariable("FORMACTION", $this->getFormAction("update","adm_object.php?cmd=gateway&ref_id=".$this->ref_id.$obj_str));
                $this->tpl->setVariable("TXT_HEADER", $this->lng->txt($this->object->getType()."_edit"));
                $this->tpl->setVariable("TARGET", $this->getTargetFrame("update"));
                $this->tpl->setVariable("TXT_CANCEL", $this->lng->txt("cancel"));
                $this->tpl->setVariable("TXT_SUBMIT", $this->lng->txt("save"));
                $this->tpl->setVariable("CMD_SUBMIT", "update");
                $this->tpl->setVariable("TXT_REQUIRED_FLD", $this->lng->txt("required_field"));
                //$this->tpl->parseCurrentBlock();
        }

Here is the call graph for this function:

& ilObjFileGUI::executeCommand (  ) 

execute command

Reimplemented from ilObjectGUI.

Definition at line 58 of file class.ilObjFileGUI.php.

References $cmd.

        {
                $next_class = $this->ctrl->getNextClass($this);
                $cmd = $this->ctrl->getCmd();

                switch ($next_class)
                {
                        default:
                                if (empty($cmd))
                                {
                                        $this->ctrl->returnToParent($this);
                                        $cmd = "view";
                                }

                                $cmd .= "Object";
                                $this->$cmd();
                                break;
                }               
        }

ilObjFileGUI::getTabs ( &$  tabs_gui  ) 

get tabs abstract method.

overwrite in derived GUI class of your object type public

Parameters:
object instance of ilTabsGUI

Reimplemented from ilObjectGUI.

Definition at line 299 of file class.ilObjFileGUI.php.

References $rbacsystem.

        {
                global $rbacsystem;

                $this->ctrl->setParameter($this,"ref_id",$this->ref_id);

                if ($rbacsystem->checkAccess('write',$this->ref_id))
                {
                        $tabs_gui->addTarget("edit_properties",
                                $this->ctrl->getLinkTarget($this, "edit"), "edit", get_class($this));
                }
                
                if ($rbacsystem->checkAccess('write',$this->ref_id))
                {
                        $tabs_gui->addTarget("versions",
                                $this->ctrl->getLinkTarget($this, "versions"), "versions", get_class($this));
                }

                if ($rbacsystem->checkAccess('edit_permission',$this->ref_id))
                {
                        $tabs_gui->addTarget("perm_settings",
                                $this->ctrl->getLinkTarget($this, "perm"), "perm", get_class($this));
                }
        }

ilObjFileGUI::ilObjFileGUI ( $  a_data,
$  a_id,
$  a_call_by_reference = true,
$  a_prepare_output = true 
)

Constructor public.

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

References ilObjectGUI::ilObjectGUI().

        {
                $this->type = "file";
                $this->ilObjectGUI($a_data,$a_id,$a_call_by_reference, $a_prepare_output);
        }

Here is the call graph for this function:

ilObjFileGUI::saveObject (  ) 

save object

public

Reimplemented from ilObjectGUI.

Definition at line 126 of file class.ilObjFileGUI.php.

References $_GET, $_POST, ilObjectGUI::$data, ilObjectGUI::$objDefinition, $rbacsystem, ilObjectGUI::getReturnLocation(), ilUtil::redirect(), sendInfo(), and ilUtil::stripSlashes().

        {
                global $rbacsystem, $objDefinition;

                $data = $_FILES["Fobject"];

                // delete trailing '/' in filename
                while (substr($data["name"]["file"],-1) == '/')
                {
                        $data["name"]["file"] = substr($data["name"]["file"],0,-1);
                }

                if (empty($data["name"]["file"]))
                {
                        $this->ilias->raiseError($this->lng->txt("msg_no_file"),$this->ilias->error_obj->MESSAGE);
                }

                if (empty($_POST["Fobject"]["title"]))
                {
                        $_POST["Fobject"]["title"] = $_FILES["Fobject"]["name"]["file"];
                        //$this->ilias->raiseError($this->lng->txt("msg_no_title"),$this->ilias->error_obj->MESSAGE);
                }

                // create and insert file in grp_tree
                include_once("classes/class.ilObjFile.php");
                $fileObj = new ilObjFile();
                $fileObj->setType($this->type);
                $fileObj->setTitle(ilUtil::stripSlashes($_POST["Fobject"]["title"]));
                $fileObj->setDescription(ilUtil::stripSlashes($_POST["Fobject"]["desc"]));
                $fileObj->setFileName(ilUtil::stripSlashes($_FILES["Fobject"]["name"]["file"]));
                $fileObj->setFileType($_FILES["Fobject"]["type"]["file"]);
                $fileObj->create();
                $fileObj->createReference();
                $fileObj->putInTree($_GET["ref_id"]);
                $fileObj->setPermissions($_GET["ref_id"]);
                // upload file to filesystem
                $fileObj->createDirectory();
                $fileObj->getUploadFile($_FILES["Fobject"]["tmp_name"]["file"],ilUtil::stripSlashes($_FILES["Fobject"]["name"]["file"]));

                sendInfo($this->lng->txt("file_added"),true);
                ilUtil::redirect($this->getReturnLocation("save",$this->ctrl->getLinkTarget($this,"")));
                //ilUtil::redirect($this->getReturnLocation("save","adm_object.php?".$this->link_params));
        }

Here is the call graph for this function:

ilObjFileGUI::sendFileObject (  ) 

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

References $_GET.

        {
                $this->object->sendFile($_GET["hist_id"]);
                
                return true;
        }

ilObjFileGUI::updateObject (  ) 

updates object entry in object_data

public

Reimplemented from ilObjectGUI.

Definition at line 175 of file class.ilObjFileGUI.php.

References $_POST, ilObjectGUI::$data, ilObjectGUI::getReturnLocation(), ilUtil::redirect(), sendInfo(), and ilUtil::stripSlashes().

        {
                $data = $_FILES["Fobject"];

                // delete trailing '/' in filename
                while (substr($data["name"]["file"],-1) == '/')
                {
                        $data["name"]["file"] = substr($data["name"]["file"],0,-1);
                }

                if (empty($data["name"]["file"]) && empty($_POST["Fobject"]["title"]))
                {
                        $this->ilias->raiseError($this->lng->txt("msg_no_title"),$this->ilias->error_obj->MESSAGE);
                }

                if (empty($_POST["Fobject"]["title"]))
                {
                        $_POST["Fobject"]["title"] = $_FILES["Fobject"]["name"]["file"];
                }

                if (!empty($data["name"]["file"]))
                {
                        $this->object->replaceFile($_FILES["Fobject"]["tmp_name"]["file"],$_FILES["Fobject"]["name"]["file"]);
                        $this->object->setFileName($_FILES["Fobject"]["name"]["file"]);
                        $this->object->setFileType($_FILES["Fobject"]["type"]["file"]);
                }
                
                $this->object->setTitle(ilUtil::stripSlashes($_POST["Fobject"]["title"]));
                $this->object->setDescription(ilUtil::stripSlashes($_POST["Fobject"]["desc"]));

                $this->update = $this->object->update();

                sendInfo($this->lng->txt("msg_obj_modified"),true);

                ilUtil::redirect($this->getReturnLocation("update",$this->ctrl->getLinkTarget($this)));
                //ilUtil::redirect($this->getReturnLocation("update","adm_object.php?ref_id=".$this->ref_id));
        }

Here is the call graph for this function:

ilObjFileGUI::versionsObject (  ) 

file versions/history

public

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

References $_GET, and $rbacsystem.

        {
                global $rbacsystem;

                if (!$rbacsystem->checkAccess("read", $_GET["ref_id"]))
                {
                        $this->ilErr->raiseError($this->lng->txt("permission_denied"),$this->ilErr->MESSAGE);
                }

                require_once("classes/class.ilHistoryGUI.php");
                
                $hist_gui =& new ilHistoryGUI($this->object->getId());
                
                // not nice, should be changed, if ilCtrl handling
                // has been introduced to administration
                $hist_html = $hist_gui->getVersionsTable(
                        array("ref_id" => $_GET["ref_id"], "cmd" => "versions",
                        "cmdClass" =>$_GET["cmdClass"], "cmdNode" =>$_GET["cmdNode"]));
                
                $this->tpl->setVariable("ADM_CONTENT", $hist_html);
        }

The documentation for this class was generated from the following file:
Generated on Fri Dec 13 2013 10:18:45 for ILIAS Release_3_5_x_branch .rev 46805 by  doxygen 1.7.1