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

Inheritance diagram for ilFileDataCourse:

Collaboration diagram for ilFileDataCourse:

Public Member Functions
	__construct (int $a_course_id)
	@inheritDoc More...

	getArchiveFile ($a_rel_name)

	getMemberExportFiles ()

	deleteMemberExportFile (string $a_name)

	getMemberExportFile (string $a_name)

	deleteArchive (string $a_rel_name)

	deleteZipFile (string $a_abs_name)

	deleteDirectory (string $a_abs_name)

	deletePdf (string $a_abs_name)

	copy (string $a_from, string $a_to)

	rCopy (string $a_from, string $a_to)

	addDirectory (string $a_rel_name)

	writeToFile (string $a_data, string $a_rel_name)

	zipFile (string $a_rel_name, string $a_zip_name)

	getCoursePath ()

	createOnlineVersion (string $a_rel_name)

	getOnlineLink (string $a_rel_name)

	__checkPath ()

	__checkImportPath ()

	__checkReadWrite ()

	__initDirectory ()

Public Member Functions inherited from ilFileData
	__construct ()

	checkPath (string $a_path)

	getPath ()

Public Member Functions inherited from ilFile
	deleteTrailingSlash (string $a_path)
	delete trailing slash of path variables More...

Protected Attributes
ilErrorHandling	$error

Protected Attributes inherited from ilFile
string	$path

Private Attributes
string	$course_path

int	$course_id

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 This class handles all operations of archive files for the course object

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

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

Constructor & Destructor Documentation

◆ __construct()

ilFileDataCourse::__construct ( int $a_course_id )

@inheritDoc

Definition at line 34 of file class.ilFileDataCourse.php.

    {
        global $DIC;
 
        $this->error = $DIC['ilErr'];
 
        define('COURSE_PATH', 'course');
 
        parent::__construct();
        $this->course_path = parent::getPath() . "/" . COURSE_PATH;
        $this->course_id = $a_course_id;
 
        if (!$this->__checkPath()) {
            $this->__initDirectory();
        }
        $this->__checkImportPath();
    }

References $DIC, __checkImportPath(), __checkPath(), ILIAS\GlobalScreen\Provider\__construct(), __initDirectory(), and error().

Here is the call graph for this function:

Member Function Documentation

◆ __checkImportPath()

ilFileDataCourse::__checkImportPath ( )

Definition at line 216 of file class.ilFileDataCourse.php.

                                       : void
    {
        if (!file_exists($this->getCoursePath() . '/import')) {
            ilFileUtils::makeDir($this->getCoursePath() . '/import');
        }
 
        if (!is_writable($this->getCoursePath() . '/import') || !is_readable($this->getCoursePath() . '/import')) {
            $this->error->raiseError("Course import path is not readable/writable by webserver", $this->error->FATAL);
        }
    }

References error(), getCoursePath(), and ilFileUtils\makeDir().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __checkPath()

ilFileDataCourse::__checkPath ( )

Definition at line 202 of file class.ilFileDataCourse.php.

                                 : bool
    {
        if (!file_exists($this->getCoursePath())) {
            return false;
        }
        if (!file_exists(CLIENT_WEB_DIR . '/courses')) {
            ilFileUtils::makeDir(CLIENT_WEB_DIR . '/courses');
        }
 
        $this->__checkReadWrite();
 
        return true;
    }

References __checkReadWrite(), CLIENT_WEB_DIR, getCoursePath(), and ilFileUtils\makeDir().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __checkReadWrite()

ilFileDataCourse::__checkReadWrite ( )

Definition at line 227 of file class.ilFileDataCourse.php.

                                      : bool
    {
        if (is_writable($this->course_path) && is_readable($this->course_path)) {
            return true;
        } else {
            $this->error->raiseError("Course directory is not readable/writable by webserver", $this->error->FATAL);
        }
        return false;
    }

References error().

Referenced by __checkPath().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __initDirectory()

ilFileDataCourse::__initDirectory ( )

Definition at line 237 of file class.ilFileDataCourse.php.

                                     : bool
    {
        if (is_writable($this->getPath())) {
            ilFileUtils::makeDir($this->getPath() . '/' . COURSE_PATH);
            $this->course_path = $this->getPath() . '/' . COURSE_PATH;
            return true;
        }
        return false;
    }

