Table for object role permissions. More...

Inheritance diagram for ilObjectOwnershipManagementTableGUI:

Collaboration diagram for ilObjectOwnershipManagementTableGUI:

Public Member Functions
	__construct (?object $parent_obj, string $parent_cmd, int $user_id, array $data=null)

Public Member Functions inherited from ilTable2GUI
	__construct (?object $a_parent_obj, string $a_parent_cmd="", string $a_template_context="")

	setOpenFormTag (bool $a_val)

	getOpenFormTag ()

	setCloseFormTag (bool $a_val)

	getCloseFormTag ()

	determineLimit ()

	getSelectableColumns ()
	Get selectable columns. More...

	determineSelectedColumns ()

	isColumnSelected (string $col)

	getSelectedColumns ()

	resetOffset (bool $a_in_determination=false)

	initFilter ()

	getParentObject ()

	getParentCmd ()

	setTopAnchor (string $a_val)

	getTopAnchor ()

	setNoEntriesText (string $a_text)

	getNoEntriesText ()

	setIsDataTable (bool $a_val)

	getIsDataTable ()

	setEnableTitle (bool $a_enabletitle)

	getEnableTitle ()

	setEnableHeader (bool $a_enableheader)

	getEnableHeader ()

	setEnableNumInfo (bool $a_val)

	getEnableNumInfo ()

	setTitle (string $a_title, string $a_icon="", string $a_icon_alt="")

	setDescription (string $a_val)

	getDescription ()

	setOrderField (string $a_order_field)

	getOrderField ()

	setData (array $a_data)
	Set table data. More...

	getData ()

	dataExists ()

	setPrefix (string $a_prefix)
	set prefix for sort and offset fields (if you have two or more tables on a page that you want to sort separately) More...

	getPrefix ()

	addFilterItem (ilTableFilterItem $a_input_item, bool $a_optional=false)

	addFilterItemByMetaType (string $id, int $type=self::FILTER_TEXT, bool $a_optional=false, string $caption="")
	Add filter by standard type. More...

	getFilterItems (bool $a_optionals=false)

	getFilterItemByPostVar (string $a_post_var)

	setFilterCols (int $a_val)

	getFilterCols ()

	setDisableFilterHiding (bool $a_val=true)

	getDisableFilterHiding ()

	isFilterSelected (string $a_col)
	Is given filter selected? More...

	getSelectedFilters ()

	determineSelectedFilters ()

	setCustomPreviousNext (string $a_prev_link, string $a_next_link)

	setFormAction (string $a_form_action, bool $a_multipart=false)

	getFormAction ()

	setFormName (string $a_name="")

	getFormName ()
	get the name of the parent form More...

	setId (string $a_val)

	getId ()

	setDisplayAsBlock (bool $a_val)

	getDisplayAsBlock ()

	setSelectAllCheckbox (string $a_select_all_checkbox, bool $a_select_all_on_top=false)

	setExternalSorting (bool $a_val)

	getExternalSorting ()

	setFilterCommand (string $a_val, string $a_caption="")

	getFilterCommand ()

	setResetCommand (string $a_val, string $a_caption="")

	getResetCommand ()

	setExternalSegmentation (bool $a_val)

	getExternalSegmentation ()

	setRowTemplate (string $a_template, string $a_template_dir="")
	Set row template. More...

	setDefaultOrderField (string $a_defaultorderfield)

	getDefaultOrderField ()

	setDefaultOrderDirection (string $a_defaultorderdirection)

	getDefaultOrderDirection ()

	setDefaultFilterVisiblity (bool $a_status)

	getDefaultFilterVisibility ()

	clearCommandButtons ()

	addCommandButton (string $a_cmd, string $a_text, string $a_onclick='', string $a_id="", string $a_class="")

	addCommandButtonInstance (ilButtonBase $a_button)

	addMultiItemSelectionButton (string $a_sel_var, array $a_options, string $a_cmd, string $a_text, string $a_default_selection='')

	setCloseCommand (string $a_link)

	addMultiCommand (string $a_cmd, string $a_text)

	addHiddenInput (string $a_name, string $a_value)

	addHeaderCommand (string $a_href, string $a_text, string $a_target="", string $a_img="")

	setTopCommands (bool $a_val)

	getTopCommands ()

	addColumn (string $a_text, string $a_sort_field="", string $a_width="", bool $a_is_checkbox_action_column=false, string $a_class="", string $a_tooltip="", bool $a_tooltip_with_html=false)

	getNavParameter ()

	setOrderLink (string $key, string $order_dir)

	fillHeader ()

	determineOffsetAndOrder (bool $a_omit_offset=false)

	storeNavParameter ()

	getHTML ()
	Get HTML. More...

	numericOrdering (string $a_field)
	Should this field be sorted numeric? More...

	render ()

	writeFilterToSession ()

	resetFilter ()

	fillFooter ()

	getLinkbar (string $a_num)

	fillHiddenRow ()

	fillActionRow ()

	setHeaderHTML (string $html)

	storeProperty (string $type, string $value)

	loadProperty (string $type)

	getCurrentState ()
	get current settings for order, limit, columns and filter More...

	setContext (string $id)

	getContext ()

	setShowRowsSelector (bool $a_value)
	Toggle rows-per-page selector. More...

	getShowRowsSelector ()

	setShowTemplates (bool $a_value)

	getShowTemplates ()

	restoreTemplate (string $a_name)
	Restore state from template. More...

	saveTemplate (string $a_name)
	Save current state as template. More...

	deleteTemplate (string $a_name)

	getLimit ()

	getOffset ()

	setExportFormats (array $formats)
	Set available export formats. More...

	setPrintMode (bool $a_value=false)

	getPrintMode ()

	getExportMode ()

	exportData (int $format, bool $send=false)
	Export and optionally send current table data. More...

	setEnableAllCommand (bool $a_value)

	setRowSelectorLabel (string $row_selector_label)

	getRowSelectorLabel ()

	setPreventDoubleSubmission (bool $a_val)

	getPreventDoubleSubmission ()

	setLimit (int $a_limit=0, int $a_default_limit=0)
	set max. More...

