Inheritance diagram for ilCourseEditParticipantsTableGUI:

Collaboration diagram for ilCourseEditParticipantsTableGUI:

Public Member Functions
	__construct ($a_parent_obj)
	Constructor.
	fillRow ($a_set)
	fill row
Public Member Functions inherited from ilTable2GUI
	__construct ($a_parent_obj, $a_parent_cmd="")
	Constructor.
&	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)

Data Fields
	$container = null

Private Attributes
	$localCourseRoles = null
	Holds the local roles of the course object.

Additional Inherited Members
Protected Member Functions inherited from ilTable2GUI
	prepareOutput ()
	Anything that must be done before HTML is generated.
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

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 34 of file class.ilCourseEditParticipantsTableGUI.php.

Constructor & Destructor Documentation

ilCourseEditParticipantsTableGUI::__construct ( $a_parent_obj )

Constructor.

public

Parameters

object parent gui object

Returns: void

Definition at line 55 of file class.ilCourseEditParticipantsTableGUI.php.

References $ilCtrl, $lng, ilTableGUI\$title, ilPrivacySettings\_getInstance(), ilCourseParticipants\_getInstanceByObjId(), ilObjRole\_getTranslation(), ilTable2GUI\addColumn(), ilTable2GUI\addCommandButton(), ilTableGUI\disable(), ilTableGUI\enable(), ilTable2GUI\setFormAction(), ilTable2GUI\setFormName(), and ilTable2GUI\setRowTemplate().

        {
                global $lng,$ilCtrl;
                
                $this->lng = $lng;
                $this->lng->loadLanguageModule('crs');
                $this->ctrl = $ilCtrl;
                
                $this->container = $a_parent_obj;
                
                include_once('./Services/PrivacySecurity/classes/class.ilPrivacySettings.php');
                $this->privacy = ilPrivacySettings::_getInstance();
                
                $this->participants = ilCourseParticipants::_getInstanceByObjId($a_parent_obj->object->getId());
                
                parent::__construct($a_parent_obj,'editMembers');
                $this->setFormName('participants');
                $this->setFormAction($this->ctrl->getFormAction($a_parent_obj));
                
                $this->addColumn($this->lng->txt('lastname'),'lastname','20%');
                $this->addColumn($this->lng->txt('login'),'login','25%');
                if($this->privacy->enabledCourseAccessTimes())
                {
                        $this->addColumn($this->lng->txt('last_access'),'access_time');
                }
                $this->addColumn($this->lng->txt('crs_passed'),'passed');
                $this->addColumn($this->lng->txt('crs_blocked'),'blocked');
                $this->addColumn($this->lng->txt('crs_notification'),'notification');
                $this->addColumn($this->lng->txt('objs_role'),'roles');
                $this->addCommandButton('updateMembers',$this->lng->txt('save'));
                $this->addCommandButton('members',$this->lng->txt('cancel'));
                
                $this->setRowTemplate("tpl.edit_participants_row.html","Modules/Course");
                
                $this->disable('sort');
                $this->enable('header');
                $this->enable('numinfo');
                $this->disable('select_all');
                
                // Performance improvement: We read the local course roles 
                // only once, instead of reading them for each row in method fillRow().
                $this->localCourseRoles = array();
                foreach($this->container->object->getLocalCourseRoles(false) as $title => $role_id)
                {
                        $this->localCourseRoles[ilObjRole::_getTranslation($title)] = array('role_id'=>$role_id, 'title'=>$title);
                }
        }

Here is the call graph for this function:

Member Function Documentation

ilCourseEditParticipantsTableGUI::fillRow ( $a_set )

fill row

public

Parameters

array usr_data

Reimplemented from ilTable2GUI.

Definition at line 111 of file class.ilCourseEditParticipantsTableGUI.php.

        {
                global $rbacsystem;
                $hasEditPermissionAccess = $rbacsystem->checkAccess('edit_permission', $this->container->object->getRefId());
                
                $this->tpl->setVariable('VAL_ID',$a_set['usr_id']);
                $this->tpl->setVariable('VAL_NAME',$a_set['lastname'].', '.$a_set['firstname']);
                
                $this->tpl->setVariable('VAL_LOGIN',$a_set['login']);
                if($this->privacy->enabledCourseAccessTimes())
                {
                        $this->tpl->setVariable('VAL_ACCESS',$a_set['access_time']);
                }
                $this->tpl->setVariable('VAL_NOTIFICATION_CHECKED',$a_set['notification'] ? 'checked="checked"' : '');
                $this->tpl->setVariable('VAL_PASSED_CHECKED',$a_set['passed'] ? 'checked="checked"' : '');
                $this->tpl->setVariable('VAL_BLOCKED_CHECKED',$a_set['blocked'] ? 'checked="checked"' : '');
                
                $this->tpl->setVariable('NUM_ROLES',count($this->participants->getRoles()));
                
                $assigned = $this->participants->getAssignedRoles($a_set['usr_id']);
                foreach($this->localCourseRoles as $localizedTitle => $roleData)
                {
                        if ($hasEditPermissionAccess || substr($roleData['title'], 0, 12) != 'il_crs_admin') 
                        {
                                $this->tpl->setCurrentBlock('roles');
                                $this->tpl->setVariable('ROLE_ID',$roleData['role_id']);
                                $this->tpl->setVariable('ROLE_NAME',$localizedTitle);
                                
                                if(in_array($roleData['role_id'],$assigned))
                                {
                                        $this->tpl->setVariable('ROLE_CHECKED','selected="selected"');
                                }
                                $this->tpl->parseCurrentBlock();
                        }
                }
        }

Field Documentation

ilCourseEditParticipantsTableGUI::$container = null

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

ilCourseEditParticipantsTableGUI::$localCourseRoles = null

private

Holds the local roles of the course object.

This variable is an associative array.

The key is the localized name of the role (for example 'Course Administrator')
The value is an associative array with the keys 'role_id' and 'title'.

Definition at line 46 of file class.ilCourseEditParticipantsTableGUI.php.

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

Modules/Course/classes/class.ilCourseEditParticipantsTableGUI.php

Public Member Functions

Data Fields

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation