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

Collaboration diagram for ilExportFileInfo:

Public Member Functions
	__construct (int $a_obj_id, string $a_export_type='', string $a_filename='')

	setExportType (string $a_type)

	getExportType ()

	setFilename (string $a_name)

	getFilename ()

	getBasename (string $a_ext='.zip')

	setObjId (int $a_id)

	getObjId ()

	setVersion (string $a_version)

	getVersion ()

	getCreationDate ()

	setCreationDate (?ilDateTime $dt=null)

	create ()

	delete ()

Static Public Member Functions
static	lookupLastExport (int $a_obj_id, string $a_type, string $a_version='')
	Lookup last export. More...

static	deleteByObjId ($a_obj_id)

Protected Member Functions
	read ()

Protected Attributes
const	CURRENT_VERSION = "4.1.0"

ilDBInterface	$db

Private Attributes
int	$obj_id = 0

string	$version = self::CURRENT_VERSION

string	$export_type = ''

string	$file_name = ''

ilDateTime	$create_date = null

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 @classDescription Stores information of creation date and versions of export files

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

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

Constructor & Destructor Documentation

◆ __construct()

ilExportFileInfo::__construct	(	int	$a_obj_id,
		string	$a_export_type = `''`,
		string	$a_filename = `''`
	)

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

    {
        global $DIC;
 
        $this->db = $DIC->database();
        $this->obj_id = $a_obj_id;
        $this->export_type = $a_export_type;
        $this->file_name = $a_filename;
        if ($this->getObjId() and $this->getExportType() and $this->getFilename()) {
            $this->read();
        }
    }

References $DIC, getExportType(), getFilename(), getObjId(), and read().

Here is the call graph for this function:

Member Function Documentation

◆ create()

ilExportFileInfo::create ( )

Definition at line 139 of file class.ilExportFileInfo.php.

                            : void
    {
        $exists_query = 'select * from export_file_info ' .
            'where obj_id = ' . $this->db->quote($this->obj_id, 'integer') . ' ' .
            'and export_type = ' . $this->db->quote($this->getExportType(), 'text') . ' ' .
            'and filename = ' . $this->db->quote($this->getFilename(), 'text');
        $exists_res = $this->db->query($exists_query);
 
        if (!$exists_res->numRows()) {
            $query = "INSERT INTO export_file_info (obj_id, export_type, filename, version, create_date) " .
                "VALUES ( " .
                $this->db->quote($this->getObjId(), 'integer') . ', ' .
                $this->db->quote($this->getExportType(), 'text') . ', ' .
                $this->db->quote($this->getFilename(), 'text') . ', ' .
                $this->db->quote($this->getVersion(), 'text') . ', ' .
                $this->db->quote(
                    $this->getCreationDate()->get(IL_CAL_DATETIME, '', ilTimeZone::UTC),
                    'timestamp'
                ) . ' ' .
                ")";
            $this->db->manipulate($query);
        }
    }

References $query, getCreationDate(), getExportType(), getFilename(), getObjId(), getVersion(), IL_CAL_DATETIME, and ilTimeZone\UTC.

Here is the call graph for this function:

◆ delete()

ilExportFileInfo::delete ( )

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

                            : void
    {
        $this->db->manipulate(
            'DELETE FROM export_file_info ' .
            'WHERE obj_id = ' . $this->db->quote($this->getObjId(), 'integer') . ' ' .
            'AND filename = ' . $this->db->quote($this->getFilename(), 'text')
        );
    }

References getFilename().

Here is the call graph for this function:

◆ deleteByObjId()

static ilExportFileInfo::deleteByObjId ( $a_obj_id )

static

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

    {
        global $DIC;
 
        $ilDB = $DIC->database();
        $ilDB->manipulate("DELETE FROM export_file_info WHERE obj_id = " . $ilDB->quote(
            $a_obj_id,
            ilDBConstants::T_INTEGER
        ));
        return true;
    }

References $DIC, $ilDB, and ilDBConstants\T_INTEGER.

◆ getBasename()

ilExportFileInfo::getBasename ( string $a_ext = '.zip' )

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

                                                       : string
    {
        return basename($this->getFilename(), $a_ext);
    }

References getFilename().

Here is the call graph for this function:

◆ getCreationDate()

ilExportFileInfo::getCreationDate ( )

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

                                     : ilDateTime
    {
        return $this->create_date instanceof ilDateTime ? $this->create_date : new ilDateTime(time(), IL_CAL_UNIX);
    }

References IL_CAL_UNIX.

Referenced by create().

Here is the caller graph for this function:

◆ getExportType()

ilExportFileInfo::getExportType ( )

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

                                   : string
    {
        return $this->export_type;
    }

References $export_type.

Referenced by __construct(), create(), and read().

Here is the caller graph for this function:

◆ getFilename()

ilExportFileInfo::getFilename ( )

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

                                 : string
    {
        return $this->file_name;
    }

References $file_name.

Referenced by __construct(), create(), delete(), getBasename(), and read().

Here is the caller graph for this function:

◆ getObjId()

ilExportFileInfo::getObjId ( )

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

                              : int
    {
        return $this->obj_id;
    }

References $obj_id.

Referenced by __construct(), create(), and read().

Here is the caller graph for this function:

◆ getVersion()

ilExportFileInfo::getVersion ( )

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

                                : string
    {
        return $this->version;
    }

References $version.

Referenced by create().

Here is the caller graph for this function:

◆ lookupLastExport()

static ilExportFileInfo::lookupLastExport	(	int	$a_obj_id,
		string	$a_type,
		string	$a_version = `''`
	)

static

Lookup last export.

Definition at line 53 of file class.ilExportFileInfo.php.

                                                                                                  : ?ilExportFileInfo
    {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        $query = "SELECT * FROM export_file_info " .
            "WHERE obj_id = " . $ilDB->quote($a_obj_id, 'integer') . ' ' .
            "AND export_type = " . $ilDB->quote($a_type, 'text') . ' ' .
            "ORDER BY create_date DESC";
        $res = $ilDB->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            if (!$a_version || $row->version == $a_version) {
                return new ilExportFileInfo((int) $row->obj_id, $row->export_type, $row->filename);
            }
        }
        return null;
    }

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

Referenced by ilExportContainer\addSubitems(), and ilExportSelectionTableGUI\parseContainer().

Here is the caller graph for this function:

◆ read()

ilExportFileInfo::read ( )

protected

Definition at line 172 of file class.ilExportFileInfo.php.

                             : void
    {
        $query = "SELECT * FROM export_file_info " .
            "WHERE obj_id = " . $this->db->quote($this->getObjId(), 'integer') . ' ' .
            "AND export_type = " . $this->db->quote($this->getExportType(), 'text') . ' ' .
            "AND filename = " . $this->db->quote($this->getFilename(), 'text');
 
        $res = $this->db->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $this->setVersion($row->version);
            $this->setCreationDate(new ilDateTime($row->create_date, IL_CAL_DATETIME, ilTimeZone::UTC));
        }
    }

References $query, $res, ilDBConstants\FETCHMODE_OBJECT, getExportType(), getFilename(), getObjId(), IL_CAL_DATETIME, setCreationDate(), setVersion(), and ilTimeZone\UTC.

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setCreationDate()

ilExportFileInfo::setCreationDate ( ?ilDateTime $dt = null )

Definition at line 134 of file class.ilExportFileInfo.php.

    {
        $this->create_date = $dt;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setExportType()

ilExportFileInfo::setExportType ( string $a_type )

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

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

◆ setFilename()

ilExportFileInfo::setFilename ( string $a_name )

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

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

◆ setObjId()

ilExportFileInfo::setObjId ( int $a_id )

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

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

◆ setVersion()

ilExportFileInfo::setVersion ( string $a_version )

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

                                                 : void
    {
        $this->version = $a_version;
    }

Referenced by read().

Here is the caller graph for this function:

Field Documentation

◆ $create_date

ilDateTime ilExportFileInfo::$create_date = null

private

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

◆ $db

ilDBInterface ilExportFileInfo::$db

protected

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

◆ $export_type

string ilExportFileInfo::$export_type = ''

private

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

Referenced by getExportType().

◆ $file_name

string ilExportFileInfo::$file_name = ''

private

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

Referenced by getFilename().

◆ $obj_id

int ilExportFileInfo::$obj_id = 0

private

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

Referenced by getObjId().

◆ $version

string ilExportFileInfo::$version = self::CURRENT_VERSION

private

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

Referenced by getVersion().

◆ CURRENT_VERSION

const ilExportFileInfo::CURRENT_VERSION = "4.1.0"

protected

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

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

Services/Export/classes/class.ilExportFileInfo.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ create()

◆ delete()

◆ deleteByObjId()

◆ getBasename()

◆ getCreationDate()

◆ getExportType()

◆ getFilename()

◆ getObjId()

◆ getVersion()

◆ lookupLastExport()

◆ read()

◆ setCreationDate()

◆ setExportType()

◆ setFilename()

◆ setObjId()

◆ setVersion()

Field Documentation

◆ $create_date

◆ $db

◆ $export_type

◆ $file_name

◆ $obj_id

◆ $version

◆ CURRENT_VERSION