ilObjObjectFolderGUI Class Reference

Class ilObjObjectFolderGUI. More...

Inheritance diagram for ilObjObjectFolderGUI:

Collaboration diagram for ilObjObjectFolderGUI:

Public Member Functions
	ilObjObjectFolderGUI ($a_data, $a_id, $a_call_by_reference)
	Constructor.
	viewObject ()
	list childs of current object
	displayList ()
	display object list
&	executeCommand ()
	execute command
	getTabs (&$tabs_gui)
	get tabs public
Public Member Functions inherited from ilObjectGUI
	ilObjectGUI ($a_data, $a_id=0, $a_call_by_reference=true, $a_prepare_output=true)
	Constructor public.
	withReferences ()
	determines wether objects are referenced or not (got ref ids or not)
	setCreationMode ($a_mode=true)
	if true, a creation screen is displayed the current $_GET[ref_id] don't belong to the current class! the mode is determined in ilrepositorygui
	getCreationMode ()
	get creation mode
	assignObject ()
	prepareOutput ()
	prepare output
	setTitleAndDescription ()
	called by prepare output
	showUpperIcon ()
	showMountWebfolderIcon ()
	setTabs ()
	set admin tabs public
	setAdminTabs ()
	set admin tabs public
	getAdminTabs (&$tabs_gui)
	administration tabs show only permissions and trash folder
	getHTML ()
	setActions ($a_actions="")
	set possible actions for objects in list.
	setSubObjects ($a_sub_objects="")
	set possible subobjects for this object.
	setLocator ()
	set Locator
	addLocatorItems ()
	should be overwritten to add object specific items (repository items are preloaded)
	omitLocator ($a_omit=true)
	addAdminLocatorItems ()
	should be overwritten to add object specific items (repository items are preloaded)
	undeleteObject ()
	get object back from trash
	insertSavedNodes ($a_source_id, $a_dest_id, $a_tree_id, &$a_affected_ids)
	recursive method to insert all saved nodes of the clipboard (maybe this function could be moved to a rbac class ?)
	confirmedDeleteObject ()
	confirmed deletion if object -> objects are moved to trash
	cancelDeleteObject ()
	cancel deletion of object
	removeFromSystemObject ()
	remove objects from trash bin and all entries therefore every object needs a specific deleteObject() method
	removeDeletedNodes ($a_node_id, $a_checked, $a_delete_objects, &$a_affected_ids)
	remove already deleted objects within the objects in trash recursive function
	createObject ()
	create new object form
	cancelObject ($in_rep=false)
	cancel action and go back to previous page public
	saveObject ()
	save object
	importObject ()
	import new object form
	editObject ()
	edit object
	displayEditForm ($fields)
	display edit form (usually called by editObject)
	updateObject ()
	updates object entry in object_data
	afterUpdate ()
	permObject ()
	show permissions of current node
	getFormAction ($a_cmd, $a_formaction="")
	get form action for command (command is method name without "Object", e.g.
	setFormAction ($a_cmd, $a_formaction)
	set specific form action for command
	getReturnLocation ($a_cmd, $a_location="")
	get return location for command (command is method name without "Object", e.g.
	setReturnLocation ($a_cmd, $a_location)
	set specific return location for command
	getTargetFrame ($a_cmd, $a_target_frame="")
	get target frame for command (command is method name without "Object", e.g.
	setTargetFrame ($a_cmd, $a_target_frame)
	set specific target frame for command
	permSaveObject ()
	save permissions
	isVisible ($a_ref_id, $a_type)
	deleteObject ($a_error=false)
	display deletion confirmation screen only for referenced objects.
	trashObject ()
	show trash content of object
	addRoleObject ()
	adds a local role This method is only called when choose the option 'you may add local roles'.
	showActions ($with_subobjects=false)
	show possible action (form buttons)
	getActions ()
	Get Actions.
	showPossibleSubObjects ()
	show possible subobjects (pulldown menu)
	getTemplateFile ($a_cmd, $a_type="")
	get a template blockfile format: tpl.
	getTitlesByRefId ($a_ref_ids)
	get Titles of objects this method is used for error messages in methods cut/copy/paste
	__showButton ($a_cmd, $a_text, $a_target= '')
	hitsperpageObject ()
&	__initTableGUI ()
	__setTableGUIBasicData (&$tbl, &$result_set, $a_from="")
	standard implementation for tables use 'from' variable use different initial setting of table
	__showClipboardTable ($a_result_set, $a_from="")
	infoObject ()
	__buildRoleFilterSelect ()
	__filterRoles ($a_roles, $a_filter)
	ownerObject ()
	changeOwnerObject ()
	redirectToRefId ($a_ref_id, $a_cmd="")
	redirects to (repository) view per ref id usually to a container and usually used at the end of a save/import method where the object gui type (of the new object) doesn't match with the type of the current $_GET["ref_id"] value
	fillCloneTemplate ($a_tpl_varname, $a_type)
	Fill object clone template This method can be called from any object GUI class that wants to offer object cloning.
	fillCloneSearchTemplate ($a_tpl_varname, $a_type)
	Add an object search in case the number of existing objects is too big to offer a selection list.
	cloneAllObject ()
	Clone single (not container object) Method is overwritten in ilContainerGUI.
	copyWizardHasOptions ($a_mode)
	Check if there is any modules specific option.
	getCenterColumnHTML ()
	Get center column.
	getRightColumnHTML ()
	Display right column.
	setColumnSettings ($column_gui)
	May be overwritten in subclasses.
	checkPermission ($a_perm, $a_cmd="")

Additional Inherited Members
Data Fields inherited from ilObjectGUI
const	COPY_WIZARD_NEEDS_PAGE = 1
	$ilias
	$objDefinition
	$tpl
	$tree
	$lng
	$data
	$object
	$ref_id
	$obj_id
	$maxcount
	$formaction
	$return_location
	$target_frame
	$tab_target_script
	$actions
	$sub_objects
	$omit_locator = false
Protected Member Functions inherited from ilObjectGUI
	searchCloneSourceObject ()
	Search clone source by title.
	buildCloneSelect ($existing_objs)
	Build a select box for clonable objects (permission write)

Detailed Description

Class ilObjObjectFolderGUI.

Author

Stefan Meyer smeye.nosp@m.r@da.nosp@m.tabay.nosp@m..de

Id:

class.ilObjObjectFolderGUI.php 16942 2008-07-14 20:09:53Z smeyer

ilObjObjectFolderGUI: ilPermissionGUI

Definition at line 38 of file class.ilObjObjectFolderGUI.php.

Member Function Documentation

ilObjObjectFolderGUI::displayList

(

)

display object list

public

Reimplemented from ilObjectGUI.

Definition at line 98 of file class.ilObjObjectFolderGUI.php.

References $_GET, ilObjectGUI\$data, and ilUtil\switchColor().

Referenced by viewObject().

        {
                include_once "./Services/Table/classes/class.ilTableGUI.php";
                return;

                // load template for table
                $this->tpl->addBlockfile("ADM_CONTENT", "adm_content", "tpl.table.html");

                // load template for table content data
                $this->tpl->addBlockfile("TBL_CONTENT", "tbl_content", "tpl.obj_tbl_rows.html");

                $num = 0;

                $obj_str = ($this->call_by_reference) ? "" : "&obj_id=".$this->obj_id;
                $this->tpl->setVariable("FORMACTION",
                        $this->ctrl->getFormAction($this));

                // create table
                $tbl = new ilTableGUI();

                // title & header columns
                $tbl->setTitle($this->object->getTitle(),"icon_".$this->object->getType()."_b.gif",$this->lng->txt("obj_".$this->object->getType()));
                $tbl->setHelp("tbl_help.php","icon_help.gif",$this->lng->txt("help"));

                foreach ($this->data["cols"] as $val)
                {
                        $header_names[] = $this->lng->txt($val);
                }

                $tbl->setHeaderNames($header_names);

                //$header_params = array("ref_id" => $this->ref_id);
                $header_params = $this->ctrl->getParameterArray($this, "view");
                $tbl->setHeaderVars($this->data["cols"],$header_params);
                $tbl->setColumnWidth(array("15","75%","25%"));

                // control
                $tbl->setOrderColumn($_GET["sort_by"]);
                $tbl->setOrderDirection($_GET["sort_order"]);
                $tbl->setLimit($_GET["limit"]);
                $tbl->setOffset($_GET["offset"]);
                $tbl->setMaxCount($this->maxcount);

                // footer
                $tbl->setFooter("tblfooter",$this->lng->txt("previous"),$this->lng->txt("next"));
                //$tbl->disable("footer");
                
                // render table
                $tbl->render();

                if (is_array($this->data["data"][0]))
                {
                        //table cell
                        for ($i=0; $i < count($this->data["data"]); $i++)
                        {
                                $data = $this->data["data"][$i];
                                $ctrl = $this->data["ctrl"][$i];

                                // color changing
                                $css_row = ilUtil::switchColor($i+1,"tblrow1","tblrow2");

                                $this->tpl->setCurrentBlock("table_cell");
                                $this->tpl->setVariable("CELLSTYLE", "tblrow1");
                                $this->tpl->parseCurrentBlock();

                                foreach ($data as $key => $val)
                                {
                                        //build link
                                        /*

                                        $n = 0;

                                        foreach ($ctrl as $key2 => $val2)
                                        {
                                                $link .= $key2."=".$val2;

                                                if ($n < count($ctrl)-1)
                                                {
                                                $link .= "&";
                                                        $n++;
                                                }
                                        }

                                        if ($key == "title")
                                        {
                                                $name_field = explode("#separator#",$val);
                                        }

                                        if ($key == "title" || $key == "type")
                                        {
                                                $this->tpl->setCurrentBlock("begin_link");
                                                $this->tpl->setVariable("LINK_TARGET", $link);

                                                $this->tpl->parseCurrentBlock();
                                                $this->tpl->touchBlock("end_link");
                                        }

                                        $this->tpl->setCurrentBlock("text");

                                        if ($key == "type")
                                        {
                                                $val = ilUtil::getImageTagByType($val,$this->tpl->tplPath);                                             
                                        }

                                        if ($key == "title")
                                        {
                                                $this->tpl->setVariable("TEXT_CONTENT", $name_field[0]);
                                                
                                                $this->tpl->setCurrentBlock("subtitle");
                                                $this->tpl->setVariable("DESC", $name_field[1]);
                                                $this->tpl->parseCurrentBlock();
                                        }
                                        else
                                        {
                                                $this->tpl->setVariable("TEXT_CONTENT", $val);
                                        }
                                
                                        $this->tpl->parseCurrentBlock();

                                        $this->tpl->setCurrentBlock("table_cell");
                                        $this->tpl->parseCurrentBlock();
                                        */
                                } //foreach

                                $this->tpl->setCurrentBlock("tbl_content");
                                $this->tpl->setVariable("CSS_ROW", $css_row);
                                $this->tpl->parseCurrentBlock();
                        } //for

                } //if is_array
                else
                {
                        $this->tpl->setCurrentBlock("notfound");
                        $this->tpl->setVariable("TXT_OBJECT_NOT_FOUND", $this->lng->txt("obj_not_found"));
                        $this->tpl->setVariable("NUM_COLS", $num);
                        $this->tpl->parseCurrentBlock();
                }
        }

Here is the call graph for this function:

Here is the caller graph for this function:

& ilObjObjectFolderGUI::executeCommand

(

)

execute command

Reimplemented from ilObjectGUI.

Definition at line 237 of file class.ilObjObjectFolderGUI.php.

References $cmd, $ret, and ilObjectGUI\prepareOutput().

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

                switch($next_class)
                {
                        case 'ilpermissiongui':
                                include_once("./classes/class.ilPermissionGUI.php");
                                $perm_gui =& new ilPermissionGUI($this);
                                $ret =& $this->ctrl->forwardCommand($perm_gui);
                                break;

                        default:
                                if(!$cmd)
                                {
                                        $cmd = "view";
                                }
                                $cmd .= "Object";
                                $this->$cmd();

                                break;
                }
                return true;
        }

Here is the call graph for this function:

ilObjObjectFolderGUI::getTabs

(

&

$tabs_gui

)

get tabs public

Parameters

object

tabs gui object

Reimplemented from ilObjectGUI.

Definition at line 269 of file class.ilObjObjectFolderGUI.php.

        {
                global $rbacsystem;

                if ($rbacsystem->checkAccess('edit_permission',$this->object->getRefId()))
                {
                        $tabs_gui->addTarget("settings",
                                $this->ctrl->getLinkTarget($this, "view"), array("view",""), "", "");

                        $tabs_gui->addTarget("perm_settings",
                                $this->ctrl->getLinkTargetByClass(array(get_class($this),'ilpermissiongui'), "perm"), array("perm","info","owner"), 'ilpermissiongui');
                }
        }

ilObjObjectFolderGUI::ilObjObjectFolderGUI	(		$a_data,
			$a_id,
			$a_call_by_reference
	)

Constructor.

Parameters

array	basic object data
integer	ref_id or obj_id (depends on referenced-flag)
boolean	true: treat id as ref_id; false: treat id as obj_id public

Definition at line 48 of file class.ilObjObjectFolderGUI.php.

References ilObjectGUI\ilObjectGUI().

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

Here is the call graph for this function:

ilObjObjectFolderGUI::viewObject

(

)

list childs of current object

public

Reimplemented from ilObjectGUI.

Definition at line 59 of file class.ilObjObjectFolderGUI.php.

References displayList(), ilDatePresentation\formatDate(), and IL_CAL_DATETIME.

        {
                global $rbacsystem;

                if (!$rbacsystem->checkAccess("visible,read",$this->object->getRefId()))
                {
                        $this->ilias->raiseError($this->lng->txt("permission_denied"),$this->ilias->error_obj->MESSAGE);
                }

                //prepare objectlist
                $this->data = array();
                $this->data["data"] = array();
                $this->data["ctrl"] = array();

                $this->data["cols"] = array("type","title","last_change");

                $this->maxcount = count($this->data["data"]);

                // now compute control information
                foreach ($this->data["data"] as $key => $val)
                {
                        $this->data["ctrl"][$key] = array(
                                                                                        "ref_id"        => $this->id,
                                                                                        "obj_id"        => $val["obj_id"],
                                                                                        "type"          => $val["type"],
                                                                                        );              

                        unset($this->data["data"][$key]["obj_id"]);
                        $this->data["data"][$key]["last_change"] = ilDatePresentation::formatDate(new ilDateTime($this->data["data"][$key]["last_change"],IL_CAL_DATETIME));
                }

                $this->displayList();   
        }

Here is the call graph for this function:

---

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

• Services/Object/classes/class.ilObjObjectFolderGUI.php