ILIAS  release_4-3 Revision
 All Data Structures Namespaces Files Functions Variables Groups Pages
Public Member Functions
ilObjTypeDefinitionGUI Class Reference

Class ilObjTypeDefinitionGUI. More...

+ Inheritance diagram for ilObjTypeDefinitionGUI:
+ Collaboration diagram for ilObjTypeDefinitionGUI:

Public Member Functions

 ilObjTypeDefinitionGUI ($a_data, $a_id, $a_call_by_reference)
 Constructor.
 viewObject ()
 list operations of object type public
 displayList ()
 display object list
 saveObject ()
 save (de-)activation of operations on object
 editObject ()
 display edit form
& 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
 getAdminTabs (&$tabs_gui)
 administration tabs show only permissions and trash folder
 getHTML ()
 confirmedDeleteObject ()
 confirmed deletion of object -> objects are moved to trash or deleted immediately, if trash is disabled
 cancelDeleteObject ()
 cancel deletion of object
 cancelObject ($in_rep=false)
 cancel action and go back to previous page public
 createObject ()
 create new object form
 cancelCreation ()
 cancel create action and go back to repository parent
 updateObject ()
 updates object entry in object_data
 getFormAction ($a_cmd, $a_formaction="")
 get form action for command (command is method name without "Object", e.g.
 isVisible ($a_ref_id, $a_type)
 deleteObject ($a_error=false)
 Display deletion confirmation screen.
 cloneAllObject ()
 Clone single (not container object) Method is overwritten in ilContainerGUI.

Additional Inherited Members

- Static Public Member Functions inherited from ilObjectGUI
static _gotoRepositoryRoot ($a_raise_error=false)
 Goto repository root.
static _gotoRepositoryNode ($a_ref_id, $a_cmd="frameset")
 Goto repository root.
- 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
const CFORM_NEW = 1
const CFORM_IMPORT = 2
const CFORM_CLONE = 3
- Protected Member Functions inherited from ilObjectGUI
 assignObject ()
 prepareOutput ()
 prepare output
 setTitleAndDescription ()
 called by prepare output
 initHeaderAction ($a_sub_type=null, $a_sub_id=null)
 Add header action menu.
 insertHeaderAction ($a_list_gui)
 Insert header action into main template.
 addHeaderAction ()
 Add header action menu.
 redrawHeaderActionObject ()
 Ajax call: redraw action header only.
 setTabs ()
 set admin tabs public
 setAdminTabs ()
 set admin tabs public
 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)
 initCreationForms ($a_new_type)
 Init creation froms.
 getCreationFormsHTML (array $a_forms)
 Get HTML for creation forms (accordion)
 initCreateForm ($a_new_type)
 Init object creation form.
 initDidacticTemplate (ilPropertyFormGUI $form)
 Show didactic template types.
 addDidacticTemplateOptions (array &$a_options)
 Add custom templates.
 getDidacticTemplateVar ($a_type)
 Get didactic template setting from creation screen.
 putObjectInTree (ilObject $a_obj, $a_parent_node_id=null)
 Add object to tree at given position.
 afterSave (ilObject $a_new_object)
 Post (successful) object creation hook.
 initEditForm ()
 Init object edit form.
 initEditCustomForm (ilPropertyFormGUI $a_form)
 Add custom fields to update form.
 getEditFormValues ()
 Get values for edit form.
 getEditFormCustomValues (array &$a_values)
 Add values to custom edit fields.
 updateCustom (ilPropertyFormGUI $a_form)
 Insert custom update form values into object.
 afterUpdate ()
 Post (successful) object update hook.
 initImportForm ($a_new_type)
 Init object import form.
 importFileObject ($parent_id=null)
 Import.
 afterImport (ilObject $a_new_object)
 Post (successful) object import hook.
 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
 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="")
 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.
 getCenterColumnHTML ()
 Get center column.
 getRightColumnHTML ()
 Display right column.
 setColumnSettings ($column_gui)
 May be overwritten in subclasses.
 checkPermission ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
 Check permission and redirect on error.
 checkPermissionBool ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
 Check permission.

Detailed Description

Class ilObjTypeDefinitionGUI.

handles operation assignment to objects (ONLY FOR TESTING PURPOSES!)

Author
Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om $Id
Id:
class.ilObjTypeDefinitionGUI.php,v 1.14 2005/11/21 17:12:08 shofmann Exp

Definition at line 18 of file class.ilObjTypeDefinitionGUI.php.

Member Function Documentation

ilObjTypeDefinitionGUI::displayList ( )

display object list

public

Definition at line 97 of file class.ilObjTypeDefinitionGUI.php.

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

Referenced by viewObject().

