ilFSStoragePRG Class Reference

store prg-files More...

Inheritance diagram for ilFSStoragePRG:

Collaboration diagram for ilFSStoragePRG:

Public Member Functions
	__construct (int $a_container_id=0)
	getMemberExportDirectory ()
	initMemberExportDirectory ()
	getMemberExportFiles ()
	getMemberExportFile (string $filename)
	addMemberExportFile ($a_data, $a_rel_name)
	deleteMemberExportFile (string $filename)
	hasMemberExportFile (string $filename)
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 ()

Protected Member Functions
	getPathPostfix ()
	getPathPrefix ()
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 ()

Protected Attributes
const	MEMBER_EXPORT_DIR = 'assingmentsExport'
Protected Attributes inherited from ilFileSystemAbstractionStorage
string	$path = null
Filesystems	$file_system_service

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)
Data Fields inherited from ilFileSystemAbstractionStorage
const	STORAGE_WEB = 1
const	STORAGE_DATA = 2
const	STORAGE_SECURED = 3

Detailed Description

store prg-files

Definition at line 24 of file ilFSStoragePRG.php.

Constructor & Destructor Documentation

__construct()

ilFSStoragePRG::__construct

(

int

$a_container_id = 0

)

Definition at line 28 of file ilFSStoragePRG.php.

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

    {
        parent::__construct(ilFileSystemAbstractionStorage::STORAGE_DATA, true, $a_container_id);
    }

Here is the call graph for this function:

Member Function Documentation

addMemberExportFile()

ilFSStoragePRG::addMemberExportFile	(		$a_data,
			$a_rel_name
	)

Definition at line 105 of file ilFSStoragePRG.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()

ilFSStoragePRG::deleteMemberExportFile

(

string

$filename

)

Definition at line 116 of file ilFSStoragePRG.php.

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

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

Here is the call graph for this function:

getMemberExportDirectory()

ilFSStoragePRG::getMemberExportDirectory

(

)

Definition at line 49 of file ilFSStoragePRG.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()

ilFSStoragePRG::getMemberExportFile

(

string

$filename

)

Definition at line 93 of file ilFSStoragePRG.php.

References $filename, and getMemberExportDirectory().

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

        if (file_exists($file_name)) {
            return file_get_contents($file_name);
        } else {
            throw new \Exception('file not found:' . $filename);
        }
        return '';
    }

Here is the call graph for this function:

getMemberExportFiles()

ilFSStoragePRG::getMemberExportFiles

(

)

Definition at line 59 of file ilFSStoragePRG.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()

ilFSStoragePRG::getPathPostfix ( )

protected

Definition at line 36 of file ilFSStoragePRG.php.

                                       : string
    {
        return 'prg';
    }

getPathPrefix()

ilFSStoragePRG::getPathPrefix ( )

protected

Definition at line 44 of file ilFSStoragePRG.php.

                                      : string
    {
        return 'StudyProgramme';
    }

hasMemberExportFile()

ilFSStoragePRG::hasMemberExportFile

(

string

$filename

)

Definition at line 121 of file ilFSStoragePRG.php.

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

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

Here is the call graph for this function:

initMemberExportDirectory()

ilFSStoragePRG::initMemberExportDirectory

(

)

Definition at line 54 of file ilFSStoragePRG.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

MEMBER_EXPORT_DIR

const ilFSStoragePRG::MEMBER_EXPORT_DIR = 'assingmentsExport'

protected

Definition at line 26 of file ilFSStoragePRG.php.

---

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

• components/ILIAS/StudyProgramme/classes/memberexport/ilFSStoragePRG.php