ilECSExport Class Reference

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 27 of file class.ilECSExport.php.

Constructor & Destructor Documentation

__construct()

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

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

References $DIC, and read().

    {
        global $DIC;

        $this->server_id = $a_server_id;
        $this->obj_id = $a_obj_id;

        $this->db = $DIC->database();
        $this->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 97 of file class.ilECSExport.php.

References $econtent_id.

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

                                   : int
    {
        return $this->econtent_id;
    }

Here is the caller graph for this function:

getServerId()

ilECSExport::getServerId

(

)

Get server id.

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

References $server_id.

Referenced by read(), and save().

                                 : int
    {
        return $this->server_id;
    }

Here is the caller graph for this function:

isExported()

ilECSExport::isExported

(

)

check if an object is exported or not

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

References $exported.

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

                                : bool
    {
        return $this->exported;
    }

Here is the caller graph for this function:

read()

ilECSExport::read ( )

private

Read.

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

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

Referenced by __construct().

                           : 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;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

save()

ilECSExport::save

(

)

Save.

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

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

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

                          : 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;
    }

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 87 of file class.ilECSExport.php.

Referenced by ilECSObjectSettings\doAdd().

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

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 69 of file class.ilECSExport.php.

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

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

Here is the caller graph for this function:

setServerId()

ilECSExport::setServerId

(

int

$a_server_id

)

Set server id.

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

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

Field Documentation

$db

ilDBInterface ilECSExport::$db

protected

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

$econtent_id

int ilECSExport::$econtent_id = 0

protected

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

Referenced by getEContentId().

$exported

bool ilECSExport::$exported = false

protected

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

Referenced by isExported().

$obj_id

int ilECSExport::$obj_id = 0

protected

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

$server_id

int ilECSExport::$server_id = 0

protected

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

Referenced by getServerId().

---

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

• components/ILIAS/WebServices/ECS/classes/class.ilECSExport.php