ILIAS  Release_4_2_x_branch Revision 61807
 All Data Structures Namespaces Files Functions Variables Groups Pages
Public Member Functions | Protected Member Functions
ilPluginsTableGUI Class Reference
Services/Component

TableGUI class for plugins listing. More...

+ Inheritance diagram for ilPluginsTableGUI:
+ Collaboration diagram for ilPluginsTableGUI:

Public Member Functions

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

Protected Member Functions

 fillRow ($a_set)
 Standard Version of Fill Row.
- Protected Member Functions inherited from ilTable2GUI
 prepareOutput ()
 Anything that must be done before HTML is generated.
 getFilterValue (ilFormPropertyGUI $a_item)
 Get current filter value.
 SetFilterValue (ilFormPropertyGUI $a_item, $a_value)
 Set current filter value.
 fillMetaExcel ($worksheet, &$a_row)
 Add meta information to excel export.
 fillHeaderExcel ($worksheet, &$a_row)
 Excel Version of Fill Row.
 fillRowExcel ($a_worksheet, &$a_row, $a_set)
 Excel Version of Fill Row.
 fillMetaCSV ($a_csv)
 Add meta information to csv export.
 fillHeaderCSV ($a_csv)
 CSV Version of Fill Header.
 fillRowCSV ($a_csv, $a_set)
 CSV Version of Fill Row.

Additional Inherited Members

- 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 EXPORT_EXCEL = 1
const EXPORT_CSV = 2
- Protected Attributes inherited from ilTable2GUI
 $close_command = ""
 $top_anchor = "il_table_top"
 $filters = array()
 $optional_filters = array()
 $filter_cmd = 'applyFilter'
 $reset_cmd = 'resetFilter'
 $filter_cols = 4
 $ext_sort = false
 $ext_seg = false
 $context = ""
 $mi_sel_buttons = null
 $disable_filter_hiding = false
 $selected_filter = false
 $top_commands = true
 $selectable_columns = array()
 $selected_column = array()
 $show_templates = false
 $show_rows_selector = 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

Detailed Description

TableGUI class for plugins listing.

Author
Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e
Version
$Id$

Definition at line 16 of file class.ilPluginsTableGUI.php.

Member Function Documentation

ilPluginsTableGUI::fillRow (   $a_set)
protected

Standard Version of Fill Row.

Most likely to be overwritten by derived class.

Reimplemented from ilTable2GUI.

Definition at line 62 of file class.ilPluginsTableGUI.php.

References $_GET, $file, $ilCtrl, $ilDB, $lang, $lng, ilPlugin\getAvailableLangFiles(), ilPlugin\getConfigureClassName(), ilPlugin\getDBUpdateScriptName(), ilPlugin\hasConfigureClass(), and ilPluginSlot\lookupSlotName().

