ilFSStorageCourse Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilFSStorageCourse:

Collaboration diagram for ilFSStorageCourse:

Public Member Functions
	__construct (int $a_container_id=0)
	initInfoDirectory ()
	getInfoDirectory ()
	initMemberExportDirectory ()
	getMemberExportDirectory ()
	addMemberExportFile ($a_data, $a_rel_name)
	getMemberExportFiles ()
	getMemberExportFile (string $a_name)
	deleteMemberExportFile (string $a_export_name)
	hasMemberExportFile (string $a_export_name)
Public Member Functions inherited from ilFileSystemAbstractionStorage
	__construct (int $a_storage_type, bool $a_path_conversion, int $a_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 ()

Static Public Member Functions
static	_clone (int $a_source_id, int $a_target_id)
Static Public Member Functions inherited from ilFileSystemAbstractionStorage
static	createPathFromId (int $a_container_id, string $a_name)
static	_copyDirectory (string $a_sdir, string $a_tdir)

Data Fields
const	MEMBER_EXPORT_DIR = 'memberExport'
const	INFO_DIR = 'info'
const	ARCHIVE_DIR = 'archives'
Data Fields inherited from ilFileSystemAbstractionStorage
const	STORAGE_WEB = 1
const	STORAGE_DATA = 2
const	STORAGE_SECURED = 3

Protected Member Functions
	getPathPostfix ()
	Implementation of abstract method protected. More...
	getPathPrefix ()
	Implementation of abstract method protected. 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 ()

Private Attributes
ilLogger	$logger

Additional Inherited Members
Protected Attributes inherited from ilFileSystemAbstractionStorage
string	$path = null
ILIAS Filesystem Filesystems	$file_system_service

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning

Author

Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Definition at line 25 of file class.ilFSStorageCourse.php.

Constructor & Destructor Documentation

__construct()

ilFSStorageCourse::__construct

(

int

$a_container_id = 0

)

PhpUndefinedMethodInspection

Definition at line 33 of file class.ilFSStorageCourse.php.

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\logger(), and ilFileSystemAbstractionStorage\STORAGE_DATA.

    {
        global $DIC;

        $this->logger = $DIC->logger()->crs();
        parent::__construct(ilFileSystemAbstractionStorage::STORAGE_DATA, true, $a_container_id);
    }

Here is the call graph for this function:

Member Function Documentation

_clone()

static ilFSStorageCourse::_clone ( int  $a_source_id, int  $a_target_id  )

static

Definition at line 42 of file class.ilFSStorageCourse.php.

References $source, and ilFileSystemAbstractionStorage\_copyDirectory().

                                                                     : bool
    {
        $source = new ilFSStorageCourse($a_source_id);
        $target = new ilFSStorageCourse($a_target_id);
        $target->create();
        ilFileSystemAbstractionStorage::_copyDirectory($source->getAbsolutePath(), $target->getAbsolutePath());

        // Delete member export files
        $target->deleteDirectory($target->getMemberExportDirectory());

        unset($source);
        unset($target);
        return true;
    }

Here is the call graph for this function:

addMemberExportFile()

ilFSStorageCourse::addMemberExportFile	(		$a_data,
			$a_rel_name
	)

Definition at line 77 of file class.ilFSStorageCourse.php.

References getMemberExportDirectory(), initMemberExportDirectory(), ILIAS\Repository\logger(), and ilFileSystemAbstractionStorage\writeToFile().

                                                             : bool
    {
        $this->initMemberExportDirectory();
        if (!$this->writeToFile($a_data, $this->getMemberExportDirectory() . '/' . $a_rel_name)) {
            $this->logger->write('Cannot write to file: ' . $this->getMemberExportDirectory() . '/' . $a_rel_name);
            return false;
        }

        return true;
    }

Here is the call graph for this function:

deleteMemberExportFile()

ilFSStorageCourse::deleteMemberExportFile

(

string

$a_export_name

)

Definition at line 130 of file class.ilFSStorageCourse.php.

References ilFileSystemAbstractionStorage\deleteFile(), and getMemberExportDirectory().

                                                                 : bool
    {
        return $this->deleteFile($this->getMemberExportDirectory() . '/' . $a_export_name);
    }

Here is the call graph for this function:

getInfoDirectory()

ilFSStorageCourse::getInfoDirectory

(

)

Definition at line 62 of file class.ilFSStorageCourse.php.

References ilFileSystemAbstractionStorage\getAbsolutePath().

Referenced by initInfoDirectory().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getMemberExportDirectory()

ilFSStorageCourse::getMemberExportDirectory

(

)

Definition at line 72 of file class.ilFSStorageCourse.php.

References ilFileSystemAbstractionStorage\getAbsolutePath().

Referenced by addMemberExportFile(), deleteMemberExportFile(), getMemberExportFile(), getMemberExportFiles(), hasMemberExportFile(), and initMemberExportDirectory().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getMemberExportFile()

ilFSStorageCourse::getMemberExportFile

(

string

$a_name

)

Definition at line 120 of file class.ilFSStorageCourse.php.

References getMemberExportDirectory().

                                                       : string
    {
        $file_name = $this->getMemberExportDirectory() . '/' . $a_name;

        if (file_exists($file_name)) {
            return file_get_contents($file_name);
        }
        return '';
    }

Here is the call graph for this function:

getMemberExportFiles()

ilFSStorageCourse::getMemberExportFiles

(

)

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

References ilFileSystemAbstractionStorage\getContainerId(), and getMemberExportDirectory().

                                          : array
    {
        if (!is_dir($this->getMemberExportDirectory())) {
            return array();
        }
        $dp = opendir($this->getMemberExportDirectory());

        $files = [];
        while ($file = readdir($dp)) {
            if (is_dir($file)) {
                continue;
            }

            if (preg_match(
                "/^([0-9]{10})_[a-zA-Z]*_export_([a-z]+)_([0-9]+)\.[a-z]+$/",
                $file,
                $matches
            ) && $matches[3] == $this->getContainerId()) {
                $timest = $matches[1];
                $file_info['name'] = $matches[0];
                $file_info['timest'] = $matches[1];
                $file_info['type'] = $matches[2];
                $file_info['id'] = $matches[3];
                $file_info['size'] = filesize($this->getMemberExportDirectory() . '/' . $file);

                $files[$timest] = $file_info;
            }
        }
        closedir($dp);
        return $files;
    }

Here is the call graph for this function:

getPathPostfix()

ilFSStorageCourse::getPathPostfix ( )

protected

Implementation of abstract method protected.

Definition at line 144 of file class.ilFSStorageCourse.php.

                                       : string
    {
        return 'crs';
    }

getPathPrefix()

ilFSStorageCourse::getPathPrefix ( )

protected

Implementation of abstract method protected.

Definition at line 153 of file class.ilFSStorageCourse.php.

                                      : string
    {
        return 'ilCourse';
    }

hasMemberExportFile()

ilFSStorageCourse::hasMemberExportFile

(

string

$a_export_name

)

Definition at line 135 of file class.ilFSStorageCourse.php.

References ilFileSystemAbstractionStorage\fileExists(), and getMemberExportDirectory().

                                                              : bool
    {
        return $this->fileExists($this->getMemberExportDirectory() . '/' . $a_export_name);
    }

Here is the call graph for this function:

initInfoDirectory()

ilFSStorageCourse::initInfoDirectory

(

)

Definition at line 57 of file class.ilFSStorageCourse.php.

References getInfoDirectory(), and ilFileUtils\makeDirParents().

                                       : void
    {
        ilFileUtils::makeDirParents($this->getInfoDirectory());
    }

Here is the call graph for this function:

initMemberExportDirectory()

ilFSStorageCourse::initMemberExportDirectory

(

)

Definition at line 67 of file class.ilFSStorageCourse.php.

References getMemberExportDirectory(), and ilFileUtils\makeDirParents().

Referenced by addMemberExportFile().

                                               : void
    {
        ilFileUtils::makeDirParents($this->getMemberExportDirectory());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$logger

ilLogger ilFSStorageCourse::$logger

private

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

ARCHIVE_DIR

const ilFSStorageCourse::ARCHIVE_DIR = 'archives'

Definition at line 29 of file class.ilFSStorageCourse.php.

INFO_DIR

const ilFSStorageCourse::INFO_DIR = 'info'

Definition at line 28 of file class.ilFSStorageCourse.php.

MEMBER_EXPORT_DIR

const ilFSStorageCourse::MEMBER_EXPORT_DIR = 'memberExport'

Definition at line 27 of file class.ilFSStorageCourse.php.

---

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

• Modules/Course/classes/class.ilFSStorageCourse.php