ILIAS  release_5-4 Revision v5.4.26-12-gabc799a52e6
ilPluginsOverviewTableGUI Class Reference

TableGUI class for components listing. More...

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

Public Member Functions

 __construct ($a_parent_obj, $a_parent_cmd="")
 
 getComponents ()
 Get pages for list. More...
 
- 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)
 
 getData ()
 
 dataExists ()
 
 setPrefix ($a_prefix)
 
 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 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)
 
- Public Member Functions inherited from ilTableGUI
 __construct ($a_data=0, $a_global_tpl=true)
 Constructor. More...
 
 setTemplate ($a_tpl)
 set template public More...
 
getTemplateObject ()
 
 setData ($a_data)
 set table data public More...
 
 getData ()
 
 setTitle ($a_title, $a_icon=0, $a_icon_alt=0)
 set table title public More...
 
 setHelp ($a_help_page, $a_help_icon, $a_help_icon_alt=0)
 set table help page public More...
 
 setHeaderNames ($a_header_names)
 set table header names public More...
 
 getColumnCount ()
 Returns the column count based on the number of the header row columns public. More...
 
 setHeaderVars ($a_header_vars, $a_header_params=0)
 set table header vars public More...
 
 setColumnWidth ($a_column_width)
 set table column widths public More...
 
 setOneColumnWidth ($a_column_width, $a_column_number)
 set one table column width 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) public More...
 
 setOffset ($a_offset)
 set dataset offset public More...
 
 getOffset ()
 Get offset. More...
 
 setOrderColumn ($a_order_column=0, $a_default_column=0)
 set order column public More...
 
 getOrderColumn ()
 Get order column. More...
 
 setOrderDirection ($a_order_direction)
 set order direction public More...
 
 getOrderDirection ()
 Get order direction. More...
 
 setFooter ($a_style, $a_previous=0, $a_next=0)
 set order direction 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 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)
 

Protected Member Functions

 getModulesCoreItems ()
 Get all available modules. More...
 
 getServicesCoreItems ()
 Get all available services. More...
 
 addPluginData (array &$plugins, array $core_items, $core_type)
 Get plugin informations. More...
 
 gatherPluginData ($a_type, ilPluginSlot $a_slot, $a_slot_subdir, array $a_plugin)
 Process plugin data for table row. More...
 
 fillRow ($a_set)
 Standard Version of Fill Row. More...
 
 getActionMenu (array $actions, $plugin_id)
 Get action menu for each row. More...
 
 getActionMenuEntries (array $a_set)
 Get entries for action menu. More...
 
 setParameter (array $a_set)
 Set parameter for plugin. More...
 
 clearParameter ()
 Clear parameter. More...
 
 addCommandToActions (array &$actions, $caption, $command)
 Add command to actions. More...
 
- 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...
 

Private Attributes

 $mode
 

Additional Inherited Members

- Static Public Member Functions inherited from ilTable2GUI
static getAllCommandLimit ()
 Get maximum number of entries to enable actions for all. More...
 
- 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 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
 

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

ilPluginsOverviewTableGUI::__construct (   $a_parent_obj,
  $a_parent_cmd = "" 
)

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

References $DIC, ilTable2GUI\addColumn(), getComponents(), ilTable2GUI\setDefaultOrderField(), ilTable2GUI\setEnableHeader(), ilTable2GUI\setFormAction(), ilTable2GUI\setId(), ilTable2GUI\setLimit(), and ilTable2GUI\setRowTemplate().

