Base class for attendance lists. More...

Collaboration diagram for ilAttendanceList:

Public Member Functions
	__construct (object $a_parent_gui, ilObject $a_parent_obj, ?ilParticipants $a_participants_object=null, ?ilWaitingList $a_waiting_list=null)

	addPreset (string $a_id, string $a_caption, bool $a_selected=false)
	Add user field. More...

	addBlank (string $a_caption)
	Add blank column preset. More...

	setTitle (string $a_title, ?string $a_description=null)
	Set titles. More...

	addUserFilter (string $a_id, string $a_caption, bool $a_checked=false)
	Add user filter. More...

	getNonMemberUserData (array &$a_res)
	Get user data for subscribers and waiting list. More...

	setBlankColumns (array $a_values)
	Add blank columns. More...

	setCallback (callable $a_callback)
	Set participant detail callback. More...

	setId (string $a_value)

	initForm (string $a_cmd="")
	Init form. More...

	initFromForm ()
	Set list attributes from post values. More...

	initFromSettings ()
	Directly set list attributes from default settings for print view. More...

	getFullscreenHTML ()
	render list in fullscreen mode More...

	getHTML ()
	render attendance list More...

Protected Member Functions
	readOrderedExportableFields ()
	read object export fields More...

	addRole (int $a_id, string $a_caption, string $a_type)
	Add role. More...

	setRoleSelection (array $a_role_ids)

Protected Attributes
ilLogger	$logger

ilLanguage	$lng

ilCtrlInterface	$ctrl

ilGlobalTemplateInterface	$tpl

object	$parent_gui

ilObject	$parent_obj

ilParticipants	$participants

ilWaitingList	$waiting_list

	$callback

array	$presets = []

array	$role_data = []

array	$roles = []

bool	$has_local_role = false

array	$blank_columns = []

string	$title = ''

string	$description = ''

array	$pre_blanks = []

string	$id = ''

bool	$include_waiting_list = false

bool	$include_subscribers = false

array	$user_filters = []

Detailed Description

Base class for attendance lists.

Author: Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Definition at line 26 of file class.ilAttendanceList.php.

Constructor & Destructor Documentation

◆ __construct()

ilAttendanceList::__construct	(	object	$a_parent_gui,
		ilObject	$a_parent_obj,
		?ilParticipants	$a_participants_object = `null`,
		?ilWaitingList	$a_waiting_list = `null`
	)

Definition at line 53 of file class.ilAttendanceList.php.

