ilMDAnnotation Class Reference

Inheritance diagram for ilMDAnnotation:

Collaboration diagram for ilMDAnnotation:

Public Member Functions
	setEntity (string $a_entity)
	getEntity ()
	setDate (string $a_date)
	getDate ()
	setDescription (string $a_desc)
	getDescription ()
	setDescriptionLanguage (ilMDLanguageItem $lng_obj)
	getDescriptionLanguage ()
	getDescriptionLanguageCode ()
	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
string	$entity = ''
string	$date = ''
string	$description = ''
ilMDLanguageItem	$description_language = null

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

Detailed Description

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

Member Function Documentation

__getFields()

ilMDAnnotation::__getFields

(

)

Returns

array<string, array<string, mixed>>

Definition at line 118 of file class.ilMDAnnotation.php.

References getDate(), getDescription(), getDescriptionLanguageCode(), getEntity(), ilMDBase\getObjId(), ilMDBase\getObjType(), 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()),
            'entity' => array('clob', $this->getEntity()),
            'a_date' => array('clob', $this->getDate()),
            'description' => array('clob', $this->getDescription()),
            'description_language' => array('text', $this->getDescriptionLanguageCode())
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_getIds()

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

static

Returns

int[]

Definition at line 171 of file class.ilMDAnnotation.php.

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

Referenced by ilMD\getAnnotationIds().

                                                                 : array
    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        $query = "SELECT meta_annotation_id FROM il_meta_annotation " .
            "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_annotation_id;
        }
        return $ids;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

delete()

ilMDAnnotation::delete

(

)

Definition at line 103 of file class.ilMDAnnotation.php.

References $query, $res, and ilMDBase\getMetaId().

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

            return true;
        }
        return false;
    }

Here is the call graph for this function:

getDate()

ilMDAnnotation::getDate

(

)

Definition at line 49 of file class.ilMDAnnotation.php.

References $date.

Referenced by __getFields(), and toXML().

                             : string
    {
        return $this->date;
    }

Here is the caller graph for this function:

getDescription()

ilMDAnnotation::getDescription

(

)

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

References $description.

Referenced by __getFields(), and toXML().

                                    : string
    {
        return $this->description;
    }

Here is the caller graph for this function:

getDescriptionLanguage()

ilMDAnnotation::getDescriptionLanguage

(

)

Definition at line 69 of file class.ilMDAnnotation.php.

References $description_language.

                                            : ilMDLanguageItem
    {
        return $this->description_language;
    }

getDescriptionLanguageCode()

ilMDAnnotation::getDescriptionLanguageCode

(

)

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

Referenced by __getFields(), and toXML().

                                                : string
    {
        if (is_object($this->description_language)) {
            return $this->description_language->getLanguageCode();
        }
        return '';
    }

Here is the caller graph for this function:

getEntity()

ilMDAnnotation::getEntity

(

)

Definition at line 39 of file class.ilMDAnnotation.php.

References $entity.

Referenced by __getFields(), and toXML().

                               : string
    {
        return $this->entity;
    }

Here is the caller graph for this function:

read()

ilMDAnnotation::read

(

)

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

References $query, $res, ilDBConstants\FETCHMODE_OBJECT, ilMDBase\getMetaId(), setDate(), setDescription(), setEntity(), ilMDBase\setObjId(), ilMDBase\setObjType(), and ilMDBase\setRBACId().

                          : bool
    {
        if ($this->getMetaId()) {
            $query = "SELECT * FROM il_meta_annotation " .
                "WHERE meta_annotation_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->setEntity($row->entity ?? '');
                $this->setDate($row->a_date ?? '');
                $this->setDescription($row->description ?? '');
                $this->description_language = new ilMDLanguageItem($row->description_language ?? '');
            }
        }
        return true;
    }

Here is the call graph for this function:

save()

ilMDAnnotation::save

(

)

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

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

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

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

Here is the call graph for this function:

setDate()

ilMDAnnotation::setDate

(

string

$a_date

)

Definition at line 44 of file class.ilMDAnnotation.php.

Referenced by read().

                                           : void
    {
        $this->date = $a_date;
    }

Here is the caller graph for this function:

setDescription()

ilMDAnnotation::setDescription

(

string

$a_desc

)

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

Referenced by read().

                                                  : void
    {
        $this->description = $a_desc;
    }

Here is the caller graph for this function:

setDescriptionLanguage()

ilMDAnnotation::setDescriptionLanguage

(

ilMDLanguageItem

$lng_obj

)

Definition at line 64 of file class.ilMDAnnotation.php.

                                                                     : void
    {
        $this->description_language = $lng_obj;
    }

setEntity()

ilMDAnnotation::setEntity

(

string

$a_entity

)

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

Referenced by read().

                                               : void
    {
        $this->entity = $a_entity;
    }

Here is the caller graph for this function:

toXML()

ilMDAnnotation::toXML

(

ilXmlWriter

$writer

)

Definition at line 151 of file class.ilMDAnnotation.php.

References getDate(), getDescription(), getDescriptionLanguageCode(), getEntity(), ilXmlWriter\xmlElement(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

                                              : void
    {
        $writer->xmlStartTag('Annotation');
        $writer->xmlElement('Entity', null, $this->getEntity());
        $writer->xmlElement('Date', null, $this->getDate());
        $writer->xmlElement(
            'Description',
            array(
                'Language' => $this->getDescriptionLanguageCode() ?: 'en'
            ),
            $this->getDescription()
        );
        $writer->xmlEndTag('Annotation');
    }

Here is the call graph for this function:

update()

ilMDAnnotation::update

(

)

Definition at line 94 of file class.ilMDAnnotation.php.

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

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

Here is the call graph for this function:

Field Documentation

$date

string ilMDAnnotation::$date = ''

private

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

Referenced by getDate().

$description

string ilMDAnnotation::$description = ''

private

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

Referenced by getDescription().

$description_language

ilMDLanguageItem ilMDAnnotation::$description_language = null

private

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

Referenced by getDescriptionLanguage().

$entity

string ilMDAnnotation::$entity = ''

private

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

Referenced by getEntity().

---

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

• Services/MetaData/classes/class.ilMDAnnotation.php