Inheritance diagram for ILIAS\Questions\Presentation\Definitions\DefaultEnvironment:

Collaboration diagram for ILIAS\Questions\Presentation\Definitions\DefaultEnvironment:

Public Member Functions
	__construct (private readonly \ilCtrl $ctrl, private readonly HTTPServices $http, private readonly Refinery $refinery, private readonly Language $lng, private readonly \ilTabsGUI $tabs_gui, private readonly UuidFactory $uuid_factory, private readonly Factory $presentation_factory, private readonly Editability $editability, private readonly RequiredCapabilities $required_capabilities, private readonly int $parent_obj_id, URI $base_uri)

	getHttpServices ()

	getLanguage ()

	getRefinery ()

	getUIFactory ()

	setEditAnswerFormBackTarget ()

	addEditAnswerFormSubTab (string $sub_action, string $language_variable)

	activateEditAnswerFormSubTab (string $sub_action)

	getPresentationFactory ()

	getUrlBuilder ()

	withSubActionParameter (string $sub_action)

	withDefaultSubAction ()

	getSubAction ()

	getEditability ()

	isMarkingRequired ()

	getAnswerFormTableActionsForRequiredCapabilities ()

	isInCreationContext ()

	getAnswerFormId ()
	Returns the answer form id of the current context either from the answer form properties, if available, or from the corresponding get parameter. More...

	getAnswerFormProperties ()

	withAnswerFormProperties (Properties $properties)

	getTableRowIdToken ()

	getTableRowIds ()

	withPreservedTableRowIdsParameter ()

	redirectTo (URLBuilder $target)

	runPageMigrations ()

	withIsInCreationContext (bool $is_in_creation_context)

	getParentObjId ()

	getAction ()

	withActionParameter (string $action)

	withQuestionIdParameter (Uuid $question_id)

	withAnswerFormTypeHashParameter (string $type_hash)

	withAnswerFormIdParameter (Uuid $answer_form_id)

	withCreateModeParameter ()

	withFormStartSubActionParameter (string $sub_action)

	withPreservedFormStartSubActionParameter ()

	getQuestionId ()

	getQuestionIds ()
	This function will either return the QuestionIds from the $_GET parameter for row ids OR from an InterruptiveItems $_POST value. More...

	getTypeClassHash ()

	getFormStartSubAction ()

	isCreateModeSimple ()

	setEditAnswerFormTabs (array $additional_actions)

	preserveParametersForPageEditorCmds ()

	setParamtersForSimpleCreateCmd (Uuid $question_id)

	isCreateAndNewAction ()

	buildURLBuilderTokenForCreateAndNew ()

	getHttpServices ()

	getLanguage ()

	getRefinery ()

	getUIFactory ()

	setEditAnswerFormBackTarget ()

	addEditAnswerFormSubTab (string $sub_action, string $text)

	activateEditAnswerFormSubTab (string $sub_action)

	getPresentationFactory ()

	getUrlBuilder ()

	getTableRowIdToken ()

	getTableRowIds ()

	getSubAction ()

	withDefaultSubAction ()

	getEditability ()

	isMarkingRequired ()

	getAnswerFormTableActionsForRequiredCapabilities ()

	isInCreationContext ()

	getAnswerFormId ()
	Returns the answer form id of the current context either from the answer form properties, if available, or from the corresponding get parameter. More...

	getAnswerFormProperties ()

	withAnswerFormProperties (Properties $properties)

	withSubActionParameter (string $sub_action)

	getFormStartSubAction ()

	withFormStartSubActionParameter (string $form_start_command)

	withPreservedFormStartSubActionParameter ()

	withPreservedTableRowIdsParameter ()

	redirectTo (URLBuilder $target)

Private Member Functions
	setQuestionIdParamterForPageEditorCmds (Uuid $question_id)

	buildEditAnswerFormBackUrl ()

	acquireURLBuilderAndParameters (URI $base_uri)

	retrieveStringValueForToken (URLBuilderToken $token)

	buildStringTrafo ()

	buildRetrieveUuidClosure ()

Private Attributes
const array	QUERY_PARAMETER_NAME_SPACE = ['q']

const string	TOKEN_STRING_ACTION = 'a'

const string	TOKEN_STRING_SUB_ACTION = 'sa'

const string	TOKEN_STRING_QUESTION_ID = 'q'

const string	TOKEN_STRING_TABLE_ROW_ID = 'r'

const string	TOKEN_STRING_TYPE_HASH = 't'

const string	TOKEN_STRING_ANSWER_FORM_ID = 'af'

const string	TOKEN_STRING_CREATE_MODE = 'cm'

const string	TOKEN_STRING_FORM_START_SUB_ACTION = 'fssa'

const string	TOKEN_STRING_CREATE_AND_NEW = 'can'

const string	PARAMETER_STRING_HIER_ID = 'hier_id'

const string	INTERRUPTIVE_ITEMS_KEY = 'interruptive_items'

const string	TAB_ID_ANSWER_FORM = 'answer_form'

Properties	$answer_form_properties = null

bool	$default_sub_action = false

bool	$is_in_creation_context = false

URLBuilder	$url_builder

readonly URLBuilderToken	$table_row_token

readonly URLBuilderToken	$question_id_token

URLBuilderToken	$sub_action_token = null

URLBuilderToken	$action_token = null

URLBuilderToken	$type_hash_token = null

URLBuilderToken	$answer_form_id_token = null

URLBuilderToken	$create_mode_token = null

URLBuilderToken	$form_start_sub_action_token = null

array	$table_row_ids = null

Detailed Description

