ILIAS\Test\Questions\Presentation\QuestionsTableActions Class Reference

Collaboration diagram for ILIAS\Test\Questions\Presentation\QuestionsTableActions:

Public Member Functions
	__construct (private readonly UIFactory $ui_factory, private readonly UIRenderer $ui_renderer, private \ilGlobalTemplateInterface $tpl, private readonly ServerRequestInterface $request, private readonly QuestionsTableQuery $table_query, private readonly Language $lng, private readonly \ilCtrl $ctrl, private readonly TestQuestionsRepository $questionrepository, private readonly Printer $question_printer, private readonly \ilObjTest $test_obj, private readonly bool $is_adjusting_questions_with_results_allowed, private readonly bool $is_in_test_with_results, private readonly bool $is_in_test_with_random_question_set, private readonly \ilTestQuestionSetConfigFactory $test_question_set_config_factory, private readonly ResponseHandler $test_response)
	setDisabledActions (OrderingRow $row, Properties $record)
	getOrderActionUrl ()
	getActions ()
	getQuestionTargetLinkBuilder ()
	handleCommand (string $cmd, array $row_ids, \Closure $protect_by_write_protection, \Closure $copy_and_link_to_questionpool, \Closure $get_table)

Private Member Functions
	getDeleteConfirmation (array $row_ids)
	redirectWithQuestionParameters (int $question_id, string $target_class, string $cmd)
	checkQuestionParametersForCopyToPool (array $question_ids)

Private Attributes
const	ACTION_SAVE_ORDER = 'save_order'
const	ACTION_DELETE = 'delete'
const	ACTION_DELETE_CONFIRMED = 'deletion_confirmed'
const	ACTION_COPY = 'copy'
const	ACTION_ADD_TO_POOL = 'add_qpl'
const	ACTION_PREVIEW = 'preview'
const	ACTION_ADJUST = 'correction'
const	ACTION_STATISTICS = 'statistics'
const	ACTION_EDIT_QUESTION = 'edit_question'
const	ACTION_EDIT_PAGE = 'edit_page'
const	ACTION_FEEDBACK = 'feedback'
const	ACTION_PRINT_QUESTIONS = 'print_questions'
const	ACTION_PRINT_ANSWERS = 'print_answers'
const	ACTION_DOWNLOAD_FILE_QUESTION_ANSWERS = 'download_files'
string	$table_id

Detailed Description

Definition at line 36 of file QuestionsTableActions.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Test\Questions\Presentation\QuestionsTableActions::__construct	(	private readonly UIFactory	$ui_factory,
		private readonly UIRenderer	$ui_renderer,
		private \ilGlobalTemplateInterface	$tpl,
		private readonly ServerRequestInterface	$request,
		private readonly QuestionsTableQuery	$table_query,
		private readonly Language	$lng,
		private readonly \ilCtrl	$ctrl,
		private readonly TestQuestionsRepository	$questionrepository,
		private readonly Printer	$question_printer,
		private readonly \ilObjTest	$test_obj,
		private readonly bool	$is_adjusting_questions_with_results_allowed,
		private readonly bool	$is_in_test_with_results,
		private readonly bool	$is_in_test_with_random_question_set,
		private readonly \ilTestQuestionSetConfigFactory	$test_question_set_config_factory,
		private readonly ResponseHandler	$test_response
	)

Parameters

array

$data

<string, mixed>

Definition at line 58 of file QuestionsTableActions.php.

      {
        $this->table_id = (string) $test_obj->getId();
    }

Member Function Documentation

checkQuestionParametersForCopyToPool()

ILIAS\Test\Questions\Presentation\QuestionsTableActions::checkQuestionParametersForCopyToPool ( array  $question_ids )

private

Parameters

array<int>

$question_ids

Definition at line 392 of file QuestionsTableActions.php.

                                                                              : bool
    {
        $question_properties = $this->questionrepository
            ->getQuestionPropertiesForQuestionIds($question_ids);
        foreach ($question_ids as $q_id) {
            if (!$this->questionrepository->originalQuestionExists($q_id)) {
                continue;
            }
 
            $type = \ilObject::_lookupType(
                \assQuestion::lookupParentObjId(
                    $question_properties[$q_id]->getGeneralQuestionProperties()->getOriginalId()
                )
            );
 
            if ($type !== 'tst') {
                $this->tpl->setOnScreenMessage('failure', $this->lng->txt('tst_link_only_unassigned'), true);
                return false;
            }
        }
        return true;
    }

