ilMDIdentifier Class Reference

Inheritance diagram for ilMDIdentifier:

Collaboration diagram for ilMDIdentifier:

Public Member Functions
	setCatalog (string $a_catalog)
	getCatalog ()
	setEntry (string $a_entry)
	getEntry ()
	save ()
	update ()
	delete ()
	__getFields ()
	read ()
	toXML (ilXmlWriter $writer)
Public Member Functions inherited from ilMDBase
	__construct (int $a_rbac_id=0, int $a_obj_id=0, string $a_type='')
	constructor More...
	read ()
	setRBACId (int $a_id)
	getRBACId ()
	setObjId (int $a_id)
	getObjId ()
	setObjType (string $a_type)
	getObjType ()
	setMetaId (int $a_meta_id, bool $a_read_data=true)
	getMetaId ()
	setParentType (string $a_parent_type)
	getParentType ()
	setParentId (int $a_id)
	getParentId ()
	setExportMode (bool $a_export_mode=true)
	getExportMode ()
	validate ()
	update ()
	save ()
	delete ()
	toXML (ilXmlWriter $writer)

Static Public Member Functions
static	_getIds (int $a_rbac_id, int $a_obj_id, int $a_parent_id, string $a_parent_type)
static	_getEntriesForObj (int $a_rbac_id, int $a_obj_id, string $a_obj_type)
static	_getEntriesForRbacObj (int $a_rbac_id, string $a_obj_type="")
static	existsIdInRbacObject (int $a_rbac_id, string $a_obj_type, string $a_catalog, string $a_entry)
static	readIdData (int $a_rbac_id, string $a_obj_type, string $a_catalog, string $a_entry)

Private Attributes
string	$catalog = ''
string	$entry = ''

Additional Inherited Members
Protected Attributes inherited from ilMDBase
ilLogger	$log
ilDBInterface	$db

Detailed Description

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

Member Function Documentation

__getFields()

ilMDIdentifier::__getFields

(

)

Returns

array<string, array<string, mixed>>

Definition at line 88 of file class.ilMDIdentifier.php.

References getCatalog(), getEntry(), ilMDBase\getObjId(), ilMDBase\getObjType(), ilMDBase\getParentId(), ilMDBase\getParentType(), and ilMDBase\getRBACId().

