Inheritance diagram for ILIAS\Language\Activities\LanguageActivity:

Collaboration diagram for ILIAS\Language\Activities\LanguageActivity:

Public Member Functions
	__construct (private readonly ?RBAC $rbac, private readonly LanguageFolder $language_folder, protected readonly DataFactory $data=new DataFactory(),)

	getType ()

	isAllowedToPerform (int $usr_id, mixed $parameters)
	This shall check if the given user is allowed to perform the activity based on business rules of this component. More...

	maybePerformAs (InputFactory $input_factory, int $usr_id, array $raw_parameters)
	Grinds the $raw_parameters through the input description, checks if the users is allowed to perform the action as requested and, if so, then attempts to performs it. More...

Public Member Functions inherited from ILIAS\Component\Activities\ActivityImpl
	getName ()
	Shall return classname of the Activity, wrapped in Name. More...

Public Member Functions inherited from ILIAS\Component\Activities\Activity
	getName ()
	Shall return classname of the Activity, wrapped in Name. More...

	getType ()

	getDescription ()

	getInputDescription (FieldFactory $f)

	getOutputDescription (Description\Factory $f)

	isAllowedToPerform (int $usr_id, mixed $parameters)
	This shall check if the given user is allowed to perform the activity based on business rules of this component. More...

	perform (mixed $parameters)
	This shall perform the activity. More...

	maybePerformAs (InputFactory $input_factory, int $usr_id, array $raw_parameters)
	Grinds the $raw_parameters through the input description, checks if the users is allowed to perform the action as requested and, if so, then attempts to performs it. More...

Protected Member Functions
	overlayWriteFailedOutputField (Description\Factory $f)
	The database was written, but the PO/MO overlay of a module was not: callers must not report plain success. More...

	invalidMarkupCustomizingOutputField (Description\Factory $f)

	duplicateCustomizingOutputField (Description\Factory $f)

	duplicateCustomizingEntries (array $skipped, array $language_keys)

	invalidMarkupCustomizingEntries (array $skipped, array $language_keys)

	normalizeParameters (array $grind_result)

Private Member Functions
	isKnownUser (int $usr_id)
	Never the anonymous user, regardless of its RBAC roles. More...

Detailed Description

Definition at line 34 of file LanguageActivity.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Language\Activities\LanguageActivity::__construct	(	private readonly ?RBAC	$rbac,
		private readonly LanguageFolder	$language_folder,
		protected readonly DataFactory	$data = `new DataFactory()`
	)

Parameters

RBAC | null $rbac null only for forSetup(); isAllowedToPerform() then throws.

Definition at line 39 of file LanguageActivity.php.

43 {

44 }

Member Function Documentation

◆ duplicateCustomizingEntries()

ILIAS\Language\Activities\LanguageActivity::duplicateCustomizingEntries	(	array	$skipped,
		array	$language_keys
	)

protected

Parameters

array<string,array<string,list<string>>>	$skipped see \ILIAS\Language\Setup\LanguageInstallationManager::getSkippedDuplicateEntries()
list<string>	$language_keys

Returns: list<string> the value of duplicateCustomizingOutputField()

Definition at line 108 of file LanguageActivity.php.

                                                                                        : array
    {
        $entries = [];
        foreach ($language_keys as $language_key) {
            foreach ($skipped[$language_key] ?? [] as $entry => $existing) {
                $entries[] = $language_key . ': ' . DuplicateIdentifierMessage::entry((string) $entry, $existing);
            }
        }
 
        return $entries;
    }

References ILIAS\Language\ComponentTranslation\DuplicateIdentifierMessage\entry().

Referenced by ILIAS\Language\Tests\Activities\LanguageActivityInvalidMarkupTestDouble\duplicateEntries(), ILIAS\Language\Activities\InstallLanguage\perform(), and ILIAS\Language\Activities\UpdateLanguage\perform().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ duplicateCustomizingOutputField()

ILIAS\Language\Activities\LanguageActivity::duplicateCustomizingOutputField ( Description\Factory $f )

protected

