Manage the ECS imported contents. More...

Collaboration diagram for ilECSImportManager:

Public Member Functions
	lookupContentId ($a_server_id, $a_mid, $a_econtent_id)
	Lookup content id The content is the - not necessarily unique - id provided by the econtent type. More...

	lookupObjIdByContentId (int $a_server_id, int $a_mid, int $a_content_id, ?string $a_sub_id=null)
	Lookup obj_id by content id. More...

	lookupObjIdsByContentId ($a_content_id)

	lookupEContentIdByContentId ($a_server_id, $a_mid, $a_content_id)
	Lookup econtent id The econtent id is the unique id from ecs. More...

	getAllImportedRemoteObjects ($a_server_id)
	get all imported links More...

	_lookupObjIdsByMID ($a_server_id, $a_mid)
	lookup obj ids by mid More...

	_lookupEContentId (int $a_obj_id)
	get econent_id More...

	lookupServerId (int $a_obj_id)
	Lookup server id of imported content. More...

	_lookupObjIds ($a_server_id, $a_econtent_id)
	Lookup obj_id. More...

	_lookupObjId (int $a_server_id, string $a_econtent_id, int $a_mid, ?string $a_sub_id=null)
	loogup obj_id by econtent and mid and server_id More...

	_deleteByObjId ($a_obj_id)
	Delete by obj_id. More...

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

	deleteRessources (int $a_server_id, int $a_mid, array $a_econtent_ids)
	Delete ressources. More...

	_isImported (int $a_server_id, string $a_econtent_id, int $a_mid, ?string $a_sub_id=null)
	check if econtent is imported for a specific mid More...

	resetServerId ($a_server_id)

Static Public Member Functions
static	getInstance ()
	Get the singleton instance of this ilECSImportManager. More...

Protected Attributes
ilDBInterface	$db

Private Member Functions
	__construct ()

Static Private Attributes
static ilECSImportManager	$instance

Detailed Description

Manage the ECS imported contents.

This class contains mainly helper functions to work with imported 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.ilECSImportManager.php.

Constructor & Destructor Documentation

◆ __construct()

ilECSImportManager::__construct ( )

private

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

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

References $DIC.

Member Function Documentation

◆ _deleteByObjId()

ilECSImportManager::_deleteByObjId ( $a_obj_id )

Delete by obj_id.

Parameters

int obj_id

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

                                             : bool
    {
        $query = "DELETE FROM ecs_import " .
            "WHERE obj_id = " . $this->db->quote($a_obj_id, 'integer') . " ";
        $this->db->manipulate($query);
        return true;
    }

◆ _isImported()

ilECSImportManager::_isImported	(	int	$a_server_id,
		string	$a_econtent_id,
		int	$a_mid,
		?string	$a_sub_id = `null`
	)

check if econtent is imported for a specific mid

Definition at line 269 of file class.ilECSImportManager.php.

                                                                                                              : int
    {
        return $this->_lookupObjId($a_server_id, $a_econtent_id, $a_mid, $a_sub_id);
    }

References _lookupObjId().

Here is the call graph for this function:

◆ _lookupEContentId()

ilECSImportManager::_lookupEContentId ( int $a_obj_id )

get econent_id

Definition at line 166 of file class.ilECSImportManager.php.

                                                    : string
    {
        $query = "SELECT * FROM ecs_import WHERE obj_id = " . $this->db->quote($a_obj_id, 'integer') . " ";
        $res = $this->db->query($query);
        if ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            return $row->econtent_id;
        }
        return "";
    }

References $res, and ilDBConstants\FETCHMODE_OBJECT.

◆ _lookupObjId()

ilECSImportManager::_lookupObjId	(	int	$a_server_id,
		string	$a_econtent_id,
		int	$a_mid,
		?string	$a_sub_id = `null`
	)

loogup obj_id by econtent and mid and server_id

Definition at line 208 of file class.ilECSImportManager.php.

                                                                                                               : int
    {
        $query = "SELECT obj_id FROM ecs_import " .
            "WHERE econtent_id = " . $this->db->quote($a_econtent_id, 'text') . " " .
            "AND mid = " . $this->db->quote($a_mid, 'integer') . " " .
            'AND server_id = ' . $this->db->quote($a_server_id, 'integer') . ' ';
 
        if (!is_null($a_sub_id)) {
            $query .= 'AND sub_id = ' . $this->db->quote($a_sub_id, 'text');
        } else {
            $query .= 'AND sub_id IS NULL';
        }
        $res = $this->db->query($query);
 
        if ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            return (int) $row->obj_id;
        }
        return 0;
    }

References $res, and ilDBConstants\FETCHMODE_OBJECT.

