Inheritance diagram for ilObjTypeDefinitionGUI:

Collaboration diagram for ilObjTypeDefinitionGUI:

Public Member Functions
	__construct ($a_data, $a_id, $a_call_by_reference)
	Constructor. More...

	viewObject ()
	list operations of object type public More...

	displayList ()
	display object list More...

	saveObject ()
	save (de-)activation of operations on object More...

	editObject ()
	display edit form More...

	executeCommand ()

	getTabs ()
	get tabs public More...

Public Member Functions inherited from ilObjectGUI
	executeCommand ()
	execute command More...

	withReferences ()
	determines wether objects are referenced or not (got ref ids or not) More...

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

	getCreationMode ()
	get creation mode More...

	prepareOutput ($a_show_subobjects=true)
	prepare output More...

	getAdminTabs ()
	administration tabs show only permissions and trash folder More...

	getHTML ()

	confirmedDeleteObject ()
	confirmed deletion of object -> objects are moved to trash or deleted immediately, if trash is disabled More...

	cancelDeleteObject ()
	cancel deletion of object More...

	cancelObject ()
	cancel action and go back to previous page public More...

	createObject ()
	create new object form More...

	cancelCreation ()
	cancel create action and go back to repository parent More...

	saveObject ()
	save object More...

	getDidacticTemplateVar ($a_type)
	Get didactic template setting from creation screen. More...

	putObjectInTree (ilObject $a_obj, $a_parent_node_id=null)
	Add object to tree at given position. More...

	editObject ()
	edit object More...

	addExternalEditFormCustom (ilPropertyFormGUI $a_form)

	updateObject ()
	updates object entry in object_data More...

	getFormAction ($a_cmd, $a_formaction="")
	get form action for command (command is method name without "Object", e.g. More...

	isVisible ($a_ref_id, $a_type)

	viewObject ()
	list childs of current object More...

	deleteObject ($a_error=false)
	Display deletion confirmation screen. More...

	cloneAllObject ()
	Clone single (not container object) Method is overwritten in ilContainerGUI. More...

	redirectAfterCreation ()
	Redirect after creation, see https://docu.ilias.de/goto_docu_wiki_wpage_5035_1357.html. More...

Protected Attributes
	$rbacadmin

	$rbacsystem

	$error

Protected Attributes inherited from ilObjectGUI
	$ilErr

	$locator

	$user

	$access

	$settings

	$rbacreview

	$toolbar

	$tmp_import_dir

	$tabs_gui = null

	$ctrl

	$object_service

Additional Inherited Members
Static Public Member Functions inherited from ilObjectGUI
static	_gotoRepositoryRoot ($a_raise_error=false)
	Goto repository root. More...

static	_gotoRepositoryNode ($a_ref_id, $a_cmd="frameset")
	Goto repository root. More...

Data Fields inherited from ilObjectGUI
const	COPY_WIZARD_NEEDS_PAGE = 1

	$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
	getObjectService ()
	Get object service. More...

	assignObject ()

	setTitleAndDescription ()
	called by prepare output More...

	initHeaderAction ($a_sub_type=null, $a_sub_id=null)
	Add header action menu. More...

	insertHeaderAction ($a_list_gui)
	Insert header action into main template. More...

	addHeaderAction ()
	Add header action menu. More...

	redrawHeaderActionObject ()
	Ajax call: redraw action header only. More...

	showMountWebfolderIcon ()

	setTabs ()
	set admin tabs public More...

	setAdminTabs ()
	set admin tabs public More...

	setLocator ()
	set Locator More...

	addLocatorItems ()
	should be overwritten to add object specific items (repository items are preloaded) More...

	omitLocator ($a_omit=true)

	addAdminLocatorItems ($a_do_not_add_object=false)
	should be overwritten to add object specific items (repository items are preloaded) More...

	initCreationForms ($a_new_type)
	Init creation froms. More...

	getCreationFormsHTML (array $a_forms)
	Get HTML for creation forms (accordion) More...

	initCreateForm ($a_new_type)
	Init object creation form. More...

	initDidacticTemplate (ilPropertyFormGUI $form)
	Show didactic template types. More...

	addDidacticTemplateOptions (array &$a_options)
	Add custom templates. More...

	afterSave (ilObject $a_new_object)
	Post (successful) object creation hook. More...

	initEditForm ()
	Init object edit form. More...

	initEditCustomForm (ilPropertyFormGUI $a_form)
	Add custom fields to update form. More...

	getEditFormValues ()
	Get values for edit form. More...

	getEditFormCustomValues (array &$a_values)
	Add values to custom edit fields. More...

	validateCustom (ilPropertyFormGUI $a_form)
	Validate custom values (if not possible with checkInput()) More...

	updateCustom (ilPropertyFormGUI $a_form)
	Insert custom update form values into object. More...

	afterUpdate ()
	Post (successful) object update hook. More...

	initImportForm ($a_new_type)
	Init object import form. More...

	importFileObject ($parent_id=null, $a_catch_errors=true)
	Import. More...

	afterImport (ilObject $a_new_object)
	Post (successful) object import hook. More...

	setFormAction ($a_cmd, $a_formaction)
	set specific form action for command More...

	getReturnLocation ($a_cmd, $a_location="")
	get return location for command (command is method name without "Object", e.g. More...

	setReturnLocation ($a_cmd, $a_location)
	set specific return location for command More...

	getTargetFrame ($a_cmd, $a_target_frame="")
	get target frame for command (command is method name without "Object", e.g. More...

	setTargetFrame ($a_cmd, $a_target_frame)
	set specific target frame for command More...

	showPossibleSubObjects ()
	show possible subobjects (pulldown menu) More...

	getTemplateFile ($a_cmd, $a_type="")
	get a template blockfile format: tpl. More...

	getTabs ()
	get tabs abstract method. More...

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

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

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

	getCenterColumnHTML ()
	Get center column. More...

	getRightColumnHTML ()
	Display right column. More...

	setColumnSettings (ilColumnGUI $column_gui)
	May be overwritten in subclasses. More...

	checkPermission ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
	Check permission and redirect on error. More...

	checkPermissionBool ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
	Check permission. More...

	enableDragDropFileUpload ()
	Enables the file upload into this object by dropping files. More...

	handleAutoRating (ilObject $a_new_obj)
	Activate rating automatically if parent container setting. More...

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.

Constructor & Destructor Documentation

◆ __construct()

ilObjTypeDefinitionGUI::__construct	(	$a_data,
		$a_id,
		$a_call_by_reference
	)

Constructor.

public

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

References $DIC.

     {
         global $DIC;
 
         $this->rbacadmin = $DIC->rbac()->admin();
         $this->rbacreview = $DIC->rbac()->review();
         $this->rbacsystem = $DIC->rbac()->system();
         $this->error = $DIC["ilErr"];
         $this->type = "typ";
         parent::__construct($a_data, $a_id, $a_call_by_reference);
     }

Member Function Documentation

◆ displayList()

ilObjTypeDefinitionGUI::displayList ( )

display object list

public

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

References $_GET, ilObjectGUI\$ctrl, ilObjectGUI\$data, $i, $key, $tbl, 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() . "'");
 
         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:

◆ editObject()

ilObjTypeDefinitionGUI::editObject ( )

display edit form

public

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

References $_GET, ilObjectGUI\$ctrl, ilObjectGUI\$data, $error, $i, ilObjectGUI\$ilErr, $key, PHPMailer\PHPMailer\$options, ilObjectGUI\$rbacreview, $rbacsystem, $tbl, ilRbacReview\_getOperationList(), data, ilUtil\formSelect(), ilUtil\getImagePath(), ilUtil\getImageTagByType(), ilUtil\sortArray(), and ilUtil\switchColor().

     {
         $rbacsystem = $this->rbacsystem;
         $rbacreview = $this->rbacreview;
         $ilErr = $this->error;
         
         if (!$rbacsystem->checkAccess("edit_permission", $_GET["ref_id"])) {
             $ilErr->raiseError($this->lng->txt("permission_denied"), $ilErr->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() . "'");
 
         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.svg"));
         $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:

◆ executeCommand()

ilObjTypeDefinitionGUI::executeCommand ( )

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

     {
         $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;
     }

◆ getTabs()

ilObjTypeDefinitionGUI::getTabs ( )

get tabs public

Parameters

object tabs gui object

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

References $rbacsystem.

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

◆ saveObject()

ilObjTypeDefinitionGUI::saveObject ( )

save (de-)activation of operations on object

public

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

References $_GET, $_POST, $error, ilObjectGUI\$ilErr, $rbacadmin, ilObjectGUI\$rbacreview, $rbacsystem, exit, and League\Flysystem\Adapter\Polyfill\update().

     {
         $rbacsystem = $this->rbacsystem;
         $rbacadmin = $this->rbacadmin;
         $rbacreview = $this->rbacreview;
         $ilErr = $this->error;
 
         if (!$rbacsystem->checkAccess('edit_permission', $_GET["ref_id"])) {
             $ilErr->raiseError($this->lng->txt("permission_denied"), $ilErr->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:

◆ viewObject()

ilObjTypeDefinitionGUI::viewObject ( )

list operations of object type public

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

References $_GET, $key, $list, $rbacadmin, ilObjectGUI\$rbacreview, ilRbacReview\_getOperationList(), data, displayList(), and ilUtil\sortArray().

     {
         $rbacadmin = $this->rbacadmin;
         $rbacreview = $this->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();
     }