Storage of ECS exported objects. More...

Collaboration diagram for ilECSExport:

Public Member Functions
	__construct ($a_server_id, $a_obj_id)
	Constructor. More...

	getServerId ()
	Get server id. More...

	setServerId ($a_server_id)
	Set server id. More...

	setExported ($a_status)
	Set exported. More...

	isExported ()
	check if an object is exported or not More...

	setEContentId ($a_id)
	set econtent id More...

	getEContentId ()
	get econtent id More...

	save ()
	Save. More...

Static Public Member Functions
static	_isExported ($a_obj_id)
	Check if object is exported. More...

static	_getAllEContentIds ($a_server_id)
	get all exported econtent ids per server More...

static	getExportedIds ()
	Get exported ids ilDB $ilDB. More...

static	getExportedIdsByType ($a_type)
	Get exported ids by type ilDB $ilDB. More...

static	getExportServerIds ($a_obj_id)
	lookup server ids of exported materials ilDB $ilDB More...

static	_getExportedIDsByServer ($a_server_id)
	get exported ids for server More...

static	lookupServerIds ($a_obj_id)
	Lookup server ids of exported objects ilDB $ilDB. More...

static	_deleteEContentIds ($a_server_id, $a_ids)
	Delete econtent ids for server. More...

static	deleteByServer ($a_server_id)
	Delete by server id ilDB $ilDB. More...

static	_isRemote ($a_server_id, $a_econtent_id)
	is remote object More...

static	deleteByServerId ($a_server_id)

Protected Attributes
	$db = null

	$server_id = 0

	$obj_id = 0

	$econtent_id = 0

	$exported = false

Private Member Functions
	read ()
	Read private. More...

Detailed Description

Storage of ECS exported objects.

This class stores the econent id and informations whether an object is exported or not.

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

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilECSExport::__construct	(	$a_server_id,
		$a_obj_id
	)

Constructor.

public

Parameters

Definition at line 50 of file class.ilECSExport.php.

References $ilDB, and read().

     {
         global $ilDB;
 
         $this->server_id = $a_server_id;
         $this->obj_id = $a_obj_id;
         
         $this->db = $ilDB;
         $this->read();
     }

Here is the call graph for this function:

Member Function Documentation

◆ _deleteEContentIds()

static ilECSExport::_deleteEContentIds	(	$a_server_id,
		$a_ids
	)

static

Delete econtent ids for server.

public

Parameters

array array of econtent ids

Definition at line 221 of file class.ilECSExport.php.

References $ilDB, $query, and $res.

Referenced by ilECSEventQueueReader\handleExportReset().

     {
         global $ilDB;
         
         if (!is_array($a_ids) or !count($a_ids)) {
             return true;
         }
         #$query = "DELETE FROM ecs_export WHERE econtent_id IN (".implode(',',ilUtil::quoteArray($a_ids)).')';
         $query = "DELETE FROM ecs_export WHERE " . $ilDB->in('econtent_id', $a_ids, false, 'integer') . ' ' .
             'AND server_id = ' . $ilDB->quote($a_server_id, 'integer');
         $res = $ilDB->manipulate($query);
         return true;
     }

Here is the caller graph for this function:

◆ _getAllEContentIds()

static ilECSExport::_getAllEContentIds ( $a_server_id )

static

get all exported econtent ids per server

public

Definition at line 105 of file class.ilECSExport.php.

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

Referenced by ilECSEventQueueReader\handleExportReset().

     {
         global $ilDB;
         
         $query = "SELECT econtent_id,obj_id FROM ecs_export " .
             'WHERE server_id = ' . $ilDB->quote($a_server_id, 'integer');
 
         $res = $ilDB->query($query);
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             $econtent_ids[$row->econtent_id] = $row->obj_id;
         }
         return $econtent_ids ? $econtent_ids : array();
     }

Here is the caller graph for this function:

◆ _getExportedIDsByServer()

static ilECSExport::_getExportedIDsByServer ( $a_server_id )

static

get exported ids for server

public

Returns

Definition at line 181 of file class.ilECSExport.php.

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

     {
         global $ilDB;
         $query = "SELECT obj_id FROM ecs_export " .
             'WHERE server_id = ' . $ilDB->quote($a_server_id, 'integer');
         $res = $ilDB->query($query);
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             $obj_ids[] = $row->obj_id;
         }
         return $obj_ids ? $obj_ids : array();
     }

◆ _isExported()

static ilECSExport::_isExported ( $a_obj_id )

static

Check if object is exported.

Parameters

int $a_obj_id

Returns: bool

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

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

Referenced by ilECSObjectSettings\addSettingsToForm().

     {
         global $ilDB;
 
         $query = 'SELECT * FROM ecs_export ' .
             'WHERE obj_id = ' . $ilDB->quote($a_obj_id, 'integer');
         $res = $ilDB->query($query);
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             return true;
         }
         return false;
     }

