ILIAS  Release_4_1_x_branch Revision 61804
 All Data Structures Namespaces Files Functions Variables Groups Pages
Public Member Functions | Data Fields | Protected Member Functions | Private Attributes
ilSessionParticipantsTableGUI Class Reference
Modules/Session
+ Inheritance diagram for ilSessionParticipantsTableGUI:
+ Collaboration diagram for ilSessionParticipantsTableGUI:

Public Member Functions

 __construct ($a_parent_obj, $a_type=self::TYPE_ADMIN, $a_show_content=true)
 Constructor.
 enableRegistration ($a_status)
 enable registration
 isRegistrationEnabled ()
 is registration enabled
 setParticipants ($a_part)
 set participants
 getParticipants ()
 get participants
 parse ()
 parse table
 fillRow ($a_set)
 fill row
- Public Member Functions inherited from ilTable2GUI
 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.
 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.
 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= '')
 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.
 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
 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.
- 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)

Data Fields

const TYPE_ADMIN = 'admin'
const TYPE_TUTOR = 'tutor'
const TYPE_MEMBER = 'member'
- 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 EXPORT_EXCEL = 1
const EXPORT_CSV = 2
- 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

 init ()
 init table
- 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.

Private Attributes

 $session_participants = null
 $participants = array()
 $reg_enabled = true

Additional Inherited Members

- 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
 $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
 $export_formats
 $export_mode
 $print_mode

Detailed Description

Author
Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e
Version
$Id$

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

Constructor & Destructor Documentation

ilSessionParticipantsTableGUI::__construct (   $a_parent_obj,
  $a_type = self::TYPE_ADMIN,
  $a_show_content = true 
)

Constructor.

public

Parameters
objectparent object
Returns

Reimplemented from ilTable2GUI.

Definition at line 50 of file class.ilSessionParticipantsTableGUI.php.

References $ilCtrl, $lng, ilTableGUI\disable(), ilTableGUI\enable(), ilTable2GUI\getParentObject(), ilTable2GUI\setFormName(), and ilTable2GUI\setPrefix().

{
global $lng,$ilCtrl;
$this->lng = $lng;
$this->lng->loadLanguageModule('sess');
$this->lng->loadLanguageModule('crs');
$this->lng->loadLanguageModule('trac');
$this->ctrl = $ilCtrl;
parent::__construct($a_parent_obj,'members');
$this->setFormName('participants');
switch($a_type)
{
case self::TYPE_ADMIN:
$this->setPrefix('admins');
break;
case self::TYPE_TUTOR:
$this->setPrefix('tutors');
break;
case self::TYPE_MEMBER:
$this->setPrefix('member');
break;
}
if($a_show_content)
{
$this->enable('sort');
$this->enable('header');
$this->enable('numinfo');
$this->enable('select_all');
}
else
{
$this->disable('content');
$this->disable('header');
$this->disable('footer');
$this->disable('numinfo');
$this->disable('select_all');
}
$this->session_participants = new ilEventParticipants($this->getParentObject()->object->getId());
}

+ Here is the call graph for this function:

Member Function Documentation

ilSessionParticipantsTableGUI::enableRegistration (   $a_status)

enable registration

public

Parameters
boolstatus
Returns

Definition at line 105 of file class.ilSessionParticipantsTableGUI.php.

{
$this->reg_enabled = $a_status;
}
ilSessionParticipantsTableGUI::fillRow (   $a_set)

fill row

public

Parameters
arraydata set

Reimplemented from ilTable2GUI.

Definition at line 181 of file class.ilSessionParticipantsTableGUI.php.

References ilUtil\getImagePath(), and isRegistrationEnabled().

{
$this->tpl->setVariable('VAL_ID',$a_set['id']);
$this->tpl->setVariable('LASTNAME',$a_set['lastname']);
$this->tpl->setVariable('FIRSTNAME',$a_set['firstname']);
$this->tpl->setVariable('LOGIN',$a_set['login']);
$this->tpl->setVariable('MARK',$a_set['mark']);
$this->tpl->setVariable('COMMENT',$a_set['comment']);
$this->tpl->setVariable('PART_CHECKED',$a_set['participated'] ? 'checked="checked"' : '');
if($this->isRegistrationEnabled())
{
$this->tpl->setCurrentBlock('registered_col');
if($a_set['registered'])
{
$this->tpl->setVariable('IMAGE_REGISTERED',ilUtil::getImagePath('icon_ok.gif'));
$this->tpl->setVariable('REGISTERED',$this->lng->txt('event_registered'));
}
else
{
$this->tpl->setVariable('IMAGE_REGISTERED',ilUtil::getImagePath('icon_not_ok.gif'));
$this->tpl->setVariable('REGISTERED',$this->lng->txt('event_not_registered'));
}
$this->tpl->parseCurrentBlock();
}
}

