ILIAS  release_7 Revision v7.30-3-g800a261c036
ilPluginsOverviewTableGUI Class Reference

TableGUI class for components listing. More...

+ Inheritance diagram for ilPluginsOverviewTableGUI:
+ Collaboration diagram for ilPluginsOverviewTableGUI:

Public Member Functions

 __construct (ilObjComponentSettingsGUI $a_parent_obj, array $filter_data, string $a_parent_cmd="")
 
- Public Member Functions inherited from ilTable2GUI
 __construct ($a_parent_obj, $a_parent_cmd="", $a_template_context="")
 ilTable2GUI constructor. More...
 
 setOpenFormTag ($a_val)
 Set open form tag. More...
 
 getOpenFormTag ()
 Get open form tag. More...
 
 setCloseFormTag ($a_val)
 Set close form tag. More...
 
 getCloseFormTag ()
 Get close form tag. More...
 
 determineLimit ()
 Determine the limit. More...
 
 getSelectableColumns ()
 Get selectable columns. More...
 
 determineSelectedColumns ()
 Determine selected columns. More...
 
 isColumnSelected ($a_col)
 Is given column selected? More...
 
 getSelectedColumns ()
 Get selected columns. More...
 
 executeCommand ()
 Execute command. More...
 
 resetOffset ($a_in_determination=false)
 Reset offset. More...
 
 initFilter ()
 Init filter. More...
 
 getParentObject ()
 Get parent object. More...
 
 getParentCmd ()
 Get parent command. More...
 
 setTopAnchor ($a_val)
 Set top anchor. More...
 
 getTopAnchor ()
 Get top anchor. More...
 
 setNoEntriesText ($a_text)
 Set text for an empty table. More...
 
 getNoEntriesText ()
 Get text for an empty table. More...
 
 setIsDataTable ($a_val)
 Set is data table. More...
 
 getIsDataTable ()
 Get is data table. More...
 
 setEnableTitle ($a_enabletitle)
 Set Enable Title. More...
 
 getEnableTitle ()
 Get Enable Title. More...
 
 setEnableHeader ($a_enableheader)
 Set Enable Header. More...
 
 getEnableHeader ()
 Get Enable Header. More...
 
 setEnableNumInfo ($a_val)
 Set enable num info. More...
 
 getEnableNumInfo ()
 Get enable num info. More...
 
 setTitle ($a_title, $a_icon=0, $a_icon_alt=0)
 Set title and title icon. More...
 
 setDescription ($a_val)
 Set description. More...
 
 getDescription ()
 Get description. More...
 
 setOrderField ($a_order_field)
 set order column More...
 
 getOrderField ()
 
 setData ($a_data)
 set table data @access public More...
 
 getData ()
 
 dataExists ()
 
 setPrefix ($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) @access public More...
 
 getPrefix ()
 
 addFilterItem ($a_input_item, $a_optional=false)
 Add filter item. More...
 
 addFilterItemByMetaType ($id, $type=self::FILTER_TEXT, $a_optional=false, $caption=null)
 Add filter by standard type. More...
 
 getFilterItems ($a_optionals=false)
 Get filter items. More...
 
 getFilterItemByPostVar ($a_post_var)
 
 setFilterCols ($a_val)
 Set filter columns. More...
 
 getFilterCols ()
 Get filter columns. More...
 
 setDisableFilterHiding ($a_val=true)
 Set disable filter hiding. More...
 
 getDisableFilterHiding ()
 Get disable filter hiding. More...
 
 isFilterSelected ($a_col)
 Is given filter selected? More...
 
 getSelectedFilters ()
 Get selected filters. More...
 
 determineSelectedFilters ()
 Determine selected filters. More...
 
 setCustomPreviousNext ($a_prev_link, $a_next_link)
 Set custom previous/next links. More...
 
 setFormAction ($a_form_action, $a_multipart=false)
 Set Form action parameter. More...
 
 getFormAction ()
 Get Form action parameter. More...
 
 setFormName ($a_formname="")
 Set Form name. More...
 
 getFormName ()
 Get Form name. More...
 
 setId ($a_val)
 Set id. More...
 
 getId ()
 Get element id. More...
 
 setDisplayAsBlock ($a_val)
 Set display as block. More...
 
 getDisplayAsBlock ()
 Get display as block. More...
 
 getSelectAllCheckbox ()
 Get the name of the checkbox that should be toggled with a select all button. More...
 
 setSelectAllCheckbox ($a_select_all_checkbox, $a_select_all_on_top=false)
 Set the name of the checkbox that should be toggled with a select all button. More...
 
 setExternalSorting ($a_val)
 Set external sorting. More...
 
 getExternalSorting ()
 Get external sorting. More...
 
 setFilterCommand ($a_val, $a_caption=null)
 Set filter command. More...
 
 getFilterCommand ()
 Get filter command. More...
 
 setResetCommand ($a_val, $a_caption=null)
 Set reset filter command. More...
 
 getResetCommand ()
 Get reset filter command. More...
 
 setExternalSegmentation ($a_val)
 Set external segmentation. More...
 
 getExternalSegmentation ()
 Get external segmentation. More...
 
 setRowTemplate ($a_template, $a_template_dir="")
 Set row template. More...
 
 setDefaultOrderField ($a_defaultorderfield)
 Set Default order field. More...
 
 getDefaultOrderField ()
 Get Default order field. More...
 
 setDefaultOrderDirection ($a_defaultorderdirection)
 Set Default order direction. More...
 
 getDefaultOrderDirection ()
 Get Default order direction. More...
 
 setDefaultFilterVisiblity ($a_status)
 Set default filter visiblity. More...
 
 getDefaultFilterVisibility ()
 Get default filter visibility. More...
 
 clearCommandButtons ()
 
 addCommandButton ($a_cmd, $a_text, $a_onclick='', $a_id="", $a_class=null)
 Add Command button. More...
 
 addCommandButtonInstance (ilButtonBase $a_button)
 Add Command button instance. More...
 
 addSelectionButton ($a_sel_var, $a_options, $a_cmd, $a_text, $a_default_selection='')
 Add Selection List + Command button. More...
 
 addMultiItemSelectionButton ($a_sel_var, $a_options, $a_cmd, $a_text, $a_default_selection='')
 Add Selection List + Command button for selected items. More...
 
 setCloseCommand ($a_link)
 Add command for closing table. More...
 
 addMultiCommand ($a_cmd, $a_text)
 Add Command button. More...
 
 addHiddenInput ($a_name, $a_value)
 Add Hidden Input field. More...
 
 addHeaderCommand ($a_href, $a_text, $a_target="", $a_img="")
 Add Header Command (Link) (Image needed for now) More...
 
 setTopCommands ($a_val)
 Set top commands (display command buttons on top of table, too) More...
 
 getTopCommands ()
 Get top commands (display command buttons on top of table, too) More...
 
 addColumn ( $a_text, $a_sort_field="", $a_width="", $a_is_checkbox_action_column=false, $a_class="", $a_tooltip="", $a_tooltip_with_html=false)
 Add a column to the header. More...
 
 getNavParameter ()
 
 setOrderLink ($sort_field, $order_dir)
 
 fillHeader ()
 
 determineOffsetAndOrder ($a_omit_offset=false)
 Determine offset and order. More...
 
 storeNavParameter ()
 
 getHTML ()
 Get HTML. More...
 
 numericOrdering ($a_field)
 Should this field be sorted numeric? More...
 
 render ()
 render table @access public More...
 
 writeFilterToSession ()
 Write filter values to session. More...
 
 resetFilter ()
 Reset filter. More...
 
 fillFooter ()
 Fill footer row. More...
 
 getLinkbar ($a_num)
 Get previous/next linkbar. More...
 
 fillHiddenRow ()
 
 fillActionRow ()
 Fill Action Row. More...
 
 setHeaderHTML ($html)
 set header html More...
 
 storeProperty ($type, $value)
 Store table property. More...
 
 loadProperty ($type)
 Load table property. More...
 
 getCurrentState ()
 get current settings for order, limit, columns and filter More...
 
 setContext ($id)
 Set context. More...
 
 getContext ()
 Get context. More...
 
 setShowRowsSelector ($a_value)
 Toggle rows-per-page selector. More...
 
 getShowRowsSelector ()
 Get rows-per-page selector state. More...
 
 setShowTemplates ($a_value)
 Toggle templates. More...
 
 getShowTemplates ()
 Get template state. More...
 
 restoreTemplate ($a_name)
 Restore state from template. More...
 
 saveTemplate ($a_name)
 Save current state as template. More...
 
 deleteTemplate ($a_name)
 Delete template. More...
 
 getLimit ()
 Get limit. More...
 
 getOffset ()
 Get offset. More...
 
 setExportFormats (array $formats)
 Set available export formats. More...
 
 setPrintMode ($a_value=false)
 Toogle print mode. More...
 
 getPrintMode ()
 Get print mode. More...
 
 getExportMode ()
 Was export activated? More...
 
 exportData ($format, $send=false)
 Export and optionally send current table data. More...
 
 setEnableAllCommand ($a_value)
 Enable actions for all entries in current result. More...
 
 setRowSelectorLabel ($row_selector_label)
 
 getRowSelectorLabel ()
 
 setPreventDoubleSubmission ($a_val)
 Set prevent double submission. More...
 
 getPreventDoubleSubmission ()
 Get prevent double submission. More...
 
 setLimit ($a_limit=0, $a_default_limit=0)
 set max. More...
 
