ilOrgUnitPermissionTableGUI Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilOrgUnitPermissionTableGUI:

Collaboration diagram for ilOrgUnitPermissionTableGUI:

Public Member Functions
	__construct (object $a_parent_obj, string $a_parent_cmd, int $a_ref_id)
	getRefId ()
	getObjId ()
	getObjType ()
	fillRow (array $a_set)
	collectData ()
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)
	getData ()
	dataExists ()
	setPrefix (string $a_prefix)
	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 ()
	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)
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
	initColumns (array $positions)
	fillSelectAll (array $row)
	fillHeaderCommand (array $row)
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...

Private Member Functions
	dic ()

Private Attributes
int	$ref_id = 0

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

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Class ilOrgUnitPermissionTableGUI

Author

Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Definition at line 23 of file class.ilOrgUnitPermissionTableGUI.php.

Constructor & Destructor Documentation

__construct()

ilOrgUnitPermissionTableGUI::__construct	(	object	$a_parent_obj,
		string	$a_parent_cmd,
		int	$a_ref_id
	)

Definition at line 27 of file class.ilOrgUnitPermissionTableGUI.php.

References ilTableGUI\$tpl, ILIAS\GlobalScreen\Provider\__construct(), ilTable2GUI\addCommandButton(), ilPermissionGUI\CMD_SAVE_POSITIONS_PERMISSIONS, ilTableGUI\disable(), ILIAS\Repository\lng(), ilTable2GUI\setDisableFilterHiding(), ilTable2GUI\setEnableHeader(), ilTable2GUI\setFormAction(), ilTable2GUI\setId(), ilTable2GUI\setNoEntriesText(), ilTable2GUI\setRowTemplate(), ilTable2GUI\setShowRowsSelector(), and ilTable2GUI\setTitle().

    {
        global $ilCtrl, $tpl;

        parent::__construct($a_parent_obj, $a_parent_cmd);

        $this->lng->loadLanguageModule('rbac');
        $this->lng->loadLanguageModule("orgu");

        $this->ref_id = $a_ref_id;

        $this->setId('objpositionperm_' . $this->ref_id);

        $tpl->addJavaScript('./Services/AccessControl/js/ilPermSelect.js');

        $this->setTitle($this->lng->txt('org_permission_settings'));
        $this->setEnableHeader(true);
        $this->disable('sort');
        $this->setFormAction($ilCtrl->getFormAction($a_parent_obj, $a_parent_cmd));
        $this->disable('numinfo');
        $this->setRowTemplate("tpl.obj_position_perm_row.html", "Modules/OrgUnit");
        $this->setShowRowsSelector(false);
        $this->setDisableFilterHiding(true);
        $this->setNoEntriesText($this->lng->txt('msg_no_roles_of_type'));

        $this->addCommandButton(\ilPermissionGUI::CMD_SAVE_POSITIONS_PERMISSIONS, $this->lng->txt('save'));
    }

Here is the call graph for this function:

Member Function Documentation

collectData()

ilOrgUnitPermissionTableGUI::collectData

(

)

Definition at line 121 of file class.ilOrgUnitPermissionTableGUI.php.

References ilOrgUnitPosition\get(), ilOrgUnitGlobalSettings\getInstance(), getObjId(), getObjType(), ilOrgUnitOperationQueries\getOperationsForContextName(), getRefId(), initColumns(), and ilTable2GUI\setData().

                                 : void
    {
        $positions = ilOrgUnitPosition::get();

        $this->initColumns($positions);

        $perms = [];

        $operations = ilOrgUnitOperationQueries::getOperationsForContextName($this->getObjType());
        $ops_ids = [];
        $from_templates = [];
        foreach ($operations as $op) {
            $ops_ids[] = $op->getOperationId();

            $ops = [];
            foreach ($positions as $position) {
                $ilOrgUnitPermission = ilOrgUnitPermissionQueries::getSetForRefId(
                    $this->getRefId(),
                    $position->getId()
                );

                $is_template = $ilOrgUnitPermission->isTemplate();
                $from_templates[$position->getId()] = $is_template;

                $ops[] = [
                    "op_id" => $op->getOperationId(),
                    "operation" => $op,
                    "position" => $position,
                    "permission" => $ilOrgUnitPermission,
                    "permission_set" => $ilOrgUnitPermission->isOperationIdSelected($op->getOperationId()),
                    "from_template" => $is_template,
                ];
            }
            $perms[] = $ops;
        }

        $perms[] = [
            "show_select_all" => true,
            "positions" => $positions,
            "ops" => $ops_ids,
            "template" => $from_templates,
        ];
        if (ilOrgUnitGlobalSettings::getInstance()
                                   ->isPositionAccessActiveForObject($this->getObjId())
        ) {
            $perms[] = [
                "header_command" => true,
                "positions" => $positions,
                "template" => $from_templates,
            ];
        }

        $this->setData($perms);
    }

Here is the call graph for this function:

dic()

ilOrgUnitPermissionTableGUI::dic ( )

private

Definition at line 185 of file class.ilOrgUnitPermissionTableGUI.php.

References $GLOBALS.

Referenced by fillHeaderCommand(), and fillRow().

                          : \ILIAS\DI\Container
    {
        return $GLOBALS['DIC'];
    }

Here is the caller graph for this function:

fillHeaderCommand()

ilOrgUnitPermissionTableGUI::fillHeaderCommand ( array  $row )

protected

Exceptions

ilTemplateException

Definition at line 214 of file class.ilOrgUnitPermissionTableGUI.php.

References dic(), getRefId(), ilOrgUnitPermissionQueries\hasLocalSet(), and ILIAS\UI\examples\Symbol\Glyph\Language\language().

Referenced by fillRow().

                                                    : void
    {
        foreach ($row["positions"] as $position) {
            $this->tpl->setCurrentBlock('header_command');
            $this->tpl->setVariable('POSITION_ID', $position->getId());
            $this->tpl->setVariable('HEADER_COMMAND_TXT', $this->dic()
                                                               ->language()
                                                               ->txt('positions_override_operations'));
            if (ilOrgUnitPermissionQueries::hasLocalSet($this->getRefId(), $position->getId())) {
                $this->tpl->setVariable('HEADER_CHECKED', "checked='checked'");
            }

            $this->tpl->parseCurrentBlock();
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

fillRow()

ilOrgUnitPermissionTableGUI::fillRow

(

array

$a_set

)

Exceptions

ilTemplateException

Definition at line 76 of file class.ilOrgUnitPermissionTableGUI.php.

References dic(), fillHeaderCommand(), fillSelectAll(), getObjType(), and ilObjectPlugin\lookupTxtById().

                                         : void
    {
        // Select all
        if (isset($a_set['show_select_all'])) {
            $this->fillSelectAll($a_set);

            return;
        }
        if (isset($a_set['header_command'])) {
            $this->fillHeaderCommand($a_set);

            return;
        }

        $objdefinition = $this->dic()['objDefinition'];
        $is_plugin = $objdefinition->isPlugin($this->getObjType());

        foreach ($a_set as $permission) {
            $position = $permission["position"];
            $op_id = $permission["op_id"];
            $operation = $permission["operation"];
            $this->tpl->setCurrentBlock('position_td');
            $this->tpl->setVariable('POSITION_ID', $position->getId());
            $this->tpl->setVariable('PERM_ID', $op_id);

            if ($is_plugin) {
                $label = ilObjectPlugin::lookupTxtById($this->getObjType(), $operation->getOperationString());
            } else {
                $label = $this->dic()->language()->txt('org_op_' . $operation->getOperationString());
            }

            $this->tpl->setVariable('TXT_PERM', $label);
            $this->tpl->setVariable('PERM_LONG', $op_id);

            if ($permission['permission_set']) {
                $this->tpl->setVariable('PERM_CHECKED', 'checked="checked"');
            }
            if ($permission['from_template']) {
                $this->tpl->setVariable('PERM_DISABLED', 'disabled="disabled"');
            }

            $this->tpl->parseCurrentBlock();
        }
    }

Here is the call graph for this function:

fillSelectAll()

ilOrgUnitPermissionTableGUI::fillSelectAll ( array  $row )

protected

Exceptions

ilTemplateException

Definition at line 193 of file class.ilOrgUnitPermissionTableGUI.php.

References ilTable2GUI\$id, ilTable2GUI\getFormName(), and ILIAS\Repository\lng().

Referenced by fillRow().

                                                : void
    {
        foreach ($row["positions"] as $position) {
            assert($position instanceof ilOrgUnitPosition);
            $this->tpl->setCurrentBlock('position_select_all');
            $id = $position->getId();
            $this->tpl->setVariable('JS_ROLE_ID', $id);
            $this->tpl->setVariable('JS_SUBID', 0);
            $this->tpl->setVariable('JS_ALL_PERMS', "['" . implode("','", $row['ops']) . "']");
            $this->tpl->setVariable('JS_FORM_NAME', $this->getFormName());
            $this->tpl->setVariable('TXT_SEL_ALL', $this->lng->txt('select_all'));
            if ($row["template"][$id]) {
                $this->tpl->setVariable('ALL_DISABLED', "disabled='disabled'");
            }
            $this->tpl->parseCurrentBlock();
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getObjId()

ilOrgUnitPermissionTableGUI::getObjId

(

)

Returns

int Object-ID of current object

Definition at line 63 of file class.ilOrgUnitPermissionTableGUI.php.

References ilObject\_lookupObjId(), and getRefId().

Referenced by collectData(), and getObjType().

                              : int
    {
        return ilObject::_lookupObjId($this->getRefId());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getObjType()

ilOrgUnitPermissionTableGUI::getObjType

(

)

Definition at line 68 of file class.ilOrgUnitPermissionTableGUI.php.

References ilObject\_lookupType(), and getObjId().

Referenced by collectData(), and fillRow().

                                : string
    {
        return ilObject::_lookupType($this->getObjId());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getRefId()

ilOrgUnitPermissionTableGUI::getRefId

(

)

Definition at line 55 of file class.ilOrgUnitPermissionTableGUI.php.

References $ref_id.

Referenced by collectData(), fillHeaderCommand(), and getObjId().

                              : int
    {
        return $this->ref_id;
    }

Here is the caller graph for this function:

initColumns()

ilOrgUnitPermissionTableGUI::initColumns ( array  $positions )

protected

Definition at line 176 of file class.ilOrgUnitPermissionTableGUI.php.

References ilTable2GUI\addColumn().

Referenced by collectData().

                                                    : bool
    {
        foreach ($positions as $position) {
            $this->addColumn($position->getTitle(), '', '', '', false, $position->getDescription());
        }

        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$ref_id

int ilOrgUnitPermissionTableGUI::$ref_id = 0

private

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

Referenced by getRefId().

---

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

• Modules/OrgUnit/classes/Positions/Permissions/class.ilOrgUnitPermissionTableGUI.php