Here is the caller graph for this function:

◆ _isRemote()

static ilECSExport::_isRemote	(	$a_server_id,
		$a_econtent_id
	)

static

is remote object

public

Parameters

int	econtent_id

Definition at line 257 of file class.ilECSExport.php.

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

Referenced by ilObjRemoteCategoryListGUI\getCommandFrame(), ilObjRemoteCourseListGUI\getCommandFrame(), ilObjRemoteGlossaryListGUI\getCommandFrame(), ilObjRemoteTestListGUI\getCommandFrame(), ilObjRemoteWikiListGUI\getCommandFrame(), ilObjRemoteGroupListGUI\getCommandFrame(), ilObjRemoteLearningModuleListGUI\getCommandFrame(), ilObjRemoteFileListGUI\getCommandFrame(), and ilRemoteObjectBase\isLocalObject().

     {
         global $ilDB;
         
         $query = "SELECT obj_id FROM ecs_export " .
             "WHERE econtent_id = " . $ilDB->quote($a_econtent_id, 'integer') . " " .
             'AND server_id = ' . $ilDB->quote($a_server_id, 'integer');
         $res = $ilDB->query($query);
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             return false;
         }
         return true;
     }

Here is the caller graph for this function:

◆ deleteByServer()

static ilECSExport::deleteByServer ( $a_server_id )

static

Delete by server id ilDB $ilDB.

Parameters

int $a_server_id

Definition at line 240 of file class.ilECSExport.php.

References $ilDB, and $query.

Referenced by ilECSSettingsGUI\doDelete().

     {
         global $ilDB;
 
         $query = 'DELETE FROM ecs_export ' .
             'WHERE server_id = ' . $ilDB->quote($a_server_id, 'integer');
         $ilDB->manipulate($query);
     }

Here is the caller graph for this function:

◆ deleteByServerId()

static ilECSExport::deleteByServerId ( $a_server_id )

static

Definition at line 363 of file class.ilECSExport.php.

References $ilDB, and $query.

Referenced by ilECSSetting\delete().

     {
         global $ilDB;
 
         $query = 'DELETE FROM ecs_export' .
             ' WHERE server_id = ' . $ilDB->quote($a_server_id, 'integer');
         $ilDB->manipulate($query);
         return true;
     }

Here is the caller graph for this function:

◆ getEContentId()

ilECSExport::getEContentId ( )

get econtent id

public

Returns: int econtent id

Definition at line 313 of file class.ilECSExport.php.

References $econtent_id.

Referenced by ilECSObjectSettings\doDelete(), ilECSObjectSettings\doUpdate(), and save().

     {
         return $this->econtent_id;
     }

Here is the caller graph for this function:

◆ getExportedIds()

static ilECSExport::getExportedIds ( )

static

Get exported ids ilDB $ilDB.

Returns: array

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

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

Referenced by ilECSObjectSettings\_handleDelete(), and ilECSSettingsGUI\exportReleased().

     {
         global $ilDB;
         $query = "SELECT obj_id FROM ecs_export ";
         $res = $ilDB->query($query);
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             $obj_ids[] = $row->obj_id;
         }
         return $obj_ids ? $obj_ids : array();
     }

Here is the caller graph for this function:

◆ getExportedIdsByType()

static ilECSExport::getExportedIdsByType ( $a_type )

static

Get exported ids by type ilDB $ilDB.

Returns: array

Definition at line 140 of file class.ilECSExport.php.

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

Referenced by ilECSSettingsGUI\released().

     {
         global $ilDB;
         $query = "SELECT e.obj_id FROM ecs_export e" .
             " JOIN object_data o ON (e.obj_id = o.obj_id)" .
             " WHERE o.type = " . $ilDB->quote($a_type, "text");
         $res = $ilDB->query($query);
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             $obj_ids[] = $row->obj_id;
         }
         return $obj_ids ? $obj_ids : array();
     }

Here is the caller graph for this function:

◆ getExportServerIds()

static ilECSExport::getExportServerIds ( $a_obj_id )

static

lookup server ids of exported materials ilDB $ilDB

Parameters

int $a_obj_id

Returns: array

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

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

Referenced by ilECSObjectSettings\_handleDelete(), ilECSObjectSettings\addSettingsToForm(), and ilECSObjectSettings\handleContentUpdate().

     {
         global $ilDB;
 
         $query = 'SELECT * FROM ecs_export ' .
             'WHERE obj_id = ' . $ilDB->quote($a_obj_id, 'integer');
         $res = $ilDB->query($query);
 
         $sids = array();
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             $sids[] = $row->server_id;
         }
         return $sids;
     }

Here is the caller graph for this function:

◆ getServerId()

ilECSExport::getServerId ( )

Get server id.

Returns: int

Definition at line 65 of file class.ilECSExport.php.

References $server_id.