Referenced by _isImported().

Here is the caller graph for this function:

◆ _lookupObjIds()

ilECSImportManager::_lookupObjIds	(	$a_server_id,
		$a_econtent_id
	)

Lookup obj_id.

Definition at line 193 of file class.ilECSImportManager.php.

                                                               : array
    {
        $query = "SELECT obj_id FROM ecs_import WHERE econtent_id  = " . $this->db->quote($a_econtent_id, 'text') . " " .
            'AND 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[] = (int) $row->obj_id;
        }
        return $obj_ids;
    }

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

Here is the call graph for this function:

◆ _lookupObjIdsByMID()

ilECSImportManager::_lookupObjIdsByMID	(	$a_server_id,
		$a_mid
	)

lookup obj ids by mid

Parameters

int mid

Returns: array int

Definition at line 149 of file class.ilECSImportManager.php.

                                                            : array
    {
        $query = "SELECT * FROM ecs_import " .
            "WHERE mid = " . $this->db->quote($a_mid, 'integer') . " " .
            'AND 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.

◆ deleteByServer()

ilECSImportManager::deleteByServer ( int $a_server_id )

Delete by server id.

Definition at line 244 of file class.ilECSImportManager.php.

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

◆ deleteRessources()

ilECSImportManager::deleteRessources	(	int	$a_server_id,
		int	$a_mid,
		array	$a_econtent_ids
	)

Delete ressources.

Parameters

string[] $a_econtent_ids

Definition at line 256 of file class.ilECSImportManager.php.

                                                                                         : bool
    {
        $query = 'DELETE FROM ecs_import ' .
                'WHERE server_id = ' . $this->db->quote($a_server_id, 'integer') . ' ' .
                'AND mid = ' . $this->db->quote($a_mid, 'integer') . ' ' .
                'AND ' . $this->db->in('econtent_id', $a_econtent_ids, false, 'text');
        $this->db->manipulate($query);
        return true;
    }

◆ getAllImportedRemoteObjects()

ilECSImportManager::getAllImportedRemoteObjects ( $a_server_id )

get all imported links

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

                                                             : array
    {
        $all = array();
        $query = "SELECT * FROM ecs_import ei JOIN object_data obd ON ei.obj_id = obd.obj_id " .
            'WHERE server_id = ' . $this->db->quote($a_server_id) . ' ' .
            'AND ' . $this->db->in('type', ilECSUtils::getPossibleRemoteTypes(), false, 'text');
        $res = $this->db->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $all[$row->econtent_id] = $row->obj_id;
        }
 
        return $all;
    }

References $res, ilDBConstants\FETCHMODE_OBJECT, and ilECSUtils\getPossibleRemoteTypes().

Here is the call graph for this function:

◆ getInstance()

static ilECSImportManager::getInstance ( )

static

Get the singleton instance of this ilECSImportManager.

Returns: ilECSImportManager

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

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

References $instance.

Referenced by ilECSUserConsentModalGUI\__construct(), ilRemoteObjectBase\createAuthResource(), ilECSMappingSettingsGUI\dDeleteTree(), ilObject\delete(), ilECSSetting\delete(), ilRemoteObjectBase\doDelete(), ilECSCmsCourseMemberCommandQueueHandler\doUpdate(), ilECSEnrolmentStatusCommandQueueHandler\doUpdate(), ilObjRemoteCategoryListGUI\getCommandFrame(), ilObjRemoteCourseListGUI\getCommandFrame(), ilObjRemoteFileListGUI\getCommandFrame(), ilObjRemoteGlossaryListGUI\getCommandFrame(), ilObjRemoteGroupListGUI\getCommandFrame(), ilObjRemoteLearningModuleListGUI\getCommandFrame(), ilObjRemoteTestListGUI\getCommandFrame(), ilObjRemoteWikiListGUI\getCommandFrame(), ilRemoteObjectBase\getFullRemoteLink(), ilECSCourseCreationHandler\getImportId(), ilRemoteObjectBase\handleDelete(), ilECSEventQueueReader\handleImportReset(), ilECSCmsTreeSynchronizer\handleTreeUpdate(), ilRemoteObjectBase\handleUpdate(), ilECSUserConsentModalGUI\initMidAndServer(), ilECSAppEventListener\initServer(), ilRemoteObjectBase\isLocalObject(), ilECSImportedContentTableGUI\parse(), ilECSCmsCourseMemberCommandQueueHandler\readCourse(), and ilECSCmsTreeSynchronizer\syncCategory().

Here is the caller graph for this function:

◆ lookupContentId()

ilECSImportManager::lookupContentId	(	$a_server_id,
		$a_mid,
		$a_econtent_id
	)