{
global $lng, $ilCtrl, $ilDB;
$ilCtrl->setParameter($this->parent_obj, "ctype", $_GET["ctype"]);
$ilCtrl->setParameter($this->parent_obj, "cname", $_GET["cname"]);
$ilCtrl->setParameter($this->parent_obj, "slot_id", $_GET["slot_id"]);
$ilCtrl->setParameter($this->parent_obj, "pname", $a_set["name"]);
// dbupdate
$file = ilPlugin::getDBUpdateScriptName($_GET["ctype"], $_GET["cname"],
ilPluginSlot::lookupSlotName($_GET["ctype"], $_GET["cname"], $_GET["slot_id"]),
$a_set["name"]);
if (@is_file($file))
{
include_once("./Services/Component/classes/class.ilPluginDBUpdate.php");
$dbupdate = new ilPluginDBUpdate($_GET["ctype"], $_GET["cname"],
$_GET["slot_id"], $a_set["name"], $ilDB, true, "");
// update command
/* if ($dbupdate->getFileVersion() > $dbupdate->getCurrentVersion())
{
$this->tpl->setCurrentBlock("db_update_cmd");
$this->tpl->setVariable("TXT_UPDATE_DB",
$lng->txt("cmps_update_db"));
$this->tpl->setVariable("HREF_UPDATE_DB",
$ilCtrl->getLinkTarget($this->parent_obj, "updatePluginDB"));
$this->tpl->parseCurrentBlock();
}
*/
// db version
$this->tpl->setCurrentBlock("db_versions");
$this->tpl->setVariable("TXT_CURRENT_VERSION",
$lng->txt("cmps_current_version"));
$this->tpl->setVariable("VAL_CURRENT_VERSION",
$dbupdate->getCurrentVersion());
$this->tpl->setVariable("TXT_FILE_VERSION",
$lng->txt("cmps_file_version"));
$this->tpl->setVariable("VAL_FILE_VERSION",
$dbupdate->getFileVersion());
$this->tpl->parseCurrentBlock();
$this->tpl->setCurrentBlock("db_update");
$this->tpl->setVariable("DB_UPDATE_FILE",
"dbupdate.php");
}
else
{
$this->tpl->setCurrentBlock("db_update");
$this->tpl->setVariable("DB_UPDATE_FILE",
$lng->txt("cmps_no_db_update_file_available"));
}
$this->tpl->parseCurrentBlock();
// language files
$langs = ilPlugin::getAvailableLangFiles($this->slot->getPluginsDirectory()."/".
$a_set["name"]."/lang");
if (count($langs) == 0)
{
$this->tpl->setCurrentBlock("lang");
$this->tpl->setVariable("VAL_LANG_FILE",
$lng->txt("cmps_no_language_file_available"));
$this->tpl->parseCurrentBlock();
}
foreach($langs as $lang)
{
$this->tpl->setCurrentBlock("lang");
$this->tpl->setVariable("VAL_LANG_FILE",
$lang["file"]);
$this->tpl->parseCurrentBlock();
}
// activation button
if ($a_set["activation_possible"])
{
$this->tpl->setCurrentBlock("activate");
$this->tpl->setVariable("HREF_ACTIVATE",
$ilCtrl->getLinkTarget($this->parent_obj, "activatePlugin"));
$this->tpl->setVariable("TXT_ACTIVATE",
$lng->txt("cmps_activate"));
$this->tpl->parseCurrentBlock();
}
// deactivation/refresh languages button
if ($a_set["is_active"])
{
// deactivate button
$this->tpl->setCurrentBlock("deactivate");
$this->tpl->setVariable("HREF_DEACTIVATE",
$ilCtrl->getLinkTarget($this->parent_obj, "deactivatePlugin"));
$this->tpl->setVariable("TXT_DEACTIVATE",
$lng->txt("cmps_deactivate"));
$this->tpl->parseCurrentBlock();
// refresh languages button
if (count($langs) > 0)
{
$this->tpl->setCurrentBlock("refresh_langs");
$this->tpl->setVariable("HREF_REFRESH_LANGS",
$ilCtrl->getLinkTarget($this->parent_obj, "refreshLanguages"));
$this->tpl->setVariable("TXT_REFRESH_LANGS",
$lng->txt("cmps_refresh"));
$this->tpl->parseCurrentBlock();
}
// configure button
if (ilPlugin::hasConfigureClass($this->slot->getPluginsDirectory(), $a_set["name"]) &&
$ilCtrl->checkTargetClass(ilPlugin::getConfigureClassName($a_set["name"])))
{
$this->tpl->setCurrentBlock("configure");
$this->tpl->setVariable("HREF_CONFIGURE",
$ilCtrl->getLinkTargetByClass(strtolower(ilPlugin::getConfigureClassName($a_set["name"])), "configure"));
$this->tpl->setVariable("TXT_CONFIGURE",
$lng->txt("cmps_configure"));
$this->tpl->parseCurrentBlock();
}
}
// update button
if ($a_set["needs_update"])
{
$this->tpl->setCurrentBlock("update");
$this->tpl->setVariable("HREF_UPDATE",
$ilCtrl->getLinkTarget($this->parent_obj, "updatePlugin"));
$this->tpl->setVariable("TXT_UPDATE",
$lng->txt("cmps_update"));
$this->tpl->parseCurrentBlock();
}
if (strlen($a_set["responsible"]))
{
$this->tpl->setCurrentBlock("responsible_mail");
$this->tpl->setVariable("VAL_PLUGIN_RESPONSIBLE_MAIL", $a_set["responsible_mail"]);
$this->tpl->parseCurrentBlock();
$this->tpl->setCurrentBlock("responsible");
$this->tpl->setVariable("TXT_RESPONSIBLE", $lng->txt("cmps_responsible"));
$this->tpl->setVariable("VAL_PLUGIN_RESPONSIBLE", $a_set["responsible"]);
$this->tpl->parseCurrentBlock();
}
$this->tpl->setVariable("VAL_PLUGIN_NAME", $a_set["name"]);
$this->tpl->setVariable("VAL_PLUGIN_ID", $a_set["id"]);
$this->tpl->setVariable("TXT_PLUGIN_NAME", $lng->txt("cmps_name"));
$this->tpl->setVariable("TXT_PLUGIN_ID", $lng->txt("cmps_id"));
$this->tpl->setVariable("TXT_PLUGIN_VERSION", $lng->txt("cmps_version"));
$this->tpl->setVariable("TXT_PHP_FILE", "plugin.php");
$this->tpl->setVariable("TXT_CLASS_FILE", $lng->txt("cmps_class_file"));
$this->tpl->setVariable("VAL_CLASS_FILE", $a_set["class_file"]);
$this->tpl->setVariable("TXT_VERSION", $lng->txt("cmps_version"));
$this->tpl->setVariable("VAL_PLUGIN_VERSION", $a_set["version"]);
$this->tpl->setVariable("TXT_ILIAS_MIN", $lng->txt("cmps_ilias_min_version"));
$this->tpl->setVariable("VAL_ILIAS_MIN", $a_set["ilias_min_version"]);
$this->tpl->setVariable("TXT_ILIAS_MAX", $lng->txt("cmps_ilias_max_version"));
$this->tpl->setVariable("VAL_ILIAS_MAX", $a_set["ilias_max_version"]);
$this->tpl->setVariable("TXT_STATUS", $lng->txt("cmps_status"));
if ($a_set["is_active"])
{
$this->tpl->setVariable("VAL_STATUS", $lng->txt("cmps_active"));
}
else
{
$r = ($a_set["inactive_reason"] != "")
? " (".$a_set["inactive_reason"].")"
: "";
$this->tpl->setVariable("VAL_STATUS", $lng->txt("cmps_inactive").$r);
}
if ($a_set["plugin_php_file_status"])
{
$this->tpl->setVariable("VAL_PLUGIN_PHP_FILE_STATUS", $lng->txt("cmps_available"));
}
else
{
$this->tpl->setVariable("VAL_PLUGIN_PHP_FILE_STATUS", $lng->txt("cmps_missing"));
}
if ($a_set["class_file_status"])
{
$this->tpl->setVariable("VAL_CLASS_FILE_STATUS", $lng->txt("cmps_available"));
}
else
{
$this->tpl->setVariable("VAL_CLASS_FILE_STATUS", $lng->txt("cmps_missing"));
}
}