- Public Member Functions inherited from ilTableGUI
 __construct ($a_data=0, $a_global_tpl=true)
 Constructor. More...
 
 setTemplate ($a_tpl)
 set template @access public More...
 
getTemplateObject ()
 
 setData ($a_data)
 set table data @access public More...
 
 getData ()
 
 setTitle ($a_title, $a_icon=0, $a_icon_alt=0)
 set table title @access public More...
 
 setHelp ($a_help_page, $a_help_icon, $a_help_icon_alt=0)
 set table help page @access public More...
 
 setHeaderNames ($a_header_names)
 set table header names @access public More...
 
 getColumnCount ()
 Returns the column count based on the number of the header row columns @access public. More...
 
 setHeaderVars ($a_header_vars, $a_header_params=0)
 set table header vars @access public More...
 
 setColumnWidth ($a_column_width)
 set table column widths @access public More...
 
 setOneColumnWidth ($a_column_width, $a_column_number)
 set one table column width @access public More...
 
 setMaxCount ($a_max_count)
 set max. More...
 
 setLimit ($a_limit=0, $a_default_limit=0)
 set max. More...
 
 getLimit ()
 Get limit. More...
 
 setPrefix ($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) @access public More...
 
 setOffset ($a_offset)
 set dataset offset @access public More...
 
 getOffset ()
 Get offset. More...
 
 setOrderColumn ($a_order_column=0, $a_default_column=0)
 set order column @access public More...
 
 getOrderColumn ()
 Get order column. More...
 
 setOrderDirection ($a_order_direction)
 set order direction @access public More...
 
 getOrderDirection ()
 Get order direction. More...
 
 setFooter ($a_style, $a_previous=0, $a_next=0)
 set order direction @access public More...
 
 enable ($a_module_name)
 enables particular modules of table More...
 
 disable ($a_module_name)
 diesables particular modules of table More...
 
 sortData ()
 
 render ()
 render table @access public More...
 
 renderHeader ()
 
 setOrderLink ($key, $order_dir)
 
 setStyle ($a_element, $a_style)
 
 getStyle ($a_element)
 
 setBase ($a_base)
 Set Base script name (deprecated, only use this for workarounds). More...
 
 getBase ()
 Get Base script name (deprecated, only use this for workarounds). More...
 
 getFormName ()
 
 setFormName ($a_name="cmd")
 
 getSelectAllCheckbox ()
 
 setSelectAllCheckbox ($a_select_all_checkbox)
 
 clearActionButtons ()
 
 addActionButton ($btn_name, $btn_value)
 

Data Fields

const F_PLUGIN_NAME = "plugin_name"
 
const F_PLUGIN_ID = "plugin_id"
 
const F_SLOT_NAME = "slot_name"
 
const F_COMPONENT_NAME = "component_name"
 
const F_PLUGIN_ACTIVE = "plugin_active"
 
- 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
 $title
 
 $icon
 
 $icon_alt
 
 $help_page
 
 $help_icon
 
 $help_icon_alt
 
 $header_names
 
 $header_vars
 
 $linkbar_vars
 
 $data
 
 $column_count
 
 $column_width
 
 $max_count
 
 $limit
 
 $max_limit = false
 
 $offset
 
 $order_column
 
 $order_direction
 
 $footer_style
 
 $footer_previous
 
 $footer_next
 
 $lang_support = true
 
 $global_tpl
 
 $form_name
 
 $select_all_checkbox
 
 $action_buttons
 
 $prefix
 
 $base = ""
 
 $enabled
 
 $styles
 

Protected Member Functions

 getComponents ()
 
 getModulesCoreItems ()
 
 getServicesCoreItems ()
 
 addPluginData (array &$plugins, array $core_items, string $core_type)
 
 gatherPluginData (string $a_type, ilPluginSlot $a_slot, string $a_slot_subdir, array $a_plugin)
 
 fillRow ($a_set)
 Standard Version of Fill Row. More...
 
 getActionMenu (array $actions, string $plugin_id)
 
 getActionMenuEntries (array $a_set)
 
 setParameter (array $a_set)
 
 clearParameter ()
 
 addCommandToActions (array &$actions, string $caption, string $command)
 