23  {
24  global $DIC;
25  $this->lng = $DIC->language();
26  $this->ctrl = $DIC->ctrl();
27 
28  parent::__construct($a_parent_obj, $a_parent_cmd);
29 
30  $this->setId("cmpspl");
31 
32  $this->addColumn($this->lng->txt("cmps_plugin"), "plugin_name");
33  $this->addColumn($this->lng->txt("id"), "plugin_id");
34  $this->addColumn($this->lng->txt("cmps_plugin_slot"), "slot_name");
35  $this->addColumn($this->lng->txt("cmps_component"), "component_name");
36  $this->addColumn($this->lng->txt("active"), "plugin_active");
37  $this->addColumn($this->lng->txt("action"));
38 
39  $this->setDefaultOrderField("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 
50  include_once("./Services/UIComponent/AdvancedSelectionList/classes/class.ilAdvancedSelectionListGUI.php");
51  }
setDefaultOrderField($a_defaultorderfield)
Set Default order field.
global $DIC
Definition: saml.php:7
setId($a_val)
Set id.
setRowTemplate($a_template, $a_template_dir="")
Set row template.
setFormAction($a_form_action, $a_multipart=false)
Set Form action parameter.
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.
setEnableHeader($a_enableheader)
Set Enable Header.
setLimit($a_limit=0, $a_default_limit=0)
+ Here is the call graph for this function:

Member Function Documentation

◆ addCommandToActions()

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

Add command to actions.

Parameters
string[]&$actions
string$captionnot translated lang var
string$command
Returns
void

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

Referenced by getActionMenuEntries().

312  {
313  $actions[$this->lng->txt($caption)]
314  = $this->ctrl->getLinkTarget($this->parent_obj, $command);
315  }
+ Here is the caller graph for this function:

◆ addPluginData()

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

Get plugin informations.

Parameters
string[]&$plugins
string[]$core_items
sring$core_type
Returns
string[]

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

References gatherPluginData(), and ilComponent\lookupPluginSlots().

Referenced by getComponents().

106  {
107  foreach ($core_items as $core_item) {
108  $plugin_slots = ilComponent::lookupPluginSlots($core_type, $core_item["subdir"]);
109  foreach ($plugin_slots as $plugin_slot) {
110  $slot = new ilPluginSlot($core_type, $core_item["subdir"], $plugin_slot["id"]);
111  foreach ($slot->getPluginsInformation() as $plugin) {
112  if ($core_type && $slot && $core_item["subdir"] && is_array($plugin) && count($plugin) > 0) {
113  $plugins[] = $this->gatherPluginData($core_type, $slot, $core_item["subdir"], $plugin);
114  }
115  }
116  }
117  }
118  }
gatherPluginData($a_type, ilPluginSlot $a_slot, $a_slot_subdir, array $a_plugin)
Process plugin data for table row.
Plugin Slot.
static lookupPluginSlots($a_type, $a_name)
Lookup all plugin slots of a component.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ clearParameter()

ilPluginsOverviewTableGUI::clearParameter ( )
protected

Clear parameter.

Returns
void

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

Referenced by getActionMenuEntries().

294  {
295  $this->ctrl->setParameter($this->parent_obj, "ctype", null);
296  $this->ctrl->setParameter($this->parent_obj, "cname", null);
297  $this->ctrl->setParameter($this->parent_obj, "slot_id", null);
298  $this->ctrl->setParameter($this->parent_obj, "pname", null);
299  }
+ 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.

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

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

169  {
170  global $DIC;
171  $rbacsystem = $DIC->rbac()->system();
172 
173  $this->tpl->setVariable("TXT_SLOT_NAME", $a_set["slot_name"]);
174  $this->tpl->setVariable(
175  "TXT_COMP_NAME",
176  $a_set["component_type"] . "/" . $a_set["component_name"]
177  );
178 
179  if ($a_set["plugin_active"]) {
180  $this->tpl->setCurrentBlock("active");
181  $this->tpl->setVariable("TXT_ACTIVE", $this->lng->txt("yes"));
182  $this->tpl->parseCurrentBlock();
183  } else {
184  $this->tpl->setCurrentBlock("inactive");
185  $this->tpl->setVariable("TXT_INACTIVE", $this->lng->txt("no"));
186  $this->tpl->parseCurrentBlock();
187  }
188 
189  $this->tpl->setVariable("TXT_PLUGIN_NAME", $a_set["plugin_name"]);
190  $this->tpl->setVariable("TXT_PLUGIN_ID", $a_set["plugin_id"]);
191 
192  if ($rbacsystem->checkAccess('write', $_GET['ref_id'])) {
193  $actions = $this->getActionMenuEntries($a_set);
194  $this->tpl->setVariable("ACTION_SELECTOR", $this->getActionMenu($actions, $a_set["plugin_id"]));
195  }
196  }
global $DIC
Definition: saml.php:7
$_GET["client_id"]
getActionMenu(array $actions, $plugin_id)
Get action menu for each row.
getActionMenuEntries(array $a_set)
Get entries for action menu.
+ Here is the call graph for this function:

◆ gatherPluginData()

ilPluginsOverviewTableGUI::gatherPluginData (   $a_type,
ilPluginSlot  $a_slot,
  $a_slot_subdir,
array  $a_plugin 
)
protected

Process plugin data for table row.

Parameters
string$a_type
ilPluginSlot$a_slot
string$a_slot_subdir
array$a_plugin
Returns
array

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

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

Referenced by addPluginData().

132  {
133  if (!$a_plugin["component_type"]) {
134  return array();
135  }
136  $plugin_db_data = ilPlugin::getPluginRecord($a_plugin["component_type"], $a_plugin["component_name"], $a_plugin["slot_id"], $a_plugin["name"]);
137 
138  $config_class = null;
139  if (ilPlugin::hasConfigureClass($a_slot->getPluginsDirectory(), $a_plugin, $plugin_db_data)
140  && $this->ctrl->checkTargetClass(ilPlugin::getConfigureClassName($a_plugin))
141  ) {
142  $config_class = strtolower(ilPlugin::getConfigureClassName($a_plugin));
143  }
144 
145  return array("slot_name" => $a_slot->getSlotName(),
146  "component_type" => $a_type,
147  "component_name" => $a_slot_subdir,
148  "slot_id" => $a_slot->getSlotId(),
149  "plugin_id" => $a_plugin["id"],
150  "plugin_name" => $a_plugin["name"],
151  "must_install" => $a_plugin["must_install"],
152  "plugin_active" => $a_plugin["is_active"],
153  "activation_possible" => $a_plugin["activation_possible"],
154  "needs_update" => $a_plugin["needs_update"],
155  "config_class" => $config_class,
156  "has_lang" => (bool) sizeof(
158  $a_slot->getPluginsDirectory() . "/" . $a_plugin["name"] . "/lang"
159  )
160  ));
161  }
getSlotName()
Get Slot Name.
static getAvailableLangFiles(string $a_lang_directory)
Get array of all language files in the plugin.
static getPluginRecord(string $a_ctype, string $a_cname, string $a_slot_id, string $a_pname)
$a_type
Definition: workflow.php:92
static hasConfigureClass(string $a_slot_dir, array $plugin_data, array $plugin_db_data)
Has the plugin a configure class?
getSlotId()
Get Slot ID.
static getConfigureClassName(array $plugin_data)
Get plugin configure class name.
getPluginsDirectory()
Get directory of.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getActionMenu()