Definition at line 85 of file LanguageActivity.php.

                                                                              : Description\Description
    {
        $text = $this->data->text()->markdown();
 
        return $f->list(
            $text->simpleDocument(
                'Entries of the customizing/local language files that were not applied because their ' .
                'identifier already exists in another module or in another spelling - the languages ' .
                'were installed regardless.'
            ),
            $f->string($text->simpleDocument(
                'Language key and entry, followed by the entries it would duplicate ' .
                '("<language>: <module>#:#<identifier> (<module>: <identifier>, ...)").'
            ))
        );
    }

References Vendor\Package\$f, and $text.

◆ getType()

ILIAS\Language\Activities\LanguageActivity::getType ( )

Implements ILIAS\Component\Activities\Activity.

Definition at line 46 of file LanguageActivity.php.

                             : ActivityType
    {
        return ActivityType::Command;
    }

◆ invalidMarkupCustomizingEntries()

ILIAS\Language\Activities\LanguageActivity::invalidMarkupCustomizingEntries	(	array	$skipped,
		array	$language_keys
	)

protected

Parameters

array<string,array<string,list<string>>>	$skipped see \ILIAS\Language\Setup\LanguageInstallationManager::getSkippedInvalidMarkupEntries()
list<string>	$language_keys

Returns: list<string> the value of invalidMarkupCustomizingOutputField()

Definition at line 126 of file LanguageActivity.php.

                                                                                            : array
    {
        $policy = new TranslationMarkupPolicy();
        $entries = [];
        foreach ($language_keys as $language_key) {
            foreach ($skipped[$language_key] ?? [] as $entry => $violations) {
                $markup = $policy->markupOf(array_map('strval', $violations));
                $entries[] = $language_key . ': ' . $entry . ($markup === [] ? '' : ': ' . implode(', ', $markup));
            }
        }
 
        return $entries;
    }

References $policy.

Referenced by ILIAS\Language\Tests\Activities\LanguageActivityInvalidMarkupTestDouble\entries(), ILIAS\Language\Activities\InstallLanguage\perform(), and ILIAS\Language\Activities\UpdateLanguage\perform().

Here is the caller graph for this function:

◆ invalidMarkupCustomizingOutputField()

ILIAS\Language\Activities\LanguageActivity::invalidMarkupCustomizingOutputField ( Description\Factory $f )

protected

Definition at line 67 of file LanguageActivity.php.

                                                                                  : Description\Description
    {
        $text = $this->data->text()->markdown();
 
        return $f->list(
            $text->simpleDocument(
                'Entries of the customizing/local language files that were not applied because their ' .
                'value contains HTML that is not allowed in language texts - the languages were ' .
                'installed regardless.'
            ),
            $f->string($text->simpleDocument(
                'Language key and entry, followed by the markup that is not allowed, language-neutral ' .
                '("<language>: <module>#:#<identifier>: <markup>, ..."; without violations only ' .
                '"<language>: <module>#:#<identifier>").'
            ))
        );
    }

References Vendor\Package\$f, and $text.

◆ isAllowedToPerform()

ILIAS\Language\Activities\LanguageActivity::isAllowedToPerform	(	int	$usr_id,
		mixed	$parameters
	)

This shall check if the given user is allowed to perform the activity based on business rules of this component.

This shall, for example, check if the given user may add this other user to a course based on RBAC and position permissions, but this shall not check overall business rules such as: root may do everything. This shall not cause any observable side effects.

Parameters

mixed $parameters whatever the FormInput from getInputDescription produces.

Implements ILIAS\Component\Activities\Activity.

Definition at line 140 of file LanguageActivity.php.

                                                                      : bool
    {
        if ($this->rbac === null) {
            throw new \LogicException(
                'RBAC is not available during Setup; '
                . static::class . '::isAllowedToPerform() cannot be used here.'
            );
        }
 
        if (!$this->isKnownUser($usr_id)) {
            return false;
        }
 
        return $this->rbac->system()->checkAccessOfUser(
            $usr_id,
            'write',
            $this->language_folder->getRefId()
        );
    }

References ILIAS\Language\Activities\LanguageActivity\isKnownUser(), and ILIAS\Repository\rbac().

Referenced by ILIAS\Language\Activities\LanguageActivity\maybePerformAs().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isKnownUser()

ILIAS\Language\Activities\LanguageActivity::isKnownUser ( int $usr_id )

private

Never the anonymous user, regardless of its RBAC roles.

Definition at line 161 of file LanguageActivity.php.

                                             : bool
    {
        if ($usr_id <= 0) {
            return false;
        }
 
        return !defined('ANONYMOUS_USER_ID') || $usr_id !== ANONYMOUS_USER_ID;
    }

References ANONYMOUS_USER_ID.

Referenced by ILIAS\Language\Activities\LanguageActivity\isAllowedToPerform().

Here is the caller graph for this function:

◆ maybePerformAs()

ILIAS\Language\Activities\LanguageActivity::maybePerformAs	(	InputFactory	$input_factory,
		int	$usr_id,
		array	$raw_parameters
	)

Grinds the $raw_parameters through the input description, checks if the users is allowed to perform the action as requested and, if so, then attempts to performs it.

Wraps the result and possible errors in the Result type.

Implements ILIAS\Component\Activities\Activity.

Definition at line 170 of file LanguageActivity.php.

                                                                                                   : Result
    {
        try {
            // inside the try: getInputDescription() may throw too; value() throws grind's input error
            $parameters = $this->normalizeParameters(
                $this->grind($this->getInputDescription($input_factory->field()), $raw_parameters)->value()
            );
            if (!$this->isAllowedToPerform($usr_id, $parameters)) {
                return new Result\Error(
                    new \DomainException('You are not allowed to manage the languages of this installation.', 403)
                );
            }
 
            // usr_id last: the trusted value wins over a spoofed form key
            return new Result\Ok($this->perform([...$parameters, 'usr_id' => $usr_id]));
        } catch (\Throwable $e) {
            return new Result\Error(Failure::of($e));
        }
    }

References Vendor\Package\$e, $parameters, ILIAS\Component\Activities\Activity\getInputDescription(), ILIAS\Language\Activities\LanguageActivity\isAllowedToPerform(), ILIAS\Language\Activities\LanguageActivity\normalizeParameters(), ILIAS\Language\Activities\Failure\of(), and ILIAS\Component\Activities\Activity\perform().

Here is the call graph for this function:

◆ normalizeParameters()

ILIAS\Language\Activities\LanguageActivity::normalizeParameters ( array $grind_result )

abstractprotected

Returns: array<string, mixed>

Reimplemented in ILIAS\Language\Activities\AddLanguageEntry, ILIAS\Language\Activities\InstallLanguage, ILIAS\Language\Activities\SetLanguageDetectionEnabled, ILIAS\Language\Activities\SetLanguageTranslationEnabled, ILIAS\Language\Tests\Activities\LanguageActivityThrowingInputDescriptionTestDouble, ILIAS\Language\Tests\Activities\LanguageActivityPerformEchoTestDouble, and ILIAS\Language\Tests\Activities\LanguageActivityInvalidMarkupTestDouble.

Referenced by ILIAS\Language\Activities\LanguageActivity\maybePerformAs().

Here is the caller graph for this function:

◆ overlayWriteFailedOutputField()

ILIAS\Language\Activities\LanguageActivity::overlayWriteFailedOutputField ( Description\Factory $f )

protected

The database was written, but the PO/MO overlay of a module was not: callers must not report plain success.

Definition at line 52 of file LanguageActivity.php.

                                                                            : Description\Description
    {
        $text = $this->data->text()->markdown();
 
        return $f->list(
            $text->simpleDocument(
                'Languages whose database content was written, but for which the per-installation ' .
                'PO/MO files of at least one module maintained in PO files could not be written ' .
                '(typically missing write permissions of the web server user on the client data ' .
                'directory) - the details are logged.'
            ),
            $f->string($text->simpleDocument('Language key of a language with an unwritten PO/MO overlay.'))
        );
    }

References Vendor\Package\$f, and $text.

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

components/ILIAS/Language/src/Activities/LanguageActivity.php

Public Member Functions

Protected Member Functions

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ duplicateCustomizingEntries()

◆ duplicateCustomizingOutputField()

◆ getType()

◆ invalidMarkupCustomizingEntries()

◆ invalidMarkupCustomizingOutputField()

◆ isAllowedToPerform()

◆ isKnownUser()

◆ maybePerformAs()

◆ normalizeParameters()

◆ overlayWriteFailedOutputField()