ILIAS\Test\Utilities\TitleColumnsBuilder Class Reference

Collaboration diagram for ILIAS\Test\Utilities\TitleColumnsBuilder:

Public Member Functions
	__construct (private readonly GeneralQuestionPropertiesRepository $properties_repository, private readonly \ilCtrl $ctrl, private readonly \ilAccessHandler $access, private readonly \ilLanguage $lng, private readonly StaticURLServices $static_url, private readonly UIFactory $ui_factory, private readonly Refinery $refinery)
	buildQuestionTitleAsLink (int $question_id, int $test_ref_id)
	buildQuestionTitleAsText (?int $question_id)
	buildTestTitleAsLink (int $test_ref_id)
	buildTestTitleAsText (int $test_ref_id)
	buildAccessCheckedTestTitleAsLinkForObjId (int $test_obj_id, string $title)
	buildAccessCheckedQuestionpoolTitleAsLink (?int $qpl_id, ?string $title=null, bool $reference=false)

Private Member Functions
	buildPossiblyLinkedTitle (int $obj_id, string $title, string $target_class_type, bool $reference=false)
	getLinkedTitle (int $ref_id, string $title, string $target_class_type)
	getFirstReferenceWithCurrentUserAccess (bool $reference, int $obj_id, array $all_ref_ids)

Detailed Description

Definition at line 30 of file TitleColumnsBuilder.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Test\Utilities\TitleColumnsBuilder::__construct	(	private readonly GeneralQuestionPropertiesRepository	$properties_repository,
		private readonly \ilCtrl	$ctrl,
		private readonly \ilAccessHandler	$access,
		private readonly \ilLanguage	$lng,
		private readonly StaticURLServices	$static_url,
		private readonly UIFactory	$ui_factory,
		private readonly Refinery	$refinery
	)

Definition at line 32 of file TitleColumnsBuilder.php.

      {
    }

Member Function Documentation

buildAccessCheckedQuestionpoolTitleAsLink()

ILIAS\Test\Utilities\TitleColumnsBuilder::buildAccessCheckedQuestionpoolTitleAsLink	(	?int	$qpl_id,
		?string	$title = null,
		bool	$reference = false
	)

Definition at line 130 of file TitleColumnsBuilder.php.

References ilObject\_lookupObjId(), ilObject\_lookupTitle(), ilObject\_lookupType(), ILIAS\Test\Utilities\TitleColumnsBuilder\buildPossiblyLinkedTitle(), ILIAS\Repository\lng(), and null.

