ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5
ilLinkCheckerTableGUI Class Reference

class ilLinkCheckerTableGUI More...

+ Inheritance diagram for ilLinkCheckerTableGUI:
+ Collaboration diagram for ilLinkCheckerTableGUI:

Public Member Functions

 __construct (ilObjectGUI $parentGUIObject, $parentStdCmd)
 Constructor. More...
 
 setLinkChecker (ilLinkChecker $linkChecker)
 Set the link checker instance. More...
 
 getLinkChecker ()
 Gget the link checker instance. More...
 
 setRowHandler (ilLinkCheckerGUIRowHandling $rowHandler)
 Set the row handler. More...
 
 getRowHandler ()
 Get the row handler. More...
 
 setRefreshButton ($txt, $cmd)
 Set refresh button attributes. More...
 
 getRefreshButton ()
 get refresh button attributes More...
 
 prepareHTML ()
 Call this before using getHTML() More...
 
- Public Member Functions inherited from ilTable2GUI
 __construct ($a_parent_obj, $a_parent_cmd="", $a_template_context="")
 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)
 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...
 
 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
 ilTableGUI ($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)
 

Private Attributes

 $linkChecker = null
 
 $rowHandler = null
 
 $refreshButton = array('txt' => null, 'cmd' => null)
 

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 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 inherited from ilTable2GUI
 prepareOutput ()
 Anything that must be done before HTML is generated. 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 ($worksheet, &$a_row)
 Add meta information to excel export. More...
 
 fillHeaderExcel ($worksheet, &$a_row)
 Excel Version of Fill Header. More...
 
 fillRowExcel ($a_worksheet, &$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 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 = 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
 
 $sortable_fields = array()
 
 $prevent_double_submission = true
 
 $row_selector_label
 

Detailed Description

class ilLinkCheckerTableGUI

Author
Michael Jansen mjans.nosp@m.en@d.nosp@m.ataba.nosp@m.y.de
Version
$Id$

Definition at line 13 of file class.ilLinkCheckerTableGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilLinkCheckerTableGUI::__construct ( ilObjectGUI  $parentGUIObject,
  $parentStdCmd 
)

Constructor.

public

Parameters
ilObjectGUIInstance of the container gui object
stringParent standard command

Definition at line 53 of file class.ilLinkCheckerTableGUI.php.

54  {
55  parent::__construct($parentGUIObject, $parentStdCmd);
56  }

Member Function Documentation

◆ getLinkChecker()

ilLinkCheckerTableGUI::getLinkChecker ( )

Gget the link checker instance.

public

Returns
ilLinkChecker

Definition at line 80 of file class.ilLinkCheckerTableGUI.php.

References $linkChecker.

Referenced by prepareHTML().

+ Here is the caller graph for this function:

◆ getRefreshButton()

ilLinkCheckerTableGUI::getRefreshButton ( )

get refresh button attributes

public

Returns
array

Definition at line 136 of file class.ilLinkCheckerTableGUI.php.

References $refreshButton.

Referenced by prepareHTML().

+ Here is the caller graph for this function:

◆ getRowHandler()

ilLinkCheckerTableGUI::getRowHandler ( )

Get the row handler.

public

Returns
ilLinkCheckerGUIRowHandling

Definition at line 107 of file class.ilLinkCheckerTableGUI.php.

References $rowHandler.

Referenced by prepareHTML().

+ Here is the caller graph for this function:

◆ prepareHTML()

ilLinkCheckerTableGUI::prepareHTML ( )

Call this before using getHTML()

public

Returns
ilLinkCheckerTableGUI

Definition at line 149 of file class.ilLinkCheckerTableGUI.php.

References $ilCtrl, $lng, $refreshButton, ilTableGUI\$title, ilTable2GUI\addColumn(), ilTable2GUI\addCommandButton(), ilDatePresentation\formatDate(), getLinkChecker(), ilTable2GUI\getParentCmd(), ilTable2GUI\getParentObject(), getRefreshButton(), getRowHandler(), IL_CAL_UNIX, ilTable2GUI\setData(), ilTable2GUI\setEnableHeader(), ilTable2GUI\setEnableNumInfo(), ilTable2GUI\setEnableTitle(), ilTable2GUI\setFormAction(), ilTable2GUI\setLimit(), ilTable2GUI\setRowTemplate(), and ilTable2GUI\setTitle().

150  {
151  global $ilCtrl, $lng;
152 
153  // #11002
154  $lng->loadLanguageModule("webr");
155 
156  $title = $this->getParentObject()->object->getTitle().' ('.$lng->txt('invalid_links_tbl').')';
157  if($last_access = $this->getLinkChecker()->getLastCheckTimestamp())
158  {
159  $title .= ', '.$lng->txt('last_change').': '.
161  }
162  $this->setTitle($title);
163 
164  $invalidLinks = $this->getLinkChecker()->getInvalidLinksFromDB();
165  if(!count($invalidLinks))
166  {
167  #$this->setNoEntriesText($lng->txt('no_invalid_links'));
168  }
169  else
170  {
171  foreach($invalidLinks as $key => $invalidLink)
172  {
173  $invalidLinks[$key] = $this->getRowHandler()->formatInvalidLinkArray($invalidLink);
174  }
175  }
176 
177  $this->addColumn($lng->txt('title'), 'title', '20%');
178  $this->addColumn($lng->txt('url'), 'url', '80%');
179  $this->addColumn('', '', '10%');
180  $this->setLimit(32000);
181  $this->setEnableHeader(true);
182  $this->setData($invalidLinks);
183 
184  $this->setFormAction($ilCtrl->getFormAction($this->getParentObject(), $this->getParentCmd()));
185  $this->setRowTemplate('tpl.link_checker_table_row.html', 'Services/LinkChecker');
186  $this->setEnableTitle(true);
187  $this->setEnableNumInfo(false);
188 
189  $refreshButton = $this->getRefreshButton();
190  $this->addCommandButton($refreshButton['cmd'], $refreshButton['txt']);
191 
192  return $this;
193  }
addCommandButton($a_cmd, $a_text, $a_onclick='', $a_id="", $a_class=null)
Add Command button.
setEnableNumInfo($a_val)
Set enable num info.
getRefreshButton()
get refresh button attributes
const IL_CAL_UNIX
getParentCmd()
Get parent command.
getParentObject()
Get parent object.
global $ilCtrl
Definition: ilias.php:18
setTitle($a_title, $a_icon=0, $a_icon_alt=0)
Set title and title icon.
getRowHandler()
Get the row handler.
static formatDate(ilDateTime $date)
Format a date public.
Date and time handling
getLinkChecker()
Gget the link checker instance.
setRowTemplate($a_template, $a_template_dir="")
Set row template.
setFormAction($a_form_action, $a_multipart=false)
Set Form action parameter.
global $lng
Definition: privfeed.php:40
setEnableHeader($a_enableheader)
Set Enable Header.
setEnableTitle($a_enabletitle)
Set Enable Title.
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.
setLimit($a_limit=0, $a_default_limit=0)
+ Here is the call graph for this function:

◆ setLinkChecker()

ilLinkCheckerTableGUI::setLinkChecker ( ilLinkChecker  $linkChecker)

Set the link checker instance.

public

Parameters
ilLinkCheckerInstance of class ilLinkChecker
Returns
ilLinkCheckerTableGUI

Definition at line 66 of file class.ilLinkCheckerTableGUI.php.

References $linkChecker.

67  {
68  $this->linkChecker = $linkChecker;
69 
70  return $this;
71  }

◆ setRefreshButton()

ilLinkCheckerTableGUI::setRefreshButton (   $txt,
  $cmd 
)

Set refresh button attributes.

public

Parameters
stringtext
stringcommand
Returns
ilLinkCheckerTableGUI

Definition at line 121 of file class.ilLinkCheckerTableGUI.php.

References $cmd, and $txt.

122  {
123  $this->refreshButton['txt'] = $txt;
124  $this->refreshButton['cmd'] = $cmd;
125 
126  return $this;
127  }
$cmd
Definition: sahs_server.php:35
$txt
Definition: error.php:12

◆ setRowHandler()

ilLinkCheckerTableGUI::setRowHandler ( ilLinkCheckerGUIRowHandling  $rowHandler)

Set the row handler.

public

Parameters
ilLinkCheckerGUIRowHandlingInstance of interface ilLinkCheckerGUIRowHandling
Returns
ilLinkCheckerTableGUI

Definition at line 93 of file class.ilLinkCheckerTableGUI.php.

References $rowHandler.

94  {
95  $this->rowHandler = $rowHandler;
96 
97  return $this;
98  }

Field Documentation

◆ $linkChecker

ilLinkCheckerTableGUI::$linkChecker = null
private

Definition at line 23 of file class.ilLinkCheckerTableGUI.php.

Referenced by getLinkChecker(), and setLinkChecker().

◆ $refreshButton

ilLinkCheckerTableGUI::$refreshButton = array('txt' => null, 'cmd' => null)
private

Definition at line 43 of file class.ilLinkCheckerTableGUI.php.

Referenced by getRefreshButton(), and prepareHTML().

◆ $rowHandler

ilLinkCheckerTableGUI::$rowHandler = null
private

Definition at line 33 of file class.ilLinkCheckerTableGUI.php.

Referenced by getRowHandler(), and setRowHandler().


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