ilMDRelation Class Reference

Inheritance diagram for ilMDRelation:

Collaboration diagram for ilMDRelation:

Public Member Functions
	getIdentifier_Ids ()
	getIdentifier_ (int $a_identifier__id)
	addIdentifier_ ()
	getDescriptionIds ()
	getDescription (int $a_description_id)
	addDescription ()
	setKind (string $a_kind)
	getKind ()
	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)

Private Attributes
const	KIND_TRANSLATION
	Compatibility fix for legacy MD classes for new db tables. More...
const string	$kind = ''

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

Detailed Description

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

Member Function Documentation

__getFields()

ilMDRelation::__getFields

(

)

Returns

array<string, array<string, mixed>>

Compatibility fix for legacy MD classes for new db tables

Definition at line 181 of file class.ilMDRelation.php.

References getKind(), ilMDBase\getObjId(), ilMDBase\getObjType(), and ilMDBase\getRBACId().

Referenced by save(), and update().

                                 : array
    {
        $kind = (string) array_search(
            $this->getKind(),
            self::KIND_TRANSLATION
        );

        return array(
            'rbac_id' => array('integer', $this->getRBACId()),
            'obj_id' => array('integer', $this->getObjId()),
            'obj_type' => array('text', $this->getObjType()),
            'kind' => array('text', $kind)
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_getIds()

static ilMDRelation::_getIds ( int  $a_rbac_id, int  $a_obj_id  )

static

Returns

int[]

Definition at line 261 of file class.ilMDRelation.php.

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

Referenced by ilMD\getRelationIds().

                                                                 : array
    {
        global $DIC;

        $ilDB = $DIC->database();

        $query = "SELECT meta_relation_id FROM il_meta_relation " .
            "WHERE rbac_id = " . $ilDB->quote($a_rbac_id, 'integer') . " " .
            "AND obj_id = " . $ilDB->quote($a_obj_id, 'integer');

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

Here is the call graph for this function:

Here is the caller graph for this function:

addDescription()

ilMDRelation::addDescription

(

)

Definition at line 98 of file class.ilMDRelation.php.

References ilMDBase\getMetaId(), ilMDBase\getObjId(), ilMDBase\getObjType(), and ilMDBase\getRBACId().

                                    : ilMDDescription
    {
        $des = new ilMDDescription($this->getRBACId(), $this->getObjId(), $this->getObjType());
        $des->setParentId($this->getMetaId());
        $des->setParentType('meta_relation');

        return $des;
    }

Here is the call graph for this function:

addIdentifier_()

ilMDRelation::addIdentifier_

(

)

Definition at line 70 of file class.ilMDRelation.php.

References ilMDBase\getMetaId(), ilMDBase\getObjId(), ilMDBase\getObjType(), and ilMDBase\getRBACId().

                                    : ilMDIdentifier_
    {
        $ide = new ilMDIdentifier_($this->getRBACId(), $this->getObjId(), $this->getObjType());
        $ide->setParentId($this->getMetaId());
        $ide->setParentType('meta_relation');

        return $ide;
    }

Here is the call graph for this function:

delete()

ilMDRelation::delete

(

)

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

References $id, $res, getDescription(), getDescriptionIds(), getIdentifier_(), getIdentifier_Ids(), and ilMDBase\getMetaId().

                            : bool
    {
        if ($this->getMetaId()) {
            $query = "DELETE FROM il_meta_relation " .
                "WHERE meta_relation_id = " . $this->db->quote($this->getMetaId(), 'integer');
            $res = $this->db->manipulate($query);

            foreach ($this->getIdentifier_Ids() as $id) {
                $ide = $this->getIdentifier_($id);
                $ide->delete();
            }
            foreach ($this->getDescriptionIds() as $id) {
                $des = $this->getDescription($id);
                $des->delete();
            }

            return true;
        }
        return false;
    }

Here is the call graph for this function:

getDescription()

ilMDRelation::getDescription

(

int

$a_description_id

)

Definition at line 87 of file class.ilMDRelation.php.

References null.

Referenced by delete(), and toXML().

                                                         : ?ilMDDescription
    {
        if (!$a_description_id) {
            return null;
        }
        $des = new ilMDDescription();
        $des->setMetaId($a_description_id);

        return $des;
    }

Here is the caller graph for this function:

getDescriptionIds()

ilMDRelation::getDescriptionIds

(

)

Returns

int[]

Definition at line 82 of file class.ilMDRelation.php.

References ilMDDescription\_getIds(), ilMDBase\getMetaId(), ilMDBase\getObjId(), and ilMDBase\getRBACId().

Referenced by delete(), and toXML().

                                       : array
    {
        return ilMDDescription::_getIds($this->getRBACId(), $this->getObjId(), $this->getMetaId(), 'meta_relation');
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getIdentifier_()

ilMDRelation::getIdentifier_

(

int

$a_identifier__id

)

Definition at line 59 of file class.ilMDRelation.php.

References null.

Referenced by delete(), and toXML().

                                                         : ?ilMDIdentifier_
    {
        if (!$a_identifier__id) {
            return null;
        }
        $ide = new ilMDIdentifier_();
        $ide->setMetaId($a_identifier__id);

        return $ide;
    }

Here is the caller graph for this function:

getIdentifier_Ids()

ilMDRelation::getIdentifier_Ids

(

)

Returns

int[]

Definition at line 54 of file class.ilMDRelation.php.

References ilMDIdentifier_\_getIds(), ilMDBase\getMetaId(), ilMDBase\getObjId(), and ilMDBase\getRBACId().

Referenced by delete(), and toXML().

                                       : array
    {
        return ilMDIdentifier_::_getIds($this->getRBACId(), $this->getObjId(), $this->getMetaId(), 'meta_relation');
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getKind()

ilMDRelation::getKind

(

)

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

References $kind.

Referenced by __getFields(), and toXML().

                             : string
    {
        return $this->kind;
    }

Here is the caller graph for this function:

read()

ilMDRelation::read

(

)

Compatibility fix for legacy MD classes for new db tables

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

References $res, ilDBConstants\FETCHMODE_OBJECT, ilMDBase\getMetaId(), setKind(), ilMDBase\setObjId(), ilMDBase\setObjType(), and ilMDBase\setRBACId().

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

            $res = $this->db->query($query);
            while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
                if (key_exists($row->kind ?? '', self::KIND_TRANSLATION)) {
                    $row->kind = self::KIND_TRANSLATION[$row->kind ?? ''];
                }

                $this->setRBACId((int) $row->rbac_id);
                $this->setObjId((int) $row->obj_id);
                $this->setObjType($row->obj_type);
                $this->setKind($row->kind ?? '');
            }
        }
        return true;
    }

Here is the call graph for this function:

save()

ilMDRelation::save

(

)

Definition at line 136 of file class.ilMDRelation.php.

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

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

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

Here is the call graph for this function:

setKind()

ilMDRelation::setKind

(

string

$a_kind

)

Definition at line 108 of file class.ilMDRelation.php.

Referenced by read().

                                           : bool
    {
        switch ($a_kind) {
            case 'IsPartOf':
            case 'HasPart':
            case 'IsVersionOf':
            case 'HasVersion':
            case 'IsFormatOf':
            case 'HasFormat':
            case 'References':
            case 'IsReferencedBy':
            case 'IsBasedOn':
            case 'IsBasisFor':
            case 'Requires':
            case 'IsRequiredBy':
                $this->kind = $a_kind;
                return true;

            default:
                return false;
        }
    }

Here is the caller graph for this function:

toXML()

ilMDRelation::toXML

(

ilXmlWriter

$writer

)

Definition at line 223 of file class.ilMDRelation.php.

References $id, getDescription(), getDescriptionIds(), getIdentifier_(), getIdentifier_Ids(), getKind(), ilMDBase\getObjId(), ilMDBase\getRBACId(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

                                              : void
    {
        $writer->xmlStartTag('Relation', array(
            'Kind' => $this->getKind() ?: 'IsPartOf'
        ));
        $writer->xmlStartTag('Resource');

        // Identifier_
        $ides = $this->getIdentifier_Ids();
        foreach ($ides as $id) {
            $ide = $this->getIdentifier_($id);
            $ide->toXML($writer);
        }
        if (!count($ides)) {
            $ide = new ilMDIdentifier_($this->getRBACId(), $this->getObjId());
            $ide->toXML($writer);
        }

        // Description
        $dess = $this->getDescriptionIds();
        foreach ($dess as $id) {
            $des = $this->getDescription($id);
            $des->toXML($writer);
        }
        if (!count($dess)) {
            $des = new ilMDDescription($this->getRBACId(), $this->getObjId());
            $des->toXML($writer);
        }

        $writer->xmlEndTag('Resource');
        $writer->xmlEndTag('Relation');
    }

Here is the call graph for this function:

update()

ilMDRelation::update

(

)

Definition at line 148 of file class.ilMDRelation.php.

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

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

Here is the call graph for this function:

Field Documentation

$kind

const string ilMDRelation::$kind = ''

private

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

Referenced by getKind().

KIND_TRANSLATION

const ilMDRelation::KIND_TRANSLATION

private

Initial value:

= [
        'ispartof' => 'IsPartOf'

Compatibility fix for legacy MD classes for new db tables.

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

---

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

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