Description of class. More...

Collaboration diagram for ilSCORMTrackingUsersTableGUI:

Public Member Functions
	__construct (int $a_obj_id, ?object $a_parent_obj, string $a_parent_cmd)

	getObjId ()

	parse ()
	Parse table content. More...

	handleCommand ()

	getFilterHTML ()

	getTableHTML ()

	getHTML ()

Private Member Functions
	getTrackedUserFilters ()

	getFilter ()

Private Attributes
int	$obj_id

object	$parent_obj

string	$parent_cmd

ilLanguage	$lng

FilterAdapterGUI	$filter = null

TableAdapterGUI	$table = null

Detailed Description

Description of class.

Author: Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om \

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

Constructor & Destructor Documentation

◆ __construct()

ilSCORMTrackingUsersTableGUI::__construct	(	int	$a_obj_id,
		?object	$a_parent_obj,
		string	$a_parent_cmd
	)

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

    {
        global $DIC;
        if ($a_parent_obj === null) {
            throw new ilException('Missing parent object');
        }
 
        $this->obj_id = $a_obj_id;
        $this->parent_obj = $a_parent_obj;
        $this->parent_cmd = $a_parent_cmd;
        $this->lng = $DIC->language();
    }

References $DIC, and ILIAS\Repository\lng().

Here is the call graph for this function:

Member Function Documentation

◆ getFilter()

ilSCORMTrackingUsersTableGUI::getFilter ( )

private

Definition at line 132 of file class.ilSCORMTrackingUsersTableGUI.php.

                                : FilterAdapterGUI
    {
        if ($this->filter === null) {
            $this->filter = new FilterAdapterGUI(
                'sco_tr_usrs_' . $this->obj_id,
                [get_class($this->parent_obj)],
                $this->parent_cmd
            );
            $this->filter->text('login_filter', $this->lng->txt('login'));
            $this->filter->text('firstname_filter', $this->lng->txt('firstname'));
            $this->filter->text('lastname_filter', $this->lng->txt('lastname'));
            $this->filter->text('email_filter', $this->lng->txt('email'));
        }
        return $this->filter;
    }

References $filter, ILIAS\Repository\filter(), and ILIAS\Repository\lng().

Referenced by getFilterHTML(), and getTrackedUserFilters().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFilterHTML()

ilSCORMTrackingUsersTableGUI::getFilterHTML ( )

Definition at line 153 of file class.ilSCORMTrackingUsersTableGUI.php.

                                   : string
    {
        return $this->getFilter()->render();
    }

References getFilter().

Referenced by getHTML().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getHTML()

ilSCORMTrackingUsersTableGUI::getHTML ( )

Definition at line 163 of file class.ilSCORMTrackingUsersTableGUI.php.

                             : string
    {
        return $this->getFilterHTML() . $this->getTableHTML();
    }

References getFilterHTML(), and getTableHTML().

Here is the call graph for this function:

◆ getObjId()

ilSCORMTrackingUsersTableGUI::getObjId ( )

Definition at line 52 of file class.ilSCORMTrackingUsersTableGUI.php.

                              : int
    {
        return $this->obj_id;
    }

References $obj_id.

◆ getTableHTML()

ilSCORMTrackingUsersTableGUI::getTableHTML ( )

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

                                  : string
    {
        return $this->table?->render() ?? '';
    }

Referenced by getHTML().

Here is the caller graph for this function:

◆ getTrackedUserFilters()

ilSCORMTrackingUsersTableGUI::getTrackedUserFilters ( )

private

Returns: array<string, string>

Definition at line 121 of file class.ilSCORMTrackingUsersTableGUI.php.

                                            : array
    {
        $filter_data = $this->getFilter()->getData() ?? [];
        return [
            'lastname_filter' => trim((string) ($filter_data['lastname_filter'] ?? '')),
            'firstname_filter' => trim((string) ($filter_data['firstname_filter'] ?? '')),
            'login_filter' => trim((string) ($filter_data['login_filter'] ?? '')),
            'email_filter' => trim((string) ($filter_data['email_filter'] ?? '')),
        ];
    }

References getFilter().

Referenced by parse().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ handleCommand()

ilSCORMTrackingUsersTableGUI::handleCommand ( )

Definition at line 148 of file class.ilSCORMTrackingUsersTableGUI.php.

                                   : bool
    {
        return $this->table?->handleCommand() ?? false;
    }

◆ parse()

ilSCORMTrackingUsersTableGUI::parse ( )

Parse table content.

Exceptions

ilDateTimeException

Definition at line 61 of file class.ilSCORMTrackingUsersTableGUI.php.

                           : void
    {
        global $DIC;
        $filters = $this->getTrackedUserFilters();
        $ui_factory = $DIC->ui()->factory();
 
        $users = $this->parent_obj->getObject()->getTrackedUsers($filters);
        $attempts = $this->parent_obj->getObject()->getAttemptsForUsers();
        $versions = $this->parent_obj->getObject()->getModuleVersionForUsers();
 
        $data = [];
        foreach ($users as $user) {
            $tmp = [];
            $tmp['id'] = (int) $user['user_id'];
            $tmp['user'] = (int) $user['user_id'];
            $tmp['name'] = ($user['lastname'] ?? '') . ', ' . ($user['firstname'] ?? '');
            $tmp['login'] = (string) ($user['login'] ?? '');
            $tmp['email'] = (string) ($user['email'] ?? '');
            $dt = new ilDateTime($user['last_access'], IL_CAL_DATETIME);
            $tmp['last_access'] = $dt->get(IL_CAL_UNIX);
            $tmp['attempts'] = (int) ($attempts[$user['user_id']] ?? 0);
            $tmp['version'] = (int) ($versions[$user['user_id']] ?? 0);
 
            $data[] = $tmp;
        }
 
        $this->table = (new TableAdapterGUI(
            'sco_tr_usrs_' . $this->obj_id,
            '',
            new ilSCORMTrackingTableRetrieval(
                $data,
                ['id', 'user', 'last_access', 'attempts', 'version']
            ),
            $this->parent_obj,
            $this->parent_cmd,
            '',
            '',
            null,
            static function (array $row): array {
                $row['last_access'] = ilDatePresentation::formatDate(
                    new ilDateTime((string) $row['last_access'], IL_CAL_UNIX)
                );
                return $row;
            },
            false
        ))
            ->filterData($filters)
            ->column('login', $ui_factory->table()->column()->text($this->lng->txt('login'))->withIsSortable(true)->withIsOptional(true, false))
            ->textColumn('name', $this->lng->txt('user'), true)
            ->column('email', $ui_factory->table()->column()->text($this->lng->txt('email'))->withIsSortable(true)->withIsOptional(true, false))
            ->textColumn('last_access', $this->lng->txt('last_access'), true)
            ->textColumn('attempts', $this->lng->txt('attempts'), true)
            ->textColumn('version', $this->lng->txt('version'), true)
            ->multiAction('deleteTrackingForUser', $this->lng->txt('delete'))
            ->multiAction('exportSelectionUsers', $this->lng->txt('export'));
    }