ILIAS\Language\ComponentTranslation\ComponentLanguageFileDirectory Class Reference

Inheritance diagram for ILIAS\Language\ComponentTranslation\ComponentLanguageFileDirectory:

Collaboration diagram for ILIAS\Language\ComponentTranslation\ComponentLanguageFileDirectory:

Public Member Functions
	__construct (private readonly Component $component, private readonly string $prefix, private readonly string $path_inside_component='lang/', ?string $shipped_file_name_pattern=null)
	getShippedFileNamePattern ()
	The name without ".po": exactly one "%s" (language key), otherwise only letters, digits, "_", "-" and "." (no "/", no ".."), e.g. More...
	getPrefix ()
	getPath ()
	getSuffix ()
	isLocal ()
	getPrefix ()
	getPath ()
	getSuffix ()
	isLocal ()
	getShippedFileNamePattern ()
	The name without ".po": exactly one "%s" (language key), otherwise only letters, digits, "_", "-" and "." (no "/", no ".."), e.g. More...

Private Attributes
string	$base_directory
readonly string	$shipped_file_name_pattern

Detailed Description

Author

Fabian Schmid fabia.nosp@m.n@sr.nosp@m..solu.nosp@m.tion.nosp@m.s

Definition at line 28 of file ComponentLanguageFileDirectory.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Language\ComponentTranslation\ComponentLanguageFileDirectory::__construct	(	private readonly Component	$component,
		private readonly string	$prefix,
		private readonly string	$path_inside_component = 'lang/',
		?string	$shipped_file_name_pattern = null
	)

Parameters

string | null

$shipped_file_name_pattern

see NamesShippedLanguageFiles, e.g. "ilias_%s"; default "<prefix>_%s"

Exceptions

InvalidArgumentException for an invalid pattern, see MigratedLanguageFilePaths::assertValidShippedFileNamePattern()

Definition at line 37 of file ComponentLanguageFileDirectory.php.

      {
        $this->shipped_file_name_pattern = $shipped_file_name_pattern ?? $prefix . '_%s';
        MigratedLanguageFilePaths::assertValidShippedFileNamePattern($this->shipped_file_name_pattern);
    }

References ILIAS\Language\ComponentTranslation\ComponentLanguageFileDirectory\$shipped_file_name_pattern, and ILIAS\Language\ComponentTranslation\MigratedLanguageFilePaths\assertValidShippedFileNamePattern().

Here is the call graph for this function:

Member Function Documentation

getPath()

ILIAS\Language\ComponentTranslation\ComponentLanguageFileDirectory::getPath

(

)

Implements ILIAS\Language\ComponentTranslation\LanguageFileDirectory.

Definition at line 57 of file ComponentLanguageFileDirectory.php.

                             : string
    {
        // cached: the location never changes and this is called repeatedly per directory loop
        if (!isset($this->base_directory)) {
            $reflector = new \ReflectionClass($this->component);
            $ilias_base_dir = (string) realpath(__DIR__ . '/../../../../../');
            $this->base_directory = str_replace($ilias_base_dir . '/', '', dirname($reflector->getFileName()));
        }
 
        return $this->base_directory . '/' . $this->path_inside_component;
    }

getPrefix()

ILIAS\Language\ComponentTranslation\ComponentLanguageFileDirectory::getPrefix

(

)

Implements ILIAS\Language\ComponentTranslation\LanguageFileDirectory.

Definition at line 52 of file ComponentLanguageFileDirectory.php.

                               : string
    {
        return $this->prefix;
    }

getShippedFileNamePattern()

ILIAS\Language\ComponentTranslation\ComponentLanguageFileDirectory::getShippedFileNamePattern

(

)

The name without ".po": exactly one "%s" (language key), otherwise only letters, digits, "_", "-" and "." (no "/", no ".."), e.g.

"ilias_%s".

Implements ILIAS\Language\ComponentTranslation\NamesShippedLanguageFiles.

Definition at line 47 of file ComponentLanguageFileDirectory.php.

                                               : string
    {
        return $this->shipped_file_name_pattern;
    }

References ILIAS\Language\ComponentTranslation\ComponentLanguageFileDirectory\$shipped_file_name_pattern.

getSuffix()

ILIAS\Language\ComponentTranslation\ComponentLanguageFileDirectory::getSuffix

(

)

Implements ILIAS\Language\ComponentTranslation\LanguageFileDirectory.

Definition at line 69 of file ComponentLanguageFileDirectory.php.

                               : string
    {
        return '';
    }

isLocal()

ILIAS\Language\ComponentTranslation\ComponentLanguageFileDirectory::isLocal

(

)

Implements ILIAS\Language\ComponentTranslation\LanguageFileDirectory.

Definition at line 74 of file ComponentLanguageFileDirectory.php.

                             : bool
    {
        return false;
    }

Field Documentation

$base_directory

string ILIAS\Language\ComponentTranslation\ComponentLanguageFileDirectory::$base_directory

private

Definition at line 30 of file ComponentLanguageFileDirectory.php.

$shipped_file_name_pattern

readonly string ILIAS\Language\ComponentTranslation\ComponentLanguageFileDirectory::$shipped_file_name_pattern

private

Definition at line 31 of file ComponentLanguageFileDirectory.php.

Referenced by ILIAS\Language\ComponentTranslation\ComponentLanguageFileDirectory\__construct(), and ILIAS\Language\ComponentTranslation\ComponentLanguageFileDirectory\getShippedFileNamePattern().

---

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

• components/ILIAS/Language/src/ComponentTranslation/ComponentLanguageFileDirectory.php