ilMDGeneral Class Reference

Inheritance diagram for ilMDGeneral:

Collaboration diagram for ilMDGeneral:

Public Member Functions
	getPossibleSubelements ()
	getIdentifierIds ()
	getIdentifier (int $a_identifier_id)
	addIdentifier ()
	getLanguageIds ()
	getLanguage (int $a_language_id)
	addLanguage ()
	getDescriptionIds ()
	getDescription (int $a_description_id)
	addDescription ()
	getKeywordIds ()
	getKeyword (int $a_keyword_id)
	addKeyword ()
	setStructure (string $a_structure)
	getStructure ()
	setTitle (string $a_title)
	getTitle ()
	setTitleLanguage (ilMDLanguageItem $lng_obj)
	getTitleLanguage ()
	getTitleLanguageCode ()
	setCoverage (string $a_coverage)
	getCoverage ()
	setCoverageLanguage (ilMDLanguageItem $lng_obj)
	getCoverageLanguage ()
	getCoverageLanguageCode ()
	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	_getId (int $a_rbac_id, int $a_obj_id)

Protected Attributes
ilMDLanguageItem	$coverage_language = null
Protected Attributes inherited from ilMDBase
ilLogger	$log
ilDBInterface	$db

Private Attributes
string	$coverage = ''
string	$structure = ''
string	$title = ''
ilMDLanguageItem	$title_language = null

Detailed Description

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

Member Function Documentation

__getFields()

ilMDGeneral::__getFields

(

)

Returns

array<string, array<string, mixed>>

Definition at line 302 of file class.ilMDGeneral.php.

References getCoverage(), getCoverageLanguageCode(), ilMDBase\getObjId(), ilMDBase\getObjType(), ilMDBase\getRBACId(), getStructure(), getTitle(), and getTitleLanguageCode().

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()),
            'general_structure' => array('text', $this->getStructure()),
            'title' => array('text', $this->getTitle()),
            'title_language' => array('text', $this->getTitleLanguageCode()),
            'coverage' => array('text', $this->getCoverage()),
            'coverage_language' => array('text', $this->getCoverageLanguageCode())
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_getId()

static ilMDGeneral::_getId ( int  $a_rbac_id, int  $a_obj_id  )

static

Definition at line 418 of file class.ilMDGeneral.php.

References $DIC, $ilDB, $query, $res, and ilDBConstants\FETCHMODE_OBJECT.

Referenced by ilMD\getGeneral(), and ilMDKeywordExposer\getGeneral().

                                                                : int
    {
        global $DIC;

        $ilDB = $DIC->database();

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

        $res = $ilDB->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            return (int) $row->meta_general_id;
        }
        return 0;
    }

Here is the caller graph for this function:

addDescription()

ilMDGeneral::addDescription

(

)

Definition at line 126 of file class.ilMDGeneral.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_general');

        return $des;
    }

Here is the call graph for this function:

addIdentifier()

ilMDGeneral::addIdentifier

(

)

Definition at line 70 of file class.ilMDGeneral.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_general');

        return $ide;
    }

Here is the call graph for this function:

addKeyword()

ilMDGeneral::addKeyword

(

)

Definition at line 154 of file class.ilMDGeneral.php.

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

Referenced by ilMDKeyword\updateKeywords().

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

        return $key;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addLanguage()

ilMDGeneral::addLanguage

(

)

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

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

                                 : ilMDLanguage
    {
        $lan = new ilMDLanguage($this->getRBACId(), $this->getObjId(), $this->getObjType());
        $lan->setParentId($this->getMetaId());
        $lan->setParentType('meta_general');

        return $lan;
    }

Here is the call graph for this function:

delete()

ilMDGeneral::delete

(

)

Definition at line 260 of file class.ilMDGeneral.php.

References $id, ILIAS\LTI\ToolProvider\$key, $query, $res, getDescription(), getDescriptionIds(), getIdentifier(), getIdentifierIds(), getKeyword(), getKeywordIds(), getLanguage(), getLanguageIds(), and ilMDBase\getMetaId().

                            : bool
    {
        if (!$this->getMetaId()) {
            return false;
        }
        // Identifier
        foreach ($this->getIdentifierIds() as $id) {
            $ide = $this->getIdentifier($id);
            $ide->delete();
        }

        // Language
        foreach ($this->getLanguageIds() as $id) {
            $lan = $this->getLanguage($id);
            $lan->delete();
        }

        // Description
        foreach ($this->getDescriptionIds() as $id) {
            $des = $this->getDescription($id);
            $des->delete();
        }

        // Keyword
        foreach ($this->getKeywordIds() as $id) {
            $key = $this->getKeyword($id);
            $key->delete();
        }

        if ($this->getMetaId()) {
            $query = "DELETE FROM il_meta_general " .
                "WHERE meta_general_id = " . $this->db->quote($this->getMetaId(), 'integer');
            $res = $this->db->manipulate($query);
            return true;
        }

        return false;
    }