Public Member Functions inherited from ilTableGUI
	__construct (array $a_data=[], bool $a_global_tpl=true)

	setTemplate (ilTemplate $a_tpl)

	getTemplateObject ()

	setData (array $a_data)
	Set table data. More...

	getData ()

	setTitle (string $a_title, string $a_icon="", string $a_icon_alt="")

	setHelp (string $a_help_page, string $a_help_icon, string $a_help_icon_alt="")

	setHeaderNames (array $a_header_names)

	getColumnCount ()

	setHeaderVars (array $a_header_vars, array $a_header_params=[])

	setColumnWidth (array $a_column_width)
	set table column widths More...

	setOneColumnWidth (string $a_column_width, int $a_column_number)

	setMaxCount (int $a_max_count)
	set max. More...

	setLimit (int $a_limit=0, int $a_default_limit=0)
	set max. More...

	getLimit ()

	setPrefix (string $a_prefix)
	set prefix for sort and offset fields (if you have two or more tables on a page that you want to sort separately) More...

	setOffset (int $a_offset)
	set dataset offset More...

	getOffset ()

	setOrderColumn (string $a_order_column="", string $a_default_column="")

	getOrderColumn ()

	setOrderDirection (string $a_order_direction)

	getOrderDirection ()

	setFooter (string $a_style, string $a_previous="", string $a_next="")

	enable (string $a_module_name)

	disable (string $a_module_name)

	sortData ()

	render ()

	renderHeader ()

	setOrderLink (string $key, string $order_dir)

	setStyle (string $a_element, string $a_style)

	getStyle (string $a_element)

	setBase (string $a_base)

	getBase ()

	getFormName ()
	get the name of the parent form More...

	setFormName (string $a_name="cmd")

	getSelectAllCheckbox ()
	get the name of the checkbox that should be toggled with a select all button More...

	setSelectAllCheckbox (string $a_select_all_checkbox)

	clearActionButtons ()

	addActionButton (string $btn_name, string $btn_value)

Protected Member Functions
	initItems (?array $data)

	fillRow (array $set)
	Standard Version of Fill Row. More...

	buildActions (int $ref_id, string $type)

	buildPath (int $ref_id)

	isParentReadOnly ()