- Protected Member Functions inherited from ilTable2GUI
 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, $a_element)
 Check if filter element is based on adv md. More...
 
 fillRow ($a_set)
 Standard Version of Fill Row. More...
 
 getFilterValue (ilFormPropertyGUI $a_item)
 Get current filter value. More...
 
 SetFilterValue (ilFormPropertyGUI $a_item, $a_value)
 Set current filter value. More...
 
 fillMetaExcel (ilExcel $a_excel, &$a_row)
 Add meta information to excel export. More...
 
 fillHeaderExcel (ilExcel $a_excel, &$a_row)
 Excel Version of Fill Header. More...
 
 fillRowExcel (ilExcel $a_excel, &$a_row, $a_set)
 Excel Version of Fill Row. More...
 
 fillMetaCSV ($a_csv)
 Add meta information to csv export. More...
 
 fillHeaderCSV ($a_csv)
 CSV Version of Fill Header. More...
 
 fillRowCSV ($a_csv, $a_set)
 CSV Version of Fill Row. More...
 

Protected Attributes

 $filter_data
 
- Protected Attributes inherited from ilTable2GUI
 $ctrl
 
 $tpl
 
 $parent_obj
 
 $parent_cmd
 
 $close_command = ""
 
 $top_anchor = "il_table_top"
 
 $filters = array()
 
 $optional_filters = array()
 
 $filter_cmd = 'applyFilter'
 
 $reset_cmd = 'resetFilter'
 
 $filter_cols = 5
 
 $ext_sort = false
 
 $ext_seg = false
 
 $context = ""
 
 $mi_sel_buttons = []
 
 $disable_filter_hiding = false
 
 $selected_filter = false
 
 $top_commands = true
 
 $selectable_columns = array()
 
 $selected_column = array()
 
 $show_templates = false
 
 $show_rows_selector = true
 
 $rows_selector_off = false
 
 $nav_determined = false
 
 $limit_determined = false
 
 $filters_determined = false
 
 $columns_determined = false
 
 $open_form_tag = true
 
 $close_form_tag = true
 
 $export_formats = []
 
 $export_mode
 
 $print_mode
 
 $enable_command_for_all
 
 $restore_filter
 
 $restore_filter_values
 
 $default_filter_visibility = false
 
 $sortable_fields = array()
 
 $prevent_double_submission = true
 
 $row_selector_label
 
 $select_all_on_top = false
 
 $sel_buttons = []
 
- Protected Attributes inherited from ilTableGUI
 $tpl
 
 $lng
 

Additional Inherited Members

- Static Public Member Functions inherited from ilTable2GUI
static getAllCommandLimit ()
 Get maximum number of entries to enable actions for all. More...
 

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

ilPluginsOverviewTableGUI::__construct ( ilObjComponentSettingsGUI  $a_parent_obj,
array  $filter_data,
string  $a_parent_cmd = "" 
)

Definition at line 21 of file class.ilPluginsOverviewTableGUI.php.