Definition at line 40 of file DefaultEnvironment.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Questions\Presentation\Definitions\DefaultEnvironment::__construct	(	private readonly \ilCtrl	$ctrl,
		private readonly HTTPServices	$http,
		private readonly Refinery	$refinery,
		private readonly Language	$lng,
		private readonly \ilTabsGUI	$tabs_gui,
		private readonly UuidFactory	$uuid_factory,
		private readonly Factory	$presentation_factory,
		private readonly Editability	$editability,
		private readonly RequiredCapabilities	$required_capabilities,
		private readonly int	$parent_obj_id,
		URI	$base_uri
	)

Definition at line 76 of file DefaultEnvironment.php.

      {
        $this->acquireURLBuilderAndParameters($base_uri);
    }

References ILIAS\Questions\Presentation\Definitions\DefaultEnvironment\acquireURLBuilderAndParameters().

Here is the call graph for this function:

Member Function Documentation

◆ acquireURLBuilderAndParameters()

ILIAS\Questions\Presentation\Definitions\DefaultEnvironment::acquireURLBuilderAndParameters ( URI $base_uri )

private

Definition at line 671 of file DefaultEnvironment.php.

     : void {
        [
            $this->url_builder,
            $this->table_row_token,
            $this->question_id_token
        ] = (new URLBuilder($base_uri))
            ->acquireParameters(
                self::QUERY_PARAMETER_NAME_SPACE,
                self::TOKEN_STRING_TABLE_ROW_ID,
                self::TOKEN_STRING_QUESTION_ID
            );
    }

Referenced by ILIAS\Questions\Presentation\Definitions\DefaultEnvironment\__construct().

Here is the caller graph for this function:

◆ activateEditAnswerFormSubTab()

ILIAS\Questions\Presentation\Definitions\DefaultEnvironment::activateEditAnswerFormSubTab ( string $sub_action )

Implements ILIAS\Questions\Presentation\Definitions\Environment.

Definition at line 143 of file DefaultEnvironment.php.

     : void {
        $this->tabs_gui->activateSubTab($sub_action);
    }

◆ addEditAnswerFormSubTab()

ILIAS\Questions\Presentation\Definitions\DefaultEnvironment::addEditAnswerFormSubTab	(	string	$sub_action,
		string	$language_variable
	)

Implements ILIAS\Questions\Presentation\Definitions\Environment.

Definition at line 127 of file DefaultEnvironment.php.

     : void {
        $this->tabs_gui->addSubTab(
            $sub_action,
            $this->lng->txt($language_variable),
            $this->withSubActionParameter($sub_action)
                ->withActionParameter(Edit::ACTION_OTHER_ANSWER_FORM)
                ->getUrlBuilder()
                ->buildURI()
                ->__toString()
        );
    }

◆ buildEditAnswerFormBackUrl()

ILIAS\Questions\Presentation\Definitions\DefaultEnvironment::buildEditAnswerFormBackUrl ( )

private

Definition at line 644 of file DefaultEnvironment.php.

                                                 : URLBuilder
    {
        if (!$this->is_in_creation_context) {
            return $this->withDefaultSubAction()->getUrlBuilder();
        }
 
        if (!$this->isCreateModeSimple()) {
            return new URLBuilder(
                new URI(
                    ILIAS_HTTP_PATH . '/' . $this->ctrl->getLinkTargetByClass(
                        \QstsQuestionPageGUI::class,
                        'edit'
                    )
                )
            );
        }
 
        return $this->withActionParameter(
            Edit::ACTION_DELETE_QUESTIONS
        )->withSubActionParameter(
            Edit::ACTION_DELETE_QUESTIONS
        )->getUrlBuilder()->withParameter(
            $this->table_row_token,
            [$this->getQuestionId()->toString()]
        );
    }

References ILIAS\Repository\ctrl(), and ILIAS\Export\ImportHandler\File\XML\Manifest\toString.

Here is the call graph for this function:

◆ buildRetrieveUuidClosure()

ILIAS\Questions\Presentation\Definitions\DefaultEnvironment::buildRetrieveUuidClosure ( )

private

Definition at line 703 of file DefaultEnvironment.php.

                                               : \Closure
    {
        return fn($v): Uuid => is_string($v)
            ? $this->uuid_factory->fromString($v)
            : throw new \UnexpectedValueException();
    }

◆ buildStringTrafo()

ILIAS\Questions\Presentation\Definitions\DefaultEnvironment::buildStringTrafo ( )

private

Definition at line 695 of file DefaultEnvironment.php.

                                       : Transformation
    {
        return $this->refinery->byTrying([
            $this->refinery->kindlyTo()->string(),
            $this->refinery->always('')
        ]);
    }

References ILIAS\Repository\refinery().

Here is the call graph for this function:

◆ buildURLBuilderTokenForCreateAndNew()

ILIAS\Questions\Presentation\Definitions\DefaultEnvironment::buildURLBuilderTokenForCreateAndNew ( )

Definition at line 626 of file DefaultEnvironment.php.

                                                         : URLBuilderToken
    {
        return new URLBuilderToken(
            self::QUERY_PARAMETER_NAME_SPACE,
            self::TOKEN_STRING_CREATE_AND_NEW
        );
    }

◆ getAction()

ILIAS\Questions\Presentation\Definitions\DefaultEnvironment::getAction ( )

Definition at line 348 of file DefaultEnvironment.php.

                               : string
    {
        $action_token = $this->action_token;
        if ($action_token === null) {
            [,$action_token] = $this->url_builder->acquireParameter(
                self::QUERY_PARAMETER_NAME_SPACE,
                self::TOKEN_STRING_ACTION
            );
        }
        return $this->retrieveStringValueForToken($action_token);
    }

◆ getAnswerFormId()

ILIAS\Questions\Presentation\Definitions\DefaultEnvironment::getAnswerFormId ( )

