Inheritance diagram for ilMailFolderTableGUI:

Collaboration diagram for ilMailFolderTableGUI:

Public Member Functions
	__construct (ilMailFolderGUI $a_parent_obj, int $a_current_folder_id, string $a_parent_cmd, bool $isTrashFolder, bool $isSentFolder, bool $isDraftsFolder, Factory $uiFactory=null, Renderer $uiRenderer=null)

	getSelectableColumns ()

	prepareHTML ()

	isDraftFolder ()

	isSentFolder ()

	isTrashFolder ()

	setSelectedItems (array $a_selected_items)

	getSelectedItems ()

	setNumberOfMails (int $a_number_of_mails)

	getNumberOfMails ()

	initFilter ()

	writeFilterToSession ()

	resetFilter ()

	getHTML ()

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
	isColumnVisible (int $index)

	fillRow (array $a_set)

	removeInvisibleFields (array $row)

	getColumnDefinition ()

	shouldUseLuceneSearch ()

	fetchTableData ()

	setTitleData (string $folderLabel, int $mailCount, int $unreadCount, string $imgFolder)

	formatActionsDropDown (array $mail)

	addViewRowAction (array $mail, array &$buttons)

	addReplyRowAction (array $mail, array &$buttons)

	addForwardRowAction (array $mail, array &$buttons)

	addPrintRowAction (array $mail, array &$buttons)

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
array	$_folderNode = []

ilMailFolderGUI	$_parentObject

int	$_currentFolderId = 0

int	$_number_of_mails = 0

array	$_selectedItems = []

bool	$_isTrashFolder = false

bool	$_isDraftsFolder = false

bool	$_isSentFolder = false

ilObjUser	$user

array	$filter = []

array	$sub_filter = []

array	$visibleOptionalColumns = []

array	$optionalColumns = []

array	$optional_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 Member Functions
	initCommandButtons ()

	initMultiCommands (array $actions)

	isLuceneEnabled ()

Private Attributes
GlobalHttpState	$http

Factory	$uiFactory

Renderer	$uiRenderer

array	$column_definition = null

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

Author: Jan Posselt jposs.nosp@m.elt@.nosp@m.datab.nosp@m.ay.d.nosp@m.e; Michael Jansen mjans.nosp@m.en@d.nosp@m.ataba.nosp@m.y.de

Definition at line 30 of file class.ilMailFolderTableGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilMailFolderTableGUI::__construct	(	ilMailFolderGUI	$a_parent_obj,
		int	$a_current_folder_id,
		string	$a_parent_cmd,
		bool	$isTrashFolder,
		bool	$isSentFolder,
		bool	$isDraftsFolder,
		Factory	$uiFactory = `null`,
		Renderer	$uiRenderer = `null`
	)

Definition at line 51 of file class.ilMailFolderTableGUI.php.

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\ctrl(), ilTable2GUI\getParentObject(), ILIAS\FileDelivery\http(), ilTable2GUI\setDefaultOrderDirection(), ilTable2GUI\setDefaultOrderField(), ilTable2GUI\setEnableTitle(), ilTable2GUI\setExternalSegmentation(), ilTable2GUI\setExternalSorting(), ilTable2GUI\setFilterCommand(), ilTable2GUI\setFormAction(), ilTable2GUI\setId(), ilTable2GUI\setPrefix(), ilTable2GUI\setResetCommand(), ilTable2GUI\setRowTemplate(), ilTable2GUI\setSelectAllCheckbox(), and ILIAS\Repository\user().

       {
         global $DIC;
         $this->user = $DIC->user();
         $this->uiFactory = $uiFactory ?? $DIC->ui()->factory();
         $this->uiRenderer = $uiRenderer ?? $DIC->ui()->renderer();
         $this->http = $DIC->http();
 
         $this->_currentFolderId = $a_current_folder_id;
         $this->_parentObject = $a_parent_obj;
 
         $this->_isTrashFolder = $isTrashFolder;
         $this->_isSentFolder = $isSentFolder;
         $this->_isDraftsFolder = $isDraftsFolder;
 
         $this->setId('mail_folder_tbl_' . $a_current_folder_id);
         $this->setPrefix('mtable');
 
         $this->setExternalSorting(true);
         $this->setExternalSegmentation(true);
         $this->setDefaultOrderField('send_time');
         $this->setDefaultOrderDirection('desc');
 
         parent::__construct($a_parent_obj, $a_parent_cmd);
 
         $this->ctrl->setParameter($this->getParentObject(), 'mobj_id', $this->_currentFolderId);
         $this->setFormAction($this->ctrl->getFormAction($this->getParentObject(), 'showFolder'));
         $this->ctrl->clearParameters($this->getParentObject());
 
         $this->setEnableTitle(true);
         $this->setSelectAllCheckbox('mail_id[]');
         $this->setRowTemplate('tpl.mail_folder_row.html', 'Services/Mail');
 
         $this->setFilterCommand('applyFilter');
         $this->setResetCommand('resetFilter');
     }

Here is the call graph for this function:

Member Function Documentation

◆ addForwardRowAction()

ilMailFolderTableGUI::addForwardRowAction	(	array	$mail,
		array &	$buttons
	)

protected

Definition at line 838 of file class.ilMailFolderTableGUI.php.

References ILIAS\Repository\ctrl(), isDraftFolder(), ILIAS\Repository\lng(), and ilMailFormGUI\MAIL_FORM_TYPE_FORWARD.