22 {
23 global $DIC;
24 $this->lng = $DIC->language();
25 $this->ctrl = $DIC->ctrl();
26 $this->filter_data = $filter_data;
27
28 parent::__construct($a_parent_obj, $a_parent_cmd);
29
30 $this->setId("cmpspl");
31
32 $this->addColumn($this->lng->txt("cmps_plugin"), self::F_PLUGIN_NAME);
33 $this->addColumn($this->lng->txt("id"), self::F_PLUGIN_ID);
34 $this->addColumn($this->lng->txt("cmps_plugin_slot"), self::F_SLOT_NAME);
35 $this->addColumn($this->lng->txt("cmps_component"), self::F_COMPONENT_NAME);
36 $this->addColumn($this->lng->txt("active"), self::F_PLUGIN_ACTIVE);
37 $this->addColumn($this->lng->txt("action"));
38
39 $this->setDefaultOrderField(self::F_PLUGIN_NAME);
40
41 $this->setEnableHeader(true);
42 $this->setFormAction($this->ctrl->getFormAction($a_parent_obj));
43 $this->setRowTemplate(
44 "tpl.plugin_overview_row.html",
45 "Services/Component"
46 );
47 $this->getComponents();
48 $this->setLimit(10000);
49 }
setEnableHeader($a_enableheader)
Set Enable Header.
setRowTemplate($a_template, $a_template_dir="")
Set row template.
setLimit($a_limit=0, $a_default_limit=0)
set max.
setDefaultOrderField($a_defaultorderfield)
Set Default order field.
addColumn( $a_text, $a_sort_field="", $a_width="", $a_is_checkbox_action_column=false, $a_class="", $a_tooltip="", $a_tooltip_with_html=false)
Add a column to the header.
setId($a_val)
Set id.
setFormAction($a_form_action, $a_multipart=false)
Set Form action parameter.
global $DIC
Definition: goto.php:24
__construct(Container $dic, ilPlugin $plugin)
@inheritDoc

References $DIC, $filter_data, ILIAS\GlobalScreen\Provider\__construct(), ilTable2GUI\addColumn(), getComponents(), ilTable2GUI\setDefaultOrderField(), ilTable2GUI\setEnableHeader(), ilTable2GUI\setFormAction(), ilTable2GUI\setId(), ilTable2GUI\setLimit(), and ilTable2GUI\setRowTemplate().

+ Here is the call graph for this function:

Member Function Documentation

◆ addCommandToActions()

ilPluginsOverviewTableGUI::addCommandToActions ( array &  $actions,
string  $caption,
string  $command 
)
protected

Definition at line 274 of file class.ilPluginsOverviewTableGUI.php.

274 : void
275 {
276 $actions[$this->lng->txt($caption)]
277 = $this->ctrl->getLinkTarget($this->parent_obj, $command);
278 }

Referenced by getActionMenuEntries().

+ Here is the caller graph for this function:

◆ addPluginData()

ilPluginsOverviewTableGUI::addPluginData ( array &  $plugins,
array  $core_items,
string  $core_type 
)
protected
Parameters
array$plugins
array$core_items
$core_type

Definition at line 106 of file class.ilPluginsOverviewTableGUI.php.

107 {
108 foreach ($core_items as $core_item) {
109 $plugin_slots = ilComponent::lookupPluginSlots($core_type, $core_item["subdir"]);
110 foreach ($plugin_slots as $plugin_slot) {
111 $slot = new ilPluginSlot($core_type, $core_item["subdir"], $plugin_slot["id"]);
112 foreach ($slot->getPluginsInformation() as $plugin) {
113 if ($core_type && $slot && $core_item["subdir"] && is_array($plugin) && count($plugin) > 0) {
114 $plugins[] = $this->gatherPluginData($core_type, $slot, $core_item["subdir"], $plugin);
115 }
116 }
117 }
118 }
119 }
static lookupPluginSlots($a_type, $a_name)
Lookup all plugin slots of a component.
gatherPluginData(string $a_type, ilPluginSlot $a_slot, string $a_slot_subdir, array $a_plugin)

References XapiProxy\$plugin, gatherPluginData(), and ilComponent\lookupPluginSlots().

Referenced by getComponents().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ clearParameter()

ilPluginsOverviewTableGUI::clearParameter ( )
protected

Definition at line 266 of file class.ilPluginsOverviewTableGUI.php.

266 : void
267 {
268 $this->ctrl->setParameter($this->parent_obj, ilObjComponentSettingsGUI::P_CTYPE, null);
269 $this->ctrl->setParameter($this->parent_obj, ilObjComponentSettingsGUI::P_CNAME, null);
270 $this->ctrl->setParameter($this->parent_obj, ilObjComponentSettingsGUI::P_SLOT_ID, null);
271 $this->ctrl->setParameter($this->parent_obj, ilObjComponentSettingsGUI::P_PLUGIN_NAME, null);
272 }

References ilObjComponentSettingsGUI\P_CNAME, ilObjComponentSettingsGUI\P_CTYPE, ilObjComponentSettingsGUI\P_PLUGIN_NAME, and ilObjComponentSettingsGUI\P_SLOT_ID.

