class.ilForumStatisticsTableGUI.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

class ilForumStatisticsTableGUI extends ilTable2GUI
{
    private bool $has_active_lp = false;
    private bool $has_general_lp_access;
    private bool $has_rbac_or_position_access;
    private ilObjUser $actor;
    private array $completed = [];
    private array $failed = [];
    private array $in_progress = [];

    public function __construct(
        ilObjForumGUI $a_parent_obj,
        string $a_parent_cmd,
        ilObjForum $forum,
        ilObjUser $actor,
        bool $has_general_lp_access,
        bool $has_rbac_or_position_access
    ) {
        parent::__construct($a_parent_obj, $a_parent_cmd);

        $lp = ilObjectLP::getInstance($forum->getId());
        if ($lp->isActive()) {
            $this->has_active_lp = true;
        }
        $this->has_general_lp_access = $has_general_lp_access;
        $this->has_rbac_or_position_access = $has_rbac_or_position_access;
        $this->actor = $actor;

        $this->setRowTemplate('tpl.statistics_table_row.html', 'Modules/Forum');

        $columns = $this->getColumnDefinition();
        foreach ($columns as $index => $column) {
            $this->addColumn(
                $column['txt'],
                isset($column['sortable']) && $column['sortable'] ? $column['field'] : '',
                ((string) ceil((100 / count($columns)))) . '%s'
            );
        }

        if ($this->has_active_lp && $this->has_general_lp_access) {
            $this->lng->loadLanguageModule('trac');
            $this->completed = ilLPStatusWrapper::_lookupCompletedForObject($forum->getId());
            $this->in_progress = ilLPStatusWrapper::_lookupInProgressForObject($forum->getId());
            $this->failed = ilLPStatusWrapper::_lookupFailedForObject($forum->getId());
        }

        $this->setDefaultOrderField('ranking');
        $this->setDefaultOrderDirection('desc');

        $this->enable('hits');
        $this->enable('sort');
    }

    protected function getColumnDefinition(): array
    {
        $i = 0;

        $columns = [];

        $columns[++$i] = [
            'field' => 'ranking',
            'txt' => $this->lng->txt('frm_statistics_ranking'),
            'sortable' => true,
        ];
        $columns[++$i] = [
            'field' => 'login',
            'txt' => $this->lng->txt('login'),
            'sortable' => true,
        ];
        $columns[++$i] = [
            'field' => 'lastname',
            'txt' => $this->lng->txt('lastname'),
            'sortable' => true,
        ];
        $columns[++$i] = [
            'field' => 'firstname',
            'txt' => $this->lng->txt('firstname'),
            'sortable' => true,
        ];
        if ($this->has_active_lp && $this->has_general_lp_access) {
            $columns[++$i] = [
                'field' => 'progress',
                'txt' => $this->lng->txt('learning_progress'),
                'sortable' => false,
            ];
        }

        return $columns;
    }

    protected function fillRow(array $a_set): void
    {
        parent::fillRow($a_set);

        $icons = ilLPStatusIcons::getInstance(ilLPStatusIcons::ICON_VARIANT_LONG);

        if ($this->has_active_lp && $this->has_general_lp_access) {
            if ($this->has_rbac_or_position_access || $this->actor->getId() === (int) $a_set['usr_id']) {
                $this->tpl->setCurrentBlock('val_lp');
                switch (true) {
                    case in_array($a_set['usr_id'], $this->completed, false):
                        $this->tpl->setVariable('LP_STATUS_ALT', $this->lng->txt(ilLPStatus::LP_STATUS_COMPLETED));
                        $this->tpl->setVariable(
                            'LP_STATUS_ICON',
                            $icons->renderIconForStatus(ilLPStatus::LP_STATUS_COMPLETED_NUM)
                        );
                        break;

                    case in_array($a_set['usr_id'], $this->in_progress, false):
                        $this->tpl->setVariable('LP_STATUS_ALT', $this->lng->txt(ilLPStatus::LP_STATUS_IN_PROGRESS));
                        $this->tpl->setVariable(
                            'LP_STATUS_ICON',
                            $icons->renderIconForStatus(ilLPStatus::LP_STATUS_IN_PROGRESS_NUM)
                        );
                        break;

                    case in_array($a_set['usr_id'], $this->failed, false):
                        $this->tpl->setVariable('LP_STATUS_ALT', $this->lng->txt(ilLPStatus::LP_STATUS_FAILED));
                        $this->tpl->setVariable(
                            'LP_STATUS_ICON',
                            $icons->renderIconForStatus(ilLPStatus::LP_STATUS_FAILED_NUM)
                        );
                        break;

                    default:
                        $this->tpl->setVariable('LP_STATUS_ALT', $this->lng->txt(ilLPStatus::LP_STATUS_NOT_ATTEMPTED));
                        $this->tpl->setVariable(
                            'LP_STATUS_ICON',
                            $icons->renderIconForStatus(ilLPStatus::LP_STATUS_NOT_ATTEMPTED_NUM)
                        );
                        break;
                }
                $this->tpl->parseCurrentBlock();
            } else {
                $this->tpl->touchBlock('no_lp');
            }
        }
    }

    public function numericOrdering(string $a_field): bool
    {
        switch ($a_field) {
            case 'ranking':
                return true;

            default:
                return false;
        }
    }
}