ilSessionFile Class Reference

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

Collaboration diagram for ilSessionFile:

Public Member Functions
	__construct (int $a_file_id=0)
	setFileId (int $a_id)
	getFileId ()
	getSessionId ()
	setSessionId (int $a_event_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 ()
	validate ()
	cloneFiles (int $a_target_event_id)
	create (bool $a_upload=true)
	delete ()
	_deleteByEvent (int $a_event_id)

Static Public Member Functions
static	_readFilesByEvent (int $a_event_id)

Protected Member Functions
	__read ()

Protected Attributes
ilErrorHandling	$ilErr
ilDBInterface	$db
ilLanguage	$lng
int	$event_id = 0
int	$file_id = 0
string	$file_name = ""
string	$file_type = ""
int	$file_size = 0
string	$tmp_name = ""
int	$error_code = 0
ilFSStorageSession	$fss_storage

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 class ilSessionFile

Author

Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

ilSessionFile::__construct

(

int

$a_file_id = 0

)

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

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

    {
        global $DIC;

        $this->ilErr = $DIC['ilErr'];
        $this->db = $DIC->database();
        $this->lng = $DIC->language();

        $this->file_id = $a_file_id;
        $this->__read();
    }

Here is the call graph for this function:

Member Function Documentation

__read()

ilSessionFile::__read ( )

protected

Definition at line 250 of file class.ilSessionFile.php.

References $db, $ilDB, $query, $res, ilDBConstants\FETCHMODE_OBJECT, getSessionId(), setFileName(), setFileSize(), setFileType(), and setSessionId().

Referenced by __construct().

                               : bool
    {
        $ilDB = $this->db;

        if (!$this->file_id) {
            return true;
        }

        // read file data
        $query = "SELECT * FROM event_file WHERE file_id = " . $ilDB->quote($this->file_id, 'integer');
        $res = $this->db->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $this->setFileName($row->file_name);
            $this->setFileSize($row->file_size);
            $this->setFileType($row->file_type);
            $this->setSessionId($row->event_id);
        }
        $this->fss_storage = new ilFSStorageSession($this->getSessionId());
        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_deleteByEvent()

ilSessionFile::_deleteByEvent

(

int

$a_event_id

)

Definition at line 220 of file class.ilSessionFile.php.

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

                                                   : bool
    {
        $ilDB = $this->db;

        // delete all event ids and delete assigned files
        $query = "DELETE FROM event_file " .
            "WHERE event_id = " . $ilDB->quote($a_event_id, 'integer');
        $res = $ilDB->manipulate($query);

        #$this->fss_storage->delete();
        return true;
    }

_readFilesByEvent()

static ilSessionFile::_readFilesByEvent ( int  $a_event_id )

static

Definition at line 233 of file class.ilSessionFile.php.

References $DIC, $ilDB, $query, $res, and ilDBConstants\FETCHMODE_OBJECT.

                                                             : array
    {
        global $DIC;

        $ilDB = $DIC->database();

        $query = "SELECT * FROM event_file " .
            "WHERE event_id = " . $ilDB->quote($a_event_id, 'integer');

        $res = $ilDB->query($query);
        $files = [];
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $files[] = new ilSessionFile($row->file_id);
        }
        return $files;
    }

cloneFiles()

ilSessionFile::cloneFiles

(

int

$a_target_event_id

)

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

References $source, getAbsolutePath(), getFileName(), getFileSize(), getFileType(), and getSessionId().

                                                      : void
    {
        $file = new ilSessionFile();
        $file->setSessionId($a_target_event_id);
        $file->setFileName($this->getFileName());
        $file->setFileType($this->getFileType());
        $file->setFileSize($this->getFileSize());
        $file->create(false);

        // Copy file
        $source = new ilFSStorageSession($this->getSessionId());
        $source->copyFile($this->getAbsolutePath(), $file->getAbsolutePath());
    }

Here is the call graph for this function:

create()

ilSessionFile::create

(

bool

$a_upload = true

)

Definition at line 170 of file class.ilSessionFile.php.