Protected Member Functions inherited from ilTable2GUI
	getRequestedValues ()

	prepareOutput ()
	Anything that must be done before HTML is generated. More...

	isFilterVisible ()
	Check if filter is visible: manually shown (session, db) or default value set. More...

	isAdvMDFilter (ilAdvancedMDRecordGUI $a_gui, ilTableFilterItem $a_element)
	Check if filter element is based on adv md. More...

	fillRow (array $a_set)
	Standard Version of Fill Row. More...

	getFilterValue (ilTableFilterItem $a_item)
	Get current filter value. More...

	setFilterValue (ilTableFilterItem $a_item, $a_value)

	fillMetaExcel (ilExcel $a_excel, int &$a_row)
	Add meta information to excel export. More...

	fillHeaderExcel (ilExcel $a_excel, int &$a_row)
	Excel Version of Fill Header. More...

	fillRowExcel (ilExcel $a_excel, int &$a_row, array $a_set)
	Excel Version of Fill Row. More...

	fillMetaCSV (ilCSVWriter $a_csv)
	Add meta information to csv export. More...

	fillHeaderCSV (ilCSVWriter $a_csv)
	CSV Version of Fill Header. More...

	fillRowCSV (ilCSVWriter $a_csv, array $a_set)
	CSV Version of Fill Row. More...

Protected Attributes
ilAccessHandler	$access

ilTree	$tree

ilObjectDefinition	$obj_definition

ILIAS UI Factory	$factory

ILIAS UI Renderer	$renderer

int	$user_id

Protected Attributes inherited from ilTable2GUI
string	$requested_tmpl_delete

string	$requested_tmpl_create

string	$requested_nav_par2 = ""

string	$requested_nav_par = ""

string	$requested_nav_par1 = ""

ILIAS Table TableGUIRequest	$table_request = null

array	$selected_columns = []

ilCtrl	$ctrl

object	$parent_obj = null

string	$parent_cmd = ""

string	$close_command = ""

string	$top_anchor = "il_table_top"

array	$filters = array()

array	$optional_filters = array()

string	$filter_cmd = 'applyFilter'

string	$reset_cmd = 'resetFilter'

int	$filter_cols = 5

bool	$ext_sort = false

bool	$ext_seg = false

string	$context = ""

array	$mi_sel_buttons = []

bool	$disable_filter_hiding = false

bool	$top_commands = true

array	$selectable_columns = array()

array	$selected_column = array()

bool	$show_templates = false

bool	$show_rows_selector = true

bool	$rows_selector_off = false

bool	$nav_determined = false

bool	$limit_determined = false

bool	$filters_determined = false

bool	$columns_determined = false

bool	$open_form_tag = true

bool	$close_form_tag = true

array	$export_formats = []

int	$export_mode = 0

bool	$print_mode = false

bool	$enable_command_for_all = false

bool	$restore_filter = false

array	$restore_filter_values = []

bool	$default_filter_visibility = false

array	$sortable_fields = array()

bool	$prevent_double_submission = true

string	$row_selector_label = ""

bool	$select_all_on_top = false

array	$sel_buttons = []

string	$nav_value = ''

string	$noentriestext = ''

string	$css_row = ''

bool	$display_as_block = false

string	$description = ''

string	$id = ""

bool	$custom_prev_next = false

string	$reset_cmd_txt = ""

string	$defaultorderfield = ""

string	$defaultorderdirection = ""

array	$column = []

bool	$datatable = false

bool	$num_info = false

bool	$form_multipart = false

array	$row_data = []

string	$order_field = ""

array	$selected_filter = []

string	$form_action = ""

string	$formname = ""

string	$sort_order = ""

array	$buttons = []

array	$multi = []

array	$hidden_inputs = []

array	$header_commands = []

string	$row_template = ""

string	$row_template_dir = ""

string	$filter_cmd_txt = ""

string	$custom_prev = ""

string	$custom_next = ""

array	$raw_post_data = null

ilGlobalTemplateInterface	$main_tpl

Protected Attributes inherited from ilTableGUI
string	$sort_order

string	$link_params

array	$header_params

	$tpl

ilLanguage	$lng

Additional Inherited Members
Static Public Member Functions inherited from ilTable2GUI
static	getAllCommandLimit ()

Static Public Member Functions inherited from ilTableGUI
static	linkbar (string $AScript, int $AHits, int $ALimit, int $AOffset, array $AParams=array(), array $ALayout=array(), string $prefix='')

Data Fields inherited from ilTable2GUI
const	FILTER_TEXT = 1

const	FILTER_SELECT = 2

const	FILTER_DATE = 3

const	FILTER_LANGUAGE = 4

const	FILTER_NUMBER_RANGE = 5

const	FILTER_DATE_RANGE = 6

