This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilMediaPoolItem:

Public Member Functions
	__construct (int $a_id=0)

	setId (int $a_val)

	getId ()

	setType (string $a_val)

	getType ()

	setForeignId (int $a_val)
	Set foreign id (mob id) More...

	getForeignId ()

	setImportId (string $a_val)

	getImportId ()

	setTitle (string $a_val)

	getTitle ()

	create ()

	read ()

	update ()

	delete ()

Static Public Member Functions
static	lookupForeignId (int $a_id)

static	lookupType (int $a_id)

static	lookupTitle (int $a_id)

static	updateObjectTitle (int $a_obj)

static	getPoolForItemId (int $a_id)

static	getIdsForType (int $a_id, string $a_type)
	Get all ids for type. More...

Protected Attributes
string	$title = ""

int	$foreign_id = 0

string	$type = ""

int	$id = 0

ilDBInterface	$db

string	$import_id = ""

Static Private Member Functions
static	lookup (int $a_id, string $a_field)

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Media Pool Item

Author: Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

Definition at line 23 of file class.ilMediaPoolItem.php.

Constructor & Destructor Documentation

◆ __construct()

ilMediaPoolItem::__construct ( int $a_id = 0 )

Parameters

int $a_id media pool item id

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

      {
        global $DIC;
 
        $this->db = $DIC->database();
        if ($a_id > 0) {
            $this->setId($a_id);
            $this->read();
        }
    }

References $DIC, read(), and setId().

Here is the call graph for this function:

Member Function Documentation

◆ create()

ilMediaPoolItem::create ( )

Definition at line 101 of file class.ilMediaPoolItem.php.

                            : void
    {
        $ilDB = $this->db;
 
        $nid = $ilDB->nextId("mep_item");
        $ilDB->manipulate("INSERT INTO mep_item " .
            "(obj_id, type, foreign_id, title, import_id) VALUES (" .
            $ilDB->quote($nid, "integer") . "," .
            $ilDB->quote($this->getType(), "text") . "," .
            $ilDB->quote($this->getForeignId(), "integer") . "," .
            $ilDB->quote($this->getTitle(), "text") . "," .
            $ilDB->quote($this->getImportId(), "text") .
            ")");
        $this->setId($nid);
    }

References $db, $ilDB, and setId().

Here is the call graph for this function:

◆ delete()

ilMediaPoolItem::delete ( )

Definition at line 147 of file class.ilMediaPoolItem.php.

                            : void
    {
        $ilDB = $this->db;
 
        $ilDB->manipulate(
            "DELETE FROM mep_item WHERE "
            . " obj_id = " . $ilDB->quote($this->getId(), "integer")
        );
    }

References $db, and $ilDB.

◆ getForeignId()

ilMediaPoolItem::getForeignId ( )

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

                                  : int
    {
        return $this->foreign_id;
    }

References $foreign_id.

◆ getId()

ilMediaPoolItem::getId ( )

Definition at line 52 of file class.ilMediaPoolItem.php.

                           : int
    {
        return $this->id;
    }

References $id.

◆ getIdsForType()

static ilMediaPoolItem::getIdsForType	(	int	$a_id,
		string	$a_type
	)

static

Get all ids for type.

Parameters

int	$a_id	media pool id
string	$a_type	media item type

Returns: int[]

Definition at line 232 of file class.ilMediaPoolItem.php.

     : array {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        $set = $ilDB->query(
            "SELECT mep_tree.child as id" .
            " FROM mep_tree JOIN mep_item ON (mep_tree.child = mep_item.obj_id) WHERE " .
            " mep_tree.mep_id = " . $ilDB->quote($a_id, "integer") . " AND " .
            " mep_item.type = " . $ilDB->quote($a_type, "text")
        );
 
        $ids = array();
        while ($rec = $ilDB->fetchAssoc($set)) {
            $ids[] = (int) $rec["id"];
        }
        return $ids;
    }

Referenced by ilMepMultiSrt\getMobIds(), and ilMediaPoolExporter\getXmlExportTailDependencies().

Here is the caller graph for this function:

◆ getImportId()

ilMediaPoolItem::getImportId ( )

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

                                 : string
    {
        return $this->import_id;
    }

References $import_id.

◆ getPoolForItemId()

static ilMediaPoolItem::getPoolForItemId ( int $a_id )

static

Returns: int[]

Definition at line 209 of file class.ilMediaPoolItem.php.

                                                      : array
    {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        $set = $ilDB->query(
            "SELECT * FROM mep_tree " .
            " WHERE child = " . $ilDB->quote($a_id, "integer")
        );
        $pool_ids = array();
        while ($rec = $ilDB->fetchAssoc($set)) {
            $pool_ids[] = (int) $rec["mep_id"];
        }
        return $pool_ids;
    }

References $DIC, $ilDB, and ILIAS\Repository\int().

Referenced by ILIAS\MediaPool\MediaPoolManager\copyItemFromEditClipboard(), ilMediaObjectUsagesTableGUI\fillRow(), ilMediaPoolImporter\finalProcessing(), ilMediaPoolDataSet\importRecord(), ILIAS\MediaPool\MediaPoolManager\isTargetWithinSource(), ILIAS\MediaPool\MediaPoolManager\pasteFromClipboard(), and ilPageEditorGUI\showSnippetInfo().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTitle()

ilMediaPoolItem::getTitle ( )

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

                              : string
    {
        return $this->title;
    }

References $title.

◆ getType()

ilMediaPoolItem::getType ( )

Definition at line 62 of file class.ilMediaPoolItem.php.

                             : string
    {
        return $this->type;
    }

References $type.

◆ lookup()

static ilMediaPoolItem::lookup	(	int	$a_id,
		string	$a_field
	)

staticprivate

Definition at line 157 of file class.ilMediaPoolItem.php.

     : ?string {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        $set = $ilDB->query("SELECT " . $a_field . " FROM mep_item WHERE " .
            " obj_id = " . $ilDB->quote($a_id, "integer"));
        if ($rec = $ilDB->fetchAssoc($set)) {
            return $rec[$a_field];
        }
        return null;
    }

◆ lookupForeignId()

static ilMediaPoolItem::lookupForeignId ( int $a_id )

static

Definition at line 173 of file class.ilMediaPoolItem.php.

                                                     : int
    {
        return (int) self::lookup($a_id, "foreign_id");
    }

Referenced by ilObjMediaPoolGUI\copyToClipboard(), ilObjMediaPool\copyTreeContent(), ilPCMediaObjectGUI\create(), ilObjMediaPool\delete(), ilObjMediaPool\deleteChild(), ilObjMediaPoolGUI\executeCommand(), ilMediaCreationGUI\insertFromPool(), ilObjMediaPoolSubItemListGUI\parseImage(), ilPCMediaObjectGUI\selectObjectReference(), and ilInternalLinkGUI\showLinkHelp().

Here is the caller graph for this function:

◆ lookupTitle()

static ilMediaPoolItem::lookupTitle ( int $a_id )

static

Definition at line 183 of file class.ilMediaPoolItem.php.

                                                 : string
    {
        return (string) self::lookup($a_id, "title");
    }

Referenced by ilObjMediaPoolGUI\allMedia(), ilObjMediaPoolGUI\confirmRemove(), ILIAS\MediaPool\MediaPoolManager\copyItemFromEditClipboard(), ilMediaObjectUsagesTableGUI\fillRow(), ilObjMediaPoolGUI\getFolderValues(), ilObjMediaPoolSubItemListGUI\getHTML(), ilMediaPoolPageGUI\getMediaPoolPageValues(), and ilMediaPoolPage\lookupTitle().

Here is the caller graph for this function:

◆ lookupType()

static ilMediaPoolItem::lookupType ( int $a_id )

static

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

                                                : string
    {
        return (string) self::lookup($a_id, "type");
    }

Referenced by ilObjMediaPoolGUI\confirmRemove(), ilObjMediaPoolGUI\copyToClipboard(), ilObjMediaPoolSubItemListGUI\getHTML(), ilObjMediaPoolGUI\paste(), ILIAS\MediaPool\MediaPoolManager\pasteFromClipboard(), and ilObjMediaPoolGUI\returnFromItem().

Here is the caller graph for this function:

◆ read()

ilMediaPoolItem::read ( )

Definition at line 117 of file class.ilMediaPoolItem.php.

                          : void
    {
        $ilDB = $this->db;
 
        $set = $ilDB->query(
            "SELECT * FROM mep_item WHERE " .
            "obj_id = " . $ilDB->quote($this->getId(), "integer")
        );
        if ($rec = $ilDB->fetchAssoc($set)) {
            $this->setType($rec["type"]);
            $this->setForeignId((int) $rec["foreign_id"]);
            $this->setTitle($rec["title"]);
            $this->setImportId((string) $rec["import_id"]);
        }
    }

References $db, $ilDB, setForeignId(), setImportId(), setTitle(), and setType().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setForeignId()

ilMediaPoolItem::setForeignId ( int $a_val )

Set foreign id (mob id)

Parameters

int $a_val foreign id

Definition at line 71 of file class.ilMediaPoolItem.php.

                                            : void
    {
        $this->foreign_id = $a_val;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setId()

ilMediaPoolItem::setId ( int $a_val )

Definition at line 47 of file class.ilMediaPoolItem.php.

                                     : void
    {
        $this->id = $a_val;
    }

Referenced by __construct(), and create().

Here is the caller graph for this function:

◆ setImportId()

ilMediaPoolItem::setImportId ( string $a_val )

Definition at line 81 of file class.ilMediaPoolItem.php.

                                              : void
    {
        $this->import_id = $a_val;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setTitle()

ilMediaPoolItem::setTitle ( string $a_val )

Definition at line 91 of file class.ilMediaPoolItem.php.

                                           : void
    {
        $this->title = $a_val;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setType()

ilMediaPoolItem::setType ( string $a_val )

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

                                          : void
    {
        $this->type = $a_val;
    }

Referenced by read().

Here is the caller graph for this function:

◆ update()

ilMediaPoolItem::update ( )

Definition at line 133 of file class.ilMediaPoolItem.php.

                            : void
    {
        $ilDB = $this->db;
 
        $ilDB->manipulate(
            "UPDATE mep_item SET " .
            " type = " . $ilDB->quote($this->getType(), "text") . "," .
            " foreign_id = " . $ilDB->quote($this->getForeignId(), "integer") . "," .
            " title = " . $ilDB->quote($this->getTitle(), "text") . "," .
            " import_id = " . $ilDB->quote($this->getImportId(), "text") .
            " WHERE obj_id = " . $ilDB->quote($this->getId(), "integer")
        );
    }

References $db, and $ilDB.

◆ updateObjectTitle()

static ilMediaPoolItem::updateObjectTitle ( int $a_obj )

static

Definition at line 189 of file class.ilMediaPoolItem.php.

                                                        : void
    {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        if (ilObject::_lookupType($a_obj) === "mob") {
            $title = ilObject::_lookupTitle($a_obj);
            $ilDB->manipulate(
                "UPDATE mep_item SET " .
                " title = " . $ilDB->quote($title, "text") .
                " WHERE foreign_id = " . $ilDB->quote($a_obj, "integer") .
                " AND type = " . $ilDB->quote("mob", "text")
            );
        }
    }

References $DIC, $ilDB, ilObject\_lookupTitle(), and ilObject\_lookupType().

Referenced by ilMediaPoolAppEventListener\handleEvent().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $db

ilDBInterface ilMediaPoolItem::$db

protected

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

Referenced by create(), delete(), read(), and update().

◆ $foreign_id

int ilMediaPoolItem::$foreign_id = 0

protected

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

Referenced by getForeignId().

◆ $id

int ilMediaPoolItem::$id = 0

protected

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

Referenced by getId().

◆ $import_id

string ilMediaPoolItem::$import_id = ""

protected

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

Referenced by getImportId().

◆ $title

string ilMediaPoolItem::$title = ""

protected

Definition at line 25 of file class.ilMediaPoolItem.php.

Referenced by getTitle().

◆ $type

string ilMediaPoolItem::$type = ""

protected

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

Referenced by getType().

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

components/ILIAS/MediaPool/classes/class.ilMediaPoolItem.php

Public Member Functions

Static Public Member Functions

Protected Attributes

Static Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ create()

◆ delete()

◆ getForeignId()

◆ getId()

◆ getIdsForType()

◆ getImportId()

◆ getPoolForItemId()

◆ getTitle()

◆ getType()

◆ lookup()

◆ lookupForeignId()

◆ lookupTitle()

◆ lookupType()

◆ read()

◆ setForeignId()

◆ setId()

◆ setImportId()

◆ setTitle()

◆ setType()

◆ update()

◆ updateObjectTitle()

Field Documentation

◆ $db

◆ $foreign_id

◆ $id

◆ $import_id

◆ $title

◆ $type