TableGUI class for search results. More...

Inheritance diagram for ilWebResourceEditableLinkTableGUI:

Collaboration diagram for ilWebResourceEditableLinkTableGUI:

Public Member Functions
	__construct ($a_parent_obj, $a_parent_cmd)
	Constructor.
	setInvalidLinks ($a_links)
	Invalid links.
	getInvalidLinks ()
	Get invalid links.
	parseSelectedLinks ($a_link_ids)
	Parse selected items.
	updateFromPost ()
	parse ()
	Parse Links.
Public Member Functions inherited from ilTable2GUI
&	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)
	getWebResourceItems ()
	Get Web resource items object.
Protected Member Functions inherited from ilTable2GUI
	prepareOutput ()
	Anything that must be done before HTML is generated.

Protected Attributes
	$web_res = null
	$invalid = 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 = 4
	$ext_sort = false
	$ext_seg = false
	$mi_sel_buttons = null
	$disable_filter_hiding = false
	$top_commands = false

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

Detailed Description

TableGUI class for search results.

Author: Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

Version: $Id$

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

Constructor & Destructor Documentation

ilWebResourceEditableLinkTableGUI::__construct	(	$a_parent_obj,
		$a_parent_cmd
	)

Constructor.

Reimplemented from ilTable2GUI.

Definition at line 25 of file class.ilWebResourceEditableLinkTableGUI.php.

References $ilCtrl, $lng, ilTable2GUI\addColumn(), ilTable2GUI\addCommandButton(), ilTable2GUI\addMultiCommand(), ilTable2GUI\getParentObject(), ilTable2GUI\setEnableHeader(), ilTable2GUI\setEnableNumInfo(), ilTable2GUI\setEnableTitle(), ilTable2GUI\setFormAction(), ilTable2GUI\setRowTemplate(), ilTable2GUI\setSelectAllCheckbox(), and ilTable2GUI\setTitle().

        {
                global $lng,$ilAccess,$ilCtrl;
                
                parent::__construct($a_parent_obj,$a_parent_cmd);
                
                // Initialize
                $this->web_res = new ilLinkResourceItems($this->getParentObject()->object->getId());
                
                
                $this->setTitle($lng->txt('webr_edit_links'));
                
                $this->addColumn('','','1px');
                $this->addColumn($this->lng->txt('title'),'title','25%');
                $this->addColumn($this->lng->txt('target'),'target','25%');
                $this->addColumn($this->lng->txt('valid'),'valid','10px');
                $this->addColumn($this->lng->txt('webr_active'),'active','10px');
                $this->addColumn($this->lng->txt('webr_disable_check'),'disable_check','10px');
                #$this->addColumn('','','10px');
                
                // TODO: Dynamic fields
                
                // TODO: sorting
                $this->setEnableHeader(true);
                $this->setFormAction($ilCtrl->getFormAction($this->getParentObject()));
                $this->setRowTemplate("tpl.webr_editable_link_row.html", 'Modules/WebResource');
                $this->setEnableTitle(true);
                $this->setEnableNumInfo(true);
                $this->setSelectAllCheckbox('link_ids');
                
                $this->addMultiCommand('confirmDeleteLink', $this->lng->txt('delete'));
                $this->addCommandButton('updateLinks', $this->lng->txt('save'));
        }

Here is the call graph for this function:

Member Function Documentation

ilWebResourceEditableLinkTableGUI::fillRow ( $a_set )

protected

See Also: ilTable2GUI::fillRow()

Reimplemented from ilTable2GUI.

Definition at line 164 of file class.ilWebResourceEditableLinkTableGUI.php.

