class.ilAttendanceList.php

Go to the documentation of this file.

<?php

/* Copyright (c) 1998-2009 ILIAS open source, Extended GPL, see docs/LICENSE */

class ilAttendanceList
{
    protected $logger = null;

    protected $parent_gui;
    protected $parent_obj; // [object]
    protected $participants; // [object]
    protected $waiting_list; // [object]
    protected $callback; // [string|array]
    protected $presets; // [array]
    protected $role_data; // [array]
    protected $roles; // [array]
    protected $has_local_role; // [bool]
    protected $blank_columns; // [array]
    protected $title; // [string]
    protected $description; // [string]
    protected $pre_blanks; // [array]
    protected $id; // [string]
    protected $include_waiting_list; // [bool]
    protected $include_subscribers;  // [bool]
    protected $user_filters; // [array]
        
    public function __construct($a_parent_gui, $a_parent_obj, ilParticipants $a_participants_object = null, ilWaitingList $a_waiting_list = null)
    {
        global $DIC;

        $this->logger = $DIC->logger()->mmbr();
        
        $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_lso_m':
                    $this->addRole($role_id, $DIC->language()->txt('event_tbl_member'), 'member');
                    break;

                case 'il_sess_':
                    $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;
            }
        }
    }

    protected function readOrderedExportableFields()
    {
        include_once('Services/PrivacySecurity/classes/class.ilPrivacySettings.php');
        include_once('Services/PrivacySecurity/classes/class.ilExportFieldsInfo.php');
        include_once('Modules/Course/classes/Export/class.ilCourseDefinedFieldDefinition.php');
        include_once('Services/User/classes/class.ilUserDefinedFields.php');

        $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;
            }
            
            ilLoggerFactory::getLogger('mmbr')->dump($field, ilLogLevel::DEBUG);
            // 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
        include_once './Modules/Course/classes/Export/class.ilCourseDefinedFieldDefinition.php';
        foreach (ilCourseDefinedFieldDefinition::_getFields($this->parent_obj->getId()) as $field_obj) {
            $this->presets['cdf_' . $field_obj->getId()] = array(
                $field_obj->getName(),
                false
            );
        }
        return true;
    }

    public function addPreset($a_id, $a_caption, $a_selected = false)
    {
        $this->presets[$a_id] = array($a_caption, $a_selected);
    }
    
    public function addBlank($a_caption)
    {
        $this->pre_blanks[] = $a_caption;
    }
    
    public function setTitle($a_title, $a_description = null)
    {
        $this->title = $a_title;
        $this->description = $a_description;
    }
    
    protected function addRole($a_id, $a_caption, $a_type)
    {
        $this->role_data[$a_id] = array($a_caption, $a_type);
    }
    
    
    
    protected function setRoleSelection($a_role_ids)
    {
        $this->roles = $a_role_ids;
    }
    
    public function addUserFilter($a_id, $a_caption, $a_checked = false)
    {
        $this->user_filters[$a_id] = array($a_caption, $a_checked);
    }
    
    public function getNonMemberUserData(array &$a_res)
    {
        global $DIC;

        $lng = $DIC['lng'];
        
        $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;
            }
        }

        include_once './Services/User/classes/class.ilUserDefinedFields.php';
        $udf = ilUserDefinedFields::_getInstance();
        
        foreach ($udf->getExportableFields($this->parent_obj->getId()) as $field_id => $udf_data) {
            foreach ($profile_data as $user_id => $field) {
                include_once './Services/User/classes/class.ilUserDefinedData.php';
                $udf_data = new ilUserDefinedData($user_id);
                $a_res[$user_id]['udf_' . $field_id] = (string) $udf_data->get('f_' . $field_id);
            }
        }
        
        if (sizeof($user_ids)) {
            // object specific user data
            include_once 'Modules/Course/classes/Export/class.ilCourseUserData.php';
            $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'] = $lng->txt('crs_subscriber');
                    } else {
                        $a_res[$user_id]['status'] = $lng->txt('crs_waiting_list');
                    }
                    
                    foreach ((array) $cdfs[$user_id] as $field_id => $value) {
                        $a_res[$user_id]['cdf_' . $field_id] = (string) $value;
                    }
                }
            }
        }
    }
    
    public function setBlankColumns(array $a_values)
    {
        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;
    }

    public function setCallback($a_callback)
    {
        $this->callback = $a_callback;
    }
    
    public function setId($a_value)
    {
        $this->id = (string) $a_value;
    }
    
    public function initForm($a_cmd = "")
    {
        global $DIC;

        $ilCtrl = $DIC['ilCtrl'];
        $lng = $DIC['lng'];
    
        $lng->loadLanguageModule('crs');
        
        include_once('./Services/Form/classes/class.ilPropertyFormGUI.php');
        $form = new ilPropertyFormGUI();
        $form->setFormAction($ilCtrl->getFormAction($this->parent_gui, $a_cmd));
        $form->setTarget('_blank');
        $form->setPreventDoubleSubmission(false);
        $form->setTitle($lng->txt('sess_gen_attendance_list'));
        
        $title = new ilTextInputGUI($lng->txt('title'), 'title');
        $title->setValue($this->title);
        $form->addItem($title);
        
        $desc = new ilTextInputGUI($lng->txt('description'), 'desc');
        $desc->setValue($this->description);
        $form->addItem($desc);
        
        if (sizeof($this->presets)) {
            $preset = new ilCheckboxGroupInputGUI($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($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($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 (substr($title, 0, 10) == 'il_' . $this->parent_obj->getType() . '_adm') {
                $role_name = 'adm';
            }
            if (substr($title, 0, 10) == 'il_' . $this->parent_obj->getType() . '_mem') {
                $role_name = 'mem';
            }
            if (substr($title, 0, 10) == 'il_' . $this->parent_obj->getType() . '_tut') {
                $role_name = 'tut';
            }
            
            $chk = new ilCheckboxOption(sprintf($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($lng->txt('event_user_selection_include_requests'), 'subscr');
            $chk_grp->addOption($chk);

            $chk = new ilCheckboxOption($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($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, $lng->txt('sess_print_attendance_list'));
        
        if ($this->id && $a_cmd) {
            include_once "Services/User/classes/class.ilUserFormSettings.php";
            $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);
        } elseif ($a_cmd == 'printForMembersOutput') {
            include_once "Services/User/classes/class.ilUserFormSettings.php";
            $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
            $settings->exportToForm($form, true);
        }
        
        return $form;
    }
    
    public function initFromForm()
    {
        $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 (substr($title, 0, 10) == 'il_' . $this->parent_obj->getType() . '_adm') {
                    $role_name = 'adm';
                }
                if (substr($title, 0, 10) == 'il_' . $this->parent_obj->getType() . '_mem') {
                    $role_name = 'mem';
                }
                if (substr($title, 0, 10) == 'il_' . $this->parent_obj->getType() . '_tut') {
                    $role_name = 'tut';
                }
                
                
                if (in_array('role_' . $role_name, (array) $selection_of_users)) {
                    $roles[] = $role_id;
                }
            }
            $this->setRoleSelection($roles);
            
            // not in sessions
            if ($this->waiting_list) {
                $this->include_subscribers = (bool) in_array('subscr', $selection_of_users);
                $this->include_waiting_list = (bool) 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] = (bool) in_array("members_" . $msub_id, $selection_of_users);
                }
            }
            
            if ($this->id) {
                #$form->setValuesByPost();
                
                #include_once "Services/User/classes/class.ilUserFormSettings.php";
                #$settings = new ilUserFormSettings($this->id);
                #$settings->deleteValue('desc'); // #11340
                #$settings->importFromForm($form);
                #$settings->store();
            }
        }
    }
    
    public function getFullscreenHTML()
    {
        $tpl = new ilTemplate('tpl.main.html', true, true);
        $tpl->setBodyClass("ilBodyPrint");
        
        // load style sheet depending on user's settings
        $location_stylesheet = ilUtil::getStyleSheetLocation();
        $tpl->setVariable("LOCATION_STYLESHEET", $location_stylesheet);
                        
        $tpl->setVariable("BODY_ATTRIBUTES", 'onload="window.print()"');
        $tpl->setVariable("CONTENT", $this->getHTML());
        
        return $tpl->show();
    }
    
    public function getHTML()
    {
        $tpl = new ilTemplate('tpl.attendance_list_print.html', true, true, 'Services/Membership');

        
        // title
        
        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);
        }
        
        ilLoggerFactory::getLogger('mmbr')->dump($this->presets, ilLogLevel::DEBUG);
        // header
        
        $tpl->setCurrentBlock('head_item');
        foreach ($this->presets as $id => $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, (array) $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];
            }
        }

        $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, array($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 = (string) ilOrgUnitPathStorage::getTextRepresentationOfUsersOrgUnits($user_id);
                                break;

                            case "name":
                                if (!$user_data[$id]) {
                                    $name = ilObjUser::_lookupName($user_id);
                                    $value = $name["lastname"] . ", " . $name["firstname"];
                                    break;
                                }
                                

                                // no break
                            case "login":
                                if (!$user_data[$id]) {
                                    $value = ilObjUser::_lookupLogin($user_id);
                                    break;
                                }

                                // no break
                            default:
                                $value = (string) $user_data[$id];
                                break;
                        }
                        $tpl->setVariable("TXT_PRESET", (string) $value);
                        $tpl->parseCurrentBlock();
                    }
                }
            }

            if ($this->blank_columns) {
                for ($loop = 0; $loop < sizeof($this->blank_columns); $loop++) {
                    $tpl->touchBlock('row_blank');
                }
            }
            
            $tpl->touchBlock("member_row");
        }
        
        return $tpl->get();
    }
}