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 ilFileSystemStorage
	__construct ($a_storage_type, $a_path_conversion, $a_container_id)
	Constructor. More...

	getContainerId ()

	create ()
	Create directory. More...

	getAbsolutePath ()
	Get absolute path of storage directory. More...

	writeToFile ($a_data, $a_absolute_path)
	Write data to file. More...

	deleteFile ($a_abs_name)
	Delete file. More...

	deleteDirectory ($a_abs_name)
	Delete directory. More...

	delete ()
	Delete complete directory. More...

	copyFile ($a_from, $a_to)
	Copy files. More...

	appendToPath ($a_appendix)

	getStorageType ()

	getPath ()
	Get path. More...

	__construct ($a_storage_type, $a_path_conversion, $a_container_id)
	Constructor. More...

	create ()
	Create directory. More...

	getAbsolutePath ()
	Get absolute path of storage directory. More...

	getShortPath ()

	rename ($from, $to)

Data Fields
const	IMG_ABSTRACT = 'abstract'

const	IMG_EXTRO = 'extro'

Data Fields inherited from ilFileSystemStorage
const	STORAGE_WEB = 1

const	STORAGE_DATA = 2

const	STORAGE_SECURED = 3

const	FACTOR = 100

const	MAX_EXPONENT = 3

const	SECURED_DIRECTORY = "sec"

Protected Member Functions
	getStoragePath ()

	getPathPrefix ()
	Get path prefix.Prefix that will be prepended to the path No trailing slash. E.g ilFiles for files@abstract @access protected Returns string path prefix e.g files More...

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

Protected Member Functions inherited from ilFileSystemStorage
	getPathPrefix ()
	Get path prefix. More...

	getPathPostfix ()
	Get directory name. More...

	init ()
	Read path info. More...

	getPathPrefix ()
	Get path prefix. More...

	getPathPostfix ()
	Get directory name. More...

Additional Inherited Members
Static Public Member Functions inherited from ilFileSystemStorage
static	_createPathFromId ($a_container_id, $a_name)
	Create a path from an id: e.g 12345 will be converted to 12/34/<name>_5. More...

static	_copyDirectory ($a_source, $a_target)
	Copy directory and all contents. More...

static	_createPathFromId ($a_container_id, $a_name)
	Create a path from an id: e.g 12345 will be converted to 12/34/<name>_5. More...

Protected Attributes inherited from ilFileSystemStorage
	$path

Detailed Description

Storage of images in settings.

Author: Nils Haagen nils..nosp@m.haag.nosp@m.en@co.nosp@m.ncep.nosp@m.ts-an.nosp@m.d-tr.nosp@m.ainin.nosp@m.g.de

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

Constructor & Destructor Documentation

◆ __construct()

ilLearningSequenceFilesystem::__construct ( )

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

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

References ilFileSystemStorage\create(), and ilFileSystemStorage\getAbsolutePath().

Here is the call graph for this function:

Member Function Documentation

◆ delete_image()

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

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

    {
        if ($which === self::IMG_ABSTRACT) {
            $delete = $settings->getAbstractImage();
            $settings = $settings->withAbstractImage(null);
        }
        if ($which === self::IMG_EXTRO) {
            $delete = $settings->getExtroImage();
            $settings = $settings->withExtroImage(null);
        }
 
        $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@abstract @access protected

Returns: string directory name

Reimplemented from ilFileSystemStorage.

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

    {
        return 'Images';
    }

◆ getPathPrefix()

ilLearningSequenceFilesystem::getPathPrefix ( )

protected

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

Returns: string path prefix e.g files

Reimplemented from ilFileSystemStorage.

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

    {
        return 'LSO';
    }

◆ getStoragePath()

ilLearningSequenceFilesystem::getStoragePath ( )

protected

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

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

◆ getStoragePathFor()

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

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

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

◆ getSuffix()

ilLearningSequenceFilesystem::getSuffix ( string $file_name )

Definition at line 70 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 23 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;
    }

Field Documentation

◆ IMG_ABSTRACT

const ilLearningSequenceFilesystem::IMG_ABSTRACT = 'abstract'

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

Referenced by ilLearningSequenceImporter\buildSettings(), ilLearningSequenceSettingsDB\delete(), and ilObjLearningSequenceSettingsGUI\update().

◆ IMG_EXTRO

const ilLearningSequenceFilesystem::IMG_EXTRO = 'extro'

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

Referenced by ilLearningSequenceImporter\buildSettings(), ilLearningSequenceSettingsDB\delete(), and ilObjLearningSequenceSettingsGUI\update().

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

Modules/LearningSequence/classes/Settings/class.ilLearningSequenceFilesystem.php

Public Member Functions

Data Fields

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ delete_image()

◆ getPathPostfix()

◆ getPathPrefix()

◆ getStoragePath()

◆ getStoragePathFor()

◆ getSuffix()

◆ moveUploaded()

Field Documentation

◆ IMG_ABSTRACT

◆ IMG_EXTRO