References $ilCtrl, $lng, $param, ilParameterAppender\_getOptionSelect(), ilParameterAppender\_isEnabled(), ilDatePresentation\formatDate(), ilUtil\formCheckbox(), ilUtil\formSelect(), getInvalidLinks(), ilTable2GUI\getParentObject(), IL_CAL_UNIX, and ilParameterAppender\parameterToInfo().

        {
                global $ilCtrl,$lng;
                
                if(in_array($a_set['id'], $this->getInvalidLinks()))
                {
                        $this->tpl->setVariable('CSS_ROW','warn');
                }
                
                // Check
                $this->tpl->setVariable('VAL_ID',$a_set['id']);
                $this->tpl->setVariable('VAL_CHECKBOX',
                        ilUtil::formCheckbox(false, 'link_ids[]',$a_set['id'])
                );
                
                // Column title
                $this->tpl->setVariable('TXT_TITLE',$this->lng->txt('title'));
                $this->tpl->setVariable('VAL_TITLE',$a_set['title']);
                $this->tpl->setVariable('TXT_DESC',$this->lng->txt('description'));
                $this->tpl->setVariable('VAL_DESC',$a_set['description']);
                
                // Column Target
                $this->tpl->setVariable('TXT_TARGET',$this->lng->txt('target'));
                $this->tpl->setVariable('VAL_TARGET',$a_set['target']);
                
                $this->tpl->setVariable('TXT_LAST_CHECK',$this->lng->txt('webr_last_check_table'));
                $this->tpl->setVariable('LAST_CHECK',
                        $a_set['last_check'] ?
                        ilDatePresentation::formatDate(new ilDateTime($a_set['last_check'],IL_CAL_UNIX)) :
                        $this->lng->txt('no_date')
                );              
                
                // Valid
                $this->tpl->setVariable('VAL_VALID',
                        ilUtil::formCheckbox($a_set['valid'], 'links['.$a_set['id'].'][vali]', 1)
                );
                
                // Active
                $this->tpl->setVariable('VAL_ACTIVE',
                        ilUtil::formCheckbox($a_set['active'], 'links['.$a_set['id'].'][act]', 1)
                );
                // Valid
                $this->tpl->setVariable('VAL_CHECK',
                        ilUtil::formCheckbox($a_set['disable_check'], 'links['.$a_set['id'].'][che]', 1)
                );
                
                // Dynamic parameters
                foreach($a_set['params'] as $param_id => $param)
                {
                        $this->tpl->setCurrentBlock('dyn_del_row');
                        $this->tpl->setVariable('TXT_DYN_DEL',$this->lng->txt('delete'));
                        $ilCtrl->setParameterByClass(get_class($this->getParentObject()),'param_id',$param_id);
                        $this->tpl->setVariable('DYN_DEL_LINK',$ilCtrl->getLinkTarget($this->getParentObject(),'deleteParameter'));
                        $this->tpl->setVariable('VAL_DYN',ilParameterAppender::parameterToInfo($param['name'],$param['value']));
                        $this->tpl->parseCurrentBlock();
                }
                if($a_set['params'])
                {
                        $this->tpl->setCurrentBlock('dyn_del_rows');
                        $this->tpl->setVariable('TXT_EXISTING',$this->lng->txt('links_existing_params'));
                        $this->tpl->parseCurrentBlock();
                }
                
                if(ilParameterAppender::_isEnabled())
                {
                        $this->tpl->setCurrentBlock('dyn_add');
                        $this->tpl->setVariable('TXT_DYN_ADD',$this->lng->txt('links_add_param'));
                        
                        $this->tpl->setVariable('TXT_DYN_NAME',$this->lng->txt('links_name'));
                        $this->tpl->setVariable('TXT_DYN_VALUE',$this->lng->txt('links_value'));
                        $this->tpl->setVariable('VAL_DYN_NAME',$a_set['name']);
                        $this->tpl->setVariable('DYN_ID',$a_set['id']);
                        $this->tpl->setVariable(
                                'SEL_DYN_VAL',
                                ilUtil::formSelect(
                                        $a_set['value'] ? $a_set['value'] : 0,
                                        'links['.$a_set['id'].'][val]',
                                        ilParameterAppender::_getOptionSelect(),
                                        false,
                                        true)
                        );
                        $this->tpl->parseCurrentBlock();
                }
                // Edit
                /*
                $ilCtrl->setParameterByClass(get_class($this->getParentObject()), 'link_id', $a_set['id']);
                $this->tpl->setVariable('EDIT_LINK',
                        $ilCtrl->getLinkTargetByClass(get_class($this->getParentObject()),'editLink')
                );
                $ilCtrl->clearParametersByClass(get_class($this->getParentObject()));
                $this->tpl->setVariable('EDIT_ALT',$this->lng->txt('edit'));
                */
                
        }