ilPluginsOverviewTableGUI::getActionMenu ( array  $actions,
  $plugin_id 
)
protected

Get action menu for each row.

Parameters
string[]$actions
int$plugin_id
Returns
ilAdvancedSelectionListGUI

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

Referenced by fillRow().

208  {
209  $alist = new ilAdvancedSelectionListGUI();
210  $alist->setId($plugin_id);
211  $alist->setListTitle($this->lng->txt("actions"));
212 
213  foreach ($actions as $caption => $cmd) {
214  $alist->addItem($caption, "", $cmd);
215  }
216 
217  return $alist->getHTML();
218  }
User interface class for advanced drop-down selection lists.
+ Here is the caller graph for this function:

◆ getActionMenuEntries()

ilPluginsOverviewTableGUI::getActionMenuEntries ( array  $a_set)
protected

Get entries for action menu.

Parameters
string[]$a_set
Returns
string[]

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

References addCommandToActions(), clearParameter(), and setParameter().

Referenced by fillRow().

229  {
230  $this->setParameter($a_set);
231 
232  $actions = array();
233  $this->ctrl->setParameter($this->parent_obj, "plugin_id", $a_set["plugin_id"]);
234  $this->addCommandToActions($actions, "info", "showPlugin");
235  $this->ctrl->setParameter($this->parent_obj, "plugin_id", null);
236 
237  if ($a_set["must_install"]) {
238  $this->addCommandToActions($actions, "cmps_install", "installPlugin");
239  } else {
240  if ($a_set["config_class"]) {
241  $actions[$this->lng->txt("cmps_configure")]
242  = $this->ctrl->getLinkTargetByClass($a_set["config_class"], "configure");
243  }
244 
245  if ($a_set["has_lang"]) {
246  $this->addCommandToActions($actions, "cmps_refresh", "refreshLanguages");
247  }
248 
249  if ($a_set["plugin_active"]) {
250  $this->addCommandToActions($actions, "cmps_deactivate", "deactivatePlugin");
251  }
252 
253  if ($a_set["activation_possible"]) {
254  $this->addCommandToActions($actions, "cmps_activate", "activatePlugin");
255  }
256 
257  // update button
258  if ($a_set["needs_update"]) {
259  $this->addCommandToActions($actions, "cmps_update", "updatePlugin");
260  }
261 
262  // #17428
263  $this->addCommandToActions($actions, "cmps_uninstall", "confirmUninstallPlugin");
264  }
265 
266  $this->clearParameter();
267 
268  return $actions;
269  }
setParameter(array $a_set)
Set parameter for plugin.
addCommandToActions(array &$actions, $caption, $command)
Add command to actions.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getComponents()