Returns the answer form id of the current context either from the answer form properties, if available, or from the corresponding get parameter.

There should always be one of the two ids availabe, but be aware that is not guaranteed, e.g. if somebody messed with the URI.

Implements ILIAS\Questions\Presentation\Definitions\Environment.

Definition at line 239 of file DefaultEnvironment.php.

                                     : ?Uuid
    {
        if ($this->answer_form_properties !== null) {
            return $this->answer_form_properties->getAnswerFormId();
        }
 
        $answer_form_id_token = $this->answer_form_id_token;
        if ($answer_form_id_token === null) {
            [,$answer_form_id_token] = $this->url_builder->acquireParameter(
                self::QUERY_PARAMETER_NAME_SPACE,
                self::TOKEN_STRING_ANSWER_FORM_ID
            );
        }
        return $this->http->wrapper()->query()->retrieve(
            $answer_form_id_token->getName(),
            $this->refinery->byTrying([
                $this->refinery->custom()->transformation(
                    $this->buildRetrieveUuidClosure()
                ),
                $this->refinery->always(null)
            ])
        );
    }

References ILIAS\UI\URLBuilderToken\getName(), and ILIAS\FileDelivery\http().

Here is the call graph for this function:

◆ getAnswerFormProperties()

ILIAS\Questions\Presentation\Definitions\DefaultEnvironment::getAnswerFormProperties ( )

Implements ILIAS\Questions\Presentation\Definitions\Environment.

Definition at line 264 of file DefaultEnvironment.php.

                                             : ?Properties
    {
        return $this->answer_form_properties;
    }

Referenced by ILIAS\Questions\AnswerForm\Capabilities\RequiredCapabilities\doFirstFormStepAction(), and ILIAS\Questions\AnswerForm\Capabilities\Definitions\AdditionalFormStepAction\toNext().

Here is the caller graph for this function:

◆ getAnswerFormTableActionsForRequiredCapabilities()

ILIAS\Questions\Presentation\Definitions\DefaultEnvironment::getAnswerFormTableActionsForRequiredCapabilities ( )

Implements ILIAS\Questions\Presentation\Definitions\Environment.

Definition at line 222 of file DefaultEnvironment.php.

                                                                      : array
    {
        return array_map(
            fn(AdditionalFormStepAction $v): TableAction => $v->getAsTableAction(
                $this->withActionParameter($v->getIdentifier())
            ),
            $this->required_capabilities->getRequiredFormStepActions()
        );
    }

References ILIAS\Questions\AnswerForm\Capabilities\Definitions\AdditionalFormStepAction\getAsTableAction(), and ILIAS\Questions\AnswerForm\Capabilities\Definitions\AdditionalFormStepAction\getIdentifier().

Here is the call graph for this function:

◆ getEditability()

ILIAS\Questions\Presentation\Definitions\DefaultEnvironment::getEditability ( )

Implements ILIAS\Questions\Presentation\Definitions\Environment.

Definition at line 210 of file DefaultEnvironment.php.

                                    : Editability
    {
        return $this->editability;
    }

◆ getFormStartSubAction()

ILIAS\Questions\Presentation\Definitions\DefaultEnvironment::getFormStartSubAction ( )

Implements ILIAS\Questions\Presentation\Definitions\Environment.

Definition at line 533 of file DefaultEnvironment.php.

                                           : string
    {
        $form_start_command_token = $this->form_start_sub_action_token;
        if ($form_start_command_token === null) {
            [,$form_start_command_token] = $this->url_builder->acquireParameter(
                self::QUERY_PARAMETER_NAME_SPACE,
                self::TOKEN_STRING_FORM_START_SUB_ACTION
            );
        }
        return $this->retrieveStringValueForToken($form_start_command_token);
    }

◆ getHttpServices()

ILIAS\Questions\Presentation\Definitions\DefaultEnvironment::getHttpServices ( )

Implements ILIAS\Questions\Presentation\Definitions\Environment.

Definition at line 93 of file DefaultEnvironment.php.

                                     : HTTPServices
    {
        return $this->http;
    }

References ILIAS\BookingManager\Common\Table\$http.

◆ getLanguage()

ILIAS\Questions\Presentation\Definitions\DefaultEnvironment::getLanguage ( )

Implements ILIAS\Questions\Presentation\Definitions\Environment.

Definition at line 99 of file DefaultEnvironment.php.

                                 : Language
    {
        return $this->lng;
    }

References $lng.

Referenced by ILIAS\Questions\Question\Views\Edit\buildBasicPropertiesCreateForm(), and ILIAS\Questions\Question\Views\Edit\buildPreviewPanelQuestionContent().

Here is the caller graph for this function:

◆ getParentObjId()

ILIAS\Questions\Presentation\Definitions\DefaultEnvironment::getParentObjId ( )

Definition at line 343 of file DefaultEnvironment.php.

                                    : int
    {
        return $this->parent_obj_id;
    }

◆ getPresentationFactory()

ILIAS\Questions\Presentation\Definitions\DefaultEnvironment::getPresentationFactory ( )

Implements ILIAS\Questions\Presentation\Definitions\Environment.

Definition at line 150 of file DefaultEnvironment.php.

                                            : Factory
    {
        return $this->presentation_factory;
    }

Referenced by ILIAS\Questions\Presentation\Views\Edit\deleteQuestions().

Here is the caller graph for this function:

◆ getQuestionId()

ILIAS\Questions\Presentation\Definitions\DefaultEnvironment::getQuestionId ( )

Definition at line 475 of file DefaultEnvironment.php.

                                   : ?Uuid
    {
        return $this->http->wrapper()->query()->retrieve(
            $this->question_id_token->getName(),
            $this->refinery->byTrying([
                $this->refinery->custom()->transformation(
                    $this->buildRetrieveUuidClosure()
                ),
                $this->refinery->always(null)
            ])
        );
    }