+ Here is the call graph for this function:

ilPluginsTableGUI::getPlugins ( )

Get pages for list.

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

References ilTable2GUI\setData().

Referenced by ilPluginsTableGUI().

{
$plugins = $this->slot->getPluginsInformation();
//var_dump($plugins);
$this->setData($plugins);
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilPluginsTableGUI::ilPluginsTableGUI (   $a_parent_obj,
  $a_parent_cmd = "",
  $a_c_type,
  $a_c_name,
  $a_slot_id 
)

Definition at line 18 of file class.ilPluginsTableGUI.php.

References $ilCtrl, $lng, ilTable2GUI\__construct(), ilTable2GUI\addColumn(), getPlugins(), ilTable2GUI\setEnableHeader(), ilTable2GUI\setFormAction(), ilTableGUI\setLimit(), ilTable2GUI\setRowTemplate(), and ilTable2GUI\setTitle().

{
global $ilCtrl, $lng;
include_once("./Services/Component/classes/class.ilPluginSlot.php");
$this->slot = new ilPluginSlot($a_c_type, $a_c_name, $a_slot_id);
parent::__construct($a_parent_obj, $a_parent_cmd);
//$this->addColumn($lng->txt("cmps_module"));
$this->addColumn($lng->txt("cmps_plugin"));
$this->addColumn($lng->txt("cmps_basic_files"));
$this->addColumn($lng->txt("cmps_languages"));
$this->addColumn($lng->txt("cmps_database"));
$this->setEnableHeader(true);
$this->setFormAction($ilCtrl->getFormAction($a_parent_obj));
$this->setRowTemplate("tpl.table_row_plugin.html",
"Services/Component");
$this->getPlugins();
//$this->setDefaultOrderField("subdir");
$this->setLimit(10000);
// save options command
//$this->addCommandButton("saveOptions", $lng->txt("cmps_save_options"));
$this->setTitle($lng->txt("cmps_plugins"));
}

+ Here is the call graph for this function:

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