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

Inheritance diagram for ilCourseFile:

Collaboration diagram for ilCourseFile:

Public Member Functions
	__construct (int $a_file_id=0)

	setFileId (int $a_id)

	getFileId ()

	getCourseId ()

	setCourseId (int $a_course_id)

	setFileName (string $a_name)

	getFileName ()

	setFileType (string $a_type)

	getFileType ()

	setFileSize (int $a_size)

	getFileSize ()

	setTemporaryName (string $a_name)

	getTemporaryName ()

	setErrorCode (int $a_code)

	getErrorCode ()

	getAbsolutePath ()

	getInfoDirectory ()

	validate ()

	create (bool $a_upload=true)

	delete ()

	__read ()

Static Public Member Functions
static	_cloneFiles (int $a_source_id, int $a_target_id)

static	_deleteByCourse (int $a_course_id)

static	_readFilesByCourse (int $a_course_id)

Protected Attributes
ilDBInterface	$db

ilLanguage	$lng

ilErrorHandling	$error

ilFSStorageCourse	$fss_storage = null

Private Attributes
int	$course_id = 0

int	$file_id = 0

string	$file_name = ''

string	$file_type = ''

int	$file_size = 0

string	$tmp_name = ''

int	$error_code = 0

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

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilCourseFile::__construct ( int $a_file_id = 0 )

Definition at line 40 of file class.ilCourseFile.php.

    {
        global $DIC;
 
        $this->lng = $DIC->language();
        $this->db = $DIC->database();
        $this->error = $DIC['ilErr'];
        $this->file_id = $a_file_id;
        $this->__read();
    }

References $DIC, __read(), error(), and ILIAS\Repository\lng().

Here is the call graph for this function:

Member Function Documentation

◆ __read()

ilCourseFile::__read ( )

Definition at line 270 of file class.ilCourseFile.php.

                            : void
    {
        if (!$this->file_id) {
            return;
        }
 
        // read file data
        $query = "SELECT * FROM crs_file WHERE file_id = " . $this->db->quote($this->file_id, 'integer');
        $res = $this->db->query($query);
        while ($row = $this->db->fetchObject($res)) {
            $this->setFileName((string) $row->file_name);
            $this->setFileSize((int) $row->file_size);
            $this->setFileType((string) $row->file_type);
            $this->setCourseId((int) $row->course_id);
        }
        $this->fss_storage = new ilFSStorageCourse($this->getCourseId());
    }

References $query, $res, getCourseId(), setCourseId(), setFileName(), setFileSize(), and setFileType().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _cloneFiles()

static ilCourseFile::_cloneFiles	(	int	$a_source_id,
		int	$a_target_id
	)

static

Definition at line 51 of file class.ilCourseFile.php.

                                                                          : void
    {
        $source = new ilFSStorageCourse($a_source_id);
 
        foreach (ilCourseFile::_readFilesByCourse($a_source_id) as $file_obj) {
            $new_file = new ilCourseFile();
            $new_file->setCourseId($a_target_id);
            $new_file->setFileName($file_obj->getFileName());
            $new_file->setFileSize($file_obj->getFileSize());
            $new_file->setFileType($file_obj->getFileType());
            $new_file->create(false);
 
            $target = new ilFSStorageCourse($a_target_id);
            $target->initInfoDirectory();
            $source->copyFile(
                $file_obj->getAbsolutePath(),
                $new_file->fss_storage->getInfoDirectory() . '/' . $new_file->getFileId()
            );
        }
    }

References $source, and _readFilesByCourse().

Referenced by ilObjCourse\cloneObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _deleteByCourse()

static ilCourseFile::_deleteByCourse ( int $a_course_id )

static

Definition at line 238 of file class.ilCourseFile.php.

                                                            : void
    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
 
        // delete all course ids and delete assigned files
        $query = "DELETE FROM crs_file " .
            "WHERE course_id = " . $ilDB->quote($a_course_id, 'integer') . "";
        $res = $ilDB->manipulate($query);
    }

References $DIC, $ilDB, $query, and $res.

Referenced by ilObjCourse\delete().

Here is the caller graph for this function:

◆ _readFilesByCourse()

static ilCourseFile::_readFilesByCourse ( int $a_course_id )

static

Parameters

int $a_course_id obj_id of course

Returns: ilCourseFile[]

Definition at line 254 of file class.ilCourseFile.php.

                                                               : array
    {
        global $DIC;
 
        $ilDB = $DIC->database();
        $query = "SELECT * FROM crs_file " .
            "WHERE course_id = " . $ilDB->quote($a_course_id, 'integer') . "";
 
        $res = $ilDB->query($query);
        $files = [];
        while ($row = $ilDB->fetchObject($res)) {
            $files[] = new ilCourseFile((int) $row->file_id);
        }
        return $files;
    }

References $DIC, $ilDB, $query, and $res.

