Inheritance diagram for ilCourseFile:

Collaboration diagram for ilCourseFile:

Public Member Functions
	__construct ($a_file_id=null)
	Constructor. More...

	setFileId ($a_id)

	getFileId ()

	getCourseId ()

	setCourseId ($a_course_id)

	setFileName ($a_name)

	getFileName ()

	setFileType ($a_type)

	getFileType ()

	setFileSize ($a_size)

	getFileSize ()

	setTemporaryName ($a_name)

	getTemporaryName ()

	setErrorCode ($a_code)

	getErrorCode ()

	getAbsolutePath ()

	validate ()

	create ($a_upload=true)

	delete ()

	__read ()

Static Public Member Functions
static	_cloneFiles ($a_source_id, $a_target_id)
	Clone course files. More...

static	_deleteByCourse ($a_course_id)

static	_readFilesByCourse ($a_course_id)

Data Fields
	$ilErr

	$ilDB

	$tree

	$lng

	$course_id = null

	$file_id = null

Private Attributes
	$fss_storage = null

Detailed Description

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

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilCourseFile::__construct ( $a_file_id = null )

Constructor.

Parameters

int $a_file_id

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

        {
                global $ilErr,$ilDB,$lng;
 
                $this->ilErr = $ilErr;
                $this->db  = $ilDB;
                $this->lng = $lng;
 
                $this->file_id = $a_file_id;
                $this->__read();
        }

References $ilDB, $ilErr, $lng, and __read().

Here is the call graph for this function:

Member Function Documentation

◆ __read()

ilCourseFile::__read ( )

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

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

References $ilDB, $query, $res, $row, 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	(	$a_source_id,
		$a_target_id
	)

static

Clone course files.

@access public

Parameters

int	source id
int	target_id

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

        {
                $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->getAbsolutePath());
                }
        }

References $target, 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 ( $a_course_id )

static

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

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

References $ilDB, $query, and $res.

Referenced by ilObjCourse\delete().

Here is the caller graph for this function:

◆ _readFilesByCourse()

static ilCourseFile::_readFilesByCourse ( $a_course_id )

static

Parameters

int $a_course_id obj_id of course

Returns: ilCourseFile[]

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

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

References $files, $ilDB, $query, $res, and $row.

Referenced by _cloneFiles(), ilObjCourseGUI\editInfoObject(), and ilObjCourseGUI\infoScreen().

Here is the caller graph for this function:

◆ create()

ilCourseFile::create ( $a_upload = true )

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

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

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

Here is the call graph for this function:

◆ delete()

ilCourseFile::delete ( )

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

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

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

Here is the call graph for this function:

◆ getAbsolutePath()