Referenced by getActionMenuEntries().

+ Here is the caller graph for this function:

◆ fillRow()

ilPluginsOverviewTableGUI::fillRow (   $a_set)
protected

Standard Version of Fill Row.

Most likely to be overwritten by derived class.

Parameters
array$a_setdata array

Reimplemented from ilTable2GUI.

Definition at line 163 of file class.ilPluginsOverviewTableGUI.php.

163 : void
164 {
165 global $DIC;
166 $rbacsystem = $DIC->rbac()->system();
167
168 $this->tpl->setVariable("TXT_SLOT_NAME", $a_set[self::F_SLOT_NAME]);
169 $this->tpl->setVariable(
170 "TXT_COMP_NAME",
171 $a_set["component_type"] . "/" . $a_set[self::F_COMPONENT_NAME]
172 );
173
174 if ($a_set[self::F_PLUGIN_ACTIVE]) {
175 $this->tpl->setCurrentBlock("active");
176 $this->tpl->setVariable("TXT_ACTIVE", $this->lng->txt("yes"));
177 $this->tpl->parseCurrentBlock();
178 } else {
179 $this->tpl->setCurrentBlock("inactive");
180 $this->tpl->setVariable("TXT_INACTIVE", $this->lng->txt("no"));
181 $this->tpl->parseCurrentBlock();
182 }
183
184 $this->tpl->setVariable("TXT_PLUGIN_NAME", $a_set[self::F_PLUGIN_NAME]);
185 $this->tpl->setVariable("TXT_PLUGIN_ID", $a_set[self::F_PLUGIN_ID]);
186
187 if ($rbacsystem->checkAccess('write', $_GET['ref_id'])) {
188 $actions = $this->getActionMenuEntries($a_set);
189 $this->tpl->setVariable("ACTION_SELECTOR", $this->getActionMenu($actions, $a_set[self::F_PLUGIN_ID]));
190 }
191 }
$_GET["client_id"]
getActionMenu(array $actions, string $plugin_id)

References $_GET, $DIC, getActionMenu(), and getActionMenuEntries().

+ Here is the call graph for this function:

◆ gatherPluginData()

ilPluginsOverviewTableGUI::gatherPluginData ( string  $a_type,
ilPluginSlot  $a_slot,
string  $a_slot_subdir,
array  $a_plugin 
)
protected
Parameters
string$a_type
ilPluginSlot$a_slot
string$a_slot_subdir
array$a_plugin
Returns
array
Exceptions
ilPluginException

Definition at line 129 of file class.ilPluginsOverviewTableGUI.php.

129 : array
130 {
131 if (!$a_plugin["component_type"]) {
132 return array();
133 }
134 $plugin_db_data = ilPlugin::getPluginRecord($a_plugin["component_type"], $a_plugin[self::F_COMPONENT_NAME], $a_plugin["slot_id"], $a_plugin["name"]);
135
136 $config_class = null;
137 if (ilPlugin::hasConfigureClass($a_slot->getPluginsDirectory(), $a_plugin, $plugin_db_data)
138 && $this->ctrl->checkTargetClass(ilPlugin::getConfigureClassName($a_plugin))
139 ) {
140 $config_class = strtolower(ilPlugin::getConfigureClassName($a_plugin));
141 }
142
143 return array(
144 self::F_SLOT_NAME => $a_slot->getSlotName(),
145 "component_type" => $a_type,
146 self::F_COMPONENT_NAME => $a_slot_subdir,
147 "slot_id" => $a_slot->getSlotId(),
148 self::F_PLUGIN_ID => $a_plugin["id"],
149 self::F_PLUGIN_NAME => $a_plugin["name"],
150 "must_install" => $a_plugin["must_install"],
151 self::F_PLUGIN_ACTIVE => $a_plugin["is_active"],
152 "activation_possible" => $a_plugin["activation_possible"],
153 "needs_update" => $a_plugin["needs_update"],
154 "config_class" => $config_class,
155 "has_lang" => (bool) sizeof(
157 $a_slot->getPluginsDirectory() . "/" . $a_plugin["name"] . "/lang"
158 )
159 )
160 );
161 }
getSlotId()
Get Slot ID.
getPluginsDirectory()
Get directory of.
getSlotName()
Get Slot Name.
static getPluginRecord(string $a_ctype, string $a_cname, string $a_slot_id, string $a_pname)
static getAvailableLangFiles(string $a_lang_directory)
Get array of all language files in the plugin.
static hasConfigureClass(string $a_slot_dir, array $plugin_data, array $plugin_db_data)
Has the plugin a configure class?
static getConfigureClassName(array $plugin_data)
Get plugin configure class name.

