GUI class for course/group subscriptions. More...

Inheritance diagram for ilSubscriberTableGUI:

Collaboration diagram for ilSubscriberTableGUI:

Public Member Functions
	__construct ($a_parent_obj, $participants, $show_content=true)
	Constructor.
	setSubscribers ($a_sub)
	set subscribers
	fillRow ($a_set)
	fill row
	readSubscriberData ()
	read data
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
	$participants = null
	$subscribers = array()
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

GUI class for course/group subscriptions.

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

Version: $Id$

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

Constructor & Destructor Documentation

ilSubscriberTableGUI::__construct	(	$a_parent_obj,
		$participants,
		$show_content = `true`
	)

Constructor.

public

Parameters

@return

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

References $ilCtrl, $lng, $participants, ilTable2GUI\addColumn(), ilTable2GUI\addMultiCommand(), ilTableGUI\disable(), ilTableGUI\enable(), ilTable2GUI\setFormAction(), ilTable2GUI\setFormName(), ilTable2GUI\setPrefix(), ilTable2GUI\setRowTemplate(), and ilTable2GUI\setSelectAllCheckbox().

        {
                global $lng,$ilCtrl;
                
                $this->lng = $lng;
                $this->lng->loadLanguageModule('grp');
                $this->lng->loadLanguageModule('crs');
                $this->ctrl = $ilCtrl;
                
                parent::__construct($a_parent_obj,'members');
                $this->setFormName('subscribers');
                $this->setFormAction($this->ctrl->getFormAction($a_parent_obj,'members'));
                $this->addColumn('','f',"1");
                $this->addColumn($this->lng->txt('lastname'),'name','20%');
                $this->addColumn($this->lng->txt('login'),'login','10%');
                $this->addColumn($this->lng->txt('application_date'),'sub_time',"15%");
                $this->addColumn($this->lng->txt('subject'),'subject','45%');
                $this->addColumn('','mail','10%');
                
                $this->addMultiCommand('assignSubscribers',$this->lng->txt('assign'));
                $this->addMultiCommand('refuseSubscribers',$this->lng->txt('refuse'));
                $this->addMultiCommand('sendMailToSelectedUsers',$this->lng->txt('crs_mem_send_mail'));
                
                $this->setPrefix('subscribers');
                $this->setSelectAllCheckbox('subscribers');
                $this->setRowTemplate("tpl.show_subscribers_row.html","Services/Membership");
                
                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');
                }       
                
                $this->participants = $participants;
        }

Here is the call graph for this function:

Member Function Documentation

ilSubscriberTableGUI::fillRow ( $a_set )

fill row

public

Parameters

@return

Reimplemented from ilTable2GUI.

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

References ilTableGUI\$prefix, ilObjCourseGrouping\_checkGroupingDependencies(), ilObject\_lookupTitle(), ilDatePresentation\formatDate(), ilObjCourseGrouping\getAssignedObjects(), ilTable2GUI\getParentObject(), and IL_CAL_UNIX.

        {
                global $ilUser;
                
                                
                include_once './Modules/Course/classes/class.ilObjCourseGrouping.php';
                if(!ilObjCourseGrouping::_checkGroupingDependencies($this->getParentObject()->object,$a_set['id']) and
                        ($ids = ilObjCourseGrouping::getAssignedObjects()))
                {
                        $prefix = $this->getParentObject()->object->getType();
                        $this->tpl->setVariable('ALERT_MSG',
                                sprintf($this->lng->txt($prefix.'_lim_assigned'),
                                ilObject::_lookupTitle(current($ids))
                                ));
                                
                }
                $this->tpl->setVariable('VAL_ID',$a_set['id']);
                $this->tpl->setVariable('VAL_NAME',$a_set['name']);
                $this->tpl->setVariable('VAL_SUBTIME',ilDatePresentation::formatDate(new ilDateTime($a_set['sub_time'],IL_CAL_UNIX)));
                $this->tpl->setVariable('VAL_LOGIN',$a_set['login']);
                
                $this->ctrl->setParameterByClass(get_class($this->getParentObject()),'member_id',$a_set['id']);
                $link = $this->ctrl->getLinkTargetByClass(get_class($this->getParentObject()),'sendMailToSelectedUsers');
                $this->tpl->setVariable('MAIL_LINK',$link);
                $this->tpl->setVariable('MAIL_TITLE',$this->lng->txt('crs_mem_send_mail'));
                
                
                if(strlen($a_set['subject']))
                {
                        $this->tpl->setVariable('VAL_SUBJECT','"'.$a_set['subject'].'"');
                        
                }
        }

Here is the call graph for this function:

ilSubscriberTableGUI::readSubscriberData ( )

read data

protected

Parameters

@return

Definition at line 158 of file class.ilSubscriberTableGUI.php.

References ilTableGUI\$data, $subscribers, ilObjUser\_lookupName(), and ilTable2GUI\setData().

Referenced by setSubscribers().

        {
                foreach($this->subscribers as $usr_id)
                {
                        
                        $data = $this->participants->getSubscriberData($usr_id);
                        
                        $tmp_arr['id'] = $usr_id;
                        $tmp_arr['sub_time'] = $data['time'];
                        $tmp_arr['subject'] = $data['subject'];
                        
                        $name = ilObjUser::_lookupName($usr_id);
                        $tmp_arr['name'] = $name['lastname'].', '.$name['firstname'];
                        $tmp_arr['login'] = ''.ilObjUser::_lookupLogin($usr_id).'';
                        
                        $subscribers[] = $tmp_arr;
                }
                $this->setData($subscribers ? $subscribers : array());
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilSubscriberTableGUI::setSubscribers ( $a_sub )

set subscribers

public

Parameters

@return

Definition at line 103 of file class.ilSubscriberTableGUI.php.

References readSubscriberData().

        {
                $this->subscribers = $a_sub;
                $this->readSubscriberData();
        }

Here is the call graph for this function:

Field Documentation

ilSubscriberTableGUI::$participants = null

protected

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

Referenced by __construct().

ilSubscriberTableGUI::$subscribers = array()

protected

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

Referenced by readSubscriberData().

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

Services/Membership/classes/class.ilSubscriberTableGUI.php

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation