Inheritance diagram for ilBuddySystemRelationsTableGUI:

Collaboration diagram for ilBuddySystemRelationsTableGUI:

Public Member Functions
	__construct (object $a_parent_obj, string $a_parent_cmd)

	initFilter ()

	populate ()

	render ()

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)

Data Fields
const	STATE_FILTER_ELM_ID = 'relation_state_type'

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 Member Functions
	fillRow (array $a_set)

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
ilGlobalTemplateInterface	$containerTemplate

bool	$hasAccessToMailSystem = false

bool	$isChatEnabled = false

ilObjUser	$user

array	$filter = []

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

Private Attributes
const	APPLY_FILTER_CMD = 'applyContactsTableFilter'

const	RESET_FILTER_CMD = 'resetContactsTableFilter'

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='')

Detailed Description

Class ilBuddyList.

Author: Michael Jansen mjans.nosp@m.en@d.nosp@m.ataba.nosp@m.y.de

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

Constructor & Destructor Documentation

◆ __construct()

ilBuddySystemRelationsTableGUI::__construct	(	object	$a_parent_obj,
		string	$a_parent_cmd
	)

Parameters

object	$a_parent_obj
string	$a_parent_cmd

Definition at line 42 of file class.ilBuddySystemRelationsTableGUI.php.

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ilTable2GUI\addColumn(), ilTable2GUI\addMultiCommand(), ILIAS\Repository\ctrl(), ilMailGlobalServices\getMailObjectRefId(), initFilter(), ILIAS\Repository\lng(), ilTable2GUI\setDefaultOrderDirection(), ilTable2GUI\setDefaultOrderField(), ilTable2GUI\setFilterCommand(), ilTable2GUI\setFormAction(), ilTable2GUI\setId(), ilTable2GUI\setResetCommand(), ilTable2GUI\setRowTemplate(), ilTable2GUI\setSelectAllCheckbox(), ilTable2GUI\setTitle(), and ILIAS\Repository\user().

     {
         global $DIC;
 
         $this->containerTemplate = $DIC['tpl'];
         $this->user = $DIC['ilUser'];
 
         $this->setId('buddy_system_tbl');
         parent::__construct($a_parent_obj, $a_parent_cmd);
 
         $this->lng->loadLanguageModule('buddysystem');
 
         $this->hasAccessToMailSystem = $DIC->rbac()->system()->checkAccess(
             'internal_mail',
             ilMailGlobalServices::getMailObjectRefId()
         );
 
         $chatSettings = new ilSetting('chatroom');
         $this->isChatEnabled = (bool) $chatSettings->get('chat_enabled', '0');
 
         $this->setDefaultOrderDirection('ASC');
         $this->setDefaultOrderField('public_name');
 
         $this->setTitle($this->lng->txt('buddy_tbl_title_relations'));
 
         if ($this->hasAccessToMailSystem || $this->isChatEnabled) {
             $this->addColumn('', 'chb', '1%', true);
             $this->setSelectAllCheckbox('usr_id');
             if ($this->hasAccessToMailSystem) {
                 $this->addMultiCommand('mailToUsers', $this->lng->txt('send_mail_to'));
             }
             if ($this->isChatEnabled) {
                 $this->addMultiCommand('inviteToChat', $this->lng->txt('invite_to_chat'));
             }
         }
 
         $this->addColumn($this->lng->txt('name'), 'public_name');
         $this->addColumn($this->lng->txt('login'), 'login');
         $this->addColumn($this->lng->txt('buddy_tbl_state_actions_col_label'), '', '', false, 'ilRight');
 
         $this->setRowTemplate('tpl.buddy_system_relation_table_row.html', 'Services/Contact/BuddySystem');
         $this->setFormAction($this->ctrl->getFormAction($a_parent_obj, $a_parent_cmd));
 
         $this->setFilterCommand(self::APPLY_FILTER_CMD);
         $this->setResetCommand(self::RESET_FILTER_CMD);
 
         $this->initFilter();
     }

Here is the call graph for this function:

Member Function Documentation

◆ fillRow()

ilBuddySystemRelationsTableGUI::fillRow ( array $a_set )

protected

Definition at line 213 of file class.ilBuddySystemRelationsTableGUI.php.

References ilObjUser\_lookupPref(), ILIAS\Repository\ctrl(), ilLegacyFormElementsUtil\formCheckbox(), ilBuddySystemLinkButton\getInstanceByUserId(), and ILIAS\Repository\user().

                                             : void
     {
         if ($this->hasAccessToMailSystem) {
             $a_set['chb'] = ilLegacyFormElementsUtil::formCheckbox(false, 'usr_id[]', (string) $a_set['usr_id']);
         }
 
         $public_profile = ilObjUser::_lookupPref($a_set['usr_id'], 'public_profile');
         if ((!$this->user->isAnonymous() && $public_profile === 'y') || $public_profile === 'g') {
             $this->ctrl->setParameterByClass(ilPublicUserProfileGUI::class, 'user', $a_set['usr_id']);
             $profile_target = $this->ctrl->getLinkTargetByClass(
                 ilPublicUserProfileGUI::class,
                 'getHTML'
             );
             $a_set['profile_link'] = $profile_target;
             $a_set['linked_public_name'] = $a_set['public_name'];
 
             $a_set['profile_link_login'] = $profile_target;
             $a_set['linked_login'] = $a_set['login'];
         } else {
             $a_set['unlinked_public_name'] = $a_set['public_name'];
             $a_set['unlinked_login'] = $a_set['login'];
         }
 
         $a_set['contact_actions'] = ilBuddySystemLinkButton::getInstanceByUserId((int) $a_set['usr_id'])->getHtml();
         parent::fillRow($a_set);
     }

