ilGroupParticipantsTableGUI Class Reference

Inheritance diagram for ilGroupParticipantsTableGUI:

Collaboration diagram for ilGroupParticipantsTableGUI:

Public Member Functions
	__construct ($a_parent_obj, $a_type= 'admin', $show_content=true, $show_learning_progress=false)
	Constructor.
	fillRow ($a_set)
	fill row
Public Member Functions inherited from ilTable2GUI
	__construct ($a_parent_obj, $a_parent_cmd="")
	Constructor.
	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
	$type = 'admin'
	$show_learning_progress = false
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.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

Version

$Id$

Definition at line 34 of file class.ilGroupParticipantsTableGUI.php.

Constructor & Destructor Documentation

ilGroupParticipantsTableGUI::__construct	(		$a_parent_obj,
			$a_type = 'admin',
			$show_content = true,
			$show_learning_progress = false
	)

Constructor.

public

Parameters

@return

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

References $ilCtrl, $lng, $show_learning_progress, ilPrivacySettings\_getInstance(), ilTable2GUI\addColumn(), ilTable2GUI\addCommandButton(), ilTableGUI\disable(), ilTableGUI\enable(), ilTable2GUI\setFormName(), ilTable2GUI\setPrefix(), ilTable2GUI\setRowTemplate(), and ilTable2GUI\setSelectAllCheckbox().

        {
                global $lng,$ilCtrl;
                
                $this->show_learning_progress = $show_learning_progress;
                
                $this->lng = $lng;
                $this->lng->loadLanguageModule('grp');
                $this->lng->loadLanguageModule('trac');
                $this->ctrl = $ilCtrl;
                
                $this->type = $a_type; 
                
                include_once('./Services/PrivacySecurity/classes/class.ilPrivacySettings.php');
                $this->privacy = ilPrivacySettings::_getInstance();
                
                parent::__construct($a_parent_obj,'members');

                $this->setFormName('participants');

                $this->addColumn('','f',"1");
                $this->addColumn($this->lng->txt('name'),'lastname','20%');
                $this->addColumn($this->lng->txt('login'),'login','25%');
                
                if($this->show_learning_progress)
                {
                        $this->addColumn($this->lng->txt('learning_progress'),'progress');
                }

                if($this->privacy->enabledGroupAccessTimes())
                {
                        $this->addColumn($this->lng->txt('last_access'),'access_time_unix');
                }
                if($this->type == 'admin')
                {
                        $this->setPrefix('admin');
                        $this->setSelectAllCheckbox('admins');
                        $this->addColumn($this->lng->txt('grp_notification'),'notification');
                        $this->addCommandButton('updateStatus',$this->lng->txt('save'));
                }
                else
                {
                        $this->setPrefix('member');
                        $this->setSelectAllCheckbox('members');
                }
                $this->addColumn($this->lng->txt(''),'optional');
                
                $this->setRowTemplate("tpl.show_participants_row.html","Modules/Group");
                
                if($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');
                }               
        }

Here is the call graph for this function:

Member Function Documentation

ilGroupParticipantsTableGUI::fillRow

(

$a_set

)

fill row

public

Parameters

@return

Reimplemented from ilTable2GUI.

Definition at line 119 of file class.ilGroupParticipantsTableGUI.php.

References ilUtil\getImagePath(), LP_STATUS_COMPLETED, LP_STATUS_FAILED, LP_STATUS_IN_PROGRESS, and LP_STATUS_NOT_ATTEMPTED.

        {
                global $ilUser,$ilAccess;
                
                $this->tpl->setVariable('VAL_ID',$a_set['usr_id']);
                $this->tpl->setVariable('VAL_NAME',$a_set['lastname'].', '.$a_set['firstname']);
                if(!$ilAccess->checkAccessOfUser($a_set['usr_id'],'read','',$this->getParentObject()->object->getRefId()) and 
                        is_array($info = $ilAccess->getInfo()))
                {
                        $this->tpl->setVariable('PARENT_ACCESS',$info[0]['text']);
                }
                
                
                if($this->privacy->enabledGroupAccessTimes())
                {
                        $this->tpl->setVariable('VAL_ACCESS',$a_set['access_time']);
                }
                
                if($this->show_learning_progress)
                {
                        $this->tpl->setCurrentBlock('lp');
                        switch($a_set['progress'])
                        {
                                case LP_STATUS_COMPLETED:
                                        $this->tpl->setVariable('LP_STATUS_ALT',$this->lng->txt($a_set['progress']));
                                        $this->tpl->setVariable('LP_STATUS_PATH',ilUtil::getImagePath('scorm/complete.gif'));
                                        break;
                                        
                                case LP_STATUS_IN_PROGRESS:
                                        $this->tpl->setVariable('LP_STATUS_ALT',$this->lng->txt($a_set['progress']));
                                        $this->tpl->setVariable('LP_STATUS_PATH',ilUtil::getImagePath('scorm/incomplete.gif'));
                                        break;

                                case LP_STATUS_NOT_ATTEMPTED:
                                        $this->tpl->setVariable('LP_STATUS_ALT',$this->lng->txt($a_set['progress']));
                                        $this->tpl->setVariable('LP_STATUS_PATH',ilUtil::getImagePath('scorm/not_attempted.gif'));
                                        break;  

                                case LP_STATUS_FAILED:
                                        $this->tpl->setVariable('LP_STATUS_ALT',$this->lng->txt($a_set['progress']));
                                        $this->tpl->setVariable('LP_STATUS_PATH',ilUtil::getImagePath('scorm/failed.gif'));
                                        break;
                                                                
                        }
                        $this->tpl->parseCurrentBlock();
                }
                
                
                if($this->type == 'admin')
                {
                        $this->tpl->setVariable('VAL_POSTNAME','admins');
                        $this->tpl->setVariable('VAL_NOTIFICATION_ID',$a_set['usr_id']);
                        $this->tpl->setVariable('VAL_NOTIFICATION_CHECKED',$a_set['notification'] ? 'checked="checked"' : '');
                }
                else
                {
                        $this->tpl->setVariable('VAL_POSTNAME','members');
                }
                
                $this->ctrl->setParameter($this->parent_obj,'member_id',$a_set['usr_id']);
                $this->tpl->setVariable('LINK_NAME',$this->ctrl->getLinkTarget($this->parent_obj,'editMember'));
                $this->tpl->setVariable('LINK_TXT',$this->lng->txt('edit'));
                $this->ctrl->clearParameters($this->parent_obj);
                
                $this->tpl->setVariable('VAL_LOGIN',$a_set['login']);

        
        }

Here is the call graph for this function:

Field Documentation

ilGroupParticipantsTableGUI::$show_learning_progress = false

protected

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

Referenced by __construct().

ilGroupParticipantsTableGUI::$type = 'admin'

protected

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

---

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

• Modules/Group/classes/class.ilGroupParticipantsTableGUI.php