Here is the call graph for this function:

ilWebResourceEditableLinkTableGUI::getInvalidLinks ( )

Get invalid links.

Returns

Definition at line 73 of file class.ilWebResourceEditableLinkTableGUI.php.

Referenced by fillRow().

        {
                return $this->invalid ? $this->invalid : array();
        }

Here is the caller graph for this function:

ilWebResourceEditableLinkTableGUI::getWebResourceItems ( )

protected

Get Web resource items object.

Returns: object ilLinkResourceItems

Definition at line 269 of file class.ilWebResourceEditableLinkTableGUI.php.

References $web_res.

Referenced by parse(), and parseSelectedLinks().

        {
                return $this->web_res;
        }

Here is the caller graph for this function:

ilWebResourceEditableLinkTableGUI::parse ( )

Parse Links.

Returns

Definition at line 134 of file class.ilWebResourceEditableLinkTableGUI.php.

References ilParameterAppender\_getParams(), getWebResourceItems(), and ilTable2GUI\setData().

        {
                $rows = array();
                
                $items = $this->getWebResourceItems()->sortItems(
                        $this->getWebResourceItems()->getAllItems()
                );
                
                foreach($items as $link)
                {
                        $tmp['id'] = $link['link_id'];
                        $tmp['title'] = $link['title'];
                        $tmp['description'] = $link['description'];
                        $tmp['target'] = $link['target'];
                        $tmp['link_id'] = $link['link_id'];
                        $tmp['active'] = $link['active'];
                        $tmp['disable_check'] = $link['disable_check'];
                        $tmp['valid'] = $link['valid'];
                        $tmp['last_check'] = $link['last_check'];
                        
                        $tmp['params'] = ilParameterAppender::_getParams($link['link_id']);
                        
                        $rows[] = $tmp;
                }
                $this->setData($rows);
        }

Here is the call graph for this function:

ilWebResourceEditableLinkTableGUI::parseSelectedLinks ( $a_link_ids )

Parse selected items.

Parameters

array $a_link_ids

Returns

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

References getWebResourceItems(), and ilTable2GUI\setData().

        {
                $rows = array();
                foreach($a_link_ids as $link_id)
                {
                        $link = $this->getWebResourceItems()->getItem($link_id);
                        $tmp['id'] = $link['link_id'];
                        $tmp['title'] = $link['title'];
                        $tmp['description'] = $link['description'];
                        $tmp['target'] = $link['target'];
                        $tmp['link_id'] = $link['link_id'];
                        $tmp['active'] = $link['active'];
                        $tmp['disable_check'] = $link['disable_check'];
                        $tmp['valid'] = $link['valid'];
                        $tmp['last_check'] = $link['last_check'];
                        $tmp['params'] = array();
                        
                        $rows[] = $tmp;
                }
                $this->setData($rows);
        }

Here is the call graph for this function:

ilWebResourceEditableLinkTableGUI::setInvalidLinks ( $a_links )

Invalid links.

Parameters

object $a_links

Returns

Definition at line 64 of file class.ilWebResourceEditableLinkTableGUI.php.

        {
                $this->invalid = $a_links;
        }

ilWebResourceEditableLinkTableGUI::updateFromPost ( )

Definition at line 106 of file class.ilWebResourceEditableLinkTableGUI.php.

References $_POST, ilTable2GUI\getData(), and ilTable2GUI\setData().

        {
                $rows = array();
                foreach($this->getData() as $link)
                {
                        $link_id = $link['id'];
                        
                        $tmp = $link;
                        $tmp['title'] = $_POST['links'][$link_id]['tit'];
                        $tmp['description'] = $_POST['links'][$link_id]['des'];
                        $tmp['target'] = $_POST['links'][$link_id]['tar'];
                        $tmp['valid'] = $_POST['links'][$link_id]['vali'];
                        $tmp['disable_check'] = $_POST['links'][$link_id]['che'];
                        $tmp['active'] = $_POST['links'][$link_id]['act'];
                        $tmp['value'] = $_POST['links'][$link_id]['val'];
                        $tmp['name'] = $_POST['links'][$link_id]['nam'];
                        $tmp['params'] = array();
                        
                        $rows[] = $tmp;
                }
                $this->setData($rows);
        }