Here is the call graph for this function:

getCoverage()

ilMDGeneral::getCoverage

(

)

Definition at line 215 of file class.ilMDGeneral.php.

References $coverage.

Referenced by __getFields(), and toXML().

                                 : string
    {
        return $this->coverage;
    }

Here is the caller graph for this function:

getCoverageLanguage()

ilMDGeneral::getCoverageLanguage

(

)

Definition at line 225 of file class.ilMDGeneral.php.

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

getCoverageLanguageCode()

ilMDGeneral::getCoverageLanguageCode

(

)

Definition at line 230 of file class.ilMDGeneral.php.

Referenced by __getFields(), and toXML().

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

Here is the caller graph for this function:

getDescription()

ilMDGeneral::getDescription

(

int

$a_description_id

)

Definition at line 115 of file class.ilMDGeneral.php.

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()

ilMDGeneral::getDescriptionIds

(

)

Returns

int[]

Definition at line 110 of file class.ilMDGeneral.php.

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

Referenced by delete(), and toXML().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getIdentifier()

ilMDGeneral::getIdentifier

(

int

$a_identifier_id

)

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

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:

getIdentifierIds()

ilMDGeneral::getIdentifierIds

(

)

Returns

int[]

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

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

Referenced by delete(), and toXML().

                                      : array
    {
        return ilMDIdentifier::_getIds($this->getRBACId(), $this->getObjId(), (int) $this->getMetaId(), 'meta_general');
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getKeyword()

ilMDGeneral::getKeyword

(

int

$a_keyword_id

)

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

References ILIAS\LTI\ToolProvider\$key.

Referenced by delete(), toXML(), and ilMDKeyword\updateKeywords().

                                                 : ?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()

ilMDGeneral::getKeywordIds

(

)

Returns

int[]

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

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

Referenced by delete(), toXML(), and ilMDKeyword\updateKeywords().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getLanguage()

ilMDGeneral::getLanguage

(

int

$a_language_id

)

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

Referenced by delete(), and toXML().

                                                   : ?ilMDLanguage
    {
        if (!$a_language_id) {
            return null;
        }
        $lan = new ilMDLanguage();
        $lan->setMetaId($a_language_id);

        return $lan;
    }

Here is the caller graph for this function:

getLanguageIds()

ilMDGeneral::getLanguageIds

(

)

Returns

int[]

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

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

Referenced by delete(), and toXML().

                                    : array
    {
        return ilMDLanguage::_getIds($this->getRBACId(), $this->getObjId(), (int) $this->getMetaId(), 'meta_general');
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getPossibleSubelements()

ilMDGeneral::getPossibleSubelements

(

)

Returns

array<string, string>

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

                                            : array
    {
        $subs['Keyword'] = 'meta_keyword';
        $subs['Language'] = 'meta_language';
        $subs['Identifier'] = 'meta_identifier';
        $subs['Description'] = 'meta_description';

        return $subs;
    }

getStructure()

ilMDGeneral::getStructure

(

)

Definition at line 180 of file class.ilMDGeneral.php.

References $structure.

Referenced by __getFields(), and toXML().

                                  : string
    {
        return $this->structure;
    }

Here is the caller graph for this function:

getTitle()

ilMDGeneral::getTitle

(

)

Definition at line 190 of file class.ilMDGeneral.php.

References $title.

Referenced by __getFields(), and toXML().

                              : string
    {
        return $this->title;
    }

Here is the caller graph for this function:

getTitleLanguage()

ilMDGeneral::getTitleLanguage

(

)

Definition at line 200 of file class.ilMDGeneral.php.

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

getTitleLanguageCode()

ilMDGeneral::getTitleLanguageCode

(

)

Definition at line 205 of file class.ilMDGeneral.php.

Referenced by __getFields(), and toXML().

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

Here is the caller graph for this function:

read()

ilMDGeneral::read

(

)

Definition at line 316 of file class.ilMDGeneral.php.

References $query, $res, ilDBConstants\FETCHMODE_OBJECT, ilMDBase\getMetaId(), setCoverage(), setCoverageLanguage(), ilMDBase\setObjId(), ilMDBase\setObjType(), ilMDBase\setRBACId(), setStructure(), setTitle(), and setTitleLanguage().

                          : bool
    {
        if ($this->getMetaId()) {
            $query = "SELECT * FROM il_meta_general " .
                "WHERE meta_general_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((string) $row->obj_type);
                $this->setStructure((string) $row->general_structure);
                $this->setTitle((string) $row->title);
                $this->setTitleLanguage(new ilMDLanguageItem($row->title_language ?? ''));
                $this->setCoverage((string) $row->coverage);
                $this->setCoverageLanguage(new ilMDLanguageItem($row->coverage_language ?? ''));
            }
        }
        return true;
    }

Here is the call graph for this function:

save()

ilMDGeneral::save

(

)

Definition at line 235 of file class.ilMDGeneral.php.

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

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

        $this->log->debug("Insert General " . print_r($fields, true));
        $this->log->logStack(ilLogLevel::DEBUG);
        //ilUtil::printBacktrace(10);

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

Here is the call graph for this function:

setCoverage()

ilMDGeneral::setCoverage

(

string

$a_coverage

)

Definition at line 210 of file class.ilMDGeneral.php.

Referenced by read().

                                                   : void
    {
        $this->coverage = $a_coverage;
    }

Here is the caller graph for this function:

setCoverageLanguage()

ilMDGeneral::setCoverageLanguage

(

ilMDLanguageItem

$lng_obj

)

Definition at line 220 of file class.ilMDGeneral.php.

Referenced by read().

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

Here is the caller graph for this function:

setStructure()

ilMDGeneral::setStructure

(

string

$a_structure

)

Definition at line 164 of file class.ilMDGeneral.php.

Referenced by read().

                                                     : bool
    {
        switch ($a_structure) {
            case 'Atomic':
            case 'Collection':
            case 'Networked':
            case 'Hierarchical':
            case 'Linear':
                $this->structure = $a_structure;
                return true;

            default:
                return false;
        }
    }

Here is the caller graph for this function:

setTitle()

ilMDGeneral::setTitle

(

string

$a_title

)

Definition at line 185 of file class.ilMDGeneral.php.

Referenced by read().

                                             : void
    {
        $this->title = $a_title;
    }

Here is the caller graph for this function:

setTitleLanguage()

ilMDGeneral::setTitleLanguage

(

ilMDLanguageItem

$lng_obj

)

Definition at line 195 of file class.ilMDGeneral.php.

Referenced by read().

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

Here is the caller graph for this function:

toXML()

ilMDGeneral::toXML

(

ilXmlWriter

$writer

)

Definition at line 337 of file class.ilMDGeneral.php.

References $id, ILIAS\LTI\ToolProvider\$key, getCoverage(), getCoverageLanguageCode(), getDescription(), getDescriptionIds(), ilMDBase\getExportMode(), getIdentifier(), getIdentifierIds(), getKeyword(), getKeywordIds(), getLanguage(), getLanguageIds(), ilMDBase\getObjId(), ilMDBase\getObjType(), ilMDBase\getRBACId(), getStructure(), getTitle(), getTitleLanguageCode(), ilXmlWriter\xmlElement(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

                                              : void
    {
        $writer->xmlStartTag('General', array(
            'Structure' => $this->getStructure() ?: 'Atomic'
        ));

        // Identifier
        $first = true;
        $identifiers = $this->getIdentifierIds();
        foreach ($identifiers as $id) {
            $ide = $this->getIdentifier($id);
            $ide->setExportMode($this->getExportMode());
            $ide->toXML($writer);
            $first = false;
        }
        if (!count($identifiers)) {
            $ide = new ilMDIdentifier(
                $this->getRBACId(),
                $this->getObjId(),
                $this->getObjType()
            );        // added type, alex, 31 Oct 2007
            $ide->setExportMode(true);
            $ide->toXML($writer);
        }

        // Title
        $writer->xmlElement(
            'Title',
            array(
                'Language' => $this->getTitleLanguageCode() ?: 'en'
            ),
            $this->getTitle()
        );

        // Language
        $languages = $this->getLanguageIds();
        foreach ($languages as $id) {
            $lan = $this->getLanguage($id);
            $lan->toXML($writer);
        }

        // Description
        $descriptions = $this->getDescriptionIds();
        foreach ($descriptions as $id) {
            $des = $this->getDescription($id);
            $des->toXML($writer);
        }
        if (!count($descriptions)) {
            // Default

            $des = new ilMDDescription($this->getRBACId(), $this->getObjId());
            $des->toXML($writer);
        }

        // Keyword
        $keywords = $this->getKeywordIds();
        foreach ($keywords as $id) {
            $key = $this->getKeyword($id);
            $key->toXML($writer);
        }
        if (!count($keywords)) {
            // Default

            $key = new ilMDKeyword($this->getRBACId(), $this->getObjId());
            $key->toXML($writer);
        }

        // Copverage
        if ($this->getCoverage() !== '') {
            $writer->xmlElement(
                'Coverage',
                array(
                    'Language' => $this->getCoverageLanguageCode() ?: 'en'
                ),
                $this->getCoverage()
            );
        }
        $writer->xmlEndTag('General');
    }

Here is the call graph for this function:

update()

ilMDGeneral::update

(

)

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

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

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

Here is the call graph for this function:

Field Documentation

$coverage

string ilMDGeneral::$coverage = ''

private

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

Referenced by getCoverage().

$coverage_language

ilMDLanguageItem ilMDGeneral::$coverage_language = null

protected

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

$structure

string ilMDGeneral::$structure = ''

private

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

Referenced by getStructure().

$title

string ilMDGeneral::$title = ''

private

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

Referenced by getTitle().

$title_language

ilMDLanguageItem ilMDGeneral::$title_language = null

private

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

---

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

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