References ilFileData\getPath(), and ilFileUtils\makeDir().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addDirectory()

ilFileDataCourse::addDirectory ( string $a_rel_name )

Definition at line 162 of file class.ilFileDataCourse.php.

                                                    : bool
    {
        ilFileUtils::makeDir($this->getCoursePath() . '/' . $a_rel_name);
        return true;
    }

References getCoursePath(), and ilFileUtils\makeDir().

Here is the call graph for this function:

◆ copy()

ilFileDataCourse::copy	(	string	$a_from,
		string	$a_to
	)

Definition at line 146 of file class.ilFileDataCourse.php.

                                                      : bool
    {
        if (file_exists($a_from)) {
            copy($a_from, $this->getCoursePath() . '/' . $a_to);
 
            return true;
        }
        return false;
    }

References copy(), and getCoursePath().

Referenced by copy().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createOnlineVersion()

ilFileDataCourse::createOnlineVersion ( string $a_rel_name )

Definition at line 190 of file class.ilFileDataCourse.php.

                                                           : bool
    {
        ilFileUtils::makeDir(CLIENT_WEB_DIR . '/courses/' . $a_rel_name);
        ilFileUtils::rCopy($this->getCoursePath() . '/' . $a_rel_name, CLIENT_WEB_DIR . '/courses/' . $a_rel_name);
        return true;
    }

References CLIENT_WEB_DIR, getCoursePath(), ilFileUtils\makeDir(), and ilFileUtils\rCopy().

Here is the call graph for this function:

◆ deleteArchive()

ilFileDataCourse::deleteArchive ( string $a_rel_name )

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

                                                     : void
    {
        $this->deleteZipFile($this->course_path . '/' . $a_rel_name . '.zip');
        $this->deleteDirectory($this->course_path . '/' . $a_rel_name);
        $this->deleteDirectory(CLIENT_WEB_DIR . '/courses/' . $a_rel_name);
        $this->deletePdf($this->course_path . '/' . $a_rel_name . '.pdf');
    }

References CLIENT_WEB_DIR, deleteDirectory(), deletePdf(), and deleteZipFile().

Here is the call graph for this function:

◆ deleteDirectory()

ilFileDataCourse::deleteDirectory ( string $a_abs_name )

Definition at line 126 of file class.ilFileDataCourse.php.

                                                       : bool
    {
        if (file_exists($a_abs_name)) {
            ilFileUtils::delDir($a_abs_name);
 
            return true;
        }
        return false;
    }

References ilFileUtils\delDir().

Referenced by deleteArchive().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deleteMemberExportFile()

ilFileDataCourse::deleteMemberExportFile ( string $a_name )

Definition at line 92 of file class.ilFileDataCourse.php.

                                                          : void
    {
        $file_name = $this->course_path . '/' . $a_name;
        if (file_exists($file_name)) {
            unlink($file_name);
        }
    }

◆ deletePdf()

ilFileDataCourse::deletePdf ( string $a_abs_name )

Definition at line 136 of file class.ilFileDataCourse.php.

                                                 : bool
    {
        if (file_exists($a_abs_name)) {
            unlink($a_abs_name);
 
            return true;
        }
        return false;
    }

Referenced by deleteArchive().

Here is the caller graph for this function:

◆ deleteZipFile()

ilFileDataCourse::deleteZipFile ( string $a_abs_name )

Definition at line 117 of file class.ilFileDataCourse.php.

                                                     : bool
    {
        if (file_exists($a_abs_name)) {
            unlink($a_abs_name);
            return true;
        }
        return false;
    }

Referenced by deleteArchive().

Here is the caller graph for this function:

◆ getArchiveFile()

ilFileDataCourse::getArchiveFile ( $a_rel_name )

Definition at line 52 of file class.ilFileDataCourse.php.

                                               : string
    {
        if (file_exists($this->course_path . '/' . $a_rel_name . '.zip')) {
            return $this->course_path . '/' . $a_rel_name . '.zip';
        }
        if (file_exists($this->course_path . '/' . $a_rel_name . '.pdf')) {
            return $this->course_path . '/' . $a_rel_name . '.pdf';
        }
        return '';
    }