Referenced by ILIAS\Test\Questions\Properties\Properties\getAsQuestionsTableRow().

     : StandardLink {
        if ($qpl_id === null) {
            return $this->ui_factory->link()->standard(
                $title ?? $this->lng->txt('tst_question_not_from_pool_info'),
                ''
            )->withDisabled();
        }

        if (\ilObject::_lookupType($qpl_id, $reference) !== 'qpl') {
            return $this->ui_factory->link()->standard(
                $this->lng->txt('tst_question_not_from_pool_info'),
                ''
            )->withDisabled();
        }

        $qpl_obj_id = $qpl_id;
        if ($reference) {
            $qpl_obj_id = \ilObject::_lookupObjId($qpl_id);
        }

        return $this->buildPossiblyLinkedTitle(
            $qpl_obj_id,
            $title ?? \ilObject::_lookupTitle($qpl_obj_id),
            \ilObjQuestionPoolGUI::class,
            $reference
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

buildAccessCheckedTestTitleAsLinkForObjId()

ILIAS\Test\Utilities\TitleColumnsBuilder::buildAccessCheckedTestTitleAsLinkForObjId	(	int	$test_obj_id,
		string	$title
	)

Definition at line 119 of file TitleColumnsBuilder.php.

References ILIAS\Test\Utilities\TitleColumnsBuilder\buildPossiblyLinkedTitle().

     : StandardLink {
        return $this->buildPossiblyLinkedTitle(
            $test_obj_id,
            $title,
            \ilObjTestGUI::class
        );
    }

Here is the call graph for this function:

buildPossiblyLinkedTitle()

ILIAS\Test\Utilities\TitleColumnsBuilder::buildPossiblyLinkedTitle ( int  $obj_id, string  $title, string  $target_class_type, bool  $reference = false  )

private

Definition at line 162 of file TitleColumnsBuilder.php.

References $ref_id, ilObject\_getAllReferences(), ILIAS\Test\Utilities\TitleColumnsBuilder\getFirstReferenceWithCurrentUserAccess(), ILIAS\Test\Utilities\TitleColumnsBuilder\getLinkedTitle(), and null.

Referenced by ILIAS\Test\Utilities\TitleColumnsBuilder\buildAccessCheckedQuestionpoolTitleAsLink(), and ILIAS\Test\Utilities\TitleColumnsBuilder\buildAccessCheckedTestTitleAsLinkForObjId().

     : StandardLink {
        $ref_id = $this->getFirstReferenceWithCurrentUserAccess(
            $reference,
            $obj_id,
            \ilObject::_getAllReferences($obj_id)
        );

        if ($ref_id === null) {
            return $this->ui_factory->link()->standard(
                "{$title} ({$this->lng->txt('status_no_permission')})",
                ''
            )->withDisabled();
        }

        return $this->getLinkedTitle($ref_id, $title, $target_class_type);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

buildQuestionTitleAsLink()

ILIAS\Test\Utilities\TitleColumnsBuilder::buildQuestionTitleAsLink	(	int	$question_id,
		int	$test_ref_id
	)

Definition at line 43 of file TitleColumnsBuilder.php.

References null, and ILIAS\Repository\refinery().

Referenced by ILIAS\Test\Logging\TestError\getLogEntryAsDataTableRow(), ILIAS\Test\Logging\TestParticipantInteraction\getLogEntryAsDataTableRow(), ILIAS\Test\Logging\TestQuestionAdministrationInteraction\getLogEntryAsDataTableRow(), and ILIAS\Test\Logging\TestScoringInteraction\getLogEntryAsDataTableRow().

     : StandardLink {
        $question_title = $this->properties_repository->getForQuestionId($question_id)?->getTitle();

        if ($question_title === null) {
            return $this->ui_factory->link()->standard(
                "{$this->lng->txt('deleted')} ({$this->lng->txt('id')}: {$question_id})",
                ''
            )->withDisabled();
        }

        return $this->ui_factory->link()->standard(
            $this->refinery->encode()->htmlSpecialCharsAsEntities()->transform(
                $this->properties_repository->getForQuestionId($question_id)?->getTitle()
            ),
            $this->static_url->builder()->build(
                'tst',
                new ReferenceId($test_ref_id),
                ['qst', $question_id]
            )->__toString()
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

buildQuestionTitleAsText()

ILIAS\Test\Utilities\TitleColumnsBuilder::buildQuestionTitleAsText

(

?int

$question_id

)

Definition at line 68 of file TitleColumnsBuilder.php.

References null, and ILIAS\Repository\refinery().

Referenced by ILIAS\Test\Logging\TestError\getLogEntryAsExportRow(), ILIAS\Test\Logging\TestQuestionAdministrationInteraction\getLogEntryAsExportRow(), ILIAS\Test\Logging\TestParticipantInteraction\getLogEntryAsExportRow(), and ILIAS\Test\Logging\TestScoringInteraction\getLogEntryAsExportRow().

     : string {
        if ($question_id === null) {
            return '';
        }
        $question_title = $this->properties_repository->getForQuestionId($question_id)?->getTitle();

        if ($question_title === null) {
            return "{$this->lng->txt('deleted')} ({$this->lng->txt('id')}: {$question_id})";
        }

        return $this->refinery->encode()->htmlSpecialCharsAsEntities()->transform($question_title);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

buildTestTitleAsLink()

ILIAS\Test\Utilities\TitleColumnsBuilder::buildTestTitleAsLink

(

int

$test_ref_id

)

Definition at line 83 of file TitleColumnsBuilder.php.

References ilObject\_isInTrash(), ilObject\_lookupObjId(), and ilObject\_lookupTitle().

Referenced by ILIAS\Test\Logging\TestError\getLogEntryAsDataTableRow(), ILIAS\Test\Logging\TestAdministrationInteraction\getLogEntryAsDataTableRow(), ILIAS\Test\Logging\TestParticipantInteraction\getLogEntryAsDataTableRow(), ILIAS\Test\Logging\TestQuestionAdministrationInteraction\getLogEntryAsDataTableRow(), and ILIAS\Test\Logging\TestScoringInteraction\getLogEntryAsDataTableRow().

                                                          : StandardLink
    {
        $test_obj_id = \ilObject::_lookupObjId($test_ref_id);
        if ($test_obj_id === 0) {
            return $this->ui_factory->link()->standard(
                "{$this->lng->txt('deleted')} ({$this->lng->txt('id')}: {$test_ref_id})",
                ''
            )->withDisabled();
        }

        if (\ilObject::_isInTrash($test_ref_id)) {
            return $this->ui_factory->link()->standard(
                "{$this->lng->txt('in_trash')} ({$this->lng->txt('title')}: "
                    . \ilObject::_lookupTitle($test_obj_id) . ", {$this->lng->txt('id')}: {$test_ref_id})",
                ''
            );
        }

        return $this->ui_factory->link()->standard(
            \ilObject::_lookupTitle($test_obj_id),
            $this->static_url->builder()->build('tst', new ReferenceId($test_ref_id))->__toString()
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

buildTestTitleAsText()

ILIAS\Test\Utilities\TitleColumnsBuilder::buildTestTitleAsText

(

int

$test_ref_id

)

Definition at line 107 of file TitleColumnsBuilder.php.

References ilObject\_lookupObjId().

Referenced by ILIAS\Test\Logging\TestAdministrationInteraction\getLogEntryAsExportRow(), ILIAS\Test\Logging\TestError\getLogEntryAsExportRow(), ILIAS\Test\Logging\TestQuestionAdministrationInteraction\getLogEntryAsExportRow(), ILIAS\Test\Logging\TestParticipantInteraction\getLogEntryAsExportRow(), and ILIAS\Test\Logging\TestScoringInteraction\getLogEntryAsExportRow().

                                                          : string
    {
        $test_obj_id = \ilObject::_lookupObjId($test_ref_id);
        if ($test_obj_id === 0) {
            return "{$this->lng->txt('deleted')} ({$this->lng->txt('id')}: {$test_ref_id})";
        }

        return \ilObject::_lookupTitle($test_obj_id);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getFirstReferenceWithCurrentUserAccess()

ILIAS\Test\Utilities\TitleColumnsBuilder::getFirstReferenceWithCurrentUserAccess ( bool  $reference, int  $obj_id, array  $all_ref_ids  )

private

Definition at line 200 of file TitleColumnsBuilder.php.

References $ref_id, ILIAS\Repository\access(), and null.

Referenced by ILIAS\Test\Utilities\TitleColumnsBuilder\buildPossiblyLinkedTitle().

     : ?int {
        if ($reference && $this->access->checkAccess('read', '', $obj_id)) {
            return $obj_id;
        }

        $references_with_access = array_filter(
            array_values($all_ref_ids),
            function (int $ref_id): bool {
                return $this->access->checkAccess('read', '', $ref_id);
            }
        );
        if ($references_with_access !== []) {
            return array_shift($references_with_access);
        }
        return null;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getLinkedTitle()

ILIAS\Test\Utilities\TitleColumnsBuilder::getLinkedTitle ( int  $ref_id, string  $title, string  $target_class_type  )

private

Definition at line 184 of file TitleColumnsBuilder.php.

References ILIAS\Repository\ctrl().

Referenced by ILIAS\Test\Utilities\TitleColumnsBuilder\buildPossiblyLinkedTitle().

     : StandardLink {
        $this->ctrl->setParameterByClass($target_class_type, 'ref_id', $ref_id);
        $linked_title = $this->ui_factory->link()->standard(
            $title,
            $this->ctrl->getLinkTargetByClass(
                [$target_class_type]
            )
        );
        $this->ctrl->clearParametersByClass($target_class_type);
        return $linked_title;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• components/ILIAS/Test/src/Utilities/TitleColumnsBuilder.php