ilAdvancedMDRecordTableGUI Class Reference

Inheritance diagram for ilAdvancedMDRecordTableGUI:

Collaboration diagram for ilAdvancedMDRecordTableGUI:

Public Member Functions
	__construct ($a_parent_obj, $a_parent_cmd= '')
	Constructor.
	fillRow ($a_set)
	Fill row.
	parseRecords ($a_records)
	Parse records.
Public Member Functions inherited from ilTable2GUI
	getParentObject ()
	Get parent object.
	getParentCmd ()
	Get parent command.
	setNoEntriesText ($a_text)
	Set text for an empty table.
	getNoEntriesText ()
	Get text for an empty table.
	setEnableTitle ($a_enabletitle)
	Set Enable Title.
	getEnableTitle ()
	Get Enable Title.
	setEnableHeader ($a_enableheader)
	Set Enable Header.
	getEnableHeader ()
	Get Enable Header.
	setTitle ($a_title, $a_icon=0, $a_icon_alt=0)
	set table title public
	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
	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.
	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.
	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.
	addCommandButton ($a_cmd, $a_text)
	Add Command button.
	setCloseCommand ($a_link)
	Add command for closing table.
	addMultiCommand ($a_cmd, $a_text)
	Add Command button.
	addHeaderCommand ($a_href, $a_text, $a_target="", $a_img="")
	Add Header Command (Link) (Image needed for now)
	addColumn ($a_text, $a_sort_field="", $a_width="")
	Add a column to the header.
	getNavParameter ()
	setOrderLink ($sort_field, $order_dir)
	fillHeader ()
	getHTML ()
	numericOrdering ($a_field)
	Should this field be sorted numeric?
	render ()
	render table public
	fillFooter ()
	Fill footer row.
	getLinkbar ($a_num)
	Get previous/next linkbar.
	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 public
	disable ($a_module_name)
	diesables particular modules of table public
	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 Attributes
	$lng = null
	$ctrl
Protected Attributes inherited from ilTable2GUI
	$close_command = ""

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

Author

Stefan Meyer smeye.nosp@m.r@da.nosp@m.tabay.nosp@m..de

Version

$Id$

Definition at line 35 of file class.ilAdvancedMDRecordTableGUI.php.

Constructor & Destructor Documentation

ilAdvancedMDRecordTableGUI::__construct	(		$a_parent_obj,
			$a_parent_cmd = ''
	)

Constructor.

public

Parameters

Reimplemented from ilTable2GUI.

Definition at line 47 of file class.ilAdvancedMDRecordTableGUI.php.

References $ilCtrl, $lng, ilTable2GUI\addColumn(), ilTable2GUI\setDefaultOrderDirection(), ilTable2GUI\setDefaultOrderField(), ilTable2GUI\setFormAction(), and ilTable2GUI\setRowTemplate().

        {
                global $lng,$ilCtrl;
                
                $this->lng = $lng;
                $this->ctrl = $ilCtrl;
                
                parent::__construct($a_parent_obj,$a_parent_cmd);
                $this->addColumn('','f',1);
                $this->addColumn($this->lng->txt('title'),'title',"30%");
                $this->addColumn($this->lng->txt('md_fields'),'fields',"35%");
                $this->addColumn($this->lng->txt('md_adv_active'),'active',"5%");
                $this->addColumn($this->lng->txt('md_obj_types'),'obj_types',"30%");
                
                $this->setFormAction($this->ctrl->getFormAction($a_parent_obj));
                $this->setRowTemplate("tpl.show_records_row.html","Services/AdvancedMetaData");
                $this->setDefaultOrderField("title");
                $this->setDefaultOrderDirection("desc");
        }

Here is the call graph for this function:

Member Function Documentation

ilAdvancedMDRecordTableGUI::fillRow

(

$a_set

)

Fill row.

public

Parameters

Reimplemented from ilTable2GUI.

Definition at line 74 of file class.ilAdvancedMDRecordTableGUI.php.

References ilAdvancedMDRecord\_getAssignableObjectTypes(), and ilAdvancedMDFieldDefinition\_getDefinitionsByRecordId().

        {
                foreach(ilAdvancedMDRecord::_getAssignableObjectTypes() as $obj_type)
                {
                        $this->tpl->setCurrentBlock('ass_obj_types');
                        $this->tpl->setVariable('VAL_OBJ_TYPE',$this->lng->txt('objs_'.$obj_type));
                        $this->tpl->setVariable('ASS_ID',$a_set['id']);
                        $this->tpl->setVariable('ASS_NAME',$obj_type);
                        if(in_array($obj_type,$a_set['obj_types']))
                        {
                                $this->tpl->setVariable('ASS_CHECKED','checked="checked"');
                        }
                        $this->tpl->parseCurrentBlock();
                }
                $this->tpl->setVariable('VAL_ID',$a_set['id']);
                $this->tpl->setVariable('VAL_TITLE',$a_set['title']);
                if(strlen($a_set['description']))
                {
                        $this->tpl->setVariable('VAL_DESCRIPTION',$a_set['description']);
                }
                $defs = ilAdvancedMDFieldDefinition::_getDefinitionsByRecordId($a_set['id']);
                if(!count($defs))
                {
                        $this->tpl->setVariable('TXT_FIELDS',$this->lng->txt('md_adv_no_fields'));
                }
                foreach($defs as $definition_obj)
                {
                        $this->tpl->setCurrentBlock('field_entry');
                        $this->tpl->setVariable('FIELD_NAME',$definition_obj->getTitle());
                        $this->tpl->parseCurrentBlock();
                }
                
                $this->tpl->setVariable('ACTIVE_CHECKED',$a_set['active'] ? ' checked="checked" ' : '');
                $this->tpl->setVariable('ACTIVE_ID',$a_set['id']);
                
                $this->ctrl->setParameter($this->parent_obj,'record_id',$a_set['id']);
                $this->tpl->setVariable('EDIT_LINK',$this->ctrl->getLinkTarget($this->parent_obj,'editRecord'));
                $this->tpl->setVariable('TXT_EDIT_RECORD',$this->lng->txt('edit'));
        }

Here is the call graph for this function:

ilAdvancedMDRecordTableGUI::parseRecords

(

$a_records

)

Parse records.

public

Parameters

array

array of record objects

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

References ilTable2GUI\setData().

        {
                foreach($a_records as $record)
                {
                        $tmp_arr['id'] = $record->getRecordId();
                        $tmp_arr['active'] = $record->isActive();
                        $tmp_arr['title'] = $record->getTitle();
                        $tmp_arr['description'] = $record->getDescription();
                        $tmp_arr['fields'] = array();
                        $tmp_arr['obj_types'] = $record->getAssignedObjectTypes();
                        
                        $records_arr[] = $tmp_arr;
                }
                $this->setData($records_arr ? $records_arr : array());
        }

Here is the call graph for this function:

Field Documentation

ilAdvancedMDRecordTableGUI::$ctrl

protected

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

ilAdvancedMDRecordTableGUI::$lng = null

protected

Definition at line 37 of file class.ilAdvancedMDRecordTableGUI.php.

Referenced by __construct().

---

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

• Services/AdvancedMetaData/classes/class.ilAdvancedMDRecordTableGUI.php