ILIAS\Questions\Legacy\Administration\ViewConfiguration Class Reference

Collaboration diagram for ILIAS\Questions\Legacy\Administration\ViewConfiguration:

Public Member Functions
	__construct (private readonly Language $lng, private readonly Refinery $refinery, private readonly UIFactory $ui_factory, RequestWrapper $query_wrapper, URLBuilder $url_builder, private readonly \ilToolbarGUI $toolbar)
	isAsync ()
	getCurrentConfiguration ()
	getURLBuilderWithPreservedConfigurationParameter (?URLBuilder $url_builder=null)
	initializeToolbar ()

Private Member Functions
	buildToolbarButton (string $identifier)
	buildButtonLabel (string $identifier, bool $enabled)

Private Attributes
const array	PARAMETER_NAMESPACE = ['q', 'vc']
const string	CONFIGURATION_TOKEN_STRING = 'c'
readonly URLBuilder	$url_builder
readonly URLBuilderToken	$configuration_token
readonly array	$current_configuration

Detailed Description

Definition at line 36 of file ViewConfiguration.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Questions\Legacy\Administration\ViewConfiguration::__construct	(	private readonly Language	$lng,
		private readonly Refinery	$refinery,
		private readonly UIFactory	$ui_factory,
		RequestWrapper	$query_wrapper,
		URLBuilder	$url_builder,
		private readonly \ilToolbarGUI	$toolbar
	)

Definition at line 46 of file ViewConfiguration.php.

      {
        [
            $this->url_builder,
            $this->configuration_token
        ] = $url_builder->acquireParameter(
            self::PARAMETER_NAMESPACE,
            self::CONFIGURATION_TOKEN_STRING
        );
 
        $this->current_configuration = $query_wrapper->retrieve(
            $this->configuration_token->getName(),
            $this->refinery->custom()->transformation(
                function (mixed $values): array {
                    $current_configuration = [
                        DefaultView::getIdentifier()
                    ];
                    if (!is_array($values)) {
                        return $current_configuration;
                    }
 
                    $available_capabilities = [
                        AsyncView::getIdentifier(),
                        DefaultView::getIdentifier(),
                        TextFeedback::getIdentifier(),
                        SuggestedLearningContent::getIdentifier(),
                        MarkingAllowingPartialPoints::getIdentifier()
                    ];
 
                    return array_reduce(
                        $values,
                        function (array $c, string $v) use ($available_capabilities): array {
                            if ($v === AsyncView::getIdentifier()
                                || $v === DefaultView::getIdentifier()) {
                                $c = array_filter(
                                    $c,
                                    fn(string $v): bool => $v !== DefaultView::getIdentifier()
                                        && $v !== AsyncView::getIdentifier()
                                );
                            }
 
                            if (in_array($v, $available_capabilities)
                                && !in_array($v, $c)) {
                                $c[] = $v;
                            }
 
                            return $c;
                        },
                        $current_configuration
                    );
                }
            )
        );
    }

References Vendor\Package\$c, ILIAS\Questions\Legacy\Administration\ViewConfiguration\$configuration_token, ILIAS\Questions\Legacy\Administration\ViewConfiguration\$current_configuration, ILIAS\Questions\Legacy\Administration\ViewConfiguration\$url_builder, ILIAS\UI\URLBuilder\acquireParameter(), and ILIAS\HTTP\Wrapper\RequestWrapper\retrieve().

Here is the call graph for this function:

Member Function Documentation

buildButtonLabel()

ILIAS\Questions\Legacy\Administration\ViewConfiguration::buildButtonLabel ( string  $identifier, bool  $enabled  )

private

Definition at line 207 of file ViewConfiguration.php.

     : string {
        $identifier_lng_string = strtolower($identifier);
 
        return $enabled
            ? $this->lng->txt("disable_{$identifier_lng_string}")
            : $this->lng->txt("enable_{$identifier_lng_string}");
    }

buildToolbarButton()

ILIAS\Questions\Legacy\Administration\ViewConfiguration::buildToolbarButton ( string  $identifier )

private

Definition at line 187 of file ViewConfiguration.php.

     : StandardButton {
        $capability_activated = in_array($identifier, $this->current_configuration);
        $filtered_configuration = array_filter(
            $this->current_configuration,
            fn(string $v): bool => $v !== $identifier
        );
 
        return $this->ui_factory->button()->standard(
            $this->buildButtonLabel($identifier, $capability_activated),
            $this->url_builder->withParameter(
                $this->configuration_token,
                $capability_activated
                    ? $filtered_configuration
                    : [...$filtered_configuration, $identifier]
            )->buildURI()->__toString()
        );
    }

getCurrentConfiguration()

ILIAS\Questions\Legacy\Administration\ViewConfiguration::getCurrentConfiguration

(

)

Definition at line 115 of file ViewConfiguration.php.

                                             : array
    {
        return $this->current_configuration;
    }

