ilMDClassification Class Reference

Inheritance diagram for ilMDClassification:

Collaboration diagram for ilMDClassification:

Public Member Functions
	getTaxonPathIds ()
	getTaxonPath (int $a_taxon_path_id)
	addTaxonPath ()
	getKeywordIds ()
	getKeyword (int $a_keyword_id)
	addKeyword ()
	setPurpose (string $a_purpose)
	getPurpose ()
	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)

Private Attributes
const	PURPOSE_TRANSLATION
	Compatibility fix for legacy MD classes for new db tables. More...
const string	$purpose = ''
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.ilMDClassification.php.

Member Function Documentation

__getFields()

ilMDClassification::__getFields

(

)

Returns

array<string, array<string, mixed>>

Compatibility fix for legacy MD classes for new db tables

Definition at line 198 of file class.ilMDClassification.php.

References getDescription(), getDescriptionLanguageCode(), ilMDBase\getObjId(), ilMDBase\getObjType(), getPurpose(), and ilMDBase\getRBACId().

Referenced by save(), and update().

                                 : array
    {
        $purpose = (string) array_search(
            $this->getPurpose(),
            self::PURPOSE_TRANSLATION
        );

        return array(
            'rbac_id' => array('integer', $this->getRBACId()),
            'obj_id' => array('integer', $this->getObjId()),
            'obj_type' => array('text', $this->getObjType()),
            'purpose' => array('text', $purpose),
            'description' => array('text', $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 ilMDClassification::_getIds ( int  $a_rbac_id, int  $a_obj_id  )

static

Returns

int[]

Definition at line 288 of file class.ilMDClassification.php.

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

Referenced by ilMD\getClassificationIds().

                                                                 : array
    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        $query = "SELECT meta_classification_id FROM il_meta_classification " .
            "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_classification_id;
        }
        return $ids;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addKeyword()

ilMDClassification::addKeyword

(

)

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

References ILIAS\LTI\ToolProvider\$key, ilMDBase\getMetaId(), ilMDBase\getObjId(), ilMDBase\getObjType(), and ilMDBase\getRBACId().

                                : ilMDKeyword
    {
        $key = new ilMDKeyword($this->getRBACId(), $this->getObjId(), $this->getObjType());
        $key->setParentId($this->getMetaId());
        $key->setParentType('meta_classification');

        return $key;
    }

Here is the call graph for this function:

addTaxonPath()

ilMDClassification::addTaxonPath

(

)

Definition at line 68 of file class.ilMDClassification.php.

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

                                  : ilMDTaxonPath
    {
        $tax = new ilMDTaxonPath($this->getRBACId(), $this->getObjId(), $this->getObjType());
        $tax->setParentId($this->getMetaId());
        $tax->setParentType('meta_classification');

        return $tax;
    }

Here is the call graph for this function:

delete()

ilMDClassification::delete

(

)

Definition at line 174 of file class.ilMDClassification.php.

References $id, ILIAS\LTI\ToolProvider\$key, $res, getKeyword(), getKeywordIds(), ilMDBase\getMetaId(), getTaxonPath(), and getTaxonPathIds().

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

            foreach ($this->getTaxonPathIds() as $id) {
                $tax = $this->getTaxonPath($id);
                $tax->delete();
            }
            foreach ($this->getKeywordIds() as $id) {
                $key = $this->getKeyword($id);
                $key->delete();
            }

            return true;
        }
        return false;
    }

Here is the call graph for this function:

getDescription()

ilMDClassification::getDescription

(

)

Definition at line 133 of file class.ilMDClassification.php.

References $description.

Referenced by __getFields(), and toXML().

                                    : string
    {
        return $this->description;
    }

Here is the caller graph for this function:

getDescriptionLanguage()

ilMDClassification::getDescriptionLanguage

(

)

Definition at line 143 of file class.ilMDClassification.php.

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

getDescriptionLanguageCode()

ilMDClassification::getDescriptionLanguageCode

(

)

Definition at line 148 of file class.ilMDClassification.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:

getKeyword()

ilMDClassification::getKeyword

(

int

$a_keyword_id

)

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

References ILIAS\LTI\ToolProvider\$key.

Referenced by delete(), and toXML().

                                                 : ?ilMDKeyword
    {
        if (!$a_keyword_id) {
            return null;
        }
        $key = new ilMDKeyword();
        $key->setMetaId($a_keyword_id);

        return $key;
    }

Here is the caller graph for this function:

getKeywordIds()

ilMDClassification::getKeywordIds

(

)

Definition at line 77 of file class.ilMDClassification.php.

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