References ilObject\_lookupType(), ILIAS\Repository\lng(), and assQuestion\lookupParentObjId().

Here is the call graph for this function:

getActions()

ILIAS\Test\Questions\Presentation\QuestionsTableActions::getActions

(

)

Definition at line 111 of file QuestionsTableActions.php.

                                : array
    {
        $ag = fn(string $type, string $label, $action): TableAction => $this->
            ui_factory->table()->action()->$type(
                $this->lng->txt($label),
                ...$this->table_query->getRowBoundURLBuilder($action)
            );
 
        $actions = [
            self::ACTION_PREVIEW => $ag('single', 'preview', self::ACTION_PREVIEW),
            self::ACTION_ADJUST => $ag('single', 'tst_corrections_qst_form', self::ACTION_ADJUST),
            self::ACTION_STATISTICS => $ag('single', 'statistics', self::ACTION_STATISTICS),
            self::ACTION_EDIT_QUESTION => $ag('single', 'edit_question', self::ACTION_EDIT_QUESTION),
            self::ACTION_EDIT_PAGE => $ag('single', 'edit_page', self::ACTION_EDIT_PAGE),
            self::ACTION_FEEDBACK => $ag('single', 'tst_feedback', self::ACTION_FEEDBACK),
            self::ACTION_PRINT_ANSWERS => $ag('single', 'print_answers', self::ACTION_PRINT_ANSWERS),
            self::ACTION_DOWNLOAD_FILE_QUESTION_ANSWERS => $ag('single', 'download_all_files', self::ACTION_DOWNLOAD_FILE_QUESTION_ANSWERS),
        ];
 
        if (!$this->is_in_test_with_random_question_set
           && (!$this->is_in_test_with_results || $this->is_adjusting_questions_with_results_allowed)) {
            $actions[self::ACTION_DELETE] = $ag('standard', 'delete', self::ACTION_DELETE)
                ->withAsync();
        }
 
        if (!$this->is_in_test_with_random_question_set && !$this->is_in_test_with_results) {
            $actions[self::ACTION_COPY] = $ag('standard', 'copy', self::ACTION_COPY);
        }
 
        return $actions + [
            self::ACTION_ADD_TO_POOL => $ag('standard', 'copy_and_link_to_questionpool', self::ACTION_ADD_TO_POOL),
            self::ACTION_PRINT_QUESTIONS => $ag('multi', 'print', self::ACTION_PRINT_QUESTIONS)
        ];
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

getDeleteConfirmation()

ILIAS\Test\Questions\Presentation\QuestionsTableActions::getDeleteConfirmation ( array  $row_ids )

private

Definition at line 335 of file QuestionsTableActions.php.

                                                          : Interruptive|MessageBox
    {
        if ($row_ids === []) {
            return $this->ui_factory->messageBox()->failure($this->lng->txt('msg_no_questions_selected'));
        }
 
        $items = [];
        foreach ($row_ids as $id) {
            $qdata = $this->test_obj->getQuestionDataset($id);
            $type = $this->questionrepository->getQuestionPropertiesForQuestionId($id)
                ->getGeneralQuestionProperties()->getTypeName($this->lng);
            $icon = $this->ui_renderer->render(
                $this->ui_factory->symbol()->icon()->standard('ques', $type, 'small')
            );
            $items[] = $this->ui_factory->modal()->interruptiveItem()->keyvalue(
                (string) $id,
                $icon . ' ' . $qdata->title,
                $type
            );
        }
 
        return $this->ui_factory->modal()->interruptive(
            $this->lng->txt('remove'),
            $this->lng->txt(
                $this->is_in_test_with_results
                    ? 'tst_remove_questions_and_results'
                    : 'tst_remove_questions'
            ),
            $this->table_query->getActionURL(self::ACTION_DELETE_CONFIRMED)->__toString()
        )
        ->withAffectedItems($items);
    }

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

Here is the call graph for this function:

getOrderActionUrl()

ILIAS\Test\Questions\Presentation\QuestionsTableActions::getOrderActionUrl

(

)

Definition at line 106 of file QuestionsTableActions.php.

                                       : URI
    {
        return $this->table_query->getActionURL(self::ACTION_SAVE_ORDER);
    }

getQuestionTargetLinkBuilder()

ILIAS\Test\Questions\Presentation\QuestionsTableActions::getQuestionTargetLinkBuilder

(

)

Definition at line 146 of file QuestionsTableActions.php.

                                                  : \Closure
    {
        return function (int $question_id): string {
            [$url_builder, $row_id_token] = $this->table_query->getRowBoundURLBuilder(self::ACTION_PREVIEW);
            return $url_builder->withParameter($row_id_token, (string) $question_id)
                ->buildURI()
                ->__toString();
        };
    }

handleCommand()

ILIAS\Test\Questions\Presentation\QuestionsTableActions::handleCommand	(	string	$cmd,
		array	$row_ids,
		\Closure	$protect_by_write_protection,
		\Closure	$copy_and_link_to_questionpool,
		\Closure	$get_table
	)

Returns

bool Show Questions After Return

Definition at line 159 of file QuestionsTableActions.php.

     : bool {
        switch ($cmd) {
            case self::ACTION_SAVE_ORDER:
                $protect_by_write_protection();
 
                if ($this->is_in_test_with_random_question_set || $this->is_in_test_with_results) {
                    $this->tpl->setOnScreenMessage('failure', $this->lng->txt('questionlist_cannot_be_altered'));
                    return true;
                }
 
                $data = $get_table()->getTableComponent()->getData();
                $this->test_obj->setQuestionOrder(array_flip($data), []);
                $this->tpl->setOnScreenMessage('success', $this->lng->txt('saved_successfully'), true);
                return true;
 
            case self::ACTION_PREVIEW:
                $this->redirectWithQuestionParameters(
                    current($row_ids),
                    \ilAssQuestionPreviewGUI::class,
                    \ilAssQuestionPreviewGUI::CMD_SHOW
                );
                return false;
 
            case self::ACTION_ADJUST:
                $this->redirectWithQuestionParameters(
                    current($row_ids),
                    \ilTestCorrectionsGUI::class,
                    'showQuestion'
                );
                return false;
 
            case self::ACTION_STATISTICS:
                $this->redirectWithQuestionParameters(
                    current($row_ids),
                    \ilAssQuestionPreviewGUI::class,
                    \ilAssQuestionPreviewGUI::CMD_STATISTICS
                );
                return false;
 
            case self::ACTION_EDIT_QUESTION:
                $question_id = current($row_ids);
                $qtype = $this->test_obj->getQuestionType($question_id);
                $target_class = $qtype . 'GUI';
                $this->redirectWithQuestionParameters(
                    $question_id,
                    $target_class,
                    'editQuestion'
                );
                return false;
 
            case self::ACTION_EDIT_PAGE:
                $this->redirectWithQuestionParameters(
                    current($row_ids),
                    \ilAssQuestionPageGUI::class,
                    'edit'
                );
                return false;
 
            case self::ACTION_FEEDBACK:
                $this->redirectWithQuestionParameters(
                    current($row_ids),
                    \ilAssQuestionFeedbackEditingGUI::class,
                    \ilAssQuestionFeedbackEditingGUI::CMD_SHOW
                );
                return false;
 
            case self::ACTION_DELETE:
                $this->test_response->sendAsync(
                    $this->ui_renderer->renderAsync(
                        $this->getDeleteConfirmation(array_filter($row_ids))
                    )
                );
                return false;
 
            case self::ACTION_DELETE_CONFIRMED:
                $row_ids = $this->request->getParsedBody()['interruptive_items'] ?? [];
                if (array_filter($row_ids) === []) {
 
                    return true;
                }
 
                if ($this->is_in_test_with_random_question_set
                    || $this->is_in_test_with_results
                        && !$this->is_adjusting_questions_with_results_allowed) {
                    $this->tpl->setOnScreenMessage('failure', $this->lng->txt('questionlist_cannot_be_altered'));
                    return true;
                }
 
                $protect_by_write_protection();
                if ($this->is_in_test_with_results) {
                    $this->test_obj->removeQuestionsWithResults($row_ids);
                } else {
                    $this->test_obj->removeQuestions($row_ids);
                    $this->test_obj->saveCompleteStatus($this->test_question_set_config_factory->getQuestionSetConfig());
                }
                $this->tpl->setOnScreenMessage('success', $this->lng->txt('tst_questions_removed'), true);
                return true;
 
            case self::ACTION_COPY:
                if (array_filter($row_ids) === []) {
                    $this->tpl->setOnScreenMessage('failure', $this->lng->txt('msg_no_questions_selected'));
                    return true;
                }
 
                if ($this->is_in_test_with_random_question_set || $this->is_in_test_with_results) {
                    $this->tpl->setOnScreenMessage('failure', $this->lng->txt('questionlist_cannot_be_altered'));
                    return true;
                }
 
                $protect_by_write_protection();
                $this->test_obj->copyQuestions($row_ids);
                $this->tpl->setOnScreenMessage('success', $this->lng->txt('copy_questions_success'), true);
                $this->ctrl->redirectByClass(\ilObjTestGUI::class, 'showQuestions');
                return true;
 
            case self::ACTION_ADD_TO_POOL:
                if (array_filter($row_ids) === []) {
                    $this->tpl->setOnScreenMessage('failure', $this->lng->txt('tst_no_question_selected_for_moving_to_qpl'));
                    return true;
                }
                $protect_by_write_protection();
                if (!$this->checkQuestionParametersForCopyToPool($row_ids)) {
                    return true;
                }
                $copy_and_link_to_questionpool();
                return false;
 
            case self::ACTION_PRINT_QUESTIONS:
                if (array_filter($row_ids) === []) {
                    $this->tpl->setOnScreenMessage('failure', $this->lng->txt('msg_no_questions_selected'));
                    return true;
                }
                $protect_by_write_protection();
                $this->question_printer->printSelectedQuestions(
                    array_reduce(
                        Types::cases(),
                        function (array $c, Types $v): array {
                            $c[$v->getLabel($this->lng)] = $this->table_query
                                ->getPrintViewTypeURL(self::ACTION_PRINT_QUESTIONS, $v->value)->__toString();
                            return $c;
                        },
                        []
                    ),
                    Types::tryFrom($this->table_query->getPrintViewType()) ?? Types::RESULTS_VIEW_TYPE_SHOW,
                    $row_ids
                );
                return false;
 
            case self::ACTION_PRINT_ANSWERS:
                $protect_by_write_protection();
                $this->question_printer->printAnswers(current($row_ids));
                return false;
 
            case self::ACTION_DOWNLOAD_FILE_QUESTION_ANSWERS:
                $protect_by_write_protection();
                $question_object = \assQuestion::instantiateQuestion(current($row_ids));
                if ($question_object instanceof \ilObjFileHandlingQuestionType) {
                    $question_object->deliverFileUploadZIPFile(
                        $this->test_obj->getRefId(),
                        $this->test_obj->getTestId(),
                        $this->test_obj->getTitle()
                    );
                }
 
                // no break
            default:
                throw new \InvalidArgumentException("No such table_cmd: '$cmd'.");
        }
    }

References Vendor\Package\$c, $data, ilAssQuestionFeedbackEditingGUI\CMD_SHOW, ilAssQuestionPreviewGUI\CMD_SHOW, ilAssQuestionPreviewGUI\CMD_STATISTICS, ILIAS\Repository\ctrl(), assQuestion\instantiateQuestion(), and ILIAS\Repository\lng().

Here is the call graph for this function:

redirectWithQuestionParameters()

ILIAS\Test\Questions\Presentation\QuestionsTableActions::redirectWithQuestionParameters ( int  $question_id, string  $target_class, string  $cmd  )

private

Definition at line 368 of file QuestionsTableActions.php.

     : void {
 
        $this->ctrl->setParameterByClass(
            $target_class,
            'q_id',
            $question_id
        );
 
        $this->ctrl->setParameterByClass(
            $target_class,
            'calling_test',
            (string) $this->test_obj->getRefId()
        );
 
        $this->ctrl->redirectByClass($target_class, $cmd);
    }

setDisabledActions()

ILIAS\Test\Questions\Presentation\QuestionsTableActions::setDisabledActions	(	OrderingRow	$row,
		Properties	$record
	)

Definition at line 78 of file QuestionsTableActions.php.

     : OrderingRow {
        $disable_default_actions = $this->is_in_test_with_random_question_set
            || $this->is_in_test_with_results;
 
        return $row->withDisabledAction(
            self::ACTION_ADD_TO_POOL,
            $this->is_in_test_with_random_question_set
        )->withDisabledAction(self::ACTION_EDIT_QUESTION, $disable_default_actions)
        ->withDisabledAction(self::ACTION_EDIT_PAGE, $disable_default_actions)
        ->withDisabledAction(
            self::ACTION_ADJUST,
            !$this->is_adjusting_questions_with_results_allowed
                || !$this->is_in_test_with_results
                || !\assQuestion::instantiateQuestionGUI(
                    $record->getGeneralQuestionProperties()->getQuestionId()
                )->supportsAdjustment()
        )->withDisabledAction(self::ACTION_FEEDBACK, $disable_default_actions)
        ->withDisabledAction(self::ACTION_PRINT_ANSWERS, !$this->is_in_test_with_results)
        ->withDisabledAction(
            self::ACTION_DOWNLOAD_FILE_QUESTION_ANSWERS,
            $row->getCellContent('type_tag') !== $this->lng->txt(\assFileUpload::class)
            || !$this->questionrepository->questionHasAnswers((int) $row->getId())
        );
    }

Field Documentation

$table_id

string ILIAS\Test\Questions\Presentation\QuestionsTableActions::$table_id

private

Definition at line 53 of file QuestionsTableActions.php.

ACTION_ADD_TO_POOL

const ILIAS\Test\Questions\Presentation\QuestionsTableActions::ACTION_ADD_TO_POOL = 'add_qpl'

private

Definition at line 42 of file QuestionsTableActions.php.

ACTION_ADJUST

const ILIAS\Test\Questions\Presentation\QuestionsTableActions::ACTION_ADJUST = 'correction'

private

Definition at line 44 of file QuestionsTableActions.php.

ACTION_COPY

const ILIAS\Test\Questions\Presentation\QuestionsTableActions::ACTION_COPY = 'copy'

private

Definition at line 41 of file QuestionsTableActions.php.

ACTION_DELETE

const ILIAS\Test\Questions\Presentation\QuestionsTableActions::ACTION_DELETE = 'delete'

private

Definition at line 39 of file QuestionsTableActions.php.

ACTION_DELETE_CONFIRMED

const ILIAS\Test\Questions\Presentation\QuestionsTableActions::ACTION_DELETE_CONFIRMED = 'deletion_confirmed'

private

Definition at line 40 of file QuestionsTableActions.php.

ACTION_DOWNLOAD_FILE_QUESTION_ANSWERS

const ILIAS\Test\Questions\Presentation\QuestionsTableActions::ACTION_DOWNLOAD_FILE_QUESTION_ANSWERS = 'download_files'

private

Definition at line 51 of file QuestionsTableActions.php.

ACTION_EDIT_PAGE

const ILIAS\Test\Questions\Presentation\QuestionsTableActions::ACTION_EDIT_PAGE = 'edit_page'

private

Definition at line 47 of file QuestionsTableActions.php.

ACTION_EDIT_QUESTION

const ILIAS\Test\Questions\Presentation\QuestionsTableActions::ACTION_EDIT_QUESTION = 'edit_question'

private

Definition at line 46 of file QuestionsTableActions.php.

ACTION_FEEDBACK

const ILIAS\Test\Questions\Presentation\QuestionsTableActions::ACTION_FEEDBACK = 'feedback'

private

Definition at line 48 of file QuestionsTableActions.php.

ACTION_PREVIEW

const ILIAS\Test\Questions\Presentation\QuestionsTableActions::ACTION_PREVIEW = 'preview'

private

Definition at line 43 of file QuestionsTableActions.php.

ACTION_PRINT_ANSWERS

const ILIAS\Test\Questions\Presentation\QuestionsTableActions::ACTION_PRINT_ANSWERS = 'print_answers'

private

Definition at line 50 of file QuestionsTableActions.php.

ACTION_PRINT_QUESTIONS

const ILIAS\Test\Questions\Presentation\QuestionsTableActions::ACTION_PRINT_QUESTIONS = 'print_questions'

private

Definition at line 49 of file QuestionsTableActions.php.

ACTION_SAVE_ORDER

const ILIAS\Test\Questions\Presentation\QuestionsTableActions::ACTION_SAVE_ORDER = 'save_order'

private

Definition at line 38 of file QuestionsTableActions.php.

ACTION_STATISTICS

const ILIAS\Test\Questions\Presentation\QuestionsTableActions::ACTION_STATISTICS = 'statistics'

private

Definition at line 45 of file QuestionsTableActions.php.

---

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

• components/ILIAS/Test/src/Questions/Presentation/QuestionsTableActions.php