Manage the ECS exported contents. More...

Collaboration diagram for ilECSExportManager:

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

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

	getExportedIds ()
	Get exported ids. More...

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

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

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

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

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

	deleteByServer (int $a_server_id)
	Delete by server id. More...

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

Static Public Member Functions
static	getInstance ()
	Get the singelton instance of this ilECSExportManager. More...

Protected Attributes
ilDBInterface	$db

Private Member Functions
	__construct ()

Static Private Attributes
static ilECSExportManager	$instance

Detailed Description

Manage the ECS exported contents.

This class contains mainly helper functions to work with exported objects.

Author: Per Pascal Seelandpasca.nosp@m.l.se.nosp@m.eland.nosp@m.@tik.nosp@m..uni-.nosp@m.stut.nosp@m.tgart.nosp@m..de

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

Constructor & Destructor Documentation

◆ __construct()

ilECSExportManager::__construct ( )

private

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

    {
        global $DIC;
 
        $this->db = $DIC->database();
    }

References $DIC.

Member Function Documentation

◆ _deleteEContentIds()

ilECSExportManager::_deleteEContentIds	(	int	$a_server_id,
		array	$a_ids
	)

Delete econtent ids for server.

Parameters

int	$a_server_id	id of the server
int[]	$a_ids	array of econtent ids

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

                                                                      : bool
    {
        if (!is_array($a_ids) || !count($a_ids)) {
            return true;
        }
        $query = "DELETE FROM ecs_export WHERE " . $this->db->in('econtent_id', $a_ids, false, 'integer') . ' ' .
            'AND server_id = ' . $this->db->quote($a_server_id, 'integer');
        $this->db->manipulate($query);
        return true;
    }

◆ _getAllEContentIds()

ilECSExportManager::_getAllEContentIds ( int $a_server_id )

get all exported econtent ids per server

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

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

References $res, and ilDBConstants\FETCHMODE_OBJECT.

◆ _getExportedIDsByServer()

ilECSExportManager::_getExportedIDsByServer ( int $a_server_id )

get exported ids for server

Definition at line 131 of file class.ilECSExportManager.php.

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

References $res, and ilDBConstants\FETCHMODE_OBJECT.

◆ _isExported()

ilECSExportManager::_isExported ( int $a_obj_id )

Check if object is exported.

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

                                              : bool
    {
        $query = 'SELECT * FROM ecs_export ' .
            'WHERE obj_id = ' . $this->db->quote($a_obj_id, 'integer');
        $res = $this->db->query($query);
        if ($res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            return true;
        }
        return false;
    }

References $res, and ilDBConstants\FETCHMODE_OBJECT.

◆ _isRemote()

ilECSExportManager::_isRemote	(	int	$a_server_id,
		int	$a_econtent_id
	)

is remote object

Definition at line 188 of file class.ilECSExportManager.php.

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

References $res, and ilDBConstants\FETCHMODE_OBJECT.

◆ deleteByServer()

ilECSExportManager::deleteByServer ( int $a_server_id )

Delete by server id.

Definition at line 178 of file class.ilECSExportManager.php.

                                                    : void
    {
        $query = 'DELETE FROM ecs_export ' .
            'WHERE server_id = ' . $this->db->quote($a_server_id, 'integer');
        $this->db->manipulate($query);
    }

◆ getExportedIds()

ilECSExportManager::getExportedIds ( )

Get exported ids.

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

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

References $res, ilDBConstants\FETCHMODE_OBJECT, and ILIAS\Repository\int().

Here is the call graph for this function:

◆ getExportedIdsByType()

ilECSExportManager::getExportedIdsByType ( string $a_type )

Get exported ids by type.

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

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

References $res, ilDBConstants\FETCHMODE_OBJECT, and ILIAS\Repository\int().

Here is the call graph for this function:

◆ getExportServerIds()

ilECSExportManager::getExportServerIds ( int $a_obj_id )

lookup server ids of exported materials

Definition at line 115 of file class.ilECSExportManager.php.

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

References $res, ilDBConstants\FETCHMODE_OBJECT, and ILIAS\Repository\int().

Here is the call graph for this function:

◆ getInstance()

static ilECSExportManager::getInstance ( )

static

Get the singelton instance of this ilECSExportManager.

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

                                        : ilECSExportManager
    {
        if (!isset(self::$instance)) {
            self::$instance = new ilECSExportManager();
        }
        return self::$instance;
    }

References $instance.

Referenced by ilECSUserConsentModalGUI\__construct(), ilECSObjectSettings\_handleDelete(), ilECSObjectSettings\addSettingsToForm(), ilECSSetting\delete(), ilECSSettingsGUI\exportReleased(), ilObjRemoteCategoryListGUI\getCommandFrame(), ilObjRemoteCourseListGUI\getCommandFrame(), ilObjRemoteFileListGUI\getCommandFrame(), ilObjRemoteGlossaryListGUI\getCommandFrame(), ilObjRemoteGroupListGUI\getCommandFrame(), ilObjRemoteLearningModuleListGUI\getCommandFrame(), ilObjRemoteTestListGUI\getCommandFrame(), ilObjRemoteWikiListGUI\getCommandFrame(), ilECSObjectSettings\handleContentUpdate(), ilECSEventQueueReader\handleExportReset(), ilRemoteObjectBase\isLocalObject(), ilECSExportedContentTableGUI\parse(), and ilECSSettingsGUI\released().

Here is the caller graph for this function:

◆ lookupServerIds()

ilECSExportManager::lookupServerIds ( int $a_obj_id )

Lookup server ids of exported objects.

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

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

References $res, ilDBConstants\FETCHMODE_OBJECT, and ILIAS\Repository\int().

Here is the call graph for this function:

Field Documentation

◆ $db

ilDBInterface ilECSExportManager::$db

protected

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

◆ $instance

ilECSExportManager ilECSExportManager::$instance

staticprivate

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

Referenced by getInstance().

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

components/ILIAS/WebServices/ECS/classes/class.ilECSExportManager.php

Public Member Functions

Static Public Member Functions

Protected Attributes

Private Member Functions

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _deleteEContentIds()

◆ _getAllEContentIds()

◆ _getExportedIDsByServer()

◆ _isExported()

◆ _isRemote()

◆ deleteByServer()

◆ getExportedIds()

◆ getExportedIdsByType()

◆ getExportServerIds()

◆ getInstance()

◆ lookupServerIds()

Field Documentation

◆ $db

◆ $instance