References ilPlugin\getAvailableLangFiles(), ilPlugin\getConfigureClassName(), ilPlugin\getPluginRecord(), ilPluginSlot\getPluginsDirectory(), ilPluginSlot\getSlotId(), ilPluginSlot\getSlotName(), and ilPlugin\hasConfigureClass().

Referenced by addPluginData().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getActionMenu()

ilPluginsOverviewTableGUI::getActionMenu ( array  $actions,
string  $plugin_id 
)
protected
Parameters
array$actions
string$plugin_id
Returns
string

Definition at line 198 of file class.ilPluginsOverviewTableGUI.php.

198 : string
199 {
200 $alist = new ilAdvancedSelectionListGUI();
201 $alist->setId($plugin_id);
202 $alist->setListTitle($this->lng->txt("actions"));
203
204 foreach ($actions as $caption => $cmd) {
205 $alist->addItem($caption, "", $cmd);
206 }
207
208 return $alist->getHTML();
209 }
User interface class for advanced drop-down selection lists.

Referenced by fillRow().

+ Here is the caller graph for this function:

◆ getActionMenuEntries()

ilPluginsOverviewTableGUI::getActionMenuEntries ( array  $a_set)
protected
Parameters
array$a_set
Returns
array

Definition at line 215 of file class.ilPluginsOverviewTableGUI.php.

215 : array
216 {
217 $this->setParameter($a_set);
218
219 $actions = array();
220 $this->ctrl->setParameter($this->parent_obj, self::F_PLUGIN_ID, $a_set[self::F_PLUGIN_ID]);
221 $this->addCommandToActions($actions, "info", "showPlugin");
222 $this->ctrl->setParameter($this->parent_obj, self::F_PLUGIN_ID, null);
223
224 if ($a_set["must_install"]) {
226 } else {
227 if ($a_set["config_class"]) {
228 $actions[$this->lng->txt("cmps_configure")]
229 = $this->ctrl->getLinkTargetByClass($a_set["config_class"], ilObjComponentSettingsGUI::CMD_CONFIGURE);
230 }
231
232 if ($a_set["has_lang"]) {
234 }
235
236 if ($a_set[self::F_PLUGIN_ACTIVE]) {
238 }
239
240 if ($a_set["activation_possible"]) {
242 }
243
244 // update button
245 if ($a_set["needs_update"]) {
247 }
248
249 // #17428
251 }
252
253 $this->clearParameter();
254
255 return $actions;
256 }
addCommandToActions(array &$actions, string $caption, string $command)

References addCommandToActions(), clearParameter(), ilObjComponentSettingsGUI\CMD_ACTIVATE_PLUGIN, ilObjComponentSettingsGUI\CMD_CONFIGURE, ilObjComponentSettingsGUI\CMD_CONFIRM_UNINSTALL_PLUGIN, ilObjComponentSettingsGUI\CMD_DEACTIVATE_PLUGIN, ilObjComponentSettingsGUI\CMD_INSTALL_PLUGIN, ilObjComponentSettingsGUI\CMD_REFRESH_LANGUAGES, ilObjComponentSettingsGUI\CMD_UPDATE_PLUGIN, and setParameter().

Referenced by fillRow().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getComponents()

ilPluginsOverviewTableGUI::getComponents ( )
protected

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

