ilMDDescription Class Reference

Inheritance diagram for ilMDDescription:

Collaboration diagram for ilMDDescription:

Public Member Functions
	setDescription (string $a_description)
	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, int $a_parent_id, string $a_parent_type)

Private Attributes
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.ilMDDescription.php.

Member Function Documentation

__getFields()

ilMDDescription::__getFields

(

)

Returns

array<string, array<string, mixed>>

Definition at line 93 of file class.ilMDDescription.php.

References getDescription(), getDescriptionLanguageCode(), 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()),
            '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 ilMDDescription::_getIds ( int  $a_rbac_id, int  $a_obj_id, int  $a_parent_id, string  $a_parent_type  )

static

Returns

int[]

Definition at line 142 of file class.ilMDDescription.php.

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

Referenced by ilMDRelation\getDescriptionIds(), ilMDGeneral\getDescriptionIds(), and ilMDEducational\getDescriptionIds().

                                                                                                          : array
    {
        global $DIC;

        $ilDB = $DIC->database();

        $query = "SELECT meta_description_id FROM il_meta_description " .
            "WHERE rbac_id = " . $ilDB->quote($a_rbac_id, ilDBConstants::T_INTEGER) . " " .
            "AND obj_id = " . $ilDB->quote($a_obj_id, ilDBConstants::T_INTEGER) . " " .
            "AND parent_id = " . $ilDB->quote($a_parent_id, ilDBConstants::T_INTEGER) . " " .
            "AND parent_type = " . $ilDB->quote($a_parent_type, ilDBConstants::T_INTEGER) . " " .
            "ORDER BY meta_description_id";

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

Here is the call graph for this function:

Here is the caller graph for this function:

delete()

ilMDDescription::delete

(

)

Definition at line 78 of file class.ilMDDescription.php.

References $res, and ilMDBase\getMetaId().

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

            return true;
        }
        return false;
    }

Here is the call graph for this function:

getDescription()

ilMDDescription::getDescription

(

)

Definition at line 37 of file class.ilMDDescription.php.

References $description.

Referenced by __getFields(), and toXML().

                                    : string
    {
        return $this->description;
    }

Here is the caller graph for this function:

getDescriptionLanguage()

ilMDDescription::getDescriptionLanguage

(

)

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

                                            : ?ilMDLanguageItem
    {
        return is_object($this->description_language) ? $this->description_language : null;
    }

getDescriptionLanguageCode()

ilMDDescription::getDescriptionLanguageCode

(

)

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

Referenced by __getFields(), and toXML().

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

Here is the caller graph for this function:

read()

ilMDDescription::read

(

)

Definition at line 106 of file class.ilMDDescription.php.

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

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

Here is the call graph for this function:

save()

ilMDDescription::save

(

)

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

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

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

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

Here is the call graph for this function:

setDescription()

ilMDDescription::setDescription

(

string

$a_description

)

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

Referenced by read().

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

Here is the caller graph for this function:

setDescriptionLanguage()

ilMDDescription::setDescriptionLanguage

(

ilMDLanguageItem

$lng_obj

)

Definition at line 42 of file class.ilMDDescription.php.

Referenced by read().

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

Here is the caller graph for this function:

toXML()

ilMDDescription::toXML

(

ilXmlWriter

$writer

)

Definition at line 126 of file class.ilMDDescription.php.

References getDescription(), getDescriptionLanguageCode(), and ilXmlWriter\xmlElement().

                                              : void
    {
        $writer->xmlElement(
            'Description',
            array(
                'Language' => $this->getDescriptionLanguageCode() ?: 'en'
            ),
            $this->getDescription()
        );
    }

Here is the call graph for this function:

update()

ilMDDescription::update

(

)

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

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

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

Here is the call graph for this function:

Field Documentation

$description

string ilMDDescription::$description = ''

private

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

Referenced by getDescription().

$description_language

ilMDLanguageItem ilMDDescription::$description_language = null

private

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

---

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

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