const	FILTER_DURATION_RANGE = 7

const	FILTER_DATETIME_RANGE = 8

const	FILTER_CHECKBOX = 9

const	EXPORT_EXCEL = 1

const	EXPORT_CSV = 2

const	ACTION_ALL_LIMIT = 1000

Data Fields inherited from ilTableGUI
string	$title = ""

string	$icon = ""

string	$icon_alt = ""

string	$help_page = ""

string	$help_icon = ""

string	$help_icon_alt = ""

array	$header_names = []

array	$header_vars = []

array	$linkbar_vars = []

array	$data = []

int	$column_count = 0

array	$column_width = []

int	$max_count = 0

int	$limit = 0

bool	$max_limit = false

int	$offset = 0

string	$order_column = ""

string	$order_direction = ""

string	$footer_style = ""

string	$footer_previous = ""

string	$footer_next = ""

bool	$lang_support = true

bool	$global_tpl = false

string	$form_name = ""

string	$select_all_checkbox = ""

array	$action_buttons = []

string	$prefix = ""

string	$base = ""

array	$enabled

array	$styles

Detailed Description

Table for object role permissions.

Author: Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Definition at line 28 of file class.ilObjectOwnershipManagementTableGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilObjectOwnershipManagementTableGUI::__construct	(	?object	$parent_obj,
		string	$parent_cmd,
		int	$user_id,
		array	$data = `null`
	)

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

    {
        global $DIC;
 
        $this->ctrl = $DIC->ctrl();
        $this->lng = $DIC->language();
        $this->access = $DIC->access();
        $this->tree = $DIC->repositoryTree();
        $this->obj_definition = $DIC["objDefinition"];
        $this->renderer = $DIC->ui()->renderer();
        $this->factory = $DIC->ui()->factory();
 
        $this->user_id = $user_id;
        $this->setId('objownmgmt'); // #16373
 
        parent::__construct($parent_obj, $parent_cmd);
 
        $this->addColumn($this->lng->txt("title"), "title");
        $this->addColumn($this->lng->txt("path"), "path");
        $this->addColumn($this->lng->txt("action"));
 
        $this->setFormAction($this->ctrl->getFormAction($parent_obj, $parent_cmd));
        $this->setRowTemplate("tpl.obj_ownership_row.html", "Services/Object");
        $this->setDisableFilterHiding();
 
        $this->setDefaultOrderField("title");
        $this->setDefaultOrderDirection("asc");
 
        $this->initItems($data);
    }

References ilTableGUI\$data, $DIC, ilTable2GUI\$parent_cmd, $user_id, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\access(), ilTable2GUI\addColumn(), ILIAS\Repository\ctrl(), initItems(), ILIAS\Repository\lng(), ilTable2GUI\setDefaultOrderDirection(), ilTable2GUI\setDefaultOrderField(), ilTable2GUI\setDisableFilterHiding(), ilTable2GUI\setFormAction(), ilTable2GUI\setId(), and ilTable2GUI\setRowTemplate().

Here is the call graph for this function:

Member Function Documentation

◆ buildActions()

ilObjectOwnershipManagementTableGUI::buildActions	(	int	$ref_id,
		string	$type
	)

protected

Definition at line 130 of file class.ilObjectOwnershipManagementTableGUI.php.

                                                              : string
    {
        $agui = new ilAdvancedSelectionListGUI();
        $agui->setId($this->id . "-" . $ref_id);
        $agui->setListTitle($this->lng->txt("actions"));
 
        $this->ctrl->setParameter($this->parent_obj, "ownid", $ref_id);
 
        $agui->addItem(
            $this->lng->txt("show"),
            "",
            ilLink::_getLink($ref_id, $type),
            "",
            "",
            "_blank"
        );
 
        $agui->addItem(
            $this->lng->txt("move"),
            "",
            $this->ctrl->getLinkTarget($this->parent_obj, "move")
        );
 
        $agui->addItem(
            $this->lng->txt("change_owner"),
            "",
            $this->ctrl->getLinkTarget($this->parent_obj, "changeOwner")
        );
 
        if (!in_array($type, array("crsr", "catr", "grpr")) && $this->obj_definition->allowExport($type)) {
            $agui->addItem(
                $this->lng->txt("export"),
                "",
                $this->ctrl->getLinkTarget($this->parent_obj, "export")
            );
        }
 
        $agui->addItem(
            $this->lng->txt("delete"),
            "",
            $this->ctrl->getLinkTarget($this->parent_obj, "delete")
        );
 
        $this->ctrl->setParameter($this->parent_obj, "ownid", "");
 
        return $agui->getHTML();
    }