ilPluginsOverviewTableGUI::getComponents ( )

Get pages for list.

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

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

Referenced by __construct().

58  {
59  $plugins = array();
60  $modules = $this->getModulesCoreItems();
61  $this->addPluginData($plugins, $modules, IL_COMP_MODULE);
62 
63  $services = $this->getServicesCoreItems();
64  $this->addPluginData($plugins, $services, IL_COMP_SERVICE);
65 
66  $this->setData($plugins);
67  }
addPluginData(array &$plugins, array $core_items, $core_type)
Get plugin informations.
const IL_COMP_MODULE
getServicesCoreItems()
Get all available services.
getModulesCoreItems()
Get all available modules.
const IL_COMP_SERVICE
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getModulesCoreItems()

ilPluginsOverviewTableGUI::getModulesCoreItems ( )
protected

Get all available modules.

Returns
string[]

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

References ilModule\getAvailableCoreModules().

Referenced by getComponents().

76  {
77  include_once("./Services/Component/classes/class.ilModule.php");
78 
80  }
static getAvailableCoreModules()
Get all available core modules.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getServicesCoreItems()

ilPluginsOverviewTableGUI::getServicesCoreItems ( )
protected

Get all available services.

Returns
string[]

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

References ilService\getAvailableCoreServices().

Referenced by getComponents().

89  {
90  include_once("./Services/Component/classes/class.ilService.php");
91 
93  }
static getAvailableCoreServices()
Get all available core services.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setParameter()

ilPluginsOverviewTableGUI::setParameter ( array  $a_set)
protected

Set parameter for plugin.

Parameters
string[]$a_set
Returns
void

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

Referenced by getActionMenuEntries().

280  {
281  $this->ctrl->setParameter($this->parent_obj, "ctype", $a_set["component_type"]);
282  $this->ctrl->setParameter($this->parent_obj, "cname", $a_set["component_name"]);
283  $this->ctrl->setParameter($this->parent_obj, "slot_id", $a_set["slot_id"]);
284  $this->ctrl->setParameter($this->parent_obj, "pname", $a_set["plugin_name"]);
285  }
+ Here is the caller graph for this function:

Field Documentation

◆ $mode

ilPluginsOverviewTableGUI::$mode
private

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


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