References $db, $ilDB, $query, $res, getErrorCode(), getFileId(), getFileName(), getFileSize(), getFileType(), getSessionId(), getTemporaryName(), ilFileUtils\moveUploadedFile(), and setFileId().

                                                 : bool
    {
        $ilDB = $this->db;

        if ($this->getErrorCode() != 0) {
            return false;
        }

        $next_id = $ilDB->nextId('event_file');
        $query = "INSERT INTO event_file (file_id,event_id,file_name,file_size,file_type) " .
            "VALUES( " .
            $ilDB->quote($next_id, 'integer') . ", " .
            $ilDB->quote($this->getSessionId(), '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 ilFSStorageSession($this->getSessionId());
        $this->fss_storage->createDirectory();

        if ($a_upload) {
            // now create file
            ilFileUtils::moveUploadedFile(
                $this->getTemporaryName(),
                $this->getFileName(),
                $this->fss_storage->getAbsolutePath() . '/' . $this->getFileId()
            );
        }

        return true;
    }

Here is the call graph for this function:

delete()

ilSessionFile::delete

(

)

Definition at line 206 of file class.ilSessionFile.php.

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

                            : bool
    {
        $ilDB = $this->db;

        // Delete db entry
        $query = "DELETE FROM event_file " .
            "WHERE file_id = " . $ilDB->quote($this->getFileId(), 'integer') . " ";
        $res = $ilDB->manipulate($query);

        // Delete file
        $this->fss_storage->deleteFile($this->getAbsolutePath());
        return true;
    }

Here is the call graph for this function:

getAbsolutePath()

ilSessionFile::getAbsolutePath

(

)

Definition at line 124 of file class.ilSessionFile.php.

References getFileId().

Referenced by cloneFiles(), and delete().

                                     : string
    {
        return $this->fss_storage->getAbsolutePath() . "/" . $this->getFileId();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getErrorCode()

ilSessionFile::getErrorCode

(

)

Definition at line 119 of file class.ilSessionFile.php.

References $error_code.

Referenced by create(), and validate().

                                  : int
    {
        return $this->error_code;
    }

Here is the caller graph for this function:

getFileId()

ilSessionFile::getFileId

(

)

Definition at line 59 of file class.ilSessionFile.php.

References $file_id.

Referenced by create(), delete(), and getAbsolutePath().

                               : int
    {
        return $this->file_id;
    }

Here is the caller graph for this function:

getFileName()

ilSessionFile::getFileName

(

)

Definition at line 79 of file class.ilSessionFile.php.

References $file_name.

Referenced by cloneFiles(), and create().

                                 : string
    {
        return $this->file_name;
    }

Here is the caller graph for this function:

getFileSize()

ilSessionFile::getFileSize

(

)

Definition at line 99 of file class.ilSessionFile.php.

References $file_size.

Referenced by cloneFiles(), and create().

                                 : int
    {
        return $this->file_size;
    }

Here is the caller graph for this function:

getFileType()

ilSessionFile::getFileType

(

)

Definition at line 89 of file class.ilSessionFile.php.

References $file_type.

Referenced by cloneFiles(), and create().

                                 : string
    {
        return $this->file_type;
    }

Here is the caller graph for this function:

getSessionId()

ilSessionFile::getSessionId

(

)

Definition at line 64 of file class.ilSessionFile.php.

References $event_id.

Referenced by __read(), cloneFiles(), and create().

                                  : int
    {
        return $this->event_id;
    }

Here is the caller graph for this function:

getTemporaryName()

ilSessionFile::getTemporaryName

(

)

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

References $tmp_name.

Referenced by create().

                                      : string
    {
        return $this->tmp_name;
    }

Here is the caller graph for this function:

setErrorCode()

ilSessionFile::setErrorCode

(

int

$a_code

)

Definition at line 114 of file class.ilSessionFile.php.

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

setFileId()

ilSessionFile::setFileId

(

int

$a_id

)

Definition at line 54 of file class.ilSessionFile.php.

Referenced by create().

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

Here is the caller graph for this function:

setFileName()

ilSessionFile::setFileName

(

string

$a_name

)

Definition at line 74 of file class.ilSessionFile.php.

Referenced by __read().

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

Here is the caller graph for this function:

setFileSize()

ilSessionFile::setFileSize

(

int

$a_size

)

Definition at line 94 of file class.ilSessionFile.php.

Referenced by __read().

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

Here is the caller graph for this function:

setFileType()

ilSessionFile::setFileType

(

string

$a_type

)

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

Referenced by __read().

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

Here is the caller graph for this function:

setSessionId()

ilSessionFile::setSessionId

(

int

$a_event_id

)

Definition at line 69 of file class.ilSessionFile.php.

Referenced by __read().

                                                 : void
    {
        $this->event_id = $a_event_id;
    }

Here is the caller graph for this function:

setTemporaryName()

ilSessionFile::setTemporaryName

(

string

$a_name

)

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

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

validate()

ilSessionFile::validate

(

)

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

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

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

            case UPLOAD_ERR_OK:
            case UPLOAD_ERR_NO_FILE:
            default:
                return true;
        }

        return false;
    }

Here is the call graph for this function:

Field Documentation

$db

ilDBInterface ilSessionFile::$db

protected

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

Referenced by __read(), _deleteByEvent(), create(), and delete().

$error_code

int ilSessionFile::$error_code = 0

protected

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

Referenced by getErrorCode().

$event_id

int ilSessionFile::$event_id = 0

protected

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

Referenced by getSessionId().

$file_id

int ilSessionFile::$file_id = 0

protected

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

Referenced by getFileId().

$file_name

string ilSessionFile::$file_name = ""

protected

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

Referenced by getFileName().

$file_size

int ilSessionFile::$file_size = 0

protected

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

Referenced by getFileSize().

$file_type

string ilSessionFile::$file_type = ""

protected

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

Referenced by getFileType().

$fss_storage

ilFSStorageSession ilSessionFile::$fss_storage

protected

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

$ilErr

ilErrorHandling ilSessionFile::$ilErr

protected

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

$lng

ilLanguage ilSessionFile::$lng

protected

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

$tmp_name

string ilSessionFile::$tmp_name = ""

protected

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

Referenced by getTemporaryName().

---

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

• Modules/Session/classes/class.ilSessionFile.php