This class handles all operations of archive files for the course object. More...

Inheritance diagram for ilFileDataCourse:

Collaboration diagram for ilFileDataCourse:

Public Member Functions
	__construct ($a_course_id)
	Constructor call base constructors checks if directory is writable and sets the optional obj_id. More...

	getArchiveFile ($a_rel_name)

	getMemberExportFiles ()
	Get all member export files. More...

	deleteMemberExportFile ($a_name)

	getMemberExportFile ($a_name)

	deleteArchive ($a_rel_name)

	deleteZipFile ($a_abs_name)

	deleteDirectory ($a_abs_name)

	deletePdf ($a_abs_name)

	copy ($a_from, $a_to)

	rCopy ($a_from, $a_to)

	addDirectory ($a_rel_name)

	writeToFile ($a_data, $a_rel_name)

	zipFile ($a_rel_name, $a_zip_name)

	getCoursePath ()
	get exercise path @access public More...

	createOnlineVersion ($a_rel_name)

	getOnlineLink ($a_rel_name)

	createImportFile ($a_tmp_name, $a_name)

	unpackImportFile ()

	validateImportFile ()

	getImportFile ()

	__checkPath ()

	__checkImportPath ()

	__checkReadWrite ()
	check if directory is writable overwritten method from base class @access private More...

	__initDirectory ()
	init directory overwritten method @access public More...

Public Member Functions inherited from ilFileData
	__construct ()
	Constructor class bas constructor and read path of directory from ilias.ini setup an mail object @access public. More...

	checkPath ($a_path)
	check if path exists and is writable More...

	getPath ()
	get Path @access public More...

Public Member Functions inherited from ilFile
	__construct ()
	Constructor get ilias object @access public. More...

	deleteTrailingSlash ($a_path)
	delete trailing slash of path variables More...

Data Fields
	$course_path

Data Fields inherited from ilFile
	$path

	$ilias

Private Attributes
	$course_id

Detailed Description

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

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilFileDataCourse::__construct ( $a_course_id )

Constructor call base constructors checks if directory is writable and sets the optional obj_id.

Parameters

int	obj_id @access public

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

    {
        define('COURSE_PATH', 'course');
        parent::__construct();
        $this->course_path = parent::getPath() . "/" . COURSE_PATH;
        $this->course_id = $a_course_id;
    
        // IF DIRECTORY ISN'T CREATED CREATE IT
        if (!$this->__checkPath()) {
            $this->__initDirectory();
        }
        // Check import dir
        $this->__checkImportPath();
    }

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

Here is the call graph for this function:

Member Function Documentation

◆ __checkImportPath()

ilFileDataCourse::__checkImportPath ( )

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

    {
        if (!@file_exists($this->getCoursePath() . '/import')) {
            ilUtil::makeDir($this->getCoursePath() . '/import');
        }
 
        if (!is_writable($this->getCoursePath() . '/import') or !is_readable($this->getCoursePath() . '/import')) {
            $this->ilias->raiseError("Course import path is not readable/writable by webserver", $this->ilias->error_obj->FATAL);
        }
    }

References getCoursePath(), and ilUtil\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 273 of file class.ilFileDataCourse.php.

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

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

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __checkReadWrite()

ilFileDataCourse::__checkReadWrite ( )

check if directory is writable overwritten method from base class @access private

Returns: bool

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

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

Referenced by __checkPath().

Here is the caller graph for this function:

◆ __initDirectory()

ilFileDataCourse::__initDirectory ( )

init directory overwritten method @access public

Returns: string path

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

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

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

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addDirectory()

ilFileDataCourse::addDirectory ( $a_rel_name )

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

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

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

Here is the call graph for this function:

◆ copy()

