ILIAS  Release_4_0_x_branch Revision 61816
 All Data Structures Namespaces Files Functions Variables Groups Pages
Public Member Functions | Protected Member Functions | Private Attributes
ilComponentsTableGUI Class Reference
Services/Component

TableGUI class for components listing. More...

+ Inheritance diagram for ilComponentsTableGUI:
+ Collaboration diagram for ilComponentsTableGUI:

Public Member Functions

 ilComponentsTableGUI ($a_parent_obj, $a_parent_cmd="", $a_mode=IL_COMP_MODULE)
 getComponents ()
 Get pages for list.
- Public Member Functions inherited from ilTable2GUI
 __construct ($a_parent_obj, $a_parent_cmd="")
 Constructor.
& 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.
 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 disable filter hiding.
 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= '')
 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="")
 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
- 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.
 getLimit ()
 Get limit.
 setOffset ($a_offset)
 set dataset offset public
 getOffset ()
 Get offset.
 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.

Private Attributes

 $mode

Additional Inherited Members

- 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
 $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
 $mi_sel_buttons = null
 $disable_filter_hiding = false
 $top_commands = false

Detailed Description

TableGUI class for components listing.

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

Definition at line 36 of file class.ilComponentsTableGUI.php.

Member Function Documentation

ilComponentsTableGUI::fillRow (   $a_set)
protected

Standard Version of Fill Row.

Most likely to be overwritten by derived class.

Reimplemented from ilTable2GUI.

Definition at line 103 of file class.ilComponentsTableGUI.php.

References $ilCtrl, $ilSetting, $lng, ilUtil\getImagePath(), IL_COMP_MODULE, ilComponent\lookupPluginSlots(), and ilUtil\prepareFormOutput().

{
global $lng, $ilCtrl, $ilSetting, $objDefinition;
// plugin slots
$plugin_slots = ilComponent::lookupPluginSlots($this->mode, $a_set["subdir"]);
foreach ($plugin_slots as $slot)
{
$this->tpl->setCurrentBlock("slot");
$this->tpl->setVariable("SLOT_NAME", $slot["name"]);
$this->tpl->setVariable("SLOT_ID", $slot["id"]);
$this->tpl->setVariable("TXT_DIR", $lng->txt("cmps_dir"));
$this->tpl->setVariable("SLOT_DIR", $slot["dir_pres"]);
$this->tpl->setVariable("TXT_LANG_PREFIX", $lng->txt("cmps_lang_prefix"));
$this->tpl->setVariable("LANG_PREFIX", $slot["lang_prefix"]);
$ilCtrl->setParameter($this->parent_obj, "ctype", $this->mode);
$ilCtrl->setParameter($this->parent_obj, "cname", $a_set["subdir"]);
$ilCtrl->setParameter($this->parent_obj, "slot_id", $slot["id"]);
$this->tpl->setVariable("HREF_SHOW_SLOT",
$ilCtrl->getLinkTarget($this->parent_obj, "showPluginSlot"));
$this->tpl->setVariable("TXT_SHOW_SLOT", $lng->txt("cmps_show_details"));
$this->tpl->parseCurrentBlock();
}
// repository object types
if ($this->mode == IL_COMP_MODULE)
{
$rep_types =
$objDefinition->getRepositoryObjectTypesForComponent(IL_COMP_MODULE, $a_set["subdir"]);
foreach ($rep_types as $rt)
{
// group
if ($rt["grp"] != "")
{
$this->tpl->setCurrentBlock("group");
$this->tpl->setVariable("TXT_GROUP", $lng->txt("cmps_group"));
$gi = $objDefinition->getGroup($rt["grp"]);
$this->tpl->setVariable("VAL_GROUP", $gi["name"]);
$this->tpl->setVariable("VAL_GROUP_ID", $rt["grp"]);
$this->tpl->parseCurrentBlock();
}
$this->tpl->setCurrentBlock("rep_object");
$this->tpl->setVariable("TXT_REP_OBJECT",
$rt["class_name"]);
$this->tpl->setVariable("TXT_REP_OBJECT_ID",
$rt["id"]);
$this->tpl->setVariable("IMG_REP_OBJECT",
ilUtil::getImagePath("icon_".$rt["id"].".gif"));
// add new position
$this->tpl->setVariable("TXT_ADD_NEW_POS",
$lng->txt("cmps_add_new_rank"));
$this->tpl->setVariable("VAR_POS",
"obj_pos[".$rt["id"]."]");
$pos = ($ilSetting->get("obj_add_new_pos_".$rt["id"]) > 0)
? $ilSetting->get("obj_add_new_pos_".$rt["id"])
: $rt["default_pos"];
$this->tpl->setVariable("VAL_POS",
ilUtil::prepareFormOutput($pos));
// disable creation
$this->tpl->setVariable("TXT_DISABLE_CREATION",
$lng->txt("cmps_disable_creation"));
$this->tpl->setVariable("VAR_DISABLE_CREATION",
"obj_dis_creation[".$rt["id"]."]");
if ($ilSetting->get("obj_dis_creation_".$rt["id"]))
{
$this->tpl->setVariable("CHECKED_DISABLE_CREATION",
' checked="checked" ');
}
$this->tpl->parseCurrentBlock();
}
$this->tpl->setCurrentBlock("rep_object_td");
if (count($rep_types) == 0)
{
$this->tpl->setVariable("DUMMY", " ");
}
$this->tpl->parseCurrentBlock();
}
$this->tpl->setVariable("TXT_MODULE_NAME", $a_set["subdir"]);
}