References ILIAS\FileDelivery\http().

Here is the call graph for this function:

◆ getQuestionIds()

ILIAS\Questions\Presentation\Definitions\DefaultEnvironment::getQuestionIds ( )

This function will either return the QuestionIds from the $_GET parameter for row ids OR from an InterruptiveItems $_POST value.

Returns: array<\ILIAS\Data\UUID\Uuid>|string|null

Definition at line 493 of file DefaultEnvironment.php.

                                    : array|string|null
    {
        return $this->http->wrapper()->query()->retrieve(
            $this->table_row_token->getName(),
            $this->refinery->byTrying([
                $this->refinery->custom()->transformation(
                    fn($v): string => $v === ['ALL_OBJECTS']
                        ? 'ALL_OBJECTS'
                        : throw new \UnexpectedValueException()
                ),
                $this->refinery->kindlyTo()->listOf(
                    $this->refinery->custom()->transformation(
                        $this->buildRetrieveUuidClosure()
                    )
                ),
                $this->refinery->always(null)
            ])
        ) ?? $this->http->wrapper()->post()->retrieve(
            self::INTERRUPTIVE_ITEMS_KEY,
            $this->refinery->kindlyTo()->listOf(
                $this->refinery->custom()->transformation(
                    $this->buildRetrieveUuidClosure()
                )
            ),
            $this->refinery->always(null)
        );
    }

References ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

Here is the call graph for this function:

◆ getRefinery()

ILIAS\Questions\Presentation\Definitions\DefaultEnvironment::getRefinery ( )

Implements ILIAS\Questions\Presentation\Definitions\Environment.

Definition at line 105 of file DefaultEnvironment.php.

                                 : Refinery
    {
        return $this->refinery;
    }

References ILIAS\UI\examples\Layout\Page\Mail\$refinery.

Referenced by ILIAS\Questions\Question\Views\Edit\buildBasicPropertiesCreateForm(), and ILIAS\Questions\Question\Views\Edit\buildPreviewPanelQuestionContent().

Here is the caller graph for this function:

◆ getSubAction()

ILIAS\Questions\Presentation\Definitions\DefaultEnvironment::getSubAction ( )

Implements ILIAS\Questions\Presentation\Definitions\Environment.

Definition at line 189 of file DefaultEnvironment.php.

                                  : string
    {
        if ($this->default_sub_action) {
            return '';
        }
 
        $sub_action_token = $this->sub_action_token;
        if ($sub_action_token === null) {
            [,$sub_action_token] = $this->url_builder->acquireParameter(
                self::QUERY_PARAMETER_NAME_SPACE,
                self::TOKEN_STRING_SUB_ACTION
            );
        }
 
        return $this->retrieveStringValueForToken(
            $sub_action_token,
            self::TOKEN_STRING_SUB_ACTION
        );
    }

Referenced by ILIAS\Questions\AnswerForm\Capabilities\Definitions\AdditionalFormStepAction\do().

Here is the caller graph for this function:

◆ getTableRowIds()

ILIAS\Questions\Presentation\Definitions\DefaultEnvironment::getTableRowIds ( )

Returns: list<string>

Implements ILIAS\Questions\Presentation\Definitions\Environment.

Definition at line 288 of file DefaultEnvironment.php.

                                    : array
    {
        if ($this->table_row_ids === null) {
            $this->table_row_ids = $this->http->wrapper()->query()->retrieve(
                $this->table_row_token->getName(),
                $this->refinery->byTrying([
                    $this->refinery->kindlyTo()->listOf(
                        $this->refinery->custom()->transformation(
                            fn($v): string => $v !== ''
                                ? $this->refinery->kindlyTo()->string()->transform($v)
                                : throw new \UnexpectedValueException()
                        )
                    ),
                    $this->refinery->always([])
                ])
            );
        }
 
        return $this->table_row_ids;
    }

References ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

Here is the call graph for this function:

◆ getTableRowIdToken()

ILIAS\Questions\Presentation\Definitions\DefaultEnvironment::getTableRowIdToken ( )

Implements ILIAS\Questions\Presentation\Definitions\Environment.

Definition at line 279 of file DefaultEnvironment.php.

                                        : URLBuilderToken
    {
        return $this->table_row_token;
    }

◆ getTypeClassHash()

ILIAS\Questions\Presentation\Definitions\DefaultEnvironment::getTypeClassHash ( )

Definition at line 521 of file DefaultEnvironment.php.

                                      : string
    {
        $type_hash_token = $this->type_hash_token;
        if ($type_hash_token === null) {
            [,$type_hash_token] = $this->url_builder->acquireParameter(
                self::QUERY_PARAMETER_NAME_SPACE,
                self::TOKEN_STRING_TYPE_HASH
            );
        }
        return $this->retrieveStringValueForToken($type_hash_token);
    }

◆ getUIFactory()

ILIAS\Questions\Presentation\Definitions\DefaultEnvironment::getUIFactory ( )

Implements ILIAS\Questions\Presentation\Definitions\Environment.

Definition at line 111 of file DefaultEnvironment.php.

                                  : UIFactory
    {
        return $this->presentation_factory->getUIFactory();
    }

Referenced by ILIAS\Questions\Question\Views\Edit\buildPreviewPanelQuestionContent().

Here is the caller graph for this function:

◆ getUrlBuilder()

ILIAS\Questions\Presentation\Definitions\DefaultEnvironment::getUrlBuilder ( )

Implements ILIAS\Questions\Presentation\Definitions\Environment.

Definition at line 156 of file DefaultEnvironment.php.

                                   : URLBuilder
    {
        return $this->url_builder;
    }