+ Here is the call graph for this function:

ilSessionParticipantsTableGUI::getParticipants ( )

get participants

public

Returns

Definition at line 139 of file class.ilSessionParticipantsTableGUI.php.

References $participants.

Referenced by parse().

{
return $this->participants;
}

+ Here is the caller graph for this function:

ilSessionParticipantsTableGUI::init ( )
protected

init table

protected

Parameters
@return

Definition at line 216 of file class.ilSessionParticipantsTableGUI.php.

References ilTable2GUI\addColumn(), isRegistrationEnabled(), ilTable2GUI\setDefaultOrderField(), ilTable2GUI\setFormAction(), ilTable2GUI\setFormName(), and ilTable2GUI\setRowTemplate().

Referenced by parse().

{
$this->setFormName('participants');
$this->setFormAction($this->ctrl->getFormAction($this->getParentObject(),'members'));
$this->addColumn($this->lng->txt('lastname'),'name','30%');
$this->addColumn($this->lng->txt('trac_mark'),'mark');
$this->addColumn($this->lng->txt('trac_comment'),'comment');
if($this->isRegistrationEnabled())
{
$this->addColumn($this->lng->txt('event_tbl_registered'),'registered');
}
$this->addColumn($this->lng->txt('event_tbl_participated'),'participated');
$this->setRowTemplate("tpl.sess_members_row.html","Modules/Session");
$this->setDefaultOrderField('name');
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilSessionParticipantsTableGUI::isRegistrationEnabled ( )

is registration enabled

public

Returns

Definition at line 116 of file class.ilSessionParticipantsTableGUI.php.

References $reg_enabled.

Referenced by fillRow(), and init().

{
return $this->reg_enabled;
}

+ Here is the caller graph for this function:

ilSessionParticipantsTableGUI::parse ( )

parse table

public

Returns

Definition at line 150 of file class.ilSessionParticipantsTableGUI.php.

References ilObjUser\_lookupLogin(), ilObjUser\_lookupName(), getParticipants(), init(), and ilTable2GUI\setData().

{
$this->init();
foreach($this->getParticipants() as $participant_id)
{
$usr_data = $this->session_participants->getUser($participant_id);
$tmp_data['id'] = $participant_id;
$name = ilObjUser::_lookupName($participant_id);
$tmp_data['name'] = $name['lastname'];
$tmp_data['lastname'] = $name['lastname'];
$tmp_data['firstname'] = $name['firstname'];
$tmp_data['login'] = ilObjUser::_lookupLogin($participant_id);
$tmp_data['mark'] = $usr_data['mark'];
$tmp_data['comment'] = $usr_data['comment'];
$tmp_data['participated'] = $this->session_participants->hasParticipated($participant_id);
$tmp_data['registered'] = $this->session_participants->isRegistered($participant_id);
$part[] = $tmp_data;
}
$this->setData($part ? $part : array());
}

+ Here is the call graph for this function:

ilSessionParticipantsTableGUI::setParticipants (   $a_part)

set participants

public

Parameters
arrayparticipants
Returns

Definition at line 128 of file class.ilSessionParticipantsTableGUI.php.

{
$this->participants = $a_part;
}

Field Documentation

ilSessionParticipantsTableGUI::$participants = array()
private

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

Referenced by getParticipants().

ilSessionParticipantsTableGUI::$reg_enabled = true
private

Definition at line 41 of file class.ilSessionParticipantsTableGUI.php.

Referenced by isRegistrationEnabled().

ilSessionParticipantsTableGUI::$session_participants = null
private

Definition at line 39 of file class.ilSessionParticipantsTableGUI.php.

const ilSessionParticipantsTableGUI::TYPE_ADMIN = 'admin'

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

Referenced by ilObjSessionGUI\membersObject().

const ilSessionParticipantsTableGUI::TYPE_MEMBER = 'member'

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

Referenced by ilObjSessionGUI\membersObject().

const ilSessionParticipantsTableGUI::TYPE_TUTOR = 'tutor'

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

Referenced by ilObjSessionGUI\membersObject().

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