51 : void
52 {
53 $plugins = [];
54 $modules = $this->getModulesCoreItems();
55 $this->addPluginData($plugins, $modules, IL_COMP_MODULE);
56
57 $services = $this->getServicesCoreItems();
58 $this->addPluginData($plugins, $services, IL_COMP_SERVICE);
59
60 // apply filters
61
62 $active_filters = array_filter($this->filter_data, static function ($value) : bool {
63 return !empty($value);
64 });
65
66 $plugins = array_filter($plugins, static function (array $plugin_data) use ($active_filters) : bool {
67 $matches_filter = true;
68 if (isset($active_filters[self::F_PLUGIN_NAME])) {
69 $matches_filter = strpos($plugin_data[self::F_PLUGIN_NAME], $active_filters[self::F_PLUGIN_NAME]) !== false;
70 }
71 if (isset($active_filters[self::F_PLUGIN_ID])) {
72 $matches_filter = strpos($plugin_data[self::F_PLUGIN_ID], $active_filters[self::F_PLUGIN_ID]) !== false;
73 }
74 if (isset($active_filters[self::F_PLUGIN_ACTIVE])) {
75 $v = (int)$active_filters[self::F_PLUGIN_ACTIVE] === 1;
76 $matches_filter = $plugin_data[self::F_PLUGIN_ACTIVE] === $v && $matches_filter;
77 }
78 if (isset($active_filters[self::F_SLOT_NAME])) {
79 $matches_filter = in_array($plugin_data[self::F_SLOT_NAME], $active_filters[self::F_SLOT_NAME], true) && $matches_filter;
80 }
81 if (isset($active_filters[self::F_COMPONENT_NAME])) {
82 $matches_filter = in_array($plugin_data['component_type'] . '/' . $plugin_data['component_name'], $active_filters[self::F_COMPONENT_NAME], true) && $matches_filter;
83 }
84
85 return $matches_filter;
86 });
87
88 $this->setData($plugins);
89 }
const IL_COMP_SERVICE
const IL_COMP_MODULE
addPluginData(array &$plugins, array $core_items, string $core_type)
setData($a_data)
set table data @access public

References addPluginData(), F_PLUGIN_ACTIVE, getModulesCoreItems(), getServicesCoreItems(), IL_COMP_MODULE, IL_COMP_SERVICE, and ilTable2GUI\setData().

Referenced by __construct().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getModulesCoreItems()

ilPluginsOverviewTableGUI::getModulesCoreItems ( )
protected

Definition at line 91 of file class.ilPluginsOverviewTableGUI.php.

91 : array
92 {
94 }
static getAvailableCoreModules()
Get all available core modules.

References ilModule\getAvailableCoreModules().

Referenced by getComponents().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getServicesCoreItems()

ilPluginsOverviewTableGUI::getServicesCoreItems ( )
protected

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

96 : array
97 {
99 }
static getAvailableCoreServices()
Get all available core services.

References ilService\getAvailableCoreServices().

Referenced by getComponents().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setParameter()

ilPluginsOverviewTableGUI::setParameter ( array  $a_set)
protected

Definition at line 258 of file class.ilPluginsOverviewTableGUI.php.

258 : void
259 {
260 $this->ctrl->setParameter($this->parent_obj, ilObjComponentSettingsGUI::P_CTYPE, $a_set["component_type"]);
261 $this->ctrl->setParameter($this->parent_obj, ilObjComponentSettingsGUI::P_CNAME, $a_set[self::F_COMPONENT_NAME]);
262 $this->ctrl->setParameter($this->parent_obj, ilObjComponentSettingsGUI::P_SLOT_ID, $a_set["slot_id"]);
263 $this->ctrl->setParameter($this->parent_obj, ilObjComponentSettingsGUI::P_PLUGIN_NAME, $a_set[self::F_PLUGIN_NAME]);
264 }

References ilObjComponentSettingsGUI\P_CNAME, ilObjComponentSettingsGUI\P_CTYPE, ilObjComponentSettingsGUI\P_PLUGIN_NAME, and ilObjComponentSettingsGUI\P_SLOT_ID.

Referenced by getActionMenuEntries().

+ Here is the caller graph for this function:

Field Documentation

◆ $filter_data

ilPluginsOverviewTableGUI::$filter_data
protected

Definition at line 19 of file class.ilPluginsOverviewTableGUI.php.

Referenced by __construct().

◆ F_COMPONENT_NAME

const ilPluginsOverviewTableGUI::F_COMPONENT_NAME = "component_name"

◆ F_PLUGIN_ACTIVE

const ilPluginsOverviewTableGUI::F_PLUGIN_ACTIVE = "plugin_active"

◆ F_PLUGIN_ID

const ilPluginsOverviewTableGUI::F_PLUGIN_ID = "plugin_id"

◆ F_PLUGIN_NAME

const ilPluginsOverviewTableGUI::F_PLUGIN_NAME = "plugin_name"

◆ F_SLOT_NAME

const ilPluginsOverviewTableGUI::F_SLOT_NAME = "slot_name"

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