References ILIAS\Questions\Legacy\Administration\ViewConfiguration\$current_configuration.

getURLBuilderWithPreservedConfigurationParameter()

ILIAS\Questions\Legacy\Administration\ViewConfiguration::getURLBuilderWithPreservedConfigurationParameter

(

?URLBuilder

$url_builder = null

)

Definition at line 120 of file ViewConfiguration.php.

     : URLBuilder {
        if ($url_builder !== null) {
            [
                $url_builder,
                $configuration_token
            ] = $url_builder->acquireParameter(
                self::PARAMETER_NAMESPACE,
                self::CONFIGURATION_TOKEN_STRING
            );
        } else {
            $url_builder = $this->url_builder;
            $configuration_token = $this->configuration_token;
        }
 
        return $url_builder->withParameter(
            $configuration_token,
            $this->current_configuration
        );
    }

References ILIAS\Questions\Legacy\Administration\ViewConfiguration\$configuration_token, ILIAS\Questions\Legacy\Administration\ViewConfiguration\$url_builder, and ILIAS\UI\URLBuilder\acquireParameter().

Here is the call graph for this function:

initializeToolbar()

ILIAS\Questions\Legacy\Administration\ViewConfiguration::initializeToolbar

(

)

Definition at line 142 of file ViewConfiguration.php.

                                       : void
    {
        $configuration_without_view = array_filter(
            $this->current_configuration,
            fn(string $v): bool => $v !== DefaultView::getIdentifier() && $v !== AsyncView::getIdentifier()
        );
        $this->toolbar->addComponent(
            $this->ui_factory->viewControl()->mode(
                [
                    $this->lng->txt('default_view') => $this->url_builder->withParameter(
                        $this->configuration_token,
                        [...$configuration_without_view, DefaultView::getIdentifier()]
                    )->buildURI()->__toString(),
                    $this->lng->txt('async_view') => $this->url_builder->withParameter(
                        $this->configuration_token,
                        [...$configuration_without_view, AsyncView::getIdentifier()]
                    )->buildURI()->__toString()
                ],
                $this->lng->txt('select_view')
            )->withActive(
                in_array(DefaultView::getIdentifier(), $this->current_configuration)
                    ? $this->lng->txt('default_view')
                    : $this->lng->txt('async_view')
            ),
        );
 
        $this->toolbar->addComponent(
            $this->buildToolbarButton(
                MarkingAllowingPartialPoints::getIdentifier()
            )
        );
 
        $this->toolbar->addComponent(
            $this->buildToolbarButton(
                TextFeedback::getIdentifier()
            )
        );
 
        $this->toolbar->addComponent(
            $this->buildToolbarButton(
                SuggestedLearningContent::getIdentifier()
            )
        );
    }

References ILIAS\Repository\lng(), and ILIAS\Repository\toolbar().

Here is the call graph for this function:

isAsync()

ILIAS\Questions\Legacy\Administration\ViewConfiguration::isAsync

(

)

Definition at line 107 of file ViewConfiguration.php.

                             : bool
    {
        return in_array(
            AsyncView::getIdentifier(),
            $this->current_configuration
        );
    }

Field Documentation

$configuration_token

readonly URLBuilderToken ILIAS\Questions\Legacy\Administration\ViewConfiguration::$configuration_token

private

Definition at line 42 of file ViewConfiguration.php.

Referenced by ILIAS\Questions\Legacy\Administration\ViewConfiguration\__construct(), and ILIAS\Questions\Legacy\Administration\ViewConfiguration\getURLBuilderWithPreservedConfigurationParameter().

$current_configuration

readonly array ILIAS\Questions\Legacy\Administration\ViewConfiguration::$current_configuration

private

Definition at line 44 of file ViewConfiguration.php.

Referenced by ILIAS\Questions\Legacy\Administration\ViewConfiguration\__construct(), and ILIAS\Questions\Legacy\Administration\ViewConfiguration\getCurrentConfiguration().

$url_builder

readonly URLBuilder ILIAS\Questions\Legacy\Administration\ViewConfiguration::$url_builder

private

Definition at line 41 of file ViewConfiguration.php.

Referenced by ILIAS\Questions\Legacy\Administration\ViewConfiguration\__construct(), and ILIAS\Questions\Legacy\Administration\ViewConfiguration\getURLBuilderWithPreservedConfigurationParameter().

CONFIGURATION_TOKEN_STRING

const string ILIAS\Questions\Legacy\Administration\ViewConfiguration::CONFIGURATION_TOKEN_STRING = 'c'

private

Definition at line 39 of file ViewConfiguration.php.

PARAMETER_NAMESPACE

const array ILIAS\Questions\Legacy\Administration\ViewConfiguration::PARAMETER_NAMESPACE = ['q', 'vc']

private

Definition at line 38 of file ViewConfiguration.php.

---

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

• components/ILIAS/Questions/Legacy/Administration/ViewConfiguration.php