ILIAS  Release_4_4_x_branch Revision 61816
 All Data Structures Namespaces Files Functions Variables Groups Pages
Public Member Functions | Protected Member Functions | Protected Attributes
ilPresentationListTableGUI Class Reference
Modules/Glossary

Term list table for presentation mode. More...

+ Inheritance diagram for ilPresentationListTableGUI:
+ Collaboration diagram for ilPresentationListTableGUI:

Public Member Functions

 __construct ($a_parent_obj, $a_parent_cmd, $a_glossary, $a_offline, $a_tax_node, $a_tax_id=0)
 Constructor.
 initFilter ()
 Init filter.
 numericOrdering ($a_field)
 Should this field be sorted numeric?
- 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.
 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.
 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.
 setEnableAllCommand ($a_value)
 Enable actions for all entries in current result.
 setRowSelectorLabel ($row_selector_label)
 getRowSelectorLabel ()
- 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 ($term)
 Fill table 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.

Protected Attributes

 $adv_cols_order = array()
- 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 = 5
 $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
 $enable_command_for_all
 $row_selector_label

Additional Inherited Members

- Static Public Member Functions inherited from ilTable2GUI
static getAllCommandLimit ()
 Get maximum number of entries to enable actions for all.
- 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 EXPORT_EXCEL = 1
const EXPORT_CSV = 2
const ACTION_ALL_LIMIT = 1000

Detailed Description

Term list table for presentation mode.

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

ilPresentationListTableGUI: ilFormPropertyDispatchGUI

Definition at line 15 of file class.ilPresentationListTableGUI.php.

Constructor & Destructor Documentation

ilPresentationListTableGUI::__construct (   $a_parent_obj,
  $a_parent_cmd,
  $a_glossary,
  $a_offline,
  $a_tax_node,
  $a_tax_id = 0 
)

Constructor.

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

References $_GET, $ilCtrl, $lng, ilTable2GUI\addColumn(), ilTableGUI\disable(), ilGlossaryAdvMetaDataAdapter\getAllFields(), ilGlossaryAdvMetaDataAdapter\getColumnOrder(), initFilter(), ilTable2GUI\setData(), ilTable2GUI\setEnableHeader(), ilTable2GUI\setEnableTitle(), ilTable2GUI\setFilterCommand(), ilTable2GUI\setFormAction(), ilTable2GUI\setId(), ilTable2GUI\setRowTemplate(), and ilTable2GUI\setShowRowsSelector().

{
global $ilCtrl, $lng, $ilAccess, $lng;
$this->glossary = $a_glossary;
$this->offline = $a_offline;
$this->tax_node = $a_tax_node;
$this->tax_id = $a_tax_id;
$this->setId("glopr".$this->glossary->getId());
include_once("./Modules/Glossary/classes/class.ilGlossaryAdvMetaDataAdapter.php");
$adv_ad = new ilGlossaryAdvMetaDataAdapter($this->glossary->getId());
$this->adv_fields = $adv_ad->getAllFields();
parent::__construct($a_parent_obj, $a_parent_cmd);
//$this->setTitle($lng->txt("cont_terms"));
if ($this->glossary->getPresentationMode() == "full_def")
{
$this->addColumn($lng->txt("cont_terms"));
}
else
{
include_once("./Modules/Glossary/classes/class.ilGlossaryAdvMetaDataAdapter.php");
$adv_ap = new ilGlossaryAdvMetaDataAdapter($this->glossary->getId());
$this->adv_cols_order = $adv_ap->getColumnOrder();
foreach ($this->adv_cols_order as $c)
{
if ($c["id"] == 0)
{
$this->addColumn($lng->txt("cont_term"), "term");
}
else
{
$this->addColumn($c["text"], "md_".$c["id"]);
}
}
$this->addColumn($lng->txt("cont_definitions"));
if ($this->glossary->isVirtual())
{
$this->addColumn($lng->txt("obj_glo"));
}
}
$this->setEnableHeader(true);
if (!$this->offline)
{
$this->setFormAction($ilCtrl->getFormAction($this->parent_obj));
}
else
{
$this->disable("footer");
}
$this->setRowTemplate("tpl.term_tbl_pres_row.html", "Modules/Glossary");
$this->setEnableTitle(true);
if (!$this->offline)
{
$this->initFilter();
$this->setFilterCommand("applyFilter");
$this->setShowRowsSelector(true);
}
//$this->setDefaultOrderField("login");
//$this->setDefaultOrderDirection("asc");
$this->setData($this->glossary->getTermList($this->filter["term"], $_GET["letter"],
$this->filter["definition"], $this->tax_node, false, true, $this->filter));
// $this->setData(array());
}