Lookup content id The content is the - not necessarily unique - id provided by the econtent type.

The econtent id is the unique id from ecs

Returns: string content id

Definition at line 57 of file class.ilECSImportManager.php.

                                                                         : string
    {
        $query = 'SELECT * from ecs_import ' .
                'WHERE server_id = ' . $this->db->quote($a_server_id, 'integer') . ' ' .
                'AND mid = ' . $this->db->quote($a_mid, 'integer') . ' ' .
                'AND econtent_id = ' . $this->db->quote($a_econtent_id, 'text');
        $res = $this->db->query($query);
        if ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            return $row->content_id;
        }
        return '';
    }

References $res, and ilDBConstants\FETCHMODE_OBJECT.

◆ lookupEContentIdByContentId()

ilECSImportManager::lookupEContentIdByContentId	(	$a_server_id,
		$a_mid,
		$a_content_id
	)

Lookup econtent id The econtent id is the unique id from ecs.

Returns: int content id

Definition at line 112 of file class.ilECSImportManager.php.

                                                                                    : int
    {
        $query = 'SELECT * from ecs_import ' .
                'WHERE server_id = ' . $this->db->quote($a_server_id, 'integer') . ' ' .
                'AND mid = ' . $this->db->quote($a_mid, 'integer') . ' ' .
                'AND content_id = ' . $this->db->quote($a_content_id, 'text');
        $res = $this->db->query($query);
        if ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            return (int) $row->econtent_id;
        }
        return 0;
    }

References $res, and ilDBConstants\FETCHMODE_OBJECT.

◆ lookupObjIdByContentId()

ilECSImportManager::lookupObjIdByContentId	(	int	$a_server_id,
		int	$a_mid,
		int	$a_content_id,
		?string	$a_sub_id = `null`
	)

Lookup obj_id by content id.

Definition at line 73 of file class.ilECSImportManager.php.

                                                                                                                     : int
    {
        $query = "SELECT obj_id FROM ecs_import " .
            "WHERE content_id = " . $this->db->quote($a_content_id, 'integer') . " " .
            "&& mid = " . $this->db->quote($a_mid, 'integer') . " " .
            '&& server_id = ' . $this->db->quote($a_server_id, 'integer') . ' ';
 
        if (!is_null($a_sub_id)) {
            $query .= 'AND sub_id = ' . $this->db->quote($a_sub_id, 'text');
        } else {
            $query .= 'AND sub_id IS NULL';
        }
        $res = $this->db->query($query);
 
        if ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            return (int) $row->obj_id;
        }
        return 0;
    }

References $res, and ilDBConstants\FETCHMODE_OBJECT.

◆ lookupObjIdsByContentId()

ilECSImportManager::lookupObjIdsByContentId ( $a_content_id )

Definition at line 93 of file class.ilECSImportManager.php.

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

References $res, and ilDBConstants\FETCHMODE_OBJECT.

◆ lookupServerId()

ilECSImportManager::lookupServerId ( int $a_obj_id )

Lookup server id of imported content.

Definition at line 179 of file class.ilECSImportManager.php.

                                                 : int
    {
        $query = 'SELECT * FROM ecs_import WHERE obj_id = ' . $this->db->quote($a_obj_id, 'integer');
        $res = $this->db->query($query);
        if ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            return (int) $row->server_id;
        }
        return 0;
    }

References $res, and ilDBConstants\FETCHMODE_OBJECT.

◆ resetServerId()

ilECSImportManager::resetServerId ( $a_server_id )

Definition at line 274 of file class.ilECSImportManager.php.

                                               : bool
    {
        $query = 'UPDATE ecs_import SET server_id = ' . $this->db->quote(0, 'integer') .
            ' WHERE server_id = ' . $this->db->quote($a_server_id, 'integer');
        $this->db->manipulate($query);
        return true;
    }

Field Documentation

◆ $db

ilDBInterface ilECSImportManager::$db

protected

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

◆ $instance

ilECSImportManager ilECSImportManager::$instance

staticprivate

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

Referenced by getInstance().

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

components/ILIAS/WebServices/ECS/classes/class.ilECSImportManager.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

◆ _deleteByObjId()

◆ _isImported()

◆ _lookupEContentId()

◆ _lookupObjId()

◆ _lookupObjIds()

◆ _lookupObjIdsByMID()

◆ deleteByServer()

◆ deleteRessources()

◆ getAllImportedRemoteObjects()

◆ getInstance()

◆ lookupContentId()

◆ lookupEContentIdByContentId()

◆ lookupObjIdByContentId()

◆ lookupObjIdsByContentId()

◆ lookupServerId()

◆ resetServerId()

Field Documentation

◆ $db

◆ $instance