Storage of an ECS exported object. More...

Collaboration diagram for ilECSExport:

Public Member Functions
	__construct (int $a_server_id, int $a_obj_id)

	getServerId ()
	Get server id. More...

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

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

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

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

	getEContentId ()
	get econtent id More...

	save ()
	Save. More...

Protected Attributes
ilDBInterface	$db

int	$server_id = 0

int	$obj_id = 0

int	$econtent_id = 0

bool	$exported = false

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

Detailed Description

Storage of an ECS exported object.

This class stores the econtent 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

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

Constructor & Destructor Documentation

◆ __construct()

ilECSExport::__construct	(	int	$a_server_id,
		int	$a_obj_id
	)

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

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

References $DIC, and read().

Here is the call graph for this function:

Member Function Documentation

◆ getEContentId()

ilECSExport::getEContentId ( )

get econtent id

Returns: int econtent id

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

                                   : int
    {
        return $this->econtent_id;
    }

References $econtent_id.

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

Here is the caller graph for this function:

◆ getServerId()

ilECSExport::getServerId ( )

Get server id.

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

                                 : int
    {
        return $this->server_id;
    }

References $server_id.

Referenced by read(), and save().

Here is the caller graph for this function:

◆ isExported()

ilECSExport::isExported ( )

check if an object is exported or not

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

                                : bool
    {
        return $this->exported;
    }

References $exported.

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

Here is the caller graph for this function:

◆ read()

ilECSExport::read ( )

private

Read.

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

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

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

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ save()

ilECSExport::save ( )

Save.

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

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setEContentId()

ilECSExport::setEContentId ( int $a_id )

set econtent id

Parameters

int $a_id econtent id (received from ECS::addResource)

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

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

Referenced by ilECSObjectSettings\doAdd().

Here is the caller graph for this function:

◆ setExported()

ilECSExport::setExported ( bool $a_status )

Set exported.

Parameters

bool $a_status export status

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

                                               : void
    {
        $this->exported = $a_status;
    }

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

Here is the caller graph for this function:

◆ setServerId()

ilECSExport::setServerId ( int $a_server_id )

Set server id.

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

                                                 : void
    {
        $this->server_id = $a_server_id;
    }

Field Documentation

◆ $db

ilDBInterface ilECSExport::$db

protected

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

◆ $econtent_id

int ilECSExport::$econtent_id = 0

protected

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

Referenced by getEContentId().

◆ $exported

bool ilECSExport::$exported = false

protected

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

Referenced by isExported().

◆ $obj_id

int ilECSExport::$obj_id = 0

protected

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

◆ $server_id

int ilECSExport::$server_id = 0

protected

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

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getEContentId()

◆ getServerId()

◆ isExported()

◆ read()

◆ save()

◆ setEContentId()

◆ setExported()

◆ setServerId()

Field Documentation

◆ $db

◆ $econtent_id

◆ $exported

◆ $obj_id

◆ $server_id