ILIAS
release_8 Revision v8.23
|
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...
Public Member Functions | |
getFilter () | |
Return array of fields that are currently stored in the filter. More... | |
setRecordData (array $data) | |
numericOrdering (string $a_field) | |
initFilterFromTableView () | |
init filters with values from tableview More... | |
initFilter () | |
normally initialize filters - used by applyFilter and resetFilter More... | |
applyFilter ($field_id, $filter_value) | |
loadProperty (string $type) | |
exportData (int $format, bool $send=false) | |
Exports the table. More... | |
![]() | |
__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) | |
![]() | |
__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 | EXPORT_EXCEL_ASYNC = 10 |
![]() | |
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 |
![]() | |
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 | |
addActionRowIfNeeded () | |
needsActionRow () | |
getStatus (ilDclBaseRecordModel $record, ilDclBaseFieldModel $field) | |
This adds the column for status. More... | |
getCommentsAjaxLink (int $recordId) | |
Get the ajax link for displaying the comments in the right panel (to be wrapped in an onclick attr) More... | |
![]() | |
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 | |
buildData () | |
Parse data from record objects to an array that is then set to this table with ::setData() More... | |
Additional Inherited Members | |
![]() | |
static | getAllCommandLimit () |
![]() | |
static | linkbar (string $AScript, int $AHits, int $ALimit, int $AOffset, array $AParams=array(), array $ALayout=array(), string $prefix='') |
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
Definition at line 19 of file class.ilDclRecordListTableGUI.php.
|
protected |
Definition at line 137 of file class.ilDclRecordListTableGUI.php.
References ilTable2GUI\addColumn(), ILIAS\Repository\lng(), and needsActionRow().
Referenced by setRecordData().
ilDclRecordListTableGUI::applyFilter | ( | $field_id, | |
$filter_value | |||
) |
Definition at line 377 of file class.ilDclRecordListTableGUI.php.
References ILIAS\UI\examples\Symbol\Glyph\Filter\filter().
Referenced by initFilter(), and initFilterFromTableView().
|
private |
Parse data from record objects to an array that is then set to this table with ::setData()
Definition at line 152 of file class.ilDclRecordListTableGUI.php.
References ilTableGUI\$data, ilTableGUI\$title, ILIAS\Repository\ctrl(), ilTable2GUI\fillRow(), getCommentsAjaxLink(), ilUtil\getImagePath(), getStatus(), ilUtil\img(), ilDclDetailedViewDefinition\isActive(), ILIAS\Repository\lng(), ilDclRecordListGUI\MODE_MANAGE, ilDclBaseFieldModel\PROP_LEARNING_PROGRESS, and ilTable2GUI\setData().
Referenced by setRecordData().
ilDclRecordListTableGUI::exportData | ( | int | $format, |
bool | $send = false |
||
) |
Exports the table.
Definition at line 417 of file class.ilDclRecordListTableGUI.php.
References $filter, ilTable2GUI\dataExists(), ilDclContentExporter\export(), and ilDclContentExporter\EXPORT_EXCEL.
|
protected |
Get the ajax link for displaying the comments in the right panel (to be wrapped in an onclick attr)
Definition at line 400 of file class.ilDclRecordListTableGUI.php.
References ilCommonActionDispatcherGUI\buildAjaxHash(), and ilNoteGUI\getListCommentsJSCall().
Referenced by buildData().
ilDclRecordListTableGUI::getFilter | ( | ) |
Return array of fields that are currently stored in the filter.
Return empty array if no filtering is required.
Definition at line 125 of file class.ilDclRecordListTableGUI.php.
References $filter.
|
protected |
This adds the column for status.
Definition at line 310 of file class.ilDclRecordListTableGUI.php.
References ilLPStatusIcons\getInstance(), ilDclCache\getRecordFieldCache(), and ilLPStatusIcons\ICON_VARIANT_LONG.
Referenced by buildData().
ilDclRecordListTableGUI::initFilter | ( | ) |
normally initialize filters - used by applyFilter and resetFilter
Definition at line 353 of file class.ilDclRecordListTableGUI.php.
References applyFilter(), and ilDclCache\getFieldRepresentation().
ilDclRecordListTableGUI::initFilterFromTableView | ( | ) |
init filters with values from tableview
Definition at line 325 of file class.ilDclRecordListTableGUI.php.
References applyFilter(), ILIAS\UI\examples\Symbol\Glyph\Filter\filter(), and ilDclCache\getFieldRepresentation().
ilDclRecordListTableGUI::loadProperty | ( | string | $type | ) |
string | $type |
Definition at line 388 of file class.ilDclRecordListTableGUI.php.
References ilTable2GUI\getId().
|
protected |
Definition at line 290 of file class.ilDclRecordListTableGUI.php.
References ilDclDetailedViewDefinition\isActive().
Referenced by addActionRowIfNeeded().
ilDclRecordListTableGUI::numericOrdering | ( | string | $a_field | ) |
Definition at line 144 of file class.ilDclRecordListTableGUI.php.
ilDclRecordListTableGUI::setRecordData | ( | array | $data | ) |
Definition at line 130 of file class.ilDclRecordListTableGUI.php.
References ilTableGUI\$data, addActionRowIfNeeded(), and buildData().
|
protected |
Definition at line 34 of file class.ilDclRecordListTableGUI.php.
|
protected |
Definition at line 31 of file class.ilDclRecordListTableGUI.php.
Referenced by exportData(), and getFilter().
|
protected |
Definition at line 35 of file class.ilDclRecordListTableGUI.php.
|
protected |
Definition at line 32 of file class.ilDclRecordListTableGUI.php.
|
protected |
Definition at line 30 of file class.ilDclRecordListTableGUI.php.
|
protected |
Definition at line 29 of file class.ilDclRecordListTableGUI.php.
|
protected |
Definition at line 23 of file class.ilDclRecordListTableGUI.php.
|
protected |
Definition at line 24 of file class.ilDclRecordListTableGUI.php.
|
protected |
Definition at line 25 of file class.ilDclRecordListTableGUI.php.
|
protected |
Definition at line 33 of file class.ilDclRecordListTableGUI.php.
const ilDclRecordListTableGUI::EXPORT_EXCEL_ASYNC = 10 |
Definition at line 21 of file class.ilDclRecordListTableGUI.php.