Referenced by delete(), and toXML().

                                   : ?array
    {
        return ilMDKeyword::_getIds($this->getRBACId(), $this->getObjId(), $this->getMetaId(), 'meta_classification');
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getPurpose()

ilMDClassification::getPurpose

(

)

Definition at line 123 of file class.ilMDClassification.php.

References $purpose.

Referenced by __getFields(), and toXML().

                                : string
    {
        return $this->purpose;
    }

Here is the caller graph for this function:

getTaxonPath()

ilMDClassification::getTaxonPath

(

int

$a_taxon_path_id

)

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

Referenced by delete(), and toXML().

                                                      : ?ilMDTaxonPath
    {
        if (!$a_taxon_path_id) {
            return null;
        }
        $tax = new ilMDTaxonPath();
        $tax->setMetaId($a_taxon_path_id);

        return $tax;
    }

Here is the caller graph for this function:

getTaxonPathIds()

ilMDClassification::getTaxonPathIds

(

)

Returns

int[]

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

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

Referenced by delete(), and toXML().

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

Here is the call graph for this function:

Here is the caller graph for this function:

read()

ilMDClassification::read

(

)

Compatibility fix for legacy MD classes for new db tables

Definition at line 218 of file class.ilMDClassification.php.

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

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

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

                $this->setRBACId((int) $row->rbac_id);
                $this->setObjId((int) $row->obj_id);
                $this->setObjType($row->obj_type);
                $this->setPurpose($row->purpose ?? '');
                $this->setDescription($row->description ?? '');
                $this->description_language = new ilMDLanguageItem($row->description_language ?? '');
            }
        }
        return true;
    }

Here is the call graph for this function:

save()

ilMDClassification::save

(

)

Definition at line 153 of file class.ilMDClassification.php.

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

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

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

Here is the call graph for this function:

setDescription()

ilMDClassification::setDescription

(

string

$a_description

)

Definition at line 128 of file class.ilMDClassification.php.

Referenced by read().

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

Here is the caller graph for this function:

setDescriptionLanguage()

ilMDClassification::setDescriptionLanguage

(

ilMDLanguageItem

$lng_obj

)

Definition at line 138 of file class.ilMDClassification.php.

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

setPurpose()

ilMDClassification::setPurpose

(

string

$a_purpose

)

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

Referenced by read().

                                                 : bool
    {
        switch ($a_purpose) {
            case 'Discipline':
            case 'Idea':
            case 'Prerequisite':
            case 'EducationalObjective':
            case 'AccessibilityRestrictions':
            case 'EducationalLevel':
            case 'SkillLevel':
            case 'SecurityLevel':
            case 'Competency':
                $this->purpose = $a_purpose;
                return true;

            default:
                return false;
        }
    }

Here is the caller graph for this function:

toXML()

ilMDClassification::toXML

(

ilXmlWriter

$writer

)

Definition at line 244 of file class.ilMDClassification.php.

References $id, ILIAS\LTI\ToolProvider\$key, getDescription(), getDescriptionLanguageCode(), getKeyword(), getKeywordIds(), ilMDBase\getObjId(), getPurpose(), ilMDBase\getRBACId(), getTaxonPath(), getTaxonPathIds(), ilXmlWriter\xmlElement(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

                                              : void
    {
        $writer->xmlStartTag('Classification', array(
            'Purpose' => $this->getPurpose() ?: 'Idea'
        ));

        // Taxon Path
        $taxs = $this->getTaxonPathIds();
        foreach ($taxs as $id) {
            $tax = $this->getTaxonPath($id);
            $tax->toXML($writer);
        }
        if (!count($taxs)) {
            $tax = new ilMDTaxonPath($this->getRBACId(), $this->getObjId());
            $tax->toXML($writer);
        }

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

        // Keyword
        $keys = $this->getKeywordIds();
        foreach ($keys as $id) {
            $key = $this->getKeyword($id);
            $key->toXML($writer);
        }
        if (!count($keys)) {
            $key = new ilMDKeyword($this->getRBACId(), $this->getObjId());
            $key->toXML($writer);
        }
        $writer->xmlEndTag('Classification');
    }

Here is the call graph for this function:

update()

ilMDClassification::update

(

)

Definition at line 165 of file class.ilMDClassification.php.

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

                            : bool
    {
        return $this->getMetaId() && $this->db->update(
            'il_meta_classification',
            $this->__getFields(),
            ["meta_classification_id" => ['integer', $this->getMetaId()]]
        );
    }

Here is the call graph for this function:

Field Documentation

$description

string ilMDClassification::$description = ''

private

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

Referenced by getDescription().

$description_language

ilMDLanguageItem ilMDClassification::$description_language = null

private

Definition at line 45 of file class.ilMDClassification.php.

$purpose

const string ilMDClassification::$purpose = ''

private

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

Referenced by getPurpose().

PURPOSE_TRANSLATION

const ilMDClassification::PURPOSE_TRANSLATION

private

Initial value:

= [
        'discipline' => 'Discipline'

Compatibility fix for legacy MD classes for new db tables.

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

---

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

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