Referenced by _cloneFiles(), ilAppointmentPresentationCourseGUI\collectPropertiesAndActions(), ilObjCourseGUI\editInfoObject(), ilAppointmentCourseFileHandler\getFiles(), and ilObjCourseGUI\infoScreen().

Here is the caller graph for this function:

◆ create()

ilCourseFile::create ( bool $a_upload = true )

Definition at line 194 of file class.ilCourseFile.php.

                                                 : bool
    {
        if ($this->getErrorCode() != 0) {
            return false;
        }
        $next_id = $this->db->nextId('crs_file');
        $query = "INSERT INTO crs_file (file_id,course_id,file_name,file_size,file_type) " .
            "VALUES( " .
            $this->db->quote($next_id, 'integer') . ", " .
            $this->db->quote($this->getCourseId(), 'integer') . ", " .
            $this->db->quote($this->getFileName(), 'text') . ", " .
            $this->db->quote($this->getFileSize(), 'integer') . ", " .
            $this->db->quote($this->getFileType(), 'text') . " " .
            ")";
        $res = $this->db->manipulate($query);
        $this->setFileId($next_id);
 
        $this->fss_storage = new ilFSStorageCourse($this->getCourseId());
        $this->fss_storage->initInfoDirectory();
 
        if ($a_upload) {
            // now create file
            ilFileUtils::moveUploadedFile(
                $this->getTemporaryName(),
                $this->getFileName(),
                $this->fss_storage->getInfoDirectory() . '/' . $this->getFileId()
            );
        }
        return true;
    }

References $query, $res, getCourseId(), getErrorCode(), getFileName(), getFileSize(), getFileType(), getTemporaryName(), ilFileUtils\moveUploadedFile(), and setFileId().

Here is the call graph for this function:

◆ delete()

ilCourseFile::delete ( )

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

                            : void
    {
        // Delete db entry
        $query = "DELETE FROM crs_file " .
            "WHERE file_id = " . $this->db->quote($this->getFileId(), 'integer') . "";
        $res = $this->db->manipulate($query);
 
        // Delete file
        if (file_exists($this->getAbsolutePath())) {
            unlink($this->getAbsolutePath());
        }
    }

References $query, $res, getAbsolutePath(), and getFileId().

Here is the call graph for this function:

◆ getAbsolutePath()

ilCourseFile::getAbsolutePath ( )

Definition at line 142 of file class.ilCourseFile.php.

                                     : string
    {
        // workaround for "secured" files.
        if (!$this->fss_storage instanceof \ilFSStorageCourse) {
            return '';
        }
 
        $file = $this->fss_storage->getInfoDirectory() . '/' . $this->getFileId();
        if (!file_exists($file)) {
            $file = $this->fss_storage->getInfoDirectory() . '/' . $this->getFileId() . '.sec';
        }
        if (file_exists($file)) {
            return $file;
        }
        return '';
    }

References getFileId().

Referenced by delete().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCourseId()

ilCourseFile::getCourseId ( )

Definition at line 82 of file class.ilCourseFile.php.

                                 : int
    {
        return $this->course_id;
    }

References $course_id.

Referenced by __read(), and create().

Here is the caller graph for this function:

◆ getErrorCode()

ilCourseFile::getErrorCode ( )

Definition at line 137 of file class.ilCourseFile.php.

                                  : int
    {
        return $this->error_code;
    }

References $error_code.

Referenced by create(), and validate().

Here is the caller graph for this function:

◆ getFileId()

ilCourseFile::getFileId ( )

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

                               : int
    {
        return $this->file_id;
    }

References $file_id.

Referenced by delete(), and getAbsolutePath().

Here is the caller graph for this function:

◆ getFileName()

ilCourseFile::getFileName ( )

Definition at line 97 of file class.ilCourseFile.php.

                                 : string
    {
        return $this->file_name;
    }

References $file_name.

Referenced by create().

Here is the caller graph for this function:

◆ getFileSize()

ilCourseFile::getFileSize ( )

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

                                 : int
    {
        return $this->file_size;
    }

References $file_size.

Referenced by create().

Here is the caller graph for this function:

◆ getFileType()

ilCourseFile::getFileType ( )

Definition at line 107 of file class.ilCourseFile.php.

                                 : string
    {
        return $this->file_type;
    }

References $file_type.

Referenced by create().

Here is the caller graph for this function:

◆ getInfoDirectory()

ilCourseFile::getInfoDirectory ( )

Definition at line 159 of file class.ilCourseFile.php.

                                      : string
    {
        if (is_object($this->fss_storage)) {
            return $this->fss_storage->getInfoDirectory();
        }
        return '';
    }

◆ getTemporaryName()

ilCourseFile::getTemporaryName ( )

Definition at line 127 of file class.ilCourseFile.php.

                                      : string
    {
        return $this->tmp_name;
    }

References $tmp_name.

Referenced by create().

Here is the caller graph for this function:

◆ setCourseId()