Referenced by save(), and update().

                                 : array
    {
        return array(
            'rbac_id' => array('integer', $this->getRBACId()),
            'obj_id' => array('integer', $this->getObjId()),
            'obj_type' => array('text', $this->getObjType()),
            'parent_type' => array('text', $this->getParentType()),
            'parent_id' => array('integer', $this->getParentId()),
            'catalog' => array('text', $this->getCatalog()),
            'entry' => array('text', $this->getEntry())
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_getEntriesForObj()

static ilMDIdentifier::_getEntriesForObj ( int  $a_rbac_id, int  $a_obj_id, string  $a_obj_type  )

static

Returns

array<int, array<string, string>>

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

References $DIC, $ilDB, $r, and $res.

                                                                                               : array
    {
        global $DIC;

        $ilDB = $DIC->database();

        $query = "SELECT meta_identifier_id, catalog, entry FROM il_meta_identifier " .
            "WHERE rbac_id = " . $ilDB->quote($a_rbac_id, 'integer') . " " .
            "AND obj_id = " . $ilDB->quote($a_obj_id, 'integer') . " " .
            "AND obj_type = " . $ilDB->quote($a_obj_type, 'text');

        $res = $ilDB->query($query);
        $entries = array();
        while ($r = $ilDB->fetchAssoc($res)) {
            $entries[$r["meta_identifier_id"]] =
                array(
                    "catalog" => $r["catalog"],
                    "entry" => $r["entry"]
                );
        }
        return $entries;
    }

_getEntriesForRbacObj()

static ilMDIdentifier::_getEntriesForRbacObj ( int  $a_rbac_id, string  $a_obj_type = ""  )

static

Returns

array<int, array<string, mixed>>

Definition at line 199 of file class.ilMDIdentifier.php.

References $DIC, $ilDB, $r, and $res.

                                                                                         : array
    {
        global $DIC;

        $ilDB = $DIC->database();

        $query = "SELECT meta_identifier_id, catalog, entry, obj_id FROM il_meta_identifier " .
            "WHERE rbac_id = " . $ilDB->quote($a_rbac_id, 'integer');

        if ($a_obj_type !== "") {
            $query .=
                " AND obj_type = " . $ilDB->quote($a_obj_type, 'text');
        }

        $res = $ilDB->query($query);
        $entries = array();
        while ($r = $ilDB->fetchAssoc($res)) {
            $entries[$r["meta_identifier_id"]] =
                array(
                    "catalog" => $r["catalog"],
                    "entry" => $r["entry"],
                    "obj_id" => $r["obj_id"]
                );
        }
        return $entries;
    }

_getIds()

static ilMDIdentifier::_getIds ( int  $a_rbac_id, int  $a_obj_id, int  $a_parent_id, string  $a_parent_type  )

static

Returns

int[]

Definition at line 150 of file class.ilMDIdentifier.php.

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

Referenced by ilMDMetaMetadata\getIdentifierIds(), and ilMDGeneral\getIdentifierIds().

                                                                                                          : array
    {
        global $DIC;

        $ilDB = $DIC->database();

        $query = "SELECT meta_identifier_id FROM il_meta_identifier " .
            "WHERE rbac_id = " . $ilDB->quote($a_rbac_id, 'integer') . " " .
            "AND obj_id = " . $ilDB->quote($a_obj_id, 'integer') . " " .
            "AND parent_id = " . $ilDB->quote($a_parent_id, 'integer') . " " .
            "AND parent_type = " . $ilDB->quote($a_parent_type, 'text');

        $res = $ilDB->query($query);
        $ids = [];
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $ids[] = (int) $row->meta_identifier_id;
        }
        return $ids;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

delete()

ilMDIdentifier::delete

(

)

Definition at line 74 of file class.ilMDIdentifier.php.

References $res, and ilMDBase\getMetaId().

                            : bool
    {
        if ($this->getMetaId()) {
            $query = "DELETE FROM il_meta_identifier " .
                "WHERE meta_identifier_id = " . $this->db->quote($this->getMetaId(), 'integer');
            $res = $this->db->manipulate($query);
            return true;
        }
        return false;
    }

Here is the call graph for this function:

existsIdInRbacObject()

static ilMDIdentifier::existsIdInRbacObject ( int  $a_rbac_id, string  $a_obj_type, string  $a_catalog, string  $a_entry  )

static

Definition at line 226 of file class.ilMDIdentifier.php.

References $DIC, $ilDB, and $r.

     : bool {
        global $DIC;

        $ilDB = $DIC->database();

        $query = "SELECT meta_identifier_id, obj_id FROM il_meta_identifier " .
            "WHERE rbac_id = " . $ilDB->quote($a_rbac_id, 'integer') .
            " AND obj_type = " . $ilDB->quote($a_obj_type, 'text') .
            " AND catalog = " . $ilDB->quote($a_catalog, 'text') .
            " AND entry = " . $ilDB->quote($a_entry, 'text');
        $s = $ilDB->query($query);
        if ($r = $ilDB->fetchAssoc($s)) {
            return true;
        }
        return false;
    }

getCatalog()

ilMDIdentifier::getCatalog

(

)

Definition at line 38 of file class.ilMDIdentifier.php.

References $catalog.

Referenced by __getFields(), and toXML().

                                : string
    {
        return $this->catalog;
    }

Here is the caller graph for this function:

getEntry()

ilMDIdentifier::getEntry

(

)

Definition at line 48 of file class.ilMDIdentifier.php.

References $entry.

Referenced by __getFields(), and toXML().

                              : string
    {
        return $this->entry;
    }

Here is the caller graph for this function:

read()

ilMDIdentifier::read

(

)

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

References $res, ilDBConstants\FETCHMODE_OBJECT, ilMDBase\getMetaId(), setCatalog(), setEntry(), ilMDBase\setObjId(), ilMDBase\setObjType(), ilMDBase\setParentId(), ilMDBase\setParentType(), and ilMDBase\setRBACId().

                          : bool
    {
        if ($this->getMetaId()) {
            $query = "SELECT * FROM il_meta_identifier " .
                "WHERE meta_identifier_id = " . $this->db->quote($this->getMetaId(), 'integer');

            $res = $this->db->query($query);
            while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
                $this->setRBACId((int) $row->rbac_id);
                $this->setObjId((int) $row->obj_id);
                $this->setObjType($row->obj_type ?? '');
                $this->setParentId((int) $row->parent_id);
                $this->setParentType($row->parent_type);
                $this->setCatalog($row->catalog ?? '');
                $this->setEntry($row->entry ?? '');
            }
        }
        return true;
    }

Here is the call graph for this function:

readIdData()

static ilMDIdentifier::readIdData ( int  $a_rbac_id, string  $a_obj_type, string  $a_catalog, string  $a_entry  )

static

Returns

array<int, array<string, mixed>>

Definition at line 251 of file class.ilMDIdentifier.php.

References $data, $DIC, $ilDB, and $r.

                                                                                                             : array
    {
        global $DIC;

        $ilDB = $DIC->database();

        $query = "SELECT * FROM il_meta_identifier " .
            "WHERE rbac_id = " . $ilDB->quote($a_rbac_id, 'integer') .
            " AND obj_type = " . $ilDB->quote($a_obj_type, 'text') .
            " AND catalog = " . $ilDB->quote($a_catalog, 'text') .
            " AND entry = " . $ilDB->quote($a_entry, 'text');
        $s = $ilDB->query($query);
        $data = array();
        while ($r = $ilDB->fetchAssoc($s)) {
            $data[] = $r;
        }
        return $data;
    }

save()

ilMDIdentifier::save

(

)

Definition at line 53 of file class.ilMDIdentifier.php.

References __getFields(), ilMDBase\getMetaId(), and ilMDBase\setMetaId().

                          : int
    {
        $fields = $this->__getFields();
        $fields['meta_identifier_id'] = array('integer', $next_id = $this->db->nextId('il_meta_identifier'));

        if ($this->db->insert('il_meta_identifier', $fields)) {
            $this->setMetaId($next_id);
            return $this->getMetaId();
        }
        return 0;
    }

Here is the call graph for this function:

setCatalog()

ilMDIdentifier::setCatalog

(

string

$a_catalog

)

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

Referenced by read().

                                                 : void
    {
        $this->catalog = $a_catalog;
    }

Here is the caller graph for this function:

setEntry()

ilMDIdentifier::setEntry

(

string

$a_entry

)

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

Referenced by read(), and ilMDXMLCopier\startParsing().

                                             : void
    {
        $this->entry = $a_entry;
    }

Here is the caller graph for this function:

toXML()

ilMDIdentifier::toXML

(

ilXmlWriter

$writer

)

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

References getCatalog(), getEntry(), ilMDBase\getExportMode(), ilMDBase\getObjId(), ilMDBase\getObjType(), ilMDBase\getRBACId(), IL_INST_ID, and ilXmlWriter\xmlElement().

                                              : void
    {
        $entry_default = ($this->getObjId() === 0)
            ? "il_" . IL_INST_ID . "_" . $this->getObjType() . "_" . $this->getRBACId()
            : "il_" . IL_INST_ID . "_" . $this->getObjType() . "_" . $this->getObjId();

        $entry = $this->getEntry() ?: $entry_default;
        $catalog = $this->getCatalog();

        if ($this->getExportMode() && $this->getCatalog() !== "ILIAS_NID") {
            $entry = $entry_default;
            $catalog = "ILIAS";
        }

        if ($catalog !== '') {
            $writer->xmlElement('Identifier', array(
                'Catalog' => $catalog,
                'Entry' => $entry
            ));
        } else {
            $writer->xmlElement('Identifier', array('Entry' => $entry));
        }
    }

Here is the call graph for this function:

update()

ilMDIdentifier::update

(

)

Definition at line 65 of file class.ilMDIdentifier.php.

References __getFields(), and ilMDBase\getMetaId().

                            : bool
    {
        return $this->getMetaId() && $this->db->update(
            'il_meta_identifier',
            $this->__getFields(),
            array("meta_identifier_id" => array('integer', $this->getMetaId()))
        );
    }

Here is the call graph for this function:

Field Documentation

$catalog

string ilMDIdentifier::$catalog = ''

private

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

Referenced by getCatalog().

$entry

string ilMDIdentifier::$entry = ''

private

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

Referenced by getEntry().

---

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

• components/ILIAS/MetaData/classes/class.ilMDIdentifier.php