+ Here is the call graph for this function:

Member Function Documentation

ilPresentationListTableGUI::fillRow (   $term)
protected

Fill table row.

Reimplemented from ilTable2GUI.

Definition at line 156 of file class.ilPresentationListTableGUI.php.

References $_GET, $ilCtrl, $lng, ilObject\_lookupTitle(), ilUtil\buildLatexImages(), ilDatePresentation\formatDate(), ilGlossaryDefinition\getDefinitionList(), IL_CAL_UNIX, ilUtil\insertLatexImages(), ilUtil\shortenText(), ilAdvancedMDFieldDefinition\TYPE_DATE, ilAdvancedMDFieldDefinition\TYPE_DATETIME, and ilPCParagraph\xml2output().

{
global $lng, $ilCtrl;
$defs = ilGlossaryDefinition::getDefinitionList($term["id"]);
$ilCtrl->setParameter($this->parent_obj, "term_id", $term["id"]);
if ($this->glossary->getPresentationMode() == "full_def")
{
$this->tpl->setCurrentBlock("fd_td");
$this->tpl->setVariable("FULL_DEF",
$this->parent_obj->listDefinitions($_GET["ref_id"], $term["id"], true));
$this->tpl->parseCurrentBlock();
}
else
{
for ($j=0; $j < count($defs); $j++)
{
$def = $defs[$j];
if (count($defs) > 1)
{
$this->tpl->setCurrentBlock("definition");
$this->tpl->setVariable("DEF_TEXT", $lng->txt("cont_definition")." ".($j + 1));
$this->tpl->parseCurrentBlock();
}
// check dirty short texts
$this->tpl->setCurrentBlock("definition");
if ($def["short_text_dirty"])
{
// #18022
$def_obj = new ilGlossaryDefinition($def["id"]);
$def_obj->updateShortText();
$short_str = $def_obj->getShortText();
}
else
{
$short_str = $def["short_text"];
}
// replace tex
// if a tex end tag is missing a tex end tag
$ltexs = strrpos($short_str, "[tex]");
$ltexe = strrpos($short_str, "[/tex]");
if ($ltexs > $ltexe)
{
$page = new ilGlossaryDefPage($def["id"]);
$page->buildDom();
$short_str = $page->getFirstParagraphText();
$short_str = strip_tags($short_str, "<br>");
$ltexe = strpos($short_str, "[/tex]", $ltexs);
$short_str = ilUtil::shortenText($short_str, $ltexe+6, true);
}
if (!$this->offline)
{
$short_str = ilUtil::insertLatexImages($short_str);
}
else
{
$short_str = ilUtil::buildLatexImages($short_str,
$this->parent_obj->getOfflineDirectory());
}
$short_str = ilPCParagraph::xml2output($short_str);
$this->tpl->setVariable("DEF_SHORT", $short_str);
$this->tpl->parseCurrentBlock();
$this->tpl->setCurrentBlock("definition_row");
$this->tpl->parseCurrentBlock();
}
// $this->tpl->touchBlock("def_td");
// display additional column 'glossary' for meta glossaries
if ($this->glossary->isVirtual())
{
$this->tpl->setCurrentBlock("glossary_row");
$glo_title = ilObject::_lookupTitle($term["glo_id"]);
$this->tpl->setVariable("GLO_TITLE", $glo_title);
$this->tpl->parseCurrentBlock();
}
}
$ilCtrl->clearParameters($this->parent_obj);
// advanced metadata
foreach ($this->adv_cols_order as $c)
{
if ($c["id"] == 0)
{
$this->tpl->setCurrentBlock("link_start");
if (!$this->offline)
{
if (!empty ($filter))
{
$ilCtrl->setParameter($this->parent_obj, "term", $filter);
$ilCtrl->setParameter($this->parent_obj, "oldoffset", $_GET["oldoffset"]);
}
$ilCtrl->setParameter($this->parent_obj, "term_id", $term["id"]);
$ilCtrl->setParameter($this->parent_obj, "offset", $_GET["offset"]);
$this->tpl->setVariable("LINK_VIEW_TERM",
$ilCtrl->getLinkTarget($this->parent_obj, "listDefinitions"));
$ilCtrl->clearParameters($this->parent_obj);
}
else
{
$this->tpl->setVariable("LINK_VIEW_TERM", "term_".$term["id"].".html");
}
$this->tpl->parseCurrentBlock();
$this->tpl->setCurrentBlock("link_end");
$this->tpl->setVariable("ANCHOR_TERM", "term_".$term["id"]);
$this->tpl->parseCurrentBlock();
$this->tpl->setCurrentBlock("td");
$this->tpl->setVariable("TEXT", $term["term"]);
$this->tpl->parseCurrentBlock();
}
else
{
$id = $c["id"];
$f = $this->adv_fields[$c["id"]];
$this->tpl->setCurrentBlock("td");
switch ($f["type"])
{
case ilAdvancedMDFieldDefinition::TYPE_DATETIME:
$val = ($term["md_".$id] > 0)
? ilDatePresentation::formatDate(new ilDateTime($term["md_".$id], IL_CAL_UNIX))
: " ";
break;
case ilAdvancedMDFieldDefinition::TYPE_DATE:
//var_dump($term["md_".$id]); echo "<br>";
$val = ($term["md_".$id] != 0)
? ilDatePresentation::formatDate(new ilDate($term["md_".$id], IL_CAL_UNIX))
: " ";
break;
default:
$val = ($term["md_".$id] != "")
? $term["md_".$id]
: " ";
break;
}
$this->tpl->setVariable("TEXT", $val);
$this->tpl->parseCurrentBlock();
}
}
}