ilCourseFile::setCourseId ( int $a_course_id )

Definition at line 87 of file class.ilCourseFile.php.

                                                 : void
    {
        $this->course_id = $a_course_id;
    }

Referenced by __read().

Here is the caller graph for this function:

◆ setErrorCode()

ilCourseFile::setErrorCode ( int $a_code )

Definition at line 132 of file class.ilCourseFile.php.

                                             : void
    {
        $this->error_code = $a_code;
    }

◆ setFileId()

ilCourseFile::setFileId ( int $a_id )

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

                                        : void
    {
        $this->file_id = $a_id;
    }

Referenced by create().

Here is the caller graph for this function:

◆ setFileName()

ilCourseFile::setFileName ( string $a_name )

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

                                               : void
    {
        $this->file_name = $a_name;
    }

Referenced by __read().

Here is the caller graph for this function:

◆ setFileSize()

ilCourseFile::setFileSize ( int $a_size )

Definition at line 112 of file class.ilCourseFile.php.

                                            : void
    {
        $this->file_size = $a_size;
    }

Referenced by __read().

Here is the caller graph for this function:

◆ setFileType()

ilCourseFile::setFileType ( string $a_type )

Definition at line 102 of file class.ilCourseFile.php.

                                               : void
    {
        $this->file_type = $a_type;
    }

Referenced by __read().

Here is the caller graph for this function:

◆ setTemporaryName()

ilCourseFile::setTemporaryName ( string $a_name )

Definition at line 122 of file class.ilCourseFile.php.

                                                    : void
    {
        $this->tmp_name = $a_name;
    }

◆ validate()

ilCourseFile::validate ( )

Definition at line 167 of file class.ilCourseFile.php.

                              : bool
    {
        switch ($this->getErrorCode()) {
            case UPLOAD_ERR_INI_SIZE:
                $this->error->appendMessage($this->lng->txt('file_upload_ini_size'));
                return false;
            case UPLOAD_ERR_FORM_SIZE:
                $this->error->appendMessage($this->lng->txt('file_upload_form_size'));
                return false;
 
            case UPLOAD_ERR_PARTIAL:
                $this->error->appendMessage($this->lng->txt('file_upload_only_partial'));
                return false;
 
            case UPLOAD_ERR_NO_TMP_DIR:
                $this->error->appendMessage($this->lng->txt('file_upload_no_tmp_dir'));
                return false;
 
            case UPLOAD_ERR_NO_FILE:
                return false;
 
            case UPLOAD_ERR_OK:
            default:
                return true;
        }
    }

References error(), getErrorCode(), and ILIAS\Repository\lng().

Here is the call graph for this function:

Field Documentation

◆ $course_id

int ilCourseFile::$course_id = 0

private

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

Referenced by getCourseId().

◆ $db

ilDBInterface ilCourseFile::$db

protected

Definition at line 35 of file class.ilCourseFile.php.

◆ $error

ilErrorHandling ilCourseFile::$error

protected

Definition at line 37 of file class.ilCourseFile.php.

◆ $error_code

int ilCourseFile::$error_code = 0

private

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

Referenced by getErrorCode().

◆ $file_id

int ilCourseFile::$file_id = 0

private

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

Referenced by getFileId().

◆ $file_name

string ilCourseFile::$file_name = ''

private

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

Referenced by getFileName().

◆ $file_size

int ilCourseFile::$file_size = 0

private

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

Referenced by getFileSize().

◆ $file_type

string ilCourseFile::$file_type = ''

private

Definition at line 30 of file class.ilCourseFile.php.

Referenced by getFileType().

◆ $fss_storage

ilFSStorageCourse ilCourseFile::$fss_storage = null

protected

Definition at line 38 of file class.ilCourseFile.php.

◆ $lng

ilLanguage ilCourseFile::$lng

protected

Definition at line 36 of file class.ilCourseFile.php.

◆ $tmp_name

string ilCourseFile::$tmp_name = ''

private

Definition at line 32 of file class.ilCourseFile.php.

Referenced by getTemporaryName().

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

Modules/Course/classes/class.ilCourseFile.php

Public Member Functions

Static Public Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __read()

◆ _cloneFiles()

◆ _deleteByCourse()

◆ _readFilesByCourse()

◆ create()

◆ delete()

◆ getAbsolutePath()

◆ getCourseId()

◆ getErrorCode()

◆ getFileId()

◆ getFileName()

◆ getFileSize()

◆ getFileType()

◆ getInfoDirectory()

◆ getTemporaryName()

◆ setCourseId()

◆ setErrorCode()

◆ setFileId()

◆ setFileName()

◆ setFileSize()

◆ setFileType()

◆ setTemporaryName()

◆ validate()

Field Documentation

◆ $course_id

◆ $db

◆ $error

◆ $error_code

◆ $file_id

◆ $file_name

◆ $file_size

◆ $file_type

◆ $fss_storage

◆ $lng

◆ $tmp_name