References $ref_id, $type, ilLink\_getLink(), ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Referenced by fillRow().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildPath()

ilObjectOwnershipManagementTableGUI::buildPath ( int $ref_id )

protected

Definition at line 178 of file class.ilObjectOwnershipManagementTableGUI.php.

                                             : string
    {
        $path = "...";
        $counter = 0;
        $path_full = $this->tree->getPathFull($ref_id);
        foreach ($path_full as $data) {
            if (++$counter < (count($path_full) - 2)) {
                continue;
            }
            if ($ref_id != $data['ref_id']) {
                $path .= " &raquo; " . $data['title'];
            }
        }
 
        return $path;
    }

References ilTableGUI\$data, $path, and $ref_id.

Referenced by initItems().

Here is the caller graph for this function:

◆ fillRow()

ilObjectOwnershipManagementTableGUI::fillRow ( array $a_set )

protected

Standard Version of Fill Row.

Most likely to be overwritten by derived class.

Parameters

array $a_set data array

Reimplemented from ilTable2GUI.

Definition at line 115 of file class.ilObjectOwnershipManagementTableGUI.php.

                                          : void
    {
        $icon = $this->factory->symbol()->icon()->standard($set["type"], $set["title"], Standard::MEDIUM);
        $this->tpl->setVariable("ICON", $this->renderer->render($icon));
 
        $this->tpl->setVariable("TITLE", strip_tags($set["title"], ilObjectGUI::ALLOWED_TAGS_IN_TITLE_AND_DESCRIPTION));
        $this->tpl->setVariable("PATH", $set["path"]);
 
        if ($set["readable"] && !$this->isParentReadOnly()) {
            $this->tpl->setCurrentBlock("actions");
            $this->tpl->setVariable("ACTIONS", $this->buildActions($set["ref_id"], $set["type"]));
            $this->tpl->parseCurrentBlock();
        }
    }

References ilTableGUI\$icon, ilObjectGUI\ALLOWED_TAGS_IN_TITLE_AND_DESCRIPTION, buildActions(), and isParentReadOnly().

Here is the call graph for this function:

◆ initItems()

ilObjectOwnershipManagementTableGUI::initItems ( ?array $data )

protected

Definition at line 69 of file class.ilObjectOwnershipManagementTableGUI.php.

                                              : void
    {
        $process_arr = [];
        $is_admin = false;
        $a_type = "";
        if (!is_null($data) && sizeof($data)) {
            if (!$this->user_id) {
                $is_admin = $this->access->checkAccess("visible", "", SYSTEM_FOLDER_ID);
            }
 
            foreach ($data as $id => $item) {
                // workspace objects won't have references
                $refs = ilObject::_getAllReferences($id);
                if ($refs) {
                    foreach ($refs as $ref_id) {
                        // objects in trash are hidden
                        if (!$this->tree->isDeleted($ref_id)) {
                            if ($this->user_id) {
                                $readable = $this->access->checkAccessOfUser(
                                    $this->user_id,
                                    "read",
                                    "",
                                    $ref_id,
                                    $a_type
                                );
                            } else {
                                $readable = $is_admin;
                            }
 
                            $process_arr[$ref_id] = [
                                "obj_id" => $id,
                                "ref_id" => $ref_id,
                                "type" => ilObject::_lookupType($id),
                                "title" => $item,
                                "path" => $this->buildPath($ref_id),
                                "readable" => $readable
                            ];
                        }
                    }
                }
            }
        }
 
        $this->setData($process_arr);
    }

References ilTableGUI\$data, ilTable2GUI\$id, $ref_id, ilObject\_getAllReferences(), ilObject\_lookupType(), ILIAS\Repository\access(), buildPath(), ilTable2GUI\setData(), and SYSTEM_FOLDER_ID.

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isParentReadOnly()

ilObjectOwnershipManagementTableGUI::isParentReadOnly ( )

protected

Definition at line 195 of file class.ilObjectOwnershipManagementTableGUI.php.

                                         : bool
    {
        if (!method_exists($this->parent_obj, 'isReadOnly')) {
            return false;
        }
        return $this->parent_obj->isReadOnly();
    }