{
include_once "./Services/Table/classes/class.ilTableGUI.php";
// 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", "adm_object.php?ref_id=".$this->ref_id."$obj_str&cmd=gateway");
// create table
$tbl = new ilTableGUI();
// title & header columns
$tbl->setTitle($this->lng->txt("obj_".$this->object->getType())." '".$this->object->getTitle()."'","icon_".$this->object->getType()."_b.png",$this->lng->txt("obj_".$this->object->getType()));
$tbl->setHelp("tbl_help.php","icon_help.png",$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,"obj_id" => $this->id);
$tbl->setHeaderVars($this->data["cols"],$header_params);
// control
$tbl->setOrderColumn($_GET["sort_by"]);
$tbl->setOrderDirection($_GET["sort_order"]);
$tbl->setLimit(0);
$tbl->setOffset(0);
$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)
{
// color for status
if ($key == "status")
{
if ($val == "enabled")
{
$color = "green";
}
else
{
$color = "red";
}
$val = "<font color=\"".$color."\">".$this->lng->txt($val)."</font>";
}
$this->tpl->setCurrentBlock("text");
if ($key == "type")
{
$val = ilUtil::getImageTagByType($val,$this->tpl->tplPath);
}
$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
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilObjTypeDefinitionGUI::editObject ( )

display edit form

public

Reimplemented from ilObjectGUI.

Definition at line 245 of file class.ilObjTypeDefinitionGUI.php.

References $_GET, ilObjectGUI\$data, ilRbacReview\_getOperationList(), ilUtil\formSelect(), ilUtil\getImagePath(), ilUtil\getImageTagByType(), ilUtil\sortArray(), and ilUtil\switchColor().

{
global $rbacsystem, $rbacreview;
if (!$rbacsystem->checkAccess("edit_permission",$_GET["ref_id"]))
{
$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", "operation", "description", "status");
$ops_valid = $rbacreview->getOperationsOnType($this->obj_id);
if ($ops_arr = ilRbacReview::_getOperationList('', $a_order, $a_direction))
{
$options = array("e" => "enabled","d" => "disabled");
foreach ($ops_arr as $key => $ops)
{
// BEGIN ROW
if (in_array($ops["ops_id"],$ops_valid))
{
$ops_status = 'e';
}
else
{
$ops_status = 'd';
}
$obj = $ops["ops_id"];
$ops_options = ilUtil::formSelect($ops_status,"id[$obj]",$options);
//visible data part
$this->data["data"][] = array(
"type" => "perm",
"operation" => $ops["operation"],
"description" => $ops["desc"],
"status" => $ops_status,
"status_html" => $ops_options,
"obj_id" => $val["ops_id"]
);
}
} //if typedata
$this->maxcount = count($this->data["data"]);
// sorting array
$this->data["data"] = ilUtil::sortArray($this->data["data"],$_GET["sort_by"],$_GET["sort_order"]);
// now compute control information
foreach ($this->data["data"] as $key => $val)
{
$this->data["ctrl"][$key] = array(
"obj_id" => $val["obj_id"],
"type" => $val["type"]
);
unset($this->data["data"][$key]["obj_id"]);
$this->data["data"][$key]["status"] = $this->data["data"][$key]["status_html"];
unset($this->data["data"][$key]["status_html"]);
}
// build table
include_once "./Services/Table/classes/class.ilTableGUI.php";
// 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", "adm_object.php?ref_id=".$this->ref_id."$obj_str&cmd=save");
// create table
$tbl = new ilTableGUI();
// title & header columns
$tbl->setTitle($this->lng->txt("edit_operations")." ".strtolower($this->lng->txt("of"))." '".$this->object->getTitle()."'","icon_".$this->object->getType()."_b.png",$this->lng->txt("obj_".$this->object->getType()));
$tbl->setHelp("tbl_help.php","icon_help.png",$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,"obj_id" => $this->id,"cmd" => "edit");
$tbl->setHeaderVars($this->data["cols"],$header_params);
// control
$tbl->setOrderColumn($_GET["sort_by"]);
$tbl->setOrderDirection($_GET["sort_order"]);
$tbl->setLimit(0);
$tbl->setOffset(0);
$tbl->setMaxCount($this->maxcount);
// SHOW VALID ACTIONS
$this->tpl->setVariable("IMG_ARROW", ilUtil::getImagePath("arrow_downright.png"));
$this->tpl->setVariable("COLUMN_COUNTS",count($this->data["cols"]));
// 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)
{
$this->tpl->setCurrentBlock("text");
if ($key == "type")
{
$val = ilUtil::getImageTagByType($val,$this->tpl->tplPath);
}
$this->tpl->setVariable("TEXT_CONTENT", $val);
$this->tpl->parseCurrentBlock();
$this->tpl->setCurrentBlock("table_cell");
$this->tpl->parseCurrentBlock();
} //foreach
$this->tpl->setVariable("BTN_VALUE", $this->lng->txt("save"));
$this->tpl->setCurrentBlock("tbl_content");
$this->tpl->setVariable("CSS_ROW", $css_row);
$this->tpl->parseCurrentBlock();
} //for
} //if is_array
}