◆ isCreateAndNewAction()

ILIAS\Questions\Presentation\Definitions\DefaultEnvironment::isCreateAndNewAction ( )

Definition at line 619 of file DefaultEnvironment.php.

                                          : bool
    {
        return $this->http->wrapper()->query()->has(
            $this->buildURLBuilderTokenForCreateAndNew()->getName()
        );
    }

References ILIAS\FileDelivery\http().

Here is the call graph for this function:

◆ isCreateModeSimple()

ILIAS\Questions\Presentation\Definitions\DefaultEnvironment::isCreateModeSimple ( )

Definition at line 545 of file DefaultEnvironment.php.

                                        : bool
    {
        $create_mode_token = $this->create_mode_token;
        if ($create_mode_token === null) {
            [, $create_mode_token] = $this->url_builder->acquireParameter(
                self::QUERY_PARAMETER_NAME_SPACE,
                self::TOKEN_STRING_CREATE_MODE
            );
        }
 
        return $this->http->wrapper()->query()->has(
            $create_mode_token->getName()
        );
    }

References ILIAS\UI\URLBuilderToken\getName(), and ILIAS\FileDelivery\http().

Here is the call graph for this function:

◆ isInCreationContext()

ILIAS\Questions\Presentation\Definitions\DefaultEnvironment::isInCreationContext ( )

Implements ILIAS\Questions\Presentation\Definitions\Environment.

Definition at line 233 of file DefaultEnvironment.php.

                                         : bool
    {
        return $this->is_in_creation_context;
    }

◆ isMarkingRequired()

ILIAS\Questions\Presentation\Definitions\DefaultEnvironment::isMarkingRequired ( )

Implements ILIAS\Questions\Presentation\Definitions\Environment.

Definition at line 216 of file DefaultEnvironment.php.

                                       : bool
    {
        return $this->required_capabilities->isMarkingRequired();
    }

◆ preserveParametersForPageEditorCmds()

ILIAS\Questions\Presentation\Definitions\DefaultEnvironment::preserveParametersForPageEditorCmds ( )

Definition at line 591 of file DefaultEnvironment.php.

                                                         : void
    {
        $this->setQuestionIdParamterForPageEditorCmds($this->getQuestionId());
    }

◆ redirectTo()

ILIAS\Questions\Presentation\Definitions\DefaultEnvironment::redirectTo ( URLBuilder $target )

Implements ILIAS\Questions\Presentation\Definitions\Environment.

Definition at line 320 of file DefaultEnvironment.php.

                                                  : void
    {
        $this->ctrl->redirectToURL(
            $target->buildURI()->__toString()
        );
    }

References ILIAS\UI\URLBuilder\buildURI(), and ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ retrieveStringValueForToken()

ILIAS\Questions\Presentation\Definitions\DefaultEnvironment::retrieveStringValueForToken ( URLBuilderToken $token )

private

Definition at line 686 of file DefaultEnvironment.php.

     : string {
        return $this->http->wrapper()->query()->retrieve(
            $token->getName(),
            $this->buildStringTrafo()
        );
    }

◆ runPageMigrations()

ILIAS\Questions\Presentation\Definitions\DefaultEnvironment::runPageMigrations ( )

Definition at line 327 of file DefaultEnvironment.php.

                                       : void
    {
        foreach ($this->required_capabilities
            ->getRequiredPageMigrationProviders() as $provider) {
            $provider->runPageMigrations();
        }
    }

◆ setEditAnswerFormBackTarget()

ILIAS\Questions\Presentation\Definitions\DefaultEnvironment::setEditAnswerFormBackTarget ( )

Implements ILIAS\Questions\Presentation\Definitions\Environment.