Here is the call graph for this function:

◆ initFilter()

ilBuddySystemRelationsTableGUI::initFilter ( )

Definition at line 94 of file class.ilBuddySystemRelationsTableGUI.php.

References ilTable2GUI\addFilterItem(), ILIAS\UI\examples\Symbol\Glyph\Filter\filter(), ilTable2GUI\getFilterItems(), ilBuddySystemRelationStateFactory\getInstance(), ILIAS\Repository\lng(), and ilSelectInputGUI\setOptions().

Referenced by __construct().

                                 : void
     {
         $this->filters = [];
         $this->filter = [];
 
         $relations_state_selection = new ilSelectInputGUI(
             $this->lng->txt('buddy_tbl_filter_state'),
             self::STATE_FILTER_ELM_ID
         );
 
         $options = [];
         $state_factory = ilBuddySystemRelationStateFactory::getInstance();
         foreach ($state_factory->getValidStates() as $state) {
             if ($state->isInitial()) {
                 continue;
             }
 
             $state_filter_mapper = $state_factory->getTableFilterStateMapper($state);
             $options += $state_filter_mapper->optionsForState();
         }
         $relations_state_selection->setOptions(['' => $this->lng->txt('please_choose')] + $options);
         $this->addFilterItem($relations_state_selection);
         $relations_state_selection->readFromSession();
         $this->filter['relation_state_type'] = $relations_state_selection->getValue();
 
         $public_name = new ilTextInputGUI($this->lng->txt('name'), 'public_name');
         $this->addFilterItem($public_name);
         $public_name->readFromSession();
         $this->filter['public_name'] = $public_name->getValue();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ populate()

ilBuddySystemRelationsTableGUI::populate ( )

Definition at line 144 of file class.ilBuddySystemRelationsTableGUI.php.

References ilTableGUI\$data, ilObjUser\_lookupActive(), ILIAS\UI\examples\Symbol\Glyph\Filter\filter(), ilBuddySystemRelationStateFactory\getInstance(), ilBuddyList\getInstanceByGlobalUser(), ilUserUtil\getNamePresentation(), ilBuddySystemRelation\getState(), ilTable2GUI\setData(), ilTable2GUI\setExternalSegmentation(), and ilTable2GUI\setExternalSorting().

                               : void
     {
         $this->setExternalSorting(false);
         $this->setExternalSegmentation(false);
 
         $data = [];
 
         $relations = ilBuddyList::getInstanceByGlobalUser()->getRelations();
 
         $state_filter = (string) $this->filter[self::STATE_FILTER_ELM_ID];
         $state_factory = ilBuddySystemRelationStateFactory::getInstance();
         $relations = $relations->filter(function (ilBuddySystemRelation $relation) use ($state_filter, $state_factory): bool {
             $state_filter_mapper = $state_factory->getTableFilterStateMapper($relation->getState());
             return $state_filter === '' || $state_filter_mapper->filterMatchesRelation($state_filter, $relation);
         });
 
         $public_names = ilUserUtil::getNamePresentation($relations->getKeys(), false, false, '', false, true, false);
         $logins = ilUserUtil::getNamePresentation($relations->getKeys(), false, false, '', false, false, false);
 
         $logins = array_map(static function (string $value): string {
             $matches = null;
             preg_match_all('/\[([^\[]+?)\]/', $value, $matches);
             return (
                 is_array($matches) &&
                 isset($matches[1]) &&
                 is_array($matches[1]) &&
                 isset($matches[1][count($matches[1]) - 1])
             ) ? $matches[1][count($matches[1]) - 1] : '';
         }, $logins);
 
         $public_name_query = (string) ($this->filter['public_name'] ?? '');
         $relations = $relations->filter(static function (ilBuddySystemRelation $relation) use (
             $public_name_query,
             $relations,
             $public_names,
             $logins
         ): bool {
             $usrId = $relations->getKey($relation);
 
             $hasMatchingName = (
                 0 === ilStr::strlen($public_name_query) ||
                 ilStr::strpos(
                     ilStr::strtolower($public_names[$usrId]),
                     ilStr::strtolower($public_name_query)
                 ) !== false ||
                 ilStr::strpos(ilStr::strtolower($logins[$usrId]), ilStr::strtolower($public_name_query)) !== false
             );
 
             if (!$hasMatchingName) {
                 return false;
             }
 
             return ilObjUser::_lookupActive($usrId);
         });
 
         foreach ($relations->toArray() as $usr_id => $relation) {
             $data[] = [
                 'usr_id' => $usr_id,
                 'public_name' => $public_names[$usr_id],
                 'login' => $logins[$usr_id]
             ];
         }
 
         $this->setData($data);
     }

Here is the call graph for this function:

◆ render()

ilBuddySystemRelationsTableGUI::render ( )

Definition at line 243 of file class.ilBuddySystemRelationsTableGUI.php.

References ilTable2GUI\getId(), ilTable2GUI\getNoEntriesText(), and ILIAS\Repository\lng().

                             : string
     {
         $listener_tpl = new ilTemplate(
             'tpl.buddy_system_relation_table_listener.html',
             true,
             true,
             'Services/Contact/BuddySystem'
         );
         $listener_tpl->setVariable('TABLE_ID', $this->getId());
         $listener_tpl->setVariable('FILTER_ELM_ID', self::STATE_FILTER_ELM_ID);
         $listener_tpl->setVariable(
             'NO_ENTRIES_TEXT',
             $this->getNoEntriesText() ?: $this->lng->txt('no_items')
         );
 
         return parent::render() . $listener_tpl->get();
     }