+ Here is the call graph for this function:

ilPresentationListTableGUI::initFilter ( )

Init filter.

Reimplemented from ilTable2GUI.

Definition at line 99 of file class.ilPresentationListTableGUI.php.

References $ilUser, $lng, ilTable2GUI\addFilterItem(), ilAdvancedMDRecordGUI\MODE_FILTER, ilTextInputGUI\setMaxLength(), and ilAdvancedMDRecordGUI\setSelectedOnly().

Referenced by __construct().

{
global $lng, $rbacreview, $ilUser, $ilDB;
// term
include_once("./Services/Form/classes/class.ilTextInputGUI.php");
$ti = new ilTextInputGUI($lng->txt("cont_term"), "term");
$ti->setMaxLength(64);
$ti->setSize(20);
$ti->setSubmitFormOnEnter(true);
$this->addFilterItem($ti);
$ti->readFromSession();
$this->filter["term"] = $ti->getValue();
// definition
if ($ilDB->getDBType() != "oracle")
{
include_once("./Services/Form/classes/class.ilTextInputGUI.php");
$ti = new ilTextInputGUI($lng->txt("cont_definition"), "defintion");
$ti->setMaxLength(64);
$ti->setSize(20);
$ti->setSubmitFormOnEnter(true);
$this->addFilterItem($ti);
$ti->readFromSession();
$this->filter["definition"] = $ti->getValue();
}
// advanced metadata
include_once('Services/AdvancedMetaData/classes/class.ilAdvancedMDRecordGUI.php');
$record_gui = new ilAdvancedMDRecordGUI(ilAdvancedMDRecordGUI::MODE_FILTER,'glo',$this->glossary->getId(),'term');
$record_gui->setSelectedOnly(true);
$record_gui->setTableGUI($this);
$record_gui->parse();
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilPresentationListTableGUI::numericOrdering (   $a_field)

Should this field be sorted numeric?

Returns
boolean numeric ordering; default is false

Reimplemented from ilTable2GUI.

Definition at line 140 of file class.ilPresentationListTableGUI.php.

References ilAdvancedMDFieldDefinition\TYPE_DATE.

{
if (substr($a_field, 0, 3) == "md_")
{
$md_id = (int) substr($a_field, 3);
if ($this->adv_fields[$md_id]["type"] == ilAdvancedMDFieldDefinition::TYPE_DATE)
{
return true;
}
}
return false;
}

Field Documentation

ilPresentationListTableGUI::$adv_cols_order = array()
protected

Definition at line 17 of file class.ilPresentationListTableGUI.php.

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