+ Here is the call graph for this function:

& ilObjTypeDefinitionGUI::executeCommand ( )

execute command

Reimplemented from ilObjectGUI.

Definition at line 400 of file class.ilObjTypeDefinitionGUI.php.

References $cmd.

{
$next_class = $this->ctrl->getNextClass($this);
$cmd = $this->ctrl->getCmd();
switch($next_class)
{
default:
if(!$cmd)
{
$cmd = "view";
}
$cmd .= "Object";
$this->$cmd();
break;
}
return true;
}
ilObjTypeDefinitionGUI::getTabs ( &  $tabs_gui)

get tabs public

Parameters
objecttabs gui object

Reimplemented from ilObjectGUI.

Definition at line 425 of file class.ilObjTypeDefinitionGUI.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("edit_operations",
$this->ctrl->getLinkTarget($this, "edit"), "edit", "", "");
}
}
ilObjTypeDefinitionGUI::ilObjTypeDefinitionGUI (   $a_data,
  $a_id,
  $a_call_by_reference 
)

Constructor.

public

Definition at line 25 of file class.ilObjTypeDefinitionGUI.php.

References ilObjectGUI\ilObjectGUI().

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

+ Here is the call graph for this function:

ilObjTypeDefinitionGUI::saveObject ( )

save (de-)activation of operations on object

public

Reimplemented from ilObjectGUI.

Definition at line 201 of file class.ilObjTypeDefinitionGUI.php.

References $_GET, $_POST, exit, and ilUtil\sendSuccess().

{
global $rbacsystem, $rbacadmin, $rbacreview;
if (!$rbacsystem->checkAccess('edit_permission', $_GET["ref_id"]))
{
$this->ilias->raiseError($this->lng->txt("permission_denied"),$this->ilias->error_obj->WARNING);
}
$ops_valid = $rbacreview->getOperationsOnType($_GET["obj_id"]);
foreach ($_POST["id"] as $ops_id => $status)
{
if ($status == 'enabled')
{
if (!in_array($ops_id,$ops_valid))
{
$rbacadmin->assignOperationToObject($_GET["obj_id"],$ops_id);
}
}
if ($status == 'disabled')
{
if (in_array($ops_id,$ops_valid))
{
$rbacadmin->deassignOperationFromObject($_GET["obj_id"],$ops_id);
}
}
}
$this->update = $this->object->update();
ilUtil::sendSuccess($this->lng->txt("saved_successfully"),true);
header("Location: adm_object.php?ref_id=".$_GET["ref_id"]."&obj_id=".$_GET["obj_id"]);
exit();
}

+ Here is the call graph for this function:

ilObjTypeDefinitionGUI::viewObject ( )

list operations of object type public

Reimplemented from ilObjectGUI.

Definition at line 35 of file class.ilObjTypeDefinitionGUI.php.

References $_GET, ilRbacReview\_getOperationList(), displayList(), and ilUtil\sortArray().

{
global $rbacadmin, $rbacreview;
//prepare objectlist
$this->data = array();
$this->data["data"] = array();
$this->data["ctrl"] = array();
$this->data["cols"] = array("type", "operation", "description", "status");
$ops_valid = $rbacreview->getOperationsOnType($_GET["obj_id"]);
if ($list = ilRbacReview::_getOperationList("",$_GET["order"], $_GET["direction"]))
{
foreach ($list as $key => $val)
{
if (in_array($val["ops_id"],$ops_valid))
{
$ops_status = 'enabled';
}
else
{
$ops_status = 'disabled';
}
//visible data part
$this->data["data"][] = array(
"type" => "perm",
"operation" => $val["operation"],
"description" => $val["desc"],
"status" => $ops_status,
"obj_id" => $val["ops_id"]
);
}
} //if typedata
$this->maxcount = count($this->data["data"]);
// sorting array
$this->data["data"] = ilUtil::sortArray($this->data["data"],$_GET["sort_by"],$_GET["sort_order"]);
// now compute control information
foreach ($this->data["data"] as $key => $val)
{
$this->data["ctrl"][$key] = array(
"obj_id" => $val["obj_id"],
"type" => $val["type"]
);
unset($this->data["data"][$key]["obj_id"]);
}
$this->displayList();
}

+ Here is the call graph for this function:

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