Storage of images in settings. More...

Inheritance diagram for ilLearningSequenceFilesystem:

Collaboration diagram for ilLearningSequenceFilesystem:

Public Member Functions
	__construct ()

	moveUploaded (string $which, array $file_info, ilLearningSequenceSettings $settings)

	delete_image (string $which, ilLearningSequenceSettings $settings)

	getStoragePathFor (string $which, int $obj_id, string $suffix)

	getSuffix (string $file_name)

Public Member Functions inherited from ilFileSystemAbstractionStorage
	__construct (private int $storage_type, private bool $path_conversion, private int $container_id)
	Constructor. More...

	fileExists (string $a_absolute_path)

	getContainerId ()

	writeToFile (string $a_data, $a_absolute_path)

	copyFile (string $a_from, string $a_to)

	create ()

	getAbsolutePath ()
	Calculates the full path on the filesystem. More...

	delete ()

	deleteDirectory (string $a_abs_name)

	deleteFile (string $a_abs_name)

	appendToPath (string $a_appendix)

	getStorageType ()

	getPath ()

Data Fields
const	IMG_ABSTRACT = 'abstract'

const	IMG_EXTRO = 'extro'

const	PATH_PRE = 'LSO'

const	PATH_POST = 'Images'

Data Fields inherited from ilFileSystemAbstractionStorage
const	STORAGE_WEB = 1

const	STORAGE_DATA = 2

const	STORAGE_SECURED = 3

Protected Member Functions
	getStoragePath ()

	getPathPrefix ()
	Get path prefix.Prefix that will be prepended to the path No trailing slash. E.g ilFiles for files More...

	getPathPostfix ()
	Get directory name.E.g for files => file Only relative path, no trailing slash '_<obj_id>' will be appended automatically More...

Protected Member Functions inherited from ilFileSystemAbstractionStorage
	getLegacyFullAbsolutePath (string $relative_path)

	getFileSystemService ()

	getPathPrefix ()
	Get path prefix. More...

	getPathPostfix ()
	Get directory name. More...

	getLegacyAbsolutePath ()
	Calculates the absolute filesystem storage location. More...

	init ()

Additional Inherited Members
Static Public Member Functions inherited from ilFileSystemAbstractionStorage
static	createPathFromId (int $a_container_id, string $a_name)

static	_copyDirectory (string $a_sdir, string $a_tdir)

Protected Attributes inherited from ilFileSystemAbstractionStorage
string	$path = null

Filesystems	$file_system_service

Detailed Description

Storage of images in settings.

Definition at line 24 of file class.ilLearningSequenceFilesystem.php.

Constructor & Destructor Documentation

◆ __construct()

ilLearningSequenceFilesystem::__construct ( )

Definition at line 31 of file class.ilLearningSequenceFilesystem.php.

    {
        parent::__construct(self::STORAGE_WEB, false, 0);
        if (!is_dir($this->getAbsolutePath())) {
            $this->create();
        }
    }

References ILIAS\GlobalScreen\Provider\__construct(), ilFileSystemAbstractionStorage\create(), and ilFileSystemAbstractionStorage\getAbsolutePath().

Here is the call graph for this function:

Member Function Documentation

◆ delete_image()

ilLearningSequenceFilesystem::delete_image	(	string	$which,
		ilLearningSequenceSettings	$settings
	)

Definition at line 61 of file class.ilLearningSequenceFilesystem.php.

                                                                                     : ilLearningSequenceSettings
    {
        $delete = '';
        if ($which === self::IMG_ABSTRACT) {
            $delete = $settings->getAbstractImage();
            $settings = $settings->withAbstractImage();
        }
        if ($which === self::IMG_EXTRO) {
            $delete = $settings->getExtroImage();
            $settings = $settings->withExtroImage();
        }
        if ($delete !== '' && str_starts_with($delete, $this->getStoragePath())) {
            $this->deleteFile($delete);
        }
        return $settings;
    }

References ilLearningSequenceSettings\getAbstractImage(), ilLearningSequenceSettings\getExtroImage(), ilLearningSequenceSettings\withAbstractImage(), and ilLearningSequenceSettings\withExtroImage().

Here is the call graph for this function:

◆ getPathPostfix()

ilLearningSequenceFilesystem::getPathPostfix ( )

protected

Get directory name.E.g for files => file Only relative path, no trailing slash '_<obj_id>' will be appended automatically

Reimplemented from ilFileSystemAbstractionStorage.

Definition at line 109 of file class.ilLearningSequenceFilesystem.php.

                                       : string
    {
        return self::PATH_POST;
    }

◆ getPathPrefix()

ilLearningSequenceFilesystem::getPathPrefix ( )

protected

Get path prefix.Prefix that will be prepended to the path No trailing slash. E.g ilFiles for files

Reimplemented from ilFileSystemAbstractionStorage.

Definition at line 101 of file class.ilLearningSequenceFilesystem.php.

                                      : string
    {
        return self::PATH_PRE;
    }

◆ getStoragePath()

ilLearningSequenceFilesystem::getStoragePath ( )

protected

Definition at line 93 of file class.ilLearningSequenceFilesystem.php.

                                       : string
    {
        return  $this->getAbsolutePath() . '/';
    }

◆ getStoragePathFor()

ilLearningSequenceFilesystem::getStoragePathFor	(	string	$which,
		int	$obj_id,
		string	$suffix
	)

Definition at line 78 of file class.ilLearningSequenceFilesystem.php.

                                                                                 : string
    {
        return $this->getStoragePath()
            . $which
            . '_'
            . $obj_id
            . '.'
            . $suffix;
    }

◆ getSuffix()

ilLearningSequenceFilesystem::getSuffix ( string $file_name )

Definition at line 88 of file class.ilLearningSequenceFilesystem.php.

                                                : string
    {
        return pathinfo($file_name, PATHINFO_EXTENSION);
    }

◆ moveUploaded()

ilLearningSequenceFilesystem::moveUploaded	(	string	$which,
		array	$file_info,
		ilLearningSequenceSettings	$settings
	)

Definition at line 39 of file class.ilLearningSequenceFilesystem.php.

     : ilLearningSequenceSettings {
        $target = $this->getStoragePathFor(
            $which,
            $settings->getObjId(),
            $this->getSuffix($file_info['name'])
        );
        move_uploaded_file($file_info['tmp_name'], $target);
 
        if ($which === self::IMG_ABSTRACT) {
            $settings = $settings->withAbstractImage($target);
        }
        if ($which === self::IMG_EXTRO) {
            $settings = $settings->withExtroImage($target);
        }
        return $settings;
    }