Referenced by formatActionsDropDown().

                                                                         : void
     {
         if (!$this->isDraftFolder()) {
             $this->ctrl->setParameterByClass(
                 ilMailFormGUI::class,
                 'mobj_id',
                 $this->_currentFolderId
             );
             $this->ctrl->setParameterByClass(
                 ilMailFormGUI::class,
                 'mail_id',
                 (int) $mail['mail_id']
             );
             $this->ctrl->setParameterByClass(
                 ilMailFormGUI::class,
                 'type',
                 ilMailFormGUI::MAIL_FORM_TYPE_FORWARD
             );
             $forwardButton = $this->uiFactory
                 ->link()
                 ->standard(
                     $this->lng->txt('forward'),
                     $this->ctrl->getLinkTargetByClass(ilMailFormGUI::class)
                 );
             $this->ctrl->clearParametersByClass(ilMailFormGUI::class);
 
             $buttons[] = $forwardButton;
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addPrintRowAction()

ilMailFolderTableGUI::addPrintRowAction	(	array	$mail,
		array &	$buttons
	)

protected

Definition at line 868 of file class.ilMailFolderTableGUI.php.

References ILIAS\Repository\ctrl(), ilTable2GUI\getParentObject(), isDraftFolder(), and ILIAS\Repository\lng().

Referenced by formatActionsDropDown().

                                                                       : void
     {
         if (!$this->isDraftFolder()) {
             $this->ctrl->setParameter($this->getParentObject(), 'mobj_id', $this->_currentFolderId);
             $this->ctrl->setParameter($this->getParentObject(), 'mail_id', (int) $mail['mail_id']);
             $printButton = $this->uiFactory
                 ->link()
                 ->standard(
                     $this->lng->txt('print'),
                     $this->ctrl->getLinkTarget($this->getParentObject(), 'printMail')
                 )->withOpenInNewViewport(true);
             $this->ctrl->clearParameters($this->getParentObject());
 
             $buttons[] = $printButton;
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addReplyRowAction()

ilMailFolderTableGUI::addReplyRowAction	(	array	$mail,
		array &	$buttons
	)

protected

Definition at line 805 of file class.ilMailFolderTableGUI.php.

References ANONYMOUS_USER_ID, ILIAS\Repository\ctrl(), isDraftFolder(), ILIAS\Repository\lng(), and ilMailFormGUI\MAIL_FORM_TYPE_REPLY.

Referenced by formatActionsDropDown().

                                                                       : void
     {
         if (
             isset($mail['sender_id']) && $mail['sender_id'] > 0 && $mail['sender_id'] !== ANONYMOUS_USER_ID &&
             !$this->isDraftFolder()
         ) {
             $this->ctrl->setParameterByClass(
                 ilMailFormGUI::class,
                 'mobj_id',
                 $this->_currentFolderId
             );
             $this->ctrl->setParameterByClass(
                 ilMailFormGUI::class,
                 'mail_id',
                 (int) $mail['mail_id']
             );
             $this->ctrl->setParameterByClass(
                 ilMailFormGUI::class,
                 'type',
                 ilMailFormGUI::MAIL_FORM_TYPE_REPLY
             );
             $replyButton = $this->uiFactory
                 ->link()
                 ->standard(
                     $this->lng->txt('reply'),
                     $this->ctrl->getLinkTargetByClass(ilMailFormGUI::class)
                 );
             $this->ctrl->clearParametersByClass(ilMailFormGUI::class);
 
             $buttons[] = $replyButton;
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addViewRowAction()

ilMailFolderTableGUI::addViewRowAction	(	array	$mail,
		array &	$buttons
	)

protected

Definition at line 765 of file class.ilMailFolderTableGUI.php.

References ILIAS\Repository\ctrl(), ilTable2GUI\getParentObject(), isDraftFolder(), ILIAS\Repository\lng(), and ilMailFormGUI\MAIL_FORM_TYPE_DRAFT.

Referenced by formatActionsDropDown().

                                                                      : void
     {
         if ($this->isDraftFolder()) {
             $this->ctrl->setParameterByClass(
                 ilMailFormGUI::class,
                 'mail_id',
                 (int) $mail['mail_id']
             );
             $this->ctrl->setParameterByClass(
                 ilMailFormGUI::class,
                 'mobj_id',
                 $this->_currentFolderId
             );
             $this->ctrl->setParameterByClass(
                 ilMailFormGUI::class,
                 'type',
                 ilMailFormGUI::MAIL_FORM_TYPE_DRAFT
             );
             $viewButton = $this->uiFactory
                 ->link()
                 ->standard(
                     $this->lng->txt('view'),
                     $this->ctrl->getLinkTargetByClass(ilMailFormGUI::class)
                 );
             $this->ctrl->clearParametersByClass(ilMailFormGUI::class);
         } else {
             $this->ctrl->setParameter($this->getParentObject(), 'mail_id', (int) $mail['mail_id']);
             $this->ctrl->setParameter($this->getParentObject(), 'mobj_id', $this->_currentFolderId);
             $viewButton = $this->uiFactory
                 ->link()
                 ->standard(
                     $this->lng->txt('view'),
                     $this->ctrl->getLinkTarget($this->getParentObject(), 'showMail')
                 );
             $this->ctrl->clearParameters($this->getParentObject());
         }
 
         $buttons[] = $viewButton;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fetchTableData()

ilMailFolderTableGUI::fetchTableData ( )

protected

Exceptions

Exception

Definition at line 358 of file class.ilMailFolderTableGUI.php.

References $_currentFolderId, ilTableGUI\$data, Vendor\Package\$e, ilMailBoxQuery\$filter, $filter, ilMailBoxQuery\$filtered_ids, ilMailBoxQuery\$folderId, ILIAS\LTI\ToolProvider\$key, ilMailBoxQuery\$limit, ilMailBoxQuery\$offset, ilMailBoxQuery\$orderColumn, ilMailBoxQuery\$orderDirection, ilMailBoxQuery\$userId, ilMailBoxQuery\_getMailBoxListData(), ANONYMOUS_USER_ID, ILIAS\Repository\ctrl(), ilTable2GUI\determineOffsetAndOrder(), ILIAS\UI\examples\Symbol\Glyph\Filter\filter(), formatActionsDropDown(), ilDatePresentation\formatDate(), ilUtil\getImagePath(), ilTable2GUI\getLimit(), ilTable2GUI\getOffset(), ilTableGUI\getOrderDirection(), ilTable2GUI\getOrderField(), ilTable2GUI\getParentObject(), ilObjUser\getPersonalPicturePath(), ilObjUser\getPublicName(), getSelectedItems(), ilMailUserCache\getUserObjectById(), ilUtil\htmlencodePlainString(), IL_CAL_DATETIME, isDraftFolder(), isSentFolder(), ILIAS\Repository\lng(), ilMailFormGUI\MAIL_FORM_TYPE_DRAFT, ilMailUserCache\preloadUserObjects(), ilTable2GUI\resetOffset(), ilTable2GUI\setData(), ilTableGUI\setMaxCount(), setNumberOfMails(), setTitleData(), shouldUseLuceneSearch(), and ILIAS\Repository\user().

Referenced by prepareHTML().

                                        : self
     {
         if ($this->_folderNode['m_type'] === 'user_folder') {
             $txt_folder = $this->_folderNode['title'];
             $img_folder = 'icon_user_folder.png';
         } else {
             $txt_folder = $this->lng->txt('mail_' . $this->_folderNode['title']);
             $img_folder = 'icon' . substr($this->_folderNode['title'], 1) . '.png';
         }
 
         $result = null;
 
         try {
             if ($this->shouldUseLuceneSearch()) {
                 $query_parser = new ilMailLuceneQueryParser($this->filter['mail_filter'] ?? '');
                 $query_parser->setFields([
                     'title' => (bool) ($this->filter['mail_filter_subject'] ?? false),
                     'content' => (bool) ($this->filter['mail_filter_body'] ?? false),
                     'mattachment' => (bool) ($this->filter['mail_filter_attach'] ?? false),
                     'msender' => (bool) ($this->filter['mail_filter_sender'] ?? false),
                     'mrcp' => (bool) ($this->filter['mail_filter_recipients'] ?? false)
                 ]);
                 $query_parser->parse();
 
                 $result = new ilMailSearchResult();
                 $searcher = new ilMailLuceneSearcher($query_parser, $result);
                 $searcher->search($this->user->getId(), $this->_currentFolderId);
 
                 if (!$result->getIds()) {
                     throw new ilException('mail_search_empty_result');
                 }
 
                 ilMailBoxQuery::$filtered_ids = $result->getIds();
                 ilMailBoxQuery::$filter = [
                     'mail_filter_only_unread' => $this->filter['mail_filter_only_unread'] ?? false,
                     'mail_filter_only_with_attachments' => $this->filter['mail_filter_only_with_attachments'] ?? false,
                 ];
             } else {
                 ilMailBoxQuery::$filter = $this->filter;
             }
 
             if (
                 isset(ilMailBoxQuery::$filter['mail_filter_only_unread']) &&
                 ($this->isDraftFolder() || $this->isSentFolder())
             ) {
                 unset(ilMailBoxQuery::$filter['mail_filter_only_unread']);
             }
 
             if (isset(ilMailBoxQuery::$filter['mail_filter_only_with_attachments']) && $this->isDraftFolder()) {
                 unset(ilMailBoxQuery::$filter['mail_filter_only_with_attachments']);
             }
 
             $this->determineOffsetAndOrder();
 
             ilMailBoxQuery::$folderId = $this->_currentFolderId;
             ilMailBoxQuery::$userId = $this->user->getId();
             ilMailBoxQuery::$limit = $this->getLimit();
             ilMailBoxQuery::$offset = $this->getOffset();
             ilMailBoxQuery::$orderDirection = $this->getOrderDirection();
             ilMailBoxQuery::$orderColumn = $this->getOrderField();
             $data = ilMailBoxQuery::_getMailBoxListData();
 
             if (!count($data['set']) && $this->getOffset() > 0) {
                 $this->resetOffset();
 
                 ilMailBoxQuery::$limit = $this->getLimit();
                 ilMailBoxQuery::$offset = $this->getOffset();
                 $data = ilMailBoxQuery::_getMailBoxListData();
             }
         } catch (Exception $e) {
             if ('mail_search_empty_result' === $e->getMessage()) {
                 $data['set'] = [];
                 $data['cnt'] = 0;
                 $data['cnt_unread'] = 0;
             } else {
                 throw $e;
             }
         }
 
         if (!$this->isDraftFolder() && !$this->isSentFolder()) {
             $user_ids = [];
             foreach ($data['set'] as $mail) {
                 if ($mail['sender_id'] && $mail['sender_id'] !== ANONYMOUS_USER_ID) {
                     $user_ids[$mail['sender_id']] = $mail['sender_id'];
                 }
             }
 
             ilMailUserCache::preloadUserObjects($user_ids);
         }
 
 
         foreach ($data['set'] as $key => $mail) {
             if (is_array($this->getSelectedItems()) &&
                 in_array($mail['mail_id'], $this->getSelectedItems(), false)
             ) {
                 $mail['checked'] = ' checked="checked" ';
             }
 
             $mail['txt_select_mail_with_subject'] = sprintf(
                 $this->lng->txt('select_mail_with_subject_x'),
                 htmlspecialchars($mail['m_subject'] ?? '')
             );
 
             if ($this->isDraftFolder() || $this->isSentFolder()) {
                 $mail['rcp_to'] = $mail['mail_login'] = ilUtil::htmlencodePlainString(
                     $this->_parentObject->umail->formatNamesForOutput((string) $mail['rcp_to']),
                     false
                 );
             } elseif ($mail['sender_id'] === ANONYMOUS_USER_ID) {
                 $mail['img_sender'] = ilUtil::getImagePath('HeaderIconAvatar.svg');
                 $mail['from'] =
                 $mail['mail_login'] =
                 $mail['alt_sender'] =
                     htmlspecialchars(ilMail::_getIliasMailerName());
             } else {
                 $user = ilMailUserCache::getUserObjectById($mail['sender_id']);
 
                 if ($user) {
                     $mail['img_sender'] = $user->getPersonalPicturePath('xxsmall');
                     $mail['from'] = $mail['mail_login'] = $mail['alt_sender'] = htmlspecialchars(
                         $user->getPublicName()
                     );
                 } else {
                     $mail['img_sender'] = '';
                     $mail['from'] = $mail['mail_login'] = trim(($mail['import_name'] ?? '') . ' ('
                         . $this->lng->txt('user_deleted') . ')');
                 }
             }
 
             if ($this->isDraftFolder()) {
                 $this->ctrl->setParameterByClass(
                     ilMailFormGUI::class,
                     'mail_id',
                     $mail['mail_id']
                 );
                 $this->ctrl->setParameterByClass(
                     ilMailFormGUI::class,
                     'mobj_id',
                     $this->_currentFolderId
                 );
                 $this->ctrl->setParameterByClass(
                     ilMailFormGUI::class,
                     'type',
                     ilMailFormGUI::MAIL_FORM_TYPE_DRAFT
                 );
                 $link_mark_as_read = $this->ctrl->getLinkTargetByClass(ilMailFormGUI::class);
                 $this->ctrl->clearParametersByClass(ilMailFormGUI::class);
             } else {
                 $this->ctrl->setParameter($this->getParentObject(), 'mail_id', $mail['mail_id']);
                 $this->ctrl->setParameter($this->getParentObject(), 'mobj_id', $this->_currentFolderId);
                 $link_mark_as_read = $this->ctrl->getLinkTarget($this->getParentObject(), 'showMail');
                 $this->ctrl->clearParameters($this->getParentObject());
             }
             $css_class = $mail['m_status'] === 'read' ? 'mailread' : 'mailunread';
 
             if ($result instanceof ilMailSearchResult) {
                 $search_result = [];
                 foreach ($result->getFields($mail['mail_id']) as $content) {
                     if ('title' === $content[0]) {
                         $mail['msr_subject_link_read'] = $link_mark_as_read;
                         $mail['msr_subject_mailclass'] = $css_class;
                         $mail['msr_subject'] = $content[1];
                     } else {
                         $search_result[] = $content[1];
                     }
                 }
                 $mail['msr_data'] = implode('', array_map(static function ($value): string {
                     return '<p>' . $value . '</p>';
                 }, $search_result));
 
                 if (!isset($mail['msr_subject']) || !$mail['msr_subject']) {
                     $mail['msr_subject_link_read'] = $link_mark_as_read;
                     $mail['msr_subject_mailclass'] = $css_class;
                     $mail['msr_subject'] = htmlspecialchars($mail['m_subject'] ?? '');
                 }
                 $mail['msr_subject_read_unread'] = $mail['m_status'] === 'read' ? $this->lng->txt('mail_is_read') : $this->lng->txt('mail_is_unread');
             } else {
                 $mail['mail_link_read'] = $link_mark_as_read;
                 $mail['mailclass'] = $css_class;
                 if ($mail['m_subject']) {
                     $mail['mail_subject'] = htmlspecialchars($mail['m_subject']);
                 } else {
                     $mail['mail_subject'] = $this->lng->txt('mail_no_subject');
                 }
                 $mail['mail_subject_read_unread'] = $mail['m_status'] === 'read' ? $this->lng->txt('mail_is_read') : $this->lng->txt('mail_is_unread');
             }
 
             $mail['mail_date'] = ilDatePresentation::formatDate(
                 new ilDateTime($mail['send_time'], IL_CAL_DATETIME)
             );
 
             $mail['attachment_indicator'] = '';
             if (is_array($mail['attachments']) && count($mail['attachments']) > 0) {
                 $this->ctrl->setParameter($this->getParentObject(), 'mail_id', (int) $mail['mail_id']);
                 if ($this->isDraftFolder()) {
                     $this->ctrl->setParameter($this->getParentObject(), 'type', ilMailFormGUI::MAIL_FORM_TYPE_DRAFT);
                 }
                 $this->ctrl->setParameter($this->getParentObject(), 'mobj_id', $this->_currentFolderId);
                 $mail['attachment_indicator'] = $this->uiRenderer->render(
                     $this->uiFactory->symbol()->glyph()->attachment(
                         $this->ctrl->getLinkTarget($this->getParentObject(), 'deliverAttachments')
                     )
                 );
                 $this->ctrl->clearParameters($this->getParentObject());
             }
 
             $mail['actions'] = $this->formatActionsDropDown($mail);
 
             $data['set'][$key] = $mail;
         }
 
         $this->setData($data['set']);
         $this->setMaxCount((int) $data['cnt']);
         $this->setNumberOfMails((int) $data['cnt']);
 
         $this->setTitleData($txt_folder, (int) $data['cnt'], (int) $data['cnt_unread'], $img_folder);
 
         return $this;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fillRow()

ilMailFolderTableGUI::fillRow ( array $a_set )

finalprotected

Definition at line 126 of file class.ilMailFolderTableGUI.php.

References ILIAS\LTI\ToolProvider\$key, and removeInvisibleFields().

                                                   : void
     {
         foreach ($this->removeInvisibleFields($a_set) as $key => $value) {
             $this->tpl->setVariable(strtoupper($key), $value);
         }
     }

Here is the call graph for this function:

◆ formatActionsDropDown()

ilMailFolderTableGUI::formatActionsDropDown ( array $mail )

protected

Definition at line 748 of file class.ilMailFolderTableGUI.php.

References ilTable2GUI\$buttons, addForwardRowAction(), addPrintRowAction(), addReplyRowAction(), addViewRowAction(), and ILIAS\Repository\lng().

Referenced by fetchTableData().

                                                          : string
     {
         $buttons = [];
 
         $this->addViewRowAction($mail, $buttons);
         $this->addReplyRowAction($mail, $buttons);
         $this->addForwardRowAction($mail, $buttons);
         $this->addPrintRowAction($mail, $buttons);
 
         $dropDown = $this->uiFactory
             ->dropdown()
             ->standard($buttons)
             ->withLabel($this->lng->txt('actions'));
 
         return $this->uiRenderer->render([$dropDown]);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getColumnDefinition()

ilMailFolderTableGUI::getColumnDefinition ( )

protected

Definition at line 146 of file class.ilMailFolderTableGUI.php.

References $column_definition, $i, isDraftFolder(), isSentFolder(), ILIAS\Repository\lng(), and shouldUseLuceneSearch().

Referenced by getSelectableColumns(), isColumnVisible(), and prepareHTML().

                                             : array
     {
         if ($this->column_definition !== null) {
             return $this->column_definition;
         }
 
         $i = 0;
 
         $columns = [];
 
         $columns[++$i] = [
             'field' => 'chb',
             'txt' => '',
             'default' => true,
             'optional' => false,
             'sortable' => false,
             'is_checkbox' => true,
             'width' => '1%'
         ];
 
         $columns[++$i] = [
             'field' => 'attachments',
             'txt' => $this->lng->txt('mail_tbl_head_attachments'),
             'default' => false,
             'optional' => true,
             'sortable' => false,
             'width' => '5%'
         ];
 
         if (!$this->isDraftFolder() && !$this->isSentFolder()) {
             $columns[++$i] = [
                 'field' => 'personal_picture',
                 'txt' => $this->lng->txt('personal_picture'),
                 'default' => true,
                 'optional' => true,
                 'sortable' => false,
                 'width' => '5%'
             ];
         }
 
         if ($this->isDraftFolder() || $this->isSentFolder()) {
             $columns[++$i] = [
                 'field' => 'rcp_to',
                 'txt' => $this->lng->txt('recipient'),
                 'default' => true,
                 'optional' => false,
                 'sortable' => true,
                 'width' => '35%'
             ];
         } else {
             $columns[++$i] = [
                 'field' => 'from',
                 'txt' => $this->lng->txt('sender'),
                 'default' => true,
                 'optional' => false,
                 'sortable' => true,
                 'width' => '20%'
             ];
         }
 
         if ($this->shouldUseLuceneSearch()) {
             $columns[++$i] = [
                 'field' => 'search_content',
                 'txt' => $this->lng->txt('search_content'),
                 'default' => true,
                 'optional' => false,
                 'sortable' => false,
                 'width' => '35%'
             ];
         } else {
             $columns[++$i] = [
                 'field' => 'm_subject',
                 'txt' => $this->lng->txt('subject'),
                 'default' => true,
                 'optional' => false,
                 'sortable' => true,
                 'width' => '35%'
             ];
         }
 
         $columns[++$i] = [
             'field' => 'send_time',
             'txt' => $this->lng->txt('date'),
             'default' => true,
             'optional' => false,
             'sortable' => true,
             'width' => '20%'
         ];
 
         $columns[++$i] = [
             'field' => 'actions',
             'txt' => $this->lng->txt('actions'),
             'default' => true,
             'optional' => false,
             'sortable' => false,
             'width' => '5%'
         ];
 
         $this->column_definition = $columns;
         return $this->column_definition;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getHTML()

ilMailFolderTableGUI::getHTML ( )

Definition at line 885 of file class.ilMailFolderTableGUI.php.

References ILIAS\Repository\ctrl(), and ilTable2GUI\getParentObject().

                              : string
     {
         $this->ctrl->setParameter($this->getParentObject(), 'mobj_id', $this->_currentFolderId);
         $html = parent::getHTML();
         $this->ctrl->clearParameters($this->getParentObject());
 
         return $html;
     }

Here is the call graph for this function:

◆ getNumberOfMails()

ilMailFolderTableGUI::getNumberOfMails ( )

Definition at line 607 of file class.ilMailFolderTableGUI.php.

References $_number_of_mails.

Referenced by initCommandButtons().

                                       : int
     {
         return $this->_number_of_mails;
     }

Here is the caller graph for this function:

◆ getSelectableColumns()

ilMailFolderTableGUI::getSelectableColumns ( )

Definition at line 96 of file class.ilMailFolderTableGUI.php.

References ilTable2GUI\$column, and getColumnDefinition().

Referenced by prepareHTML().

                                           : array
     {
         $optionalColumns = array_filter($this->getColumnDefinition(), static function (array $column): bool {
             return isset($column['optional']) && $column['optional'];
         });
 
         $columns = [];
         foreach ($optionalColumns as $column) {
             $columns[$column['field']] = $column;
         }
 
         return $columns;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSelectedItems()

ilMailFolderTableGUI::getSelectedItems ( )

Definition at line 337 of file class.ilMailFolderTableGUI.php.

References $_selectedItems.

Referenced by fetchTableData().

                                       : array
     {
         return $this->_selectedItems;
     }

Here is the caller graph for this function:

◆ initCommandButtons()

ilMailFolderTableGUI::initCommandButtons ( )

private

Definition at line 294 of file class.ilMailFolderTableGUI.php.

References ilTable2GUI\addCommandButton(), getNumberOfMails(), and ILIAS\Repository\lng().

Referenced by prepareHTML().

                                          : self
     {
         if ($this->_folderNode['m_type'] === 'trash' && $this->getNumberOfMails() > 0) {
             $this->addCommandButton('confirmEmptyTrash', $this->lng->txt('mail_empty_trash'));
         }
 
         return $this;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initFilter()

ilMailFolderTableGUI::initFilter ( )

Definition at line 612 of file class.ilMailFolderTableGUI.php.

References ilTable2GUI\addFilterItem(), ILIAS\UI\examples\Symbol\Glyph\Filter\filter(), IL_CAL_UNIX, ILIAS\Repository\int(), isDraftFolder(), isLuceneEnabled(), isSentFolder(), ILIAS\Repository\lng(), ilDateDurationInputGUI\setAllowOpenIntervals(), ilCheckboxInputGUI\setOptionTitle(), ilTextInputGUI\setSubmitFormOnEnter(), and ilCheckboxInputGUI\setValue().

Referenced by ilMailFolderGUI\getMailFolderTable().

                                 : void
     {
         $this->filter = [];
 
         $quickFilter = new ilMailQuickFilterInputGUI($this->lng->txt('mail_filter'), 'mail_filter');
         $quickFilter->setSubmitFormOnEnter(false);
         $this->addFilterItem($quickFilter);
         $quickFilter->readFromSession();
         $this->filter['mail_filter'] = $quickFilter->getValue();
 
         if ($this->isDraftFolder() || $this->isSentFolder()) {
             $this->sub_filter[] = $subFilterInRecipients = new ilCheckboxInputGUI(
                 $this->lng->txt('mail_filter_recipients'),
                 'mail_filter_recipients'
             );
             $subFilterInRecipients->setOptionTitle($this->lng->txt('mail_filter_recipients'));
             $subFilterInRecipients->setValue('1');
             $quickFilter->addSubItem($subFilterInRecipients);
             $subFilterInRecipients->setParentTable($this);
             $subFilterInRecipients->readFromSession();
             $this->filter['mail_filter_recipients'] = (int) $subFilterInRecipients->getChecked();
         } else {
             $this->sub_filter[] = $subFilterInSender = new ilCheckboxInputGUI(
                 $this->lng->txt('mail_filter_sender'),
                 'mail_filter_sender'
             );
             $subFilterInSender->setOptionTitle($this->lng->txt('mail_filter_sender'));
             $subFilterInSender->setValue('1');
             $quickFilter->addSubItem($subFilterInSender);
             $subFilterInSender->setParentTable($this);
             $subFilterInSender->readFromSession();
             $this->filter['mail_filter_sender'] = (int) $subFilterInSender->getChecked();
         }
 
         $this->sub_filter[] = $subFilterInSubject = new ilCheckboxInputGUI(
             $this->lng->txt('mail_filter_subject'),
             'mail_filter_subject'
         );
         $subFilterInSubject->setOptionTitle($this->lng->txt('mail_filter_subject'));
         $subFilterInSubject->setValue('1');
         $quickFilter->addSubItem($subFilterInSubject);
         $subFilterInSubject->setParentTable($this);
         $subFilterInSubject->readFromSession();
         $this->filter['mail_filter_subject'] = (int) $subFilterInSubject->getChecked();
 
         $this->sub_filter[] = $subFilterInBody = new ilCheckboxInputGUI(
             $this->lng->txt('mail_filter_body'),
             'mail_filter_body'
         );
         $subFilterInBody->setOptionTitle($this->lng->txt('mail_filter_body'));
         $subFilterInBody->setValue('1');
         $quickFilter->addSubItem($subFilterInBody);
         $subFilterInBody->setParentTable($this);
         $subFilterInBody->readFromSession();
         $this->filter['mail_filter_body'] = (int) $subFilterInBody->getChecked();
 
         if ($this->isLuceneEnabled()) {
             $this->sub_filter[] = $subFilterInAttachments = new ilCheckboxInputGUI(
                 $this->lng->txt('mail_filter_attach'),
                 'mail_filter_attach'
             );
             $subFilterInAttachments->setOptionTitle($this->lng->txt('mail_filter_attach'));
             $subFilterInAttachments->setValue('1');
             $quickFilter->addSubItem($subFilterInAttachments);
             $subFilterInAttachments->setParentTable($this);
             $subFilterInAttachments->readFromSession();
             $this->filter['mail_filter_attach'] = (int) $subFilterInAttachments->getChecked();
         }
 
         if (!$this->isDraftFolder() && !$this->isSentFolder()) {
             $onlyUnread = new ilCheckboxInputGUI(
                 $this->lng->txt('mail_filter_only_unread'),
                 'mail_filter_only_unread'
             );
             $onlyUnread->setValue('1');
             $this->addFilterItem($onlyUnread);
             $onlyUnread->readFromSession();
             $this->filter['mail_filter_only_unread'] = (int) $onlyUnread->getChecked();
 
             $onlyUserMails = new ilCheckboxInputGUI(
                 $this->lng->txt('mail_filter_only_user_mails'),
                 'mail_filter_only_user_mails'
             );
             $onlyUserMails->setValue('1');
             $this->addFilterItem($onlyUserMails);
             $onlyUserMails->readFromSession();
             $this->filter['mail_filter_only_user_mails'] = (int) $onlyUserMails->getChecked();
         }
 
         if (!$this->isDraftFolder()) {
             $onlyWithAttachments = new ilCheckboxInputGUI(
                 $this->lng->txt('mail_filter_only_with_attachments'),
                 'mail_filter_only_with_attachments'
             );
             $onlyWithAttachments->setValue('1');
             $this->addFilterItem($onlyWithAttachments);
             $onlyWithAttachments->readFromSession();
             $this->filter['mail_filter_only_with_attachments'] = (int) $onlyWithAttachments->getChecked();
         }
 
         $duration = new ilDateDurationInputGUI($this->lng->txt('mail_filter_period'), 'period');
         $duration->setAllowOpenIntervals(true);
         $duration->setStartText($this->lng->txt('mail_filter_period_from'));
         $duration->setEndText($this->lng->txt('mail_filter_period_until'));
         $duration->setStart(new ilDateTime(null, IL_CAL_UNIX));
         $duration->setEnd(new ilDateTime(null, IL_CAL_UNIX));
         $duration->setShowTime(false);
         $this->addFilterItem($duration);
         $duration->readFromSession();
         $this->filter['period'] = $duration->getValue();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initMultiCommands()

ilMailFolderTableGUI::initMultiCommands ( array $actions )

private

Definition at line 303 of file class.ilMailFolderTableGUI.php.

References ILIAS\LTI\ToolProvider\$key, ilTable2GUI\addMultiCommand(), isTrashFolder(), and ILIAS\Repository\lng().

Referenced by prepareHTML().

                                                       : self
     {
         foreach ($actions as $key => $action) {
             if ($key === 'moveMails') {
                 $folders = $this->_parentObject->mbox->getSubFolders();
                 foreach ($folders as $folder) {
                     if ($folder['type'] !== 'trash' || !$this->isTrashFolder()) {
                         if ($folder['type'] !== 'user_folder') {
                             $label = $action . ' ' . $this->lng->txt('mail_' . $folder['title']) .
                                 ($folder['type'] === 'trash' ? ' (' . $this->lng->txt('delete') . ')' : '');
                             $this->addMultiCommand($key . '_' . $folder['obj_id'], $label);
                         } else {
                             $this->addMultiCommand(
                                 $key . '_' . $folder['obj_id'],
                                 $action . ' ' . $folder['title']
                             );
                         }
                     }
                 }
             } elseif ($key !== 'deleteMails' || $this->isTrashFolder()) {
                 $this->addMultiCommand($key, $action);
             }
         }
 
         return $this;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isColumnVisible()

ilMailFolderTableGUI::isColumnVisible ( int $index )

protected

Definition at line 110 of file class.ilMailFolderTableGUI.php.

References ilTable2GUI\$column, $index, and getColumnDefinition().

Referenced by prepareHTML().

                                                   : bool
     {
         $columnDefinition = $this->getColumnDefinition();
         if (array_key_exists($index, $columnDefinition)) {
             $column = $columnDefinition[$index];
             if (isset($column['optional']) && !$column['optional']) {
                 return true;
             }
             if (array_key_exists($column['field'], $this->visibleOptionalColumns)) {
                 return true;
             }
         }
 
         return false;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isDraftFolder()

ilMailFolderTableGUI::isDraftFolder ( )

Definition at line 279 of file class.ilMailFolderTableGUI.php.

References $_isDraftsFolder.

Referenced by addForwardRowAction(), addPrintRowAction(), addReplyRowAction(), addViewRowAction(), fetchTableData(), getColumnDefinition(), and initFilter().

                                    : bool
     {
         return $this->_isDraftsFolder;
     }

Here is the caller graph for this function:

◆ isLuceneEnabled()

ilMailFolderTableGUI::isLuceneEnabled ( )

private

Definition at line 350 of file class.ilMailFolderTableGUI.php.

References ilSearchSettings\getInstance().

Referenced by initFilter(), and shouldUseLuceneSearch().

                                       : bool
     {
         return ilSearchSettings::getInstance()->enabledLucene();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isSentFolder()

ilMailFolderTableGUI::isSentFolder ( )

Definition at line 284 of file class.ilMailFolderTableGUI.php.

References $_isSentFolder.

Referenced by fetchTableData(), getColumnDefinition(), and initFilter().

                                   : bool
     {
         return $this->_isSentFolder;
     }

Here is the caller graph for this function:

◆ isTrashFolder()

ilMailFolderTableGUI::isTrashFolder ( )

Definition at line 289 of file class.ilMailFolderTableGUI.php.

References $_isTrashFolder.

Referenced by initMultiCommands().

                                    : bool
     {
         return $this->_isTrashFolder;
     }

Here is the caller graph for this function:

◆ prepareHTML()

ilMailFolderTableGUI::prepareHTML ( )

final

Exceptions

Exception

Definition at line 251 of file class.ilMailFolderTableGUI.php.

References ilTable2GUI\$column, $index, ilTable2GUI\addColumn(), fetchTableData(), getColumnDefinition(), getSelectableColumns(), ilTable2GUI\getSelectedColumns(), initCommandButtons(), initMultiCommands(), isColumnVisible(), and ILIAS\Repository\user().

                                        : self
     {
         $columns = $this->getColumnDefinition();
         $this->optionalColumns = $this->getSelectableColumns();
         $this->visibleOptionalColumns = $this->getSelectedColumns();
         foreach ($columns as $index => $column) {
             if ($this->isColumnVisible($index)) {
                 $this->addColumn(
                     $column['txt'],
                     isset($column['sortable']) && $column['sortable'] ? $column['field'] : '',
                     $column['width'] ?? '',
                     isset($column['is_checkbox']) && $column['is_checkbox']
                 );
             }
         }
 
         $mtree = new ilTree($this->user->getId());
         $mtree->setTableNames('mail_tree', 'mail_obj_data');
         $this->_folderNode = $mtree->getNodeData($this->_currentFolderId);
 
         $this->fetchTableData();
 
         $this->initCommandButtons();
         $this->initMultiCommands($this->_parentObject->mbox->getActions($this->_currentFolderId));
 
         return $this;
     }

Here is the call graph for this function:

◆ removeInvisibleFields()

ilMailFolderTableGUI::removeInvisibleFields ( array $row )

protected

Definition at line 133 of file class.ilMailFolderTableGUI.php.

Referenced by fillRow().

                                                         : array
     {
         if (!array_key_exists('attachments', $this->visibleOptionalColumns)) {
             unset($row['attachment_indicator']);
         }
 
         if (!array_key_exists('personal_picture', $this->visibleOptionalColumns)) {
             unset($row['img_sender'], $row['alt_sender']);
         }
 
         return $row;
     }

Here is the caller graph for this function:

◆ resetFilter()

ilMailFolderTableGUI::resetFilter ( )

Definition at line 736 of file class.ilMailFolderTableGUI.php.

References ILIAS\FileDelivery\http().

                                  : void
     {
         parent::resetFilter();
 
         foreach ($this->sub_filter as $item) {
             if ($item->checkInput()) {
                 $item->setValueByArray($this->http->request()->getParsedBody());
                 $item->clearFromSession();
             }
         }
     }

Here is the call graph for this function:

◆ setNumberOfMails()

ilMailFolderTableGUI::setNumberOfMails ( int $a_number_of_mails )

Definition at line 600 of file class.ilMailFolderTableGUI.php.

Referenced by fetchTableData().

                                                             : self
     {
         $this->_number_of_mails = $a_number_of_mails;
 
         return $this;
     }

Here is the caller graph for this function:

◆ setSelectedItems()

ilMailFolderTableGUI::setSelectedItems ( array $a_selected_items )

Definition at line 330 of file class.ilMailFolderTableGUI.php.

                                                              : self
     {
         $this->_selectedItems = $a_selected_items;
 
         return $this;
     }

◆ setTitleData()

ilMailFolderTableGUI::setTitleData	(	string	$folderLabel,
		int	$mailCount,
		int	$unreadCount,
		string	$imgFolder
	)

protected

Exceptions

ilTemplateException

Definition at line 581 of file class.ilMailFolderTableGUI.php.

References ILIAS\Repository\lng(), and ilTable2GUI\setTitle().

Referenced by fetchTableData().

                                                                                                              : self
     {
         $titleTemplate = new ilTemplate(
             'tpl.mail_folder_title.html',
             true,
             true,
             'Services/Mail'
         );
         $titleTemplate->setVariable('TXT_FOLDER', $folderLabel);
         $titleTemplate->setVariable('MAIL_COUNT', $mailCount);
         $titleTemplate->setVariable('TXT_MAIL_S', $this->lng->txt('mail_s'));
         $titleTemplate->setVariable('MAIL_COUNT_UNREAD', $unreadCount);
         $titleTemplate->setVariable('TXT_UNREAD', $this->lng->txt('unread'));
 
         $this->setTitle($titleTemplate->get(), $imgFolder);
 
         return $this;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ shouldUseLuceneSearch()

ilMailFolderTableGUI::shouldUseLuceneSearch ( )

protected

Definition at line 342 of file class.ilMailFolderTableGUI.php.

References ILIAS\UI\examples\Symbol\Glyph\Filter\filter(), and isLuceneEnabled().

Referenced by fetchTableData(), and getColumnDefinition().

                                               : bool
     {
         return isset($this->filter['mail_filter']) &&
             is_string($this->filter['mail_filter']) &&
             $this->filter['mail_filter'] !== '' &&
             $this->isLuceneEnabled();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeFilterToSession()

ilMailFolderTableGUI::writeFilterToSession ( )

Definition at line 724 of file class.ilMailFolderTableGUI.php.

References ILIAS\FileDelivery\http().

                                           : void
     {
         parent::writeFilterToSession();
 
         foreach ($this->sub_filter as $item) {
             if ($item->checkInput()) {
                 $item->setValueByArray($this->http->request()->getParsedBody());
                 $item->writeToSession();
             }
         }
     }