Definition at line 117 of file DefaultEnvironment.php.

                                                 : void
    {
        $this->tabs_gui->clearTargets();
        $this->tabs_gui->setBackTarget(
            $this->lng->txt('cancel'),
            $this->buildEditAnswerFormBackUrl()->buildURI()->__toString()
        );
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

◆ setEditAnswerFormTabs()

ILIAS\Questions\Presentation\Definitions\DefaultEnvironment::setEditAnswerFormTabs ( array $additional_actions )

Parameters

array<

ILIAS\Questions\AnswerForm\Capabilities\Action> $additional_actions

Definition at line 564 of file DefaultEnvironment.php.

     : void {
        $this->tabs_gui->addTab(
            self::TAB_ID_ANSWER_FORM,
            $this->lng->txt('answer_form'),
            $this->withDefaultSubAction()->getUrlBuilder()->buildURI()->__toString()
        );
 
        foreach ($additional_actions as $action) {
            $action->addTab(
                $this,
                $this->tabs_gui,
                $this->lng
            );
        }
 
        $this->tabs_gui->addSubTab(
            self::TAB_ID_ANSWER_FORM,
            $this->lng->txt('overview'),
            $this->withDefaultSubAction()->getUrlBuilder()->buildURI()->__toString()
        );
 
        $this->tabs_gui->activateTab(self::TAB_ID_ANSWER_FORM);
        $this->tabs_gui->activateSubTab(self::TAB_ID_ANSWER_FORM);
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

◆ setParamtersForSimpleCreateCmd()

ILIAS\Questions\Presentation\Definitions\DefaultEnvironment::setParamtersForSimpleCreateCmd ( Uuid $question_id )

Definition at line 596 of file DefaultEnvironment.php.

     : void {
        $this->setQuestionIdParamterForPageEditorCmds($question_id);
 
        $this->ctrl->setParameterByClass(
            \QstsQuestionPageGUI::class,
            self::PARAMETER_STRING_HIER_ID,
            '1'
        );
 
        [, $create_mode_token] = $this->url_builder->acquireParameter(
            self::QUERY_PARAMETER_NAME_SPACE,
            self::TOKEN_STRING_CREATE_MODE
        );
 
        $this->ctrl->setParameterByClass(
            \QstsQuestionPageGUI::class,
            $create_mode_token->getName(),
            '1'
        );
    }

◆ setQuestionIdParamterForPageEditorCmds()

ILIAS\Questions\Presentation\Definitions\DefaultEnvironment::setQuestionIdParamterForPageEditorCmds ( Uuid $question_id )

private

Definition at line 634 of file DefaultEnvironment.php.

     : void {
        $this->ctrl->setParameterByClass(
            \QstsQuestionPageGUI::class,
            $this->question_id_token->getName(),
            $question_id->toString()
        );
    }

◆ withActionParameter()

ILIAS\Questions\Presentation\Definitions\DefaultEnvironment::withActionParameter ( string $action )

Definition at line 360 of file DefaultEnvironment.php.

     : self {
        $clone = clone $this;
        if ($clone->action_token === null) {
            [
                $clone->url_builder,
                $clone->action_token
            ] = $this->url_builder->acquireParameter(
                self::QUERY_PARAMETER_NAME_SPACE,
                self::TOKEN_STRING_ACTION
            );
        }
        $clone->url_builder = $clone->url_builder
            ->withParameter($clone->action_token, $action);
        return $clone;
    }

Referenced by ILIAS\Questions\AnswerForm\Capabilities\RequiredCapabilities\create(), and ILIAS\Questions\AnswerForm\Capabilities\Definitions\AdditionalFormStepAction\toPrevious().

Here is the caller graph for this function:

◆ withAnswerFormIdParameter()

ILIAS\Questions\Presentation\Definitions\DefaultEnvironment::withAnswerFormIdParameter ( Uuid $answer_form_id )

Definition at line 406 of file DefaultEnvironment.php.

     : self {
        $clone = clone $this;
        if ($clone->answer_form_id_token === null) {
            [
                $clone->url_builder,
                $clone->answer_form_id_token
            ] = $this->url_builder->acquireParameter(
                self::QUERY_PARAMETER_NAME_SPACE,
                self::TOKEN_STRING_ANSWER_FORM_ID
            );
        }
        $clone->url_builder = $clone->url_builder->withParameter(
            $clone->answer_form_id_token,
            $answer_form_id->toString()
        );
        return $clone;
    }

◆ withAnswerFormProperties()

ILIAS\Questions\Presentation\Definitions\DefaultEnvironment::withAnswerFormProperties ( Properties $properties )

Implements ILIAS\Questions\Presentation\Definitions\Environment.

Definition at line 270 of file DefaultEnvironment.php.

     : self {
        $clone = clone $this;
        $clone->answer_form_properties = $properties;
        return $clone;
    }

◆ withAnswerFormTypeHashParameter()

ILIAS\Questions\Presentation\Definitions\DefaultEnvironment::withAnswerFormTypeHashParameter ( string $type_hash )

Definition at line 387 of file DefaultEnvironment.php.

     : self {
        $clone = clone $this;
        if ($clone->type_hash_token === null) {
            [
                $clone->url_builder,
                $clone->type_hash_token
            ] = $this->url_builder->acquireParameter(
                self::QUERY_PARAMETER_NAME_SPACE,
                self::TOKEN_STRING_TYPE_HASH
            );
        }
 
        $clone->url_builder = $clone->url_builder
            ->withParameter($clone->type_hash_token, $type_hash);
        return $clone;
    }

◆ withCreateModeParameter()

ILIAS\Questions\Presentation\Definitions\DefaultEnvironment::withCreateModeParameter ( )

Definition at line 426 of file DefaultEnvironment.php.

                                             : self
    {
        $clone = clone $this;
        if ($clone->create_mode_token === null) {
            [
                $clone->url_builder,
                $clone->create_mode_token
            ] = $this->url_builder->acquireParameter(
                self::QUERY_PARAMETER_NAME_SPACE,
                self::TOKEN_STRING_CREATE_MODE
            );
        }
 
        $clone->url_builder = $clone->url_builder
            ->withParameter($clone->create_mode_token, '1');
        return $clone;
    }

◆ withDefaultSubAction()

ILIAS\Questions\Presentation\Definitions\DefaultEnvironment::withDefaultSubAction ( )

Implements ILIAS\Questions\Presentation\Definitions\Environment.

Definition at line 181 of file DefaultEnvironment.php.

                                          : self
    {
        $clone = clone $this;
        $clone->default_sub_action = true;
        return $clone;
    }

Referenced by ILIAS\Questions\Presentation\Views\Edit\buildAfterQuestionCreationRedirectUri().

Here is the caller graph for this function:

◆ withFormStartSubActionParameter()

ILIAS\Questions\Presentation\Definitions\DefaultEnvironment::withFormStartSubActionParameter ( string $sub_action )

Implements ILIAS\Questions\Presentation\Definitions\Environment.

Definition at line 445 of file DefaultEnvironment.php.

     : self {
        $clone = clone $this;
        if ($clone->form_start_sub_action_token === null) {
            [
                $clone->url_builder,
                $clone->form_start_sub_action_token
            ] = $this->url_builder->acquireParameter(
                self::QUERY_PARAMETER_NAME_SPACE,
                self::TOKEN_STRING_FORM_START_SUB_ACTION
            );
        }
 
        $clone->url_builder = $clone->url_builder
            ->withParameter(
                $clone->form_start_sub_action_token,
                $sub_action
            );
        return $clone;
    }

◆ withIsInCreationContext()

ILIAS\Questions\Presentation\Definitions\DefaultEnvironment::withIsInCreationContext ( bool $is_in_creation_context )

Definition at line 335 of file DefaultEnvironment.php.

     : self {
        $clone = clone $this;
        $clone->is_in_creation_context = $is_in_creation_context;
        return $clone;
    }

◆ withPreservedFormStartSubActionParameter()

ILIAS\Questions\Presentation\Definitions\DefaultEnvironment::withPreservedFormStartSubActionParameter ( )

Implements ILIAS\Questions\Presentation\Definitions\Environment.

Definition at line 468 of file DefaultEnvironment.php.

                                                              : self
    {
        return $this->withFormStartSubActionParameter(
            $this->getFormStartSubAction()
        );
    }

◆ withPreservedTableRowIdsParameter()

ILIAS\Questions\Presentation\Definitions\DefaultEnvironment::withPreservedTableRowIdsParameter ( )

Implements ILIAS\Questions\Presentation\Definitions\Environment.

Definition at line 310 of file DefaultEnvironment.php.

                                                       : self
    {
        $clone = clone $this;
        $clone->table_row_ids = $clone->getTableRowIds();
        $clone->url_builder = $this->url_builder
            ->withParameter($this->table_row_token, $clone->table_row_ids);
        return $clone;
    }

Referenced by ILIAS\Questions\AnswerForm\Capabilities\Definitions\AdditionalFormStepAction\do().

Here is the caller graph for this function:

◆ withQuestionIdParameter()

ILIAS\Questions\Presentation\Definitions\DefaultEnvironment::withQuestionIdParameter ( Uuid $question_id )

Definition at line 378 of file DefaultEnvironment.php.

     : self {
        $clone = clone $this;
        $clone->url_builder = $this->url_builder
            ->withParameter($this->question_id_token, $question_id->toString());
        return $clone;
    }

◆ withSubActionParameter()

ILIAS\Questions\Presentation\Definitions\DefaultEnvironment::withSubActionParameter ( string $sub_action )

Implements ILIAS\Questions\Presentation\Definitions\Environment.

Definition at line 162 of file DefaultEnvironment.php.

     : self {
        $clone = clone $this;
        if ($clone->sub_action_token === null) {
            [
                $clone->url_builder,
                $clone->sub_action_token
            ] = $this->url_builder->acquireParameter(
                self::QUERY_PARAMETER_NAME_SPACE,
                self::TOKEN_STRING_SUB_ACTION
            );
        }
        $clone->url_builder = $clone->url_builder
            ->withParameter($clone->sub_action_token, $sub_action);
        return $clone;
    }

Field Documentation

◆ $action_token

URLBuilderToken ILIAS\Questions\Presentation\Definitions\DefaultEnvironment::$action_token = null

private

Definition at line 68 of file DefaultEnvironment.php.

◆ $answer_form_id_token

URLBuilderToken ILIAS\Questions\Presentation\Definitions\DefaultEnvironment::$answer_form_id_token = null

private

Definition at line 70 of file DefaultEnvironment.php.

◆ $answer_form_properties

Properties ILIAS\Questions\Presentation\Definitions\DefaultEnvironment::$answer_form_properties = null

private

Definition at line 59 of file DefaultEnvironment.php.

◆ $create_mode_token

URLBuilderToken ILIAS\Questions\Presentation\Definitions\DefaultEnvironment::$create_mode_token = null

private

Definition at line 71 of file DefaultEnvironment.php.

◆ $default_sub_action

bool ILIAS\Questions\Presentation\Definitions\DefaultEnvironment::$default_sub_action = false

private

Definition at line 61 of file DefaultEnvironment.php.

◆ $form_start_sub_action_token

URLBuilderToken ILIAS\Questions\Presentation\Definitions\DefaultEnvironment::$form_start_sub_action_token = null

private

Definition at line 72 of file DefaultEnvironment.php.

◆ $is_in_creation_context

bool ILIAS\Questions\Presentation\Definitions\DefaultEnvironment::$is_in_creation_context = false

private

Definition at line 62 of file DefaultEnvironment.php.

◆ $question_id_token

readonly URLBuilderToken ILIAS\Questions\Presentation\Definitions\DefaultEnvironment::$question_id_token

private

Definition at line 66 of file DefaultEnvironment.php.

◆ $sub_action_token

URLBuilderToken ILIAS\Questions\Presentation\Definitions\DefaultEnvironment::$sub_action_token = null

private

Definition at line 67 of file DefaultEnvironment.php.

◆ $table_row_ids

array ILIAS\Questions\Presentation\Definitions\DefaultEnvironment::$table_row_ids = null

private

Definition at line 74 of file DefaultEnvironment.php.

◆ $table_row_token

readonly URLBuilderToken ILIAS\Questions\Presentation\Definitions\DefaultEnvironment::$table_row_token

private

Definition at line 65 of file DefaultEnvironment.php.

◆ $type_hash_token

URLBuilderToken ILIAS\Questions\Presentation\Definitions\DefaultEnvironment::$type_hash_token = null

private

Definition at line 69 of file DefaultEnvironment.php.

◆ $url_builder

URLBuilder ILIAS\Questions\Presentation\Definitions\DefaultEnvironment::$url_builder

private

Definition at line 64 of file DefaultEnvironment.php.

◆ INTERRUPTIVE_ITEMS_KEY

const string ILIAS\Questions\Presentation\Definitions\DefaultEnvironment::INTERRUPTIVE_ITEMS_KEY = 'interruptive_items'

private

Definition at line 55 of file DefaultEnvironment.php.

◆ PARAMETER_STRING_HIER_ID

const string ILIAS\Questions\Presentation\Definitions\DefaultEnvironment::PARAMETER_STRING_HIER_ID = 'hier_id'

private

Definition at line 53 of file DefaultEnvironment.php.

◆ QUERY_PARAMETER_NAME_SPACE

const array ILIAS\Questions\Presentation\Definitions\DefaultEnvironment::QUERY_PARAMETER_NAME_SPACE = ['q']

private

Definition at line 42 of file DefaultEnvironment.php.

◆ TAB_ID_ANSWER_FORM

const string ILIAS\Questions\Presentation\Definitions\DefaultEnvironment::TAB_ID_ANSWER_FORM = 'answer_form'

private

Definition at line 57 of file DefaultEnvironment.php.

◆ TOKEN_STRING_ACTION

const string ILIAS\Questions\Presentation\Definitions\DefaultEnvironment::TOKEN_STRING_ACTION = 'a'

private

Definition at line 43 of file DefaultEnvironment.php.

◆ TOKEN_STRING_ANSWER_FORM_ID

const string ILIAS\Questions\Presentation\Definitions\DefaultEnvironment::TOKEN_STRING_ANSWER_FORM_ID = 'af'

private

Definition at line 48 of file DefaultEnvironment.php.

◆ TOKEN_STRING_CREATE_AND_NEW

const string ILIAS\Questions\Presentation\Definitions\DefaultEnvironment::TOKEN_STRING_CREATE_AND_NEW = 'can'

private

Definition at line 51 of file DefaultEnvironment.php.

◆ TOKEN_STRING_CREATE_MODE

const string ILIAS\Questions\Presentation\Definitions\DefaultEnvironment::TOKEN_STRING_CREATE_MODE = 'cm'

private

Definition at line 49 of file DefaultEnvironment.php.

◆ TOKEN_STRING_FORM_START_SUB_ACTION

const string ILIAS\Questions\Presentation\Definitions\DefaultEnvironment::TOKEN_STRING_FORM_START_SUB_ACTION = 'fssa'

private

Definition at line 50 of file DefaultEnvironment.php.

◆ TOKEN_STRING_QUESTION_ID

const string ILIAS\Questions\Presentation\Definitions\DefaultEnvironment::TOKEN_STRING_QUESTION_ID = 'q'

private

Definition at line 45 of file DefaultEnvironment.php.

◆ TOKEN_STRING_SUB_ACTION

const string ILIAS\Questions\Presentation\Definitions\DefaultEnvironment::TOKEN_STRING_SUB_ACTION = 'sa'

private

Definition at line 44 of file DefaultEnvironment.php.

◆ TOKEN_STRING_TABLE_ROW_ID

const string ILIAS\Questions\Presentation\Definitions\DefaultEnvironment::TOKEN_STRING_TABLE_ROW_ID = 'r'

private

Definition at line 46 of file DefaultEnvironment.php.

◆ TOKEN_STRING_TYPE_HASH

const string ILIAS\Questions\Presentation\Definitions\DefaultEnvironment::TOKEN_STRING_TYPE_HASH = 't'

private

Definition at line 47 of file DefaultEnvironment.php.

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

components/ILIAS/Questions/src/Presentation/Definitions/DefaultEnvironment.php

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ acquireURLBuilderAndParameters()

◆ activateEditAnswerFormSubTab()

◆ addEditAnswerFormSubTab()

◆ buildEditAnswerFormBackUrl()

◆ buildRetrieveUuidClosure()

◆ buildStringTrafo()

◆ buildURLBuilderTokenForCreateAndNew()

◆ getAction()

◆ getAnswerFormId()

◆ getAnswerFormProperties()

◆ getAnswerFormTableActionsForRequiredCapabilities()

◆ getEditability()

◆ getFormStartSubAction()

◆ getHttpServices()

◆ getLanguage()

◆ getParentObjId()

◆ getPresentationFactory()

◆ getQuestionId()

◆ getQuestionIds()

◆ getRefinery()

◆ getSubAction()

◆ getTableRowIds()

◆ getTableRowIdToken()

◆ getTypeClassHash()

◆ getUIFactory()

◆ getUrlBuilder()

◆ isCreateAndNewAction()

◆ isCreateModeSimple()

◆ isInCreationContext()

◆ isMarkingRequired()

◆ preserveParametersForPageEditorCmds()

◆ redirectTo()

◆ retrieveStringValueForToken()

◆ runPageMigrations()

◆ setEditAnswerFormBackTarget()

◆ setEditAnswerFormTabs()

◆ setParamtersForSimpleCreateCmd()

◆ setQuestionIdParamterForPageEditorCmds()

◆ withActionParameter()

◆ withAnswerFormIdParameter()

◆ withAnswerFormProperties()

◆ withAnswerFormTypeHashParameter()

◆ withCreateModeParameter()

◆ withDefaultSubAction()

◆ withFormStartSubActionParameter()

◆ withIsInCreationContext()

◆ withPreservedFormStartSubActionParameter()

◆ withPreservedTableRowIdsParameter()

◆ withQuestionIdParameter()

◆ withSubActionParameter()

Field Documentation

◆ $action_token

◆ $answer_form_id_token

◆ $answer_form_properties

◆ $create_mode_token

◆ $default_sub_action

◆ $form_start_sub_action_token

◆ $is_in_creation_context

◆ $question_id_token

◆ $sub_action_token

◆ $table_row_ids

◆ $table_row_token

◆ $type_hash_token

◆ $url_builder

◆ INTERRUPTIVE_ITEMS_KEY

◆ PARAMETER_STRING_HIER_ID

◆ QUERY_PARAMETER_NAME_SPACE

◆ TAB_ID_ANSWER_FORM

◆ TOKEN_STRING_ACTION

◆ TOKEN_STRING_ANSWER_FORM_ID

◆ TOKEN_STRING_CREATE_AND_NEW

◆ TOKEN_STRING_CREATE_MODE

◆ TOKEN_STRING_FORM_START_SUB_ACTION