ilFileDataCourse::copy	(	$a_from,
		$a_to
	)

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

    {
        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:

◆ createImportFile()

ilFileDataCourse::createImportFile	(	$a_tmp_name,
		$a_name
	)

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

    {
        ilUtil::makeDir($this->getCoursePath() . '/import/crs_' . $this->course_id);
 
        ilUtil::moveUploadedFile(
            $a_tmp_name,
            $a_name,
            $this->getCoursePath() . '/import/crs_' . $this->course_id . '/' . $a_name
        );
        $this->import_file_info = pathinfo($this->getCoursePath() . '/import/crs_' . $this->course_id . '/' . $a_name);
    }

References getCoursePath(), ilUtil\makeDir(), and ilUtil\moveUploadedFile().

Here is the call graph for this function:

◆ createOnlineVersion()

ilFileDataCourse::createOnlineVersion ( $a_rel_name )

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

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

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

Here is the call graph for this function:

◆ deleteArchive()

ilFileDataCourse::deleteArchive ( $a_rel_name )

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

    {
        $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');
 
        return true;
    }

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

Here is the call graph for this function:

◆ deleteDirectory()

ilFileDataCourse::deleteDirectory ( $a_abs_name )

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

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

References ilUtil\delDir().

Referenced by deleteArchive().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deleteMemberExportFile()

ilFileDataCourse::deleteMemberExportFile ( $a_name )

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

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

◆ deletePdf()

ilFileDataCourse::deletePdf ( $a_abs_name )

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

    {
        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 ( $a_abs_name )

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

    {
        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 67 of file class.ilFileDataCourse.php.

    {
        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 false;
    }

◆ getCoursePath()

ilFileDataCourse::getCoursePath ( )

get exercise path @access public

Returns: string path

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

    {
        return $this->course_path;
    }

References $course_path.

Referenced by __checkImportPath(), __checkPath(), addDirectory(), copy(), createImportFile(), createOnlineVersion(), getImportFile(), rCopy(), unpackImportFile(), validateImportFile(), writeToFile(), and zipFile().

Here is the caller graph for this function:

◆ getImportFile()

ilFileDataCourse::getImportFile ( )

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

    {
        return $this->getCoursePath() . '/import/crs_' . $this->course_id
            . '/' . basename($this->import_file_info['basename'], '.zip')
            . '/' . basename($this->import_file_info['basename'], '.zip') . '.xml';
    }

References getCoursePath().

Here is the call graph for this function:

◆ getMemberExportFile()

ilFileDataCourse::getMemberExportFile ( $a_name )

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

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

◆ getMemberExportFiles()

ilFileDataCourse::getMemberExportFiles ( )

Get all member export files.

@access public

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

    {
        $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) and $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 ? $files : array();
    }

◆ getOnlineLink()

ilFileDataCourse::getOnlineLink ( $a_rel_name )

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

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

References ilUtil\getWebspaceDir().

Here is the call graph for this function:

◆ rCopy()

ilFileDataCourse::rCopy	(	$a_from,
		$a_to
	)

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

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

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

Here is the call graph for this function:

◆ unpackImportFile()

ilFileDataCourse::unpackImportFile ( )

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

    {
        return ilUtil::unzip($this->getCoursePath() . '/import/crs_' . $this->course_id . '/' . $this->import_file_info['basename']);
    }

References getCoursePath(), and ilUtil\unzip().

Here is the call graph for this function:

◆ validateImportFile()

ilFileDataCourse::validateImportFile ( )

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

    {
        if (!is_dir($this->getCoursePath() . '/import/crs_' . $this->course_id) . '/' .
           basename($this->import_file_info['basename'], '.zip')) {
            return false;
        }
        if (!file_exists($this->getCoursePath() . '/import/crs_' . $this->course_id
                        . '/' . basename($this->import_file_info['basename'], '.zip')
                        . '/' . basename($this->import_file_info['basename'], '.zip') . '.xml')) {
            return false;
        }
    }

References getCoursePath().

Here is the call graph for this function:

◆ writeToFile()

ilFileDataCourse::writeToFile	(	$a_data,
		$a_rel_name
	)

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

    {
        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	(	$a_rel_name,
		$a_zip_name
	)

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

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

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

Here is the call graph for this function:

Field Documentation

◆ $course_id

ilFileDataCourse::$course_id

private

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

◆ $course_path

ilFileDataCourse::$course_path

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

Referenced by getCoursePath().

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

Modules/Course/classes/class.ilFileDataCourse.php

Public Member Functions

Data Fields

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __checkImportPath()

◆ __checkPath()

◆ __checkReadWrite()

◆ __initDirectory()

◆ addDirectory()

◆ copy()

◆ createImportFile()

◆ createOnlineVersion()

◆ deleteArchive()

◆ deleteDirectory()

◆ deleteMemberExportFile()

◆ deletePdf()

◆ deleteZipFile()

◆ getArchiveFile()

◆ getCoursePath()

◆ getImportFile()

◆ getMemberExportFile()

◆ getMemberExportFiles()

◆ getOnlineLink()

◆ rCopy()

◆ unpackImportFile()

◆ validateImportFile()

◆ writeToFile()

◆ zipFile()

Field Documentation

◆ $course_id

◆ $course_path