ilCourseFile::getAbsolutePath ( )

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

        {
                if(is_object($this->fss_storage))
                {
                        return $this->fss_storage->getInfoDirectory().'/'.$this->getFileId();
                }
                return false;
        }

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 100 of file class.ilCourseFile.php.

        {
                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 145 of file class.ilCourseFile.php.

        {
                return $this->error_code;
        }

Referenced by create(), and validate().

Here is the caller graph for this function:

◆ getFileId()

ilCourseFile::getFileId ( )

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

        {
                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 113 of file class.ilCourseFile.php.

        {
                return $this->file_name;
        }

Referenced by create().

Here is the caller graph for this function:

◆ getFileSize()

ilCourseFile::getFileSize ( )

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

        {
                return $this->file_size;
        }

Referenced by create().

Here is the caller graph for this function:

◆ getFileType()

ilCourseFile::getFileType ( )

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

        {
                return $this->file_type;
        }

Referenced by create().

Here is the caller graph for this function:

◆ getTemporaryName()

ilCourseFile::getTemporaryName ( )

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

        {
                return $this->tmp_name;
        }

Referenced by create().

Here is the caller graph for this function:

◆ setCourseId()

ilCourseFile::setCourseId ( $a_course_id )

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

        {
                $this->course_id = $a_course_id;
        }

Referenced by __read().

Here is the caller graph for this function:

◆ setErrorCode()

ilCourseFile::setErrorCode ( $a_code )

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

        {
                $this->error_code = $a_code;
        }

◆ setFileId()

ilCourseFile::setFileId ( $a_id )

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

        {
                $this->file_id = $a_id;
        }

Referenced by create().

Here is the caller graph for this function:

◆ setFileName()

ilCourseFile::setFileName ( $a_name )

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

        {
                $this->file_name = $a_name;
        }

Referenced by __read().

Here is the caller graph for this function:

◆ setFileSize()

ilCourseFile::setFileSize ( $a_size )

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

        {
                $this->file_size = $a_size;
        }

Referenced by __read().

Here is the caller graph for this function:

◆ setFileType()

ilCourseFile::setFileType ( $a_type )

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

        {
                $this->file_type = $a_type;
        }

References $a_type.

Referenced by __read().

Here is the caller graph for this function:

◆ setTemporaryName()

ilCourseFile::setTemporaryName ( $a_name )

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

        {
                $this->tmp_name = $a_name;
        }

◆ validate()

ilCourseFile::validate ( )

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

        {
                switch($this->getErrorCode())
                {
                        case UPLOAD_ERR_INI_SIZE:
                                $this->ilErr->appendMessage($this->lng->txt('file_upload_ini_size'));
                                break;
                        case UPLOAD_ERR_FORM_SIZE:
                                $this->ilErr->appendMessage($this->lng->txt('file_upload_form_size'));
                                break;
 
                        case UPLOAD_ERR_PARTIAL:
                                $this->ilErr->appendMessage($this->lng->txt('file_upload_only_partial'));
                                break;
 
                        case UPLOAD_ERR_NO_TMP_DIR:
                                $this->ilErr->appendMessage($this->lng->txt('file_upload_no_tmp_dir'));
                                break;
 
                                // not possible with php 4
                        #case UPLOAD_ERR_CANT_WRITE:
                        #       $this->ilErr->appendMessage($this->lng->txt('file_upload_no_write'));
                        #       break;
 
                        case UPLOAD_ERR_OK:
                        case UPLOAD_ERR_NO_FILE:
                        default:
                                return true;
                }
        }

References getErrorCode().

Here is the call graph for this function:

Field Documentation

◆ $course_id

ilCourseFile::$course_id = null

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

Referenced by getCourseId().

◆ $file_id

ilCourseFile::$file_id = null

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

Referenced by getFileId().

◆ $fss_storage

ilCourseFile::$fss_storage = null

private

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

◆ $ilDB

ilCourseFile::$ilDB

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

Referenced by __construct(), __read(), _deleteByCourse(), _readFilesByCourse(), create(), and delete().

◆ $ilErr

ilCourseFile::$ilErr

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

Referenced by __construct().

◆ $lng

ilCourseFile::$lng

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

Referenced by __construct().

◆ $tree

ilCourseFile::$tree

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

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

Modules/Course/classes/class.ilCourseFile.php

Public Member Functions

Static Public Member Functions

Data Fields

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __read()

◆ _cloneFiles()

◆ _deleteByCourse()

◆ _readFilesByCourse()

◆ create()

◆ delete()

◆ getAbsolutePath()

◆ getCourseId()

◆ getErrorCode()

◆ getFileId()

◆ getFileName()

◆ getFileSize()

◆ getFileType()

◆ getTemporaryName()

◆ setCourseId()

◆ setErrorCode()

◆ setFileId()

◆ setFileName()

◆ setFileSize()

◆ setFileType()

◆ setTemporaryName()

◆ validate()

Field Documentation

◆ $course_id

◆ $file_id

◆ $fss_storage

◆ $ilDB

◆ $ilErr

◆ $lng

◆ $tree