Referenced by read(), and save().

     {
         return $this->server_id;
     }

Here is the caller graph for this function:

◆ isExported()

ilECSExport::isExported ( )

check if an object is exported or not

public

Definition at line 289 of file class.ilECSExport.php.

References $exported.

Referenced by ilECSObjectSettings\doDelete(), and save().

     {
         return (bool) $this->exported;
     }

Here is the caller graph for this function:

◆ lookupServerIds()

static ilECSExport::lookupServerIds ( $a_obj_id )

static

Lookup server ids of exported objects ilDB $ilDB.

Parameters

<type> $a_obj_id

Returns: <type>

Definition at line 199 of file class.ilECSExport.php.

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

Referenced by ilECSReleasedContentTableGUI\parse().

     {
         global $ilDB;
 
         $query = 'SELECT * FROM ecs_export ' .
             'WHERE obj_id = ' . $ilDB->quote($a_obj_id, 'integer') . ' ';
         $res = $ilDB->query($query);
         $sids = array();
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             $sids[] = $row->server_id;
         }
         return $sids;
     }

Here is the caller graph for this function:

◆ read()

ilECSExport::read ( )

private

Read private.

Definition at line 349 of file class.ilECSExport.php.

References $ilDB, $query, $res, $row, ilDBConstants\FETCHMODE_OBJECT, and getServerId().

Referenced by __construct().

     {
         global $ilDB;
         
         $query = "SELECT * FROM ecs_export WHERE " .
             "obj_id = " . $this->db->quote($this->obj_id, 'integer') . " AND " .
             'server_id = ' . $ilDB->quote($this->getServerId(), 'integer');
         $res = $this->db->query($query);
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             $this->econtent_id = $row->econtent_id;
             $this->exported = true;
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ save()

ilECSExport::save ( )

Save.

public

Definition at line 323 of file class.ilECSExport.php.

References $ilDB, $query, $res, getEContentId(), getServerId(), and isExported().

Referenced by ilECSObjectSettings\doAdd(), and ilECSObjectSettings\doDelete().

     {
         global $ilDB;
 
         $query = "DELETE FROM ecs_export " .
             "WHERE obj_id = " . $this->db->quote($this->obj_id, 'integer') . " " .
             'AND server_id = ' . $ilDB->quote($this->getServerId());
         $res = $ilDB->manipulate($query);
     
         if ($this->isExported()) {
             $query = "INSERT INTO ecs_export (server_id,obj_id,econtent_id) " .
                 "VALUES ( " .
                 $this->db->quote($this->getServerId(), 'integer') . ', ' .
                 $this->db->quote($this->obj_id, 'integer') . ", " .
                 $this->db->quote($this->getEContentId(), 'integer') . " " .
                 ")";
             $res = $ilDB->manipulate($query);
         }
         
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setEContentId()

ilECSExport::setEContentId ( $a_id )

set econtent id

public

Parameters

int	econtent id (received from ECS::addResource)

Definition at line 301 of file class.ilECSExport.php.

Referenced by ilECSObjectSettings\doAdd().

     {
         $this->econtent_id = $a_id;
     }

Here is the caller graph for this function:

◆ setExported()

ilECSExport::setExported ( $a_status )

Set exported.

public

Parameters

bool	export status

Definition at line 278 of file class.ilECSExport.php.

Referenced by ilECSObjectSettings\doAdd(), and ilECSObjectSettings\doDelete().

     {
         $this->exported = $a_status;
     }

Here is the caller graph for this function:

◆ setServerId()

ilECSExport::setServerId ( $a_server_id )

Set server id.

Parameters

int $a_server_id

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

     {
         $this->server_id = $a_server_id;
     }

Field Documentation

◆ $db

ilECSExport::$db = null

protected

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

◆ $econtent_id

ilECSExport::$econtent_id = 0

protected

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

Referenced by getEContentId().

◆ $exported

ilECSExport::$exported = false

protected

Definition at line 41 of file class.ilECSExport.php.

Referenced by isExported().

◆ $obj_id

ilECSExport::$obj_id = 0

protected

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

◆ $server_id

ilECSExport::$server_id = 0

protected

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

Referenced by getServerId().

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

Services/WebServices/ECS/classes/class.ilECSExport.php

Public Member Functions

Static Public Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _deleteEContentIds()

◆ _getAllEContentIds()

◆ _getExportedIDsByServer()

◆ _isExported()

◆ _isRemote()

◆ deleteByServer()

◆ deleteByServerId()

◆ getEContentId()

◆ getExportedIds()

◆ getExportedIdsByType()

◆ getExportServerIds()

◆ getServerId()

◆ isExported()

◆ lookupServerIds()

◆ read()

◆ save()

◆ setEContentId()

◆ setExported()

◆ setServerId()

Field Documentation

◆ $db

◆ $econtent_id

◆ $exported

◆ $obj_id

◆ $server_id