References $DIC, ilObject\_lookupTitle(), addRole(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ILIAS\Repository\logger(), and readOrderedExportableFields().

       {
         global $DIC;
 
         $this->logger = $DIC->logger()->mmbr();
         $this->lng = $DIC->language();
         $this->ctrl = $DIC->ctrl();
         $this->tpl = $DIC->ui()->mainTemplate();
 
         $this->parent_gui = $a_parent_gui;
         $this->parent_obj = $a_parent_obj;
         $this->participants = $a_participants_object;
         $this->waiting_list = $a_waiting_list;
 
         // always available
         $this->presets['name'] = array($DIC->language()->txt('name'), true);
         $this->presets['login'] = array($DIC->language()->txt('login'), true);
 
         // add exportable fields
         $this->readOrderedExportableFields();
 
         $DIC->language()->loadLanguageModule('crs');
 
         // roles
         $roles = $this->participants->getRoles();
 
         foreach ($roles as $role_id) {
             $title = ilObject::_lookupTitle($role_id);
             switch (substr($title, 0, 8)) {
                 case 'il_crs_a':
                 case 'il_grp_a':
                 case 'il_lso_a':
                     $this->addRole($role_id, $DIC->language()->txt('event_tbl_admin'), 'admin');
                     break;
 
                 case 'il_crs_t':
                     $this->addRole($role_id, $DIC->language()->txt('event_tbl_tutor'), 'tutor');
                     break;
 
                 case 'il_crs_m':
                 case 'il_grp_m':
                 case 'il_sess_':
                 case 'il_lso_m':
                     $this->addRole($role_id, $DIC->language()->txt('event_tbl_member'), 'member');
                     break;
 
                     // local
                 default:
                     $this->has_local_role = true;
                     $this->addRole($role_id, $title, 'local');
                     break;
             }
         }
     }

Here is the call graph for this function:

Member Function Documentation

◆ addBlank()

ilAttendanceList::addBlank ( string $a_caption )

Add blank column preset.

Definition at line 165 of file class.ilAttendanceList.php.

                                                : void
     {
         $this->pre_blanks[] = $a_caption;
     }

◆ addPreset()

ilAttendanceList::addPreset	(	string	$a_id,
		string	$a_caption,
		bool	$a_selected = `false`
	)

Add user field.

Definition at line 157 of file class.ilAttendanceList.php.

Referenced by initFromForm(), and initFromSettings().

                                                                                         : void
     {
         $this->presets[$a_id] = array($a_caption, $a_selected);
     }

Here is the caller graph for this function:

◆ addRole()

ilAttendanceList::addRole	(	int	$a_id,
		string	$a_caption,
		string	$a_type
	)

protected

Add role.

Definition at line 182 of file class.ilAttendanceList.php.

Referenced by __construct().

                                                                             : void
     {
         $this->role_data[$a_id] = array($a_caption, $a_type);
     }

Here is the caller graph for this function:

◆ addUserFilter()

ilAttendanceList::addUserFilter	(	string	$a_id,
		string	$a_caption,
		bool	$a_checked = `false`
	)

Add user filter.

Definition at line 195 of file class.ilAttendanceList.php.

                                                                                            : void
     {
         $this->user_filters[$a_id] = array($a_caption, $a_checked);
     }

◆ getFullscreenHTML()

ilAttendanceList::getFullscreenHTML ( )

render list in fullscreen mode

Definition at line 542 of file class.ilAttendanceList.php.

References getHTML().

                                        : void
     {
         $this->tpl->setContent($this->getHTML());
         $this->tpl->addOnLoadCode("il.Util.print();");
     }

Here is the call graph for this function:

◆ getHTML()

ilAttendanceList::getHTML ( )

render attendance list

Definition at line 551 of file class.ilAttendanceList.php.

References ilObjUser\_lookupLogin(), ilObjUser\_lookupName(), ilUtil\_sortIds(), ilDatePresentation\formatDate(), ilGlobalTemplateInterface\get(), IL_CAL_UNIX, ilGlobalTemplateInterface\parseCurrentBlock(), ilGlobalTemplateInterface\setCurrentBlock(), ilDatePresentation\setUseRelativeDates(), ilGlobalTemplateInterface\setVariable(), and ilGlobalTemplateInterface\touchBlock().

Referenced by getFullscreenHTML().

                              : string
     {
         $tpl = new ilTemplate('tpl.attendance_list_print.html', true, true, 'Services/Membership');
         ilDatePresentation::setUseRelativeDates(false);
         $time = ilDatePresentation::formatDate(new ilDateTime(time(), IL_CAL_UNIX));
 
         $tpl->setVariable('TXT_TITLE', $this->title);
         if ($this->description) {
             $tpl->setVariable('TXT_DESCRIPTION', $this->description . " (" . $time . ")");
         } else {
             $tpl->setVariable('TXT_DESCRIPTION', $time);
         }
 
         $tpl->setCurrentBlock('head_item');
         foreach ($this->presets as $item) {
             if ($item[1]) {
                 $tpl->setVariable('TXT_HEAD', $item[0]);
                 $tpl->parseCurrentBlock();
             }
         }
 
         if ($this->blank_columns) {
             foreach ($this->blank_columns as $blank) {
                 $tpl->setVariable('TXT_HEAD', $blank);
                 $tpl->parseCurrentBlock();
             }
         }
 
         // handle members
 
         $valid_user_ids = $filters = array();
 
         if ($this->roles) {
             if ($this->has_local_role) {
                 $members = array();
                 foreach ($this->participants->getMembers() as $member_id) {
                     foreach ($this->participants->getAssignedRoles($member_id) as $role_id) {
                         $members[$role_id][] = $member_id;
                     }
                 }
             } else {
                 $members = $this->participants->getMembers();
             }
 
             foreach ($this->roles as $role_id) {
                 switch ($this->role_data[$role_id][1]) {
                     case "admin":
                         $valid_user_ids = array_merge($valid_user_ids, $this->participants->getAdmins());
                         break;
 
                     case "tutor":
                         $valid_user_ids = array_merge($valid_user_ids, $this->participants->getTutors());
                         break;
 
                         // member/local
                     default:
                         if (!$this->has_local_role) {
                             $valid_user_ids = array_merge($valid_user_ids, $members);
                         } else {
                             $valid_user_ids = array_merge($valid_user_ids, (array) ($members[$role_id] ?? []));
                         }
                         break;
                 }
             }
         }
 
         if ($this->include_subscribers) {
             $valid_user_ids = array_merge($valid_user_ids, $this->participants->getSubscribers());
         }
 
         if ($this->include_waiting_list) {
             $valid_user_ids = array_merge($valid_user_ids, $this->waiting_list->getUserIds());
         }
 
         if ($this->user_filters) {
             foreach ($this->user_filters as $sub_id => $sub_item) {
                 $filters[$sub_id] = (bool) ($sub_item[2] ?? false);
             }
         }
         $valid_user_ids = ilUtil::_sortIds(array_unique($valid_user_ids), 'usr_data', 'lastname', 'usr_id');
         foreach ($valid_user_ids as $user_id) {
             if ($this->callback) {
                 $user_data = call_user_func_array($this->callback, [(int) $user_id, $filters]);
                 if (!$user_data) {
                     continue;
                 }
 
                 $tpl->setCurrentBlock("row_preset");
                 foreach ($this->presets as $id => $item) {
                     if ($item[1]) {
                         switch ($id) {
                             case 'org_units':
                                 $value = ilOrgUnitPathStorage::getTextRepresentationOfUsersOrgUnits((int) $user_id);
                                 break;
 
                             case "name":
                                 if (!($user_data[$id] ?? null)) {
                                     $name = ilObjUser::_lookupName((int) $user_id);
                                     $value = $name["lastname"] . ", " . $name["firstname"];
                                     break;
                                 }
                                 // no break
                             case "login":
                                 if (!($user_data[$id] ?? false)) {
                                     $value = ilObjUser::_lookupLogin((int) $user_id);
                                     break;
                                 }
 
                                 // no break
                             default:
                                 $value = (string) ($user_data[$id] ?? '');
                                 break;
                         }
                         $tpl->setVariable("TXT_PRESET", $value);
                         $tpl->parseCurrentBlock();
                     }
                 }
             }
 
             if ($this->blank_columns) {
                 for ($loop = 0, $loopMax = count($this->blank_columns); $loop < $loopMax; $loop++) {
                     $tpl->touchBlock('row_blank');
                 }
             }
 
             $tpl->touchBlock("member_row");
         }
         return $tpl->get();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getNonMemberUserData()

ilAttendanceList::getNonMemberUserData ( array & $a_res )

Get user data for subscribers and waiting list.

Definition at line 203 of file class.ilAttendanceList.php.

References ilUserDefinedFields\_getInstance(), ilCourseUserData\_getValuesByObjId(), ilObjUser\_readUsersProfileData(), ilObjectFactory\getInstanceByObjId(), and ILIAS\Repository\lng().

                                                        : void
     {
         $subscriber_ids = $this->participants->getSubscribers();
         $user_ids = $subscriber_ids;
         if ($this->waiting_list) {
             $user_ids = array_merge($user_ids, $this->waiting_list->getUserIds());
         }
 
         // Finally read user profile data
         $profile_data = ilObjUser::_readUsersProfileData($user_ids);
         foreach ($profile_data as $user_id => $fields) {
             foreach ((array) $fields as $field => $value) {
                 $a_res[$user_id][$field] = $value;
             }
         }
 
         $udf = ilUserDefinedFields::_getInstance();
 
         foreach ($udf->getExportableFields($this->parent_obj->getId()) as $field_id => $udf_data) {
             foreach ($profile_data as $user_id => $field) {
                 $udf_data = new ilUserDefinedData($user_id);
                 $a_res[$user_id]['udf_' . $field_id] = $udf_data->get('f_' . $field_id);
             }
         }
 
         if (count($user_ids)) {
             // object specific user data
             $cdfs = ilCourseUserData::_getValuesByObjId($this->parent_obj->getId());
             foreach (array_unique($user_ids) as $user_id) {
                 if ($tmp_obj = ilObjectFactory::getInstanceByObjId($user_id, false)) {
                     $a_res[$user_id]['login'] = $tmp_obj->getLogin();
                     $a_res[$user_id]['name'] = $tmp_obj->getLastname() . ', ' . $tmp_obj->getFirstname();
 
                     if (in_array($user_id, $subscriber_ids)) {
                         $a_res[$user_id]['status'] = $this->lng->txt('crs_subscriber');
                     } else {
                         $a_res[$user_id]['status'] = $this->lng->txt('crs_waiting_list');
                     }
 
                     foreach ((array) ($cdfs[$user_id] ?? []) as $field_id => $value) {
                         $a_res[$user_id]['cdf_' . $field_id] = (string) $value;
                     }
                 }
             }
         }
     }

Here is the call graph for this function:

◆ initForm()

ilAttendanceList::initForm ( string $a_cmd = "" )

Init form.

Definition at line 284 of file class.ilAttendanceList.php.

References $id, ILIAS\LTI\ToolProvider\$settings, ilObject\_lookupTitle(), ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Referenced by initFromForm().

                                                 : ilPropertyFormGUI
     {
         $this->lng->loadLanguageModule('crs');
 
         $form = new ilPropertyFormGUI();
         $form->setFormAction($this->ctrl->getFormAction($this->parent_gui, $a_cmd));
         $form->setPreventDoubleSubmission(false);
         $form->setTitle($this->lng->txt('sess_gen_attendance_list'));
 
         $title = new ilTextInputGUI($this->lng->txt('title'), 'title');
         $title->setValue($this->title);
         $form->addItem($title);
 
         $desc = new ilTextInputGUI($this->lng->txt('description'), 'desc');
         $desc->setValue($this->description);
         $form->addItem($desc);
 
         if (count($this->presets)) {
             $preset = new ilCheckboxGroupInputGUI($this->lng->txt('user_detail'), 'preset');
             $preset_value = array();
             foreach ($this->presets as $id => $item) {
                 $preset->addOption(new ilCheckboxOption($item[0], $id));
                 if ($item[1]) {
                     $preset_value[] = $id;
                 }
             }
             $preset->setValue($preset_value);
             $form->addItem($preset);
         }
 
         $blank = new ilTextInputGUI($this->lng->txt('event_blank_columns'), 'blank');
         $blank->setMulti(true);
         $form->addItem($blank);
 
         if ($this->pre_blanks) {
             $blank->setValue($this->pre_blanks);
         }
 
         $checked = array();
 
         $chk_grp = new ilCheckboxGroupInputGUI($this->lng->txt('event_user_selection'), 'selection_of_users');
 
         // participants by roles
         foreach ($this->role_data as $role_id => $role_data) {
             $title = ilObject::_lookupTitle($role_id);
 
             $role_name = $role_id;
             if (strpos($title, 'il_' . $this->parent_obj->getType() . '_adm') === 0) {
                 $role_name = 'adm';
             }
             if (strpos($title, 'il_' . $this->parent_obj->getType() . '_mem') === 0) {
                 $role_name = 'mem';
             }
             if (strpos($title, 'il_' . $this->parent_obj->getType() . '_tut') === 0) {
                 $role_name = 'tut';
             }
 
             $chk = new ilCheckboxOption(
                 sprintf($this->lng->txt('event_user_selection_include_role'), $role_data[0]),
                 'role_' . $role_name
             );
             $checked[] = 'role_' . $role_name;
             $chk_grp->addOption($chk);
         }
 
         if ($this->waiting_list) {
             $chk = new ilCheckboxOption($this->lng->txt('event_user_selection_include_requests'), 'subscr');
             $chk_grp->addOption($chk);
 
             $chk = new ilCheckboxOption($this->lng->txt('event_user_selection_include_waiting_list'), 'wlist');
             $chk_grp->addOption($chk);
         }
 
         if ($this->user_filters) {
             foreach ($this->user_filters as $sub_id => $sub_item) {
                 $chk = new ilCheckboxOption(
                     sprintf($this->lng->txt('event_user_selection_include_filter'), $sub_item[0]),
                     'members_' . $sub_id
                 );
                 if ($sub_item[1]) {
                     $checked[] = 'members_' . $sub_id;
                 }
                 $chk_grp->addOption($chk);
             }
         }
         $chk_grp->setValue($checked);
         $form->addItem($chk_grp);
 
         $form->addCommandButton($a_cmd, $this->lng->txt('sess_print_attendance_list'));
 
         if ($this->id && $a_cmd) {
             $settings = new ilUserFormSettings($this->id);
             if (!$settings->hasStoredEntry()) {
                 $settings = new ilUserFormSettings($this->parent_obj->getType() . 's_pview', -1);
             }
 
             $settings->deleteValue('desc'); // #11340
             $settings->exportToForm($form);
         }
         return $form;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initFromForm()

ilAttendanceList::initFromForm ( )

Set list attributes from post values.

Definition at line 389 of file class.ilAttendanceList.php.

References $id, ilObject\_lookupTitle(), addPreset(), initForm(), setBlankColumns(), setRoleSelection(), and setTitle().

                                   : void
     {
         $form = $this->initForm();
         if ($form->checkInput()) {
             foreach (array_keys($this->presets) as $id) {
                 $this->presets[$id][1] = false;
             }
             foreach ((array) $form->getInput('preset') as $value) {
                 if (isset($this->presets[$value])) {
                     $this->presets[$value][1] = true;
                 } else {
                     $this->addPreset($value, $value, true);
                 }
             }
 
             $this->setTitle($form->getInput('title'), $form->getInput('desc'));
             $this->setBlankColumns($form->getInput('blank'));
 
             $selection_of_users = (array) $form->getInput('selection_of_users'); // #18238
 
             $roles = array();
             foreach (array_keys($this->role_data) as $role_id) {
                 $title = ilObject::_lookupTitle($role_id);
                 $role_name = $role_id;
                 if (strpos($title, 'il_' . $this->parent_obj->getType() . '_adm') === 0) {
                     $role_name = 'adm';
                 }
                 if (strpos($title, 'il_' . $this->parent_obj->getType() . '_mem') === 0) {
                     $role_name = 'mem';
                 }
                 if (strpos($title, 'il_' . $this->parent_obj->getType() . '_tut') === 0) {
                     $role_name = 'tut';
                 }
 
                 if (in_array('role_' . $role_name, $selection_of_users)) {
                     $roles[] = $role_id;
                 }
             }
             $this->setRoleSelection($roles);
 
             // not in sessions
             if ($this->waiting_list) {
                 $this->include_subscribers = in_array('subscr', $selection_of_users);
                 $this->include_waiting_list = in_array('wlist', $selection_of_users);
             }
 
             if ($this->user_filters) {
                 foreach (array_keys($this->user_filters) as $msub_id) {
                     $this->user_filters[$msub_id][2] = in_array("members_" . $msub_id, $selection_of_users);
                 }
             }
 
             if ($this->id) {
                 #$form->setValuesByPost();
 
                 #$settings = new ilUserFormSettings($this->id);
                 #$settings->deleteValue('desc'); // #11340
                 #$settings->importFromForm($form);
                 #$settings->store();
             }
         }
     }

Here is the call graph for this function:

◆ initFromSettings()

ilAttendanceList::initFromSettings ( )

Directly set list attributes from default settings for print view.

Definition at line 455 of file class.ilAttendanceList.php.

References $description, $id, $pre_blanks, ILIAS\LTI\ToolProvider\$settings, $title, ilObject\_lookupTitle(), addPreset(), setBlankColumns(), setRoleSelection(), and setTitle().

                                       : void
     {
         $settings = new ilUserFormSettings(
             $this->parent_obj->getType() . 's_pview_' . $this->parent_obj->getId(),
             -1
         );
         if (!$settings->hasStoredEntry()) {
             // init from global defaults
             $settings = new ilUserFormSettings($this->parent_obj->getType() . 's_pview', -1);
         }
         $settings->deleteValue('desc'); // #11340
 
         // title and description
         $this->setTitle(
             (string) ($settings->getValue('title') ?? $this->title),
             (string) ($settings->getValue('desc') ?? $this->description)
         );
 
         // preset
         if ($preset_value = $settings->getValue('preset')) {
             foreach (array_keys($this->presets) as $id) {
                 $this->presets[$id][1] = false;
             }
             foreach ((array) $preset_value as $value) {
                 if (isset($this->presets[$value])) {
                     $this->presets[$value][1] = true;
                 } else {
                     $this->addPreset($value, $value, true);
                 }
             }
         }
 
         // blank
         $this->setBlankColumns(
             (array) ($settings->getValue('blank') ?? $this->pre_blanks)
         );
 
         // selection of users
         $selection_of_users = $settings->getValue('selection_of_users');
 
         //      participants by roles
         $roles = [];
         foreach ($this->role_data as $role_id => $role_data) {
             $title = ilObject::_lookupTitle($role_id);
 
             $role_name = $role_id;
             if (strpos($title, 'il_' . $this->parent_obj->getType() . '_adm') === 0) {
                 $role_name = 'adm';
             }
             if (strpos($title, 'il_' . $this->parent_obj->getType() . '_mem') === 0) {
                 $role_name = 'mem';
             }
             if (strpos($title, 'il_' . $this->parent_obj->getType() . '_tut') === 0) {
                 $role_name = 'tut';
             }
 
             if (
                 isset($selection_of_users) &&
                 !in_array('role_' . $role_name, $selection_of_users)
             ) {
                 continue;
             }
             $roles[] = $role_id;
         }
         $this->setRoleSelection($roles);
 
         //      waiting list and subscribers (not in sessions)
         if ($this->waiting_list && isset($selection_of_users)) {
             $this->include_subscribers = in_array('subscr', $selection_of_users);
             $this->include_waiting_list = in_array('wlist', $selection_of_users);
         }
 
         //      user filters
         foreach (array_keys($this->user_filters) as $msub_id) {
             if (isset($selection_of_users)) {
                 $this->user_filters[$msub_id][2] = in_array("members_" . $msub_id, $selection_of_users);
                 continue;
             }
             if ($this->user_filters[$msub_id][1]) {
                 $this->user_filters[$msub_id][2] = true;
             }
         }
     }

Here is the call graph for this function:

◆ readOrderedExportableFields()

ilAttendanceList::readOrderedExportableFields ( )

protected

read object export fields

Definition at line 115 of file class.ilAttendanceList.php.

References $GLOBALS, ilCourseDefinedFieldDefinition\_getFields(), ilUserDefinedFields\_getInstance(), and ilExportFieldsInfo\_getInstanceByType().

Referenced by __construct().

                                                     : bool
     {
         $field_info = ilExportFieldsInfo::_getInstanceByType($this->parent_obj->getType());
         $field_info->sortExportFields();
 
         foreach ($field_info->getExportableFields() as $field) {
             switch ($field) {
                 case 'username':
                 case 'firstname':
                 case 'lastname':
                     continue 2;
             }
 
             // Check if default enabled
             $this->presets[$field] = array(
                 $GLOBALS['DIC']['lng']->txt($field),
                 false
             );
         }
 
         // add udf fields
         $udf = ilUserDefinedFields::_getInstance();
         foreach ($udf->getExportableFields($this->parent_obj->getId()) as $field_id => $udf_data) {
             $this->presets['udf_' . $field_id] = array(
                 $udf_data['field_name'],
                 false
             );
         }
 
         // add cdf fields
         foreach (ilCourseDefinedFieldDefinition::_getFields($this->parent_obj->getId()) as $field_obj) {
             $this->presets['cdf_' . $field_obj->getId()] = array(
                 $field_obj->getName(),
                 false
             );
         }
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setBlankColumns()

ilAttendanceList::setBlankColumns ( array $a_values )

Add blank columns.

Definition at line 253 of file class.ilAttendanceList.php.

Referenced by initFromForm(), and initFromSettings().

                                                     : void
     {
         if (!implode("", $a_values)) {
             $a_values = array();
         } else {
             foreach ($a_values as $idx => $value) {
                 $a_values[$idx] = trim($value);
                 if ($a_values[$idx] == "") {
                     unset($a_values[$idx]);
                 }
             }
         }
         $this->blank_columns = $a_values;
     }

Here is the caller graph for this function:

◆ setCallback()

ilAttendanceList::setCallback ( callable $a_callback )

Set participant detail callback.

Definition at line 271 of file class.ilAttendanceList.php.

                                                      : void
     {
         $this->callback = $a_callback;
     }

◆ setId()

ilAttendanceList::setId ( string $a_value )

Definition at line 276 of file class.ilAttendanceList.php.

                                           : void
     {
         $this->id = $a_value;
     }

◆ setRoleSelection()

ilAttendanceList::setRoleSelection ( array $a_role_ids )

protected

Definition at line 187 of file class.ilAttendanceList.php.

Referenced by initFromForm(), and initFromSettings().

                                                           : void
     {
         $this->roles = $a_role_ids;
     }

Here is the caller graph for this function:

◆ setTitle()

ilAttendanceList::setTitle	(	string	$a_title,
		?string	$a_description = `null`
	)

Set titles.

Definition at line 173 of file class.ilAttendanceList.php.

Referenced by initFromForm(), and initFromSettings().

                                                                             : void
     {
         $this->title = $a_title;
         $this->description = (string) $a_description;
     }

Here is the caller graph for this function:

Field Documentation

◆ $blank_columns

array ilAttendanceList::$blank_columns = []

protected

Definition at line 44 of file class.ilAttendanceList.php.

◆ $callback

ilAttendanceList::$callback

protected

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

◆ $ctrl

ilCtrlInterface ilAttendanceList::$ctrl

protected

Definition at line 30 of file class.ilAttendanceList.php.

◆ $description

string ilAttendanceList::$description = ''

protected

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

Referenced by initFromSettings().

◆ $has_local_role

bool ilAttendanceList::$has_local_role = false

protected

Definition at line 43 of file class.ilAttendanceList.php.

◆ $id

string ilAttendanceList::$id = ''

protected

Definition at line 48 of file class.ilAttendanceList.php.

Referenced by initForm(), initFromForm(), and initFromSettings().

◆ $include_subscribers

bool ilAttendanceList::$include_subscribers = false

protected

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

◆ $include_waiting_list

bool ilAttendanceList::$include_waiting_list = false

protected

Definition at line 49 of file class.ilAttendanceList.php.

◆ $lng

ilLanguage ilAttendanceList::$lng

protected

Definition at line 29 of file class.ilAttendanceList.php.

◆ $logger

ilLogger ilAttendanceList::$logger

protected

Definition at line 28 of file class.ilAttendanceList.php.

◆ $parent_gui

object ilAttendanceList::$parent_gui

protected

Definition at line 32 of file class.ilAttendanceList.php.

◆ $parent_obj

ilObject ilAttendanceList::$parent_obj

protected

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

◆ $participants

ilParticipants ilAttendanceList::$participants

protected

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

◆ $pre_blanks

array ilAttendanceList::$pre_blanks = []

protected

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

Referenced by initFromSettings().

◆ $presets

array ilAttendanceList::$presets = []

protected

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

◆ $role_data

array ilAttendanceList::$role_data = []

protected

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

◆ $roles

array ilAttendanceList::$roles = []

protected

Definition at line 42 of file class.ilAttendanceList.php.

◆ $title

string ilAttendanceList::$title = ''

protected

Definition at line 45 of file class.ilAttendanceList.php.

Referenced by initFromSettings().

◆ $tpl

ilGlobalTemplateInterface ilAttendanceList::$tpl

protected

Definition at line 31 of file class.ilAttendanceList.php.

◆ $user_filters

array ilAttendanceList::$user_filters = []

protected

Definition at line 51 of file class.ilAttendanceList.php.

◆ $waiting_list

ilWaitingList ilAttendanceList::$waiting_list

protected

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

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

Services/Membership/classes/class.ilAttendanceList.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addBlank()

◆ addPreset()

◆ addRole()

◆ addUserFilter()

◆ getFullscreenHTML()

◆ getHTML()

◆ getNonMemberUserData()

◆ initForm()

◆ initFromForm()

◆ initFromSettings()

◆ readOrderedExportableFields()

◆ setBlankColumns()

◆ setCallback()

◆ setId()

◆ setRoleSelection()

◆ setTitle()

Field Documentation

◆ $blank_columns

◆ $callback

◆ $ctrl

◆ $description

◆ $has_local_role

◆ $id

◆ $include_subscribers

◆ $include_waiting_list

◆ $lng

◆ $logger

◆ $parent_gui

◆ $parent_obj

◆ $participants

◆ $pre_blanks

◆ $presets

◆ $role_data

◆ $roles

◆ $title

◆ $tpl

◆ $user_filters

◆ $waiting_list