◆ getCoursePath()

ilFileDataCourse::getCoursePath ( )

Definition at line 185 of file class.ilFileDataCourse.php.

                                   : string
    {
        return $this->course_path;
    }

References $course_path.

Referenced by __checkImportPath(), __checkPath(), addDirectory(), copy(), createOnlineVersion(), rCopy(), writeToFile(), and zipFile().

Here is the caller graph for this function:

◆ getMemberExportFile()

ilFileDataCourse::getMemberExportFile ( string $a_name )

Definition at line 100 of file class.ilFileDataCourse.php.

                                                       : string
    {
        $file_name = $this->course_path . '/' . $a_name;
        if (file_exists($file_name)) {
            return file_get_contents($file_name);
        }
        return '';
    }

◆ getMemberExportFiles()

ilFileDataCourse::getMemberExportFiles ( )

Definition at line 63 of file class.ilFileDataCourse.php.

                                          : array
    {
        $files = array();
        $dp = opendir($this->course_path);
 
        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->course_id) {
                $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->course_path . '/' . $file);
 
                $files[$timest] = $file_info;
            }
        }
        closedir($dp);
        return $files;
    }

◆ getOnlineLink()

ilFileDataCourse::getOnlineLink ( string $a_rel_name )

Definition at line 197 of file class.ilFileDataCourse.php.

                                                     : string
    {
        return ilFileUtils::getWebspaceDir('filesystem') . '/courses/' . $a_rel_name . '/index.html';
    }

References ilFileUtils\getWebspaceDir().

Here is the call graph for this function:

◆ rCopy()

ilFileDataCourse::rCopy	(	string	$a_from,
		string	$a_to
	)

Definition at line 156 of file class.ilFileDataCourse.php.

                                                       : bool
    {
        ilFileUtils::rCopy($a_from, $this->getCoursePath() . '/' . $a_to);
        return true;
    }

References getCoursePath(), and ilFileUtils\rCopy().

Here is the call graph for this function:

◆ writeToFile()

ilFileDataCourse::writeToFile	(	string	$a_data,
		string	$a_rel_name
	)

Definition at line 168 of file class.ilFileDataCourse.php.

                                                                   : bool
    {
        if (!$fp = fopen($this->getCoursePath() . '/' . $a_rel_name, 'w+')) {
            die("Cannot open file: " . $this->getCoursePath() . '/' . $a_rel_name);
        }
        fwrite($fp, $a_data);
        return true;
    }

References getCoursePath().

Here is the call graph for this function:

◆ zipFile()

ilFileDataCourse::zipFile	(	string	$a_rel_name,
		string	$a_zip_name
	)

Definition at line 177 of file class.ilFileDataCourse.php.

                                                                   : int
    {
        ilFileUtils::zip($this->getCoursePath() . '/' . $a_rel_name, $this->getCoursePath() . '/' . $a_zip_name);
 
        // RETURN filesize
        return (int) filesize($this->getCoursePath() . '/' . $a_zip_name);
    }

References getCoursePath(), and ilFileUtils\zip().

Here is the call graph for this function:

Field Documentation

◆ $course_id

int ilFileDataCourse::$course_id

private

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

◆ $course_path

string ilFileDataCourse::$course_path

private

Definition at line 26 of file class.ilFileDataCourse.php.

Referenced by getCoursePath().

◆ $error

ilErrorHandling ilFileDataCourse::$error

protected

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

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

Modules/Course/classes/class.ilFileDataCourse.php

Public Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __checkImportPath()

◆ __checkPath()

◆ __checkReadWrite()

◆ __initDirectory()

◆ addDirectory()

◆ copy()

◆ createOnlineVersion()

◆ deleteArchive()

◆ deleteDirectory()

◆ deleteMemberExportFile()

◆ deletePdf()

◆ deleteZipFile()

◆ getArchiveFile()

◆ getCoursePath()

◆ getMemberExportFile()

◆ getMemberExportFiles()

◆ getOnlineLink()

◆ rCopy()

◆ writeToFile()

◆ zipFile()

Field Documentation

◆ $course_id

◆ $course_path

◆ $error