+ Here is the call graph for this function:

ilComponentsTableGUI::getComponents ( )

Get pages for list.

Definition at line 83 of file class.ilComponentsTableGUI.php.

References ilModule\getAvailableCoreModules(), ilService\getAvailableCoreServices(), IL_COMP_MODULE, and ilTable2GUI\setData().

Referenced by ilComponentsTableGUI().

{
if ($this->mode == IL_COMP_MODULE)
{
include_once("./Services/Component/classes/class.ilModule.php");
$modules = ilModule::getAvailableCoreModules();
$this->setData($modules);
}
else
{
include_once("./Services/Component/classes/class.ilService.php");
$services = ilService::getAvailableCoreServices();
$this->setData($services);
}
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilComponentsTableGUI::ilComponentsTableGUI (   $a_parent_obj,
  $a_parent_cmd = "",
  $a_mode = IL_COMP_MODULE 
)

Definition at line 40 of file class.ilComponentsTableGUI.php.

References $ilCtrl, $lng, ilTable2GUI\__construct(), ilTable2GUI\addColumn(), ilTable2GUI\addCommandButton(), getComponents(), IL_COMP_MODULE, ilTable2GUI\setDefaultOrderField(), ilTable2GUI\setEnableHeader(), ilTable2GUI\setFormAction(), ilTableGUI\setLimit(), ilTable2GUI\setRowTemplate(), and ilTable2GUI\setTitle().

{
global $ilCtrl, $lng;
$this->mode = $a_mode;
parent::__construct($a_parent_obj, $a_parent_cmd);
if ($this->mode == IL_COMP_MODULE)
{
$this->addColumn($lng->txt("cmps_module"));
$this->addColumn($lng->txt("cmps_rep_object"));
}
else
{
$this->addColumn($lng->txt("cmps_service"));
}
$this->addColumn($lng->txt("cmps_plugin_slot"));
$this->setEnableHeader(true);
$this->setFormAction($ilCtrl->getFormAction($a_parent_obj));
$this->setRowTemplate("tpl.table_row_component.html",
"Services/Component");
$this->getComponents();
$this->setDefaultOrderField("subdir");
$this->setLimit(10000);
// save options command
$this->addCommandButton("saveOptions", $lng->txt("cmps_save_options"));
if ($this->mode == IL_COMP_MODULE)
{
$this->setTitle($lng->txt("cmps_modules"));
}
else
{
$this->setTitle($lng->txt("cmps_services"));
}
}

+ Here is the call graph for this function:

Field Documentation

ilComponentsTableGUI::$mode
private

Definition at line 38 of file class.ilComponentsTableGUI.php.

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