Stores information of creation date and versions of export files More...

Collaboration diagram for ilExportFileInfo:

Public Member Functions
	__construct ($a_obj_id, $a_export_type='', $a_filename='')
	ilExportFileInfo constructor. More...

	setExportType ($a_type)
	set export type More...

	getExportType ()
	get export type More...

	setFilename ($a_name)
	set filename More...

	getFilename ()
	get filename More...

	getBasename ($a_ext='.zip')

	setObjId ($a_id)
	Set obj id. More...

	getObjId ()
	Get obj id. More...

	setVersion ($a_version)
	set version More...

	getVersion ()
	get version More...

	getCreationDate ()
	get creation date More...

	setCreationDate (ilDateTime $dt=null)
	set creation date More...

	create ()
	Create new export entry. More...

	delete ()
	Delete one export entry. More...

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

static	deleteByObjId ($a_obj_id)
	Delete all export entries by obj_id. More...

Data Fields
const	CURRENT_VERSION = "4.1.0"

Protected Member Functions
	read ()
	Read. More...

Private Attributes
	$obj_id = 0

	$version = self::CURRENT_VERSION

	$export_type = ''

	$file_name = ''

	$create_date = null

Detailed Description

Stores information of creation date and versions of export files

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

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

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

ilExportFileInfo constructor.

Parameters

int	$a_obj_id
string	$a_export_type
string	$a_filename

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

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

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

Here is the call graph for this function:

Member Function Documentation

◆ create()

ilExportFileInfo::create ( )

Create new export entry.

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

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

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

Here is the call graph for this function:

◆ delete()

ilExportFileInfo::delete ( )

Delete one export entry.

Returns

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

References $ilDB.

     {
         global $ilDB;
         
         $ilDB->manipulate(
             'DELETE FROM export_file_info ' .
             'WHERE obj_id = ' . $ilDB->quote($this->getObjId(), 'integer') . ' ' .
             'AND filename = ' . $ilDB->quote($this->getFilename(), 'text')
         );
         return true;
     }

◆ deleteByObjId()

static ilExportFileInfo::deleteByObjId ( $a_obj_id )

static

Delete all export entries by obj_id.

Parameters

object $a_obj_id

Returns

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

References $ilDB.

     {
         global $ilDB;
         
         $ilDB->manipulate("DELETE FROM export_file_info WHERE obj_id = " . $ilDB->quote($a_obj_id));
         return true;
     }

◆ getBasename()

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

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

References getFilename().

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

Here is the call graph for this function:

◆ getCreationDate()

ilExportFileInfo::getCreationDate ( )

get creation date

Returns: ilDateTime $date

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

References IL_CAL_UNIX, and time.

Referenced by create().

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

Here is the caller graph for this function:

◆ getExportType()

ilExportFileInfo::getExportType ( )

get export type

Returns: string export type

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

References $export_type.

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

     {
         return $this->export_type;
     }

Here is the caller graph for this function:

◆ getFilename()

ilExportFileInfo::getFilename ( )

get filename

Returns

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

References $file_name.

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

     {
         return $this->file_name;
     }

Here is the caller graph for this function:

◆ getObjId()

ilExportFileInfo::getObjId ( )

Get obj id.

Returns

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

References $obj_id.

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

     {
         return $this->obj_id;
     }

Here is the caller graph for this function:

◆ getVersion()

ilExportFileInfo::getVersion ( )

get version

Returns

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

References $version.

Referenced by create().

     {
         return $this->version;
     }

Here is the caller graph for this function:

◆ lookupLastExport()

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

static

Lookup last export.

Parameters

object	$a_obj_id
	string	type xml \| html \| scorm2004...
	string	version

Returns: object ilExportFileInfo

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

References $a_type, $ilDB, $query, $res, $row, and ilDBConstants\FETCHMODE_OBJECT.

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

     {
         global $ilDB;
         
         $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 or $row->version == $a_version) {
                 return new ilExportFileInfo($row->obj_id, $row->export_type, $row->filename);
             }
         }
         return null;
     }

Here is the caller graph for this function:

◆ read()

ilExportFileInfo::read ( )

protected

Read.

Returns

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

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

Referenced by __construct().

     {
         global $ilDB;
         
         $query = "SELECT * FROM export_file_info " .
             "WHERE obj_id = " . $ilDB->quote($this->getObjId(), 'integer') . ' ' .
             "AND export_type = " . $ilDB->quote($this->getExportType(), 'text') . ' ' .
             "AND filename = " . $ilDB->quote($this->getFilename(), 'text');
             
         $res = $ilDB->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));
         }
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setCreationDate()

ilExportFileInfo::setCreationDate ( ilDateTime $dt = null )

set creation date

Parameters

ilDateTime $dt [optional]

Returns

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

Referenced by read().

     {
         $this->create_date = $dt;
     }

Here is the caller graph for this function:

◆ setExportType()

ilExportFileInfo::setExportType ( $a_type )

set export type

Parameters

string $a_type xml | html ...

Returns

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

References $a_type.

     {
         $this->export_type = $a_type;
     }

◆ setFilename()

ilExportFileInfo::setFilename ( $a_name )

set filename

Parameters

string $a_name

Returns

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

     {
         $this->file_name = $a_name;
     }

◆ setObjId()

ilExportFileInfo::setObjId ( $a_id )

Set obj id.

Parameters

object $a_id

Returns

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

     {
         $this->obj_id = $a_id;
     }

◆ setVersion()

ilExportFileInfo::setVersion ( $a_version )

set version

Returns

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

Referenced by read().

     {
         $this->version = $a_version;
     }

Here is the caller graph for this function:

Field Documentation

◆ $create_date

ilExportFileInfo::$create_date = null

private

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

◆ $export_type

ilExportFileInfo::$export_type = ''

private

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

Referenced by getExportType().

◆ $file_name

ilExportFileInfo::$file_name = ''

private

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

Referenced by getFilename().

◆ $obj_id

ilExportFileInfo::$obj_id = 0

private

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

Referenced by getObjId().

◆ $version

ilExportFileInfo::$version = self::CURRENT_VERSION

private

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

Referenced by getVersion().

◆ CURRENT_VERSION

const ilExportFileInfo::CURRENT_VERSION = "4.1.0"

Definition at line 15 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

Data Fields

Protected Member Functions

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

◆ $export_type

◆ $file_name

◆ $obj_id

◆ $version

◆ CURRENT_VERSION