ilMediaPoolItem Class Reference

Media Pool Item. More...

Collaboration diagram for ilMediaPoolItem:

Public Member Functions
	__construct ($a_id=0)
	Construtor. More...
	setId ($a_val)
	Set id. More...
	getId ()
	Get id. More...
	setType ($a_val)
	Set type. More...
	getType ()
	Get type. More...
	setForeignId ($a_val)
	Set foreign id. More...
	getForeignId ()
	Get foreign id. More...
	setImportId ($a_val)
	Set import id. More...
	getImportId ()
	Get import id. More...
	setTitle ($a_val)
	Set title. More...
	getTitle ()
	Get title. More...
	create ()
	Create. More...
	read ()
	Read. More...
	update ()
	Update. More...
	delete ()
	Delete. More...

Static Public Member Functions
static	lookupForeignId ($a_id)
	Lookup Foreign Id. More...
static	lookupType ($a_id)
	Lookup type. More...
static	lookupTitle ($a_id)
	Lookup title. More...
static	updateObjectTitle ($a_obj)
	Update object title. More...
static	getPoolForItemId ($a_id)
	Get media pools for item id. More...
static	getIdsForType ($a_id, $a_type)
	Get all ids for type. More...

Protected Attributes
	$db
	$import_id

Static Private Member Functions
static	lookup ($a_id, $a_field)
	Lookup. More...

Detailed Description

Media Pool Item.

Author

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

ilMediaPoolItem::__construct

(

$a_id = 0

)

Construtor.

Parameters

int	media pool item id

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

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

    {
        global $DIC;

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

Here is the call graph for this function:

Member Function Documentation

create()

ilMediaPoolItem::create

(

)

Create.

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

References $db, $ilDB, getForeignId(), getImportId(), getTitle(), getType(), and setId().

    {
        $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);
    }

Here is the call graph for this function:

delete()

ilMediaPoolItem::delete

(

)

Delete.

Parameters

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

References $db, and $ilDB.

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

getForeignId()

ilMediaPoolItem::getForeignId

(

)

Get foreign id.

Returns

int foreign id

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

Referenced by create().

    {
        return $this->foreign_id;
    }

Here is the caller graph for this function:

getId()

ilMediaPoolItem::getId

(

)

Get id.

Returns

int id

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

References $id.

    {
        return $this->id;
    }

getIdsForType()

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

static

Get all ids for type.

Parameters

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

References $a_type, $DIC, $ilDB, and array.

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

    {
        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[] = $rec["id"];
        }
        return $ids;
    }

Here is the caller graph for this function:

getImportId()

ilMediaPoolItem::getImportId

(

)

Get import id.

Returns

string import id

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

References $import_id.

Referenced by create().

    {
        return $this->import_id;
    }

Here is the caller graph for this function:

getPoolForItemId()

static ilMediaPoolItem::getPoolForItemId (   $a_id )

static

Get media pools for item id.

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

References $DIC, $ilDB, and array.

Referenced by ilMediaPoolImporter\finalProcessing(), ilMediaPoolDataSet\importRecord(), and ilPageEditorGUI\showSnippetInfo().

    {
        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[] = $rec["mep_id"];
        }
        return $pool_ids;               // currently this array should contain only one id
    }

Here is the caller graph for this function:

getTitle()

ilMediaPoolItem::getTitle

(

)

Get title.

Returns

string title

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

References $title.

Referenced by create().

    {
        return $this->title;
    }

Here is the caller graph for this function:

getType()

ilMediaPoolItem::getType

(

)

Get type.

Returns

string type

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

References $type.

Referenced by create().

    {
        return $this->type;
    }

Here is the caller graph for this function:

lookup()

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

staticprivate

Lookup.

Parameters

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

References $DIC, and $ilDB.

    {
        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 false;
    }

lookupForeignId()

static ilMediaPoolItem::lookupForeignId (   $a_id )

static

Lookup Foreign Id.

Parameters

int	mep item id

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

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

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

Here is the caller graph for this function:

lookupTitle()

static ilMediaPoolItem::lookupTitle (   $a_id )

static

Lookup title.

Parameters

int	mep item id

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

Referenced by ilObjMediaPoolGUI\allMedia(), ilObjMediaPoolGUI\confirmRemove(), ilObjMediaPoolGUI\getFolderValues(), ilObjMediaPoolSubItemListGUI\getHTML(), ilObjMediaPoolGUI\getMediaPoolPageValues(), ilObjMediaPoolGUI\insertFromClipboard(), ilMediaPoolPage\lookupTitle(), ilPCContentInclude\modifyPageContentPostXsl(), and ilMediaPoolPageGUI\showPage().

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

Here is the caller graph for this function:

lookupType()

static ilMediaPoolItem::lookupType (   $a_id )

static

Lookup type.

Parameters

int	mep item id

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

Referenced by ilObjMediaPoolGUI\confirmRemove(), ilObjMediaPoolGUI\copyToClipboard(), and ilObjMediaPoolSubItemListGUI\getHTML().

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

Here is the caller graph for this function:

read()

ilMediaPoolItem::read

(

)

Read.

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

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

Referenced by __construct().

    {
        $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($rec["foreign_id"]);
            $this->setTitle($rec["title"]);
            $this->setImportId($rec["import_id"]);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setForeignId()

ilMediaPoolItem::setForeignId

(

$a_val

)

Set foreign id.

Parameters

int	foreign id

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

Referenced by read().

    {
        $this->foreign_id = $a_val;
    }

Here is the caller graph for this function:

setId()

ilMediaPoolItem::setId

(

$a_val

)

Set id.

Parameters

int

id

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

Referenced by __construct(), and create().

    {
        $this->id = $a_val;
    }

Here is the caller graph for this function:

setImportId()

ilMediaPoolItem::setImportId

(

$a_val

)

Set import id.

Parameters

string

$a_val

import id

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

Referenced by read().

    {
        $this->import_id = $a_val;
    }

Here is the caller graph for this function:

setTitle()

ilMediaPoolItem::setTitle

(

$a_val

)

Set title.

Parameters

string

title

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

Referenced by read().

    {
        $this->title = $a_val;
    }

Here is the caller graph for this function:

setType()

ilMediaPoolItem::setType

(

$a_val

)

Set type.

Parameters

string

type

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

Referenced by read().

    {
        $this->type = $a_val;
    }

Here is the caller graph for this function:

update()

ilMediaPoolItem::update

(

)

Update.

Parameters

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

References $db, and $ilDB.

    {
        $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")
        );
    }

updateObjectTitle()

static ilMediaPoolItem::updateObjectTitle (   $a_obj )

static

Update object title.

Parameters

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

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

Referenced by ilMediaPoolAppEventListener\handleEvent().

    {
        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")
            );
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$db

ilMediaPoolItem::$db

protected

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

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

$import_id

ilMediaPoolItem::$import_id

protected

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

Referenced by getImportId().

---

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

• Modules/MediaPool/classes/class.ilMediaPoolItem.php