ilMDTaxonPath Class Reference

Inheritance diagram for ilMDTaxonPath:

Collaboration diagram for ilMDTaxonPath:

Public Member Functions
	getTaxonIds ()
	getTaxon (int $a_taxon_id)
	addTaxon ()
	setSource (string $a_source)
	getSource ()
	setSourceLanguage (ilMDLanguageItem $lng_obj)
	getSourceLanguage ()
	getSourceLanguageCode ()
	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	$source = ''
ilMDLanguageItem	$source_language = null

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

Detailed Description

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

Member Function Documentation

__getFields()

ilMDTaxonPath::__getFields

(

)

Returns

array<string, array<string, mixed>>

Definition at line 132 of file class.ilMDTaxonPath.php.

References ilMDBase\getObjId(), ilMDBase\getObjType(), ilMDBase\getParentId(), ilMDBase\getParentType(), ilMDBase\getRBACId(), getSource(), and getSourceLanguageCode().

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()),
            'source' => array('text', $this->getSource()),
            'source_language' => array('text', $this->getSourceLanguageCode())
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_getIds()

static ilMDTaxonPath::_getIds ( int  $a_rbac_id, int  $a_obj_id, int  $a_parent_id, string  $a_parent_type  )

static

Returns

int[]

Definition at line 194 of file class.ilMDTaxonPath.php.

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

Referenced by ilMDClassification\getTaxonPathIds().

                                                                                                          : array
    {
        global $DIC;

        $ilDB = $DIC->database();

        $query = "SELECT meta_taxon_path_id FROM il_meta_taxon_path " .
            "WHERE rbac_id = " . $ilDB->quote($a_rbac_id, 'integer') . " " .
            "AND obj_id = " . $ilDB->quote($a_obj_id, 'integer') . " " .
            "AND parent_id = " . $ilDB->quote($a_parent_id, 'integer') . " " .
            "AND parent_type = " . $ilDB->quote($a_parent_type, 'text');

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

Here is the call graph for this function:

Here is the caller graph for this function:

addTaxon()

ilMDTaxonPath::addTaxon

(

)

Definition at line 56 of file class.ilMDTaxonPath.php.

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

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

        return $tax;
    }

Here is the call graph for this function:

delete()

ilMDTaxonPath::delete

(

)

Definition at line 112 of file class.ilMDTaxonPath.php.

References $id, $res, ilMDBase\getMetaId(), getTaxon(), and getTaxonIds().

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

            foreach ($this->getTaxonIds() as $id) {
                $tax = $this->getTaxon($id);
                $tax->delete();
            }

            return true;
        }
        return false;
    }

Here is the call graph for this function:

getSource()

ilMDTaxonPath::getSource

(

)

Definition at line 71 of file class.ilMDTaxonPath.php.

References $source.

Referenced by __getFields(), and toXML().

                               : string
    {
        return $this->source;
    }

Here is the caller graph for this function:

getSourceLanguage()

ilMDTaxonPath::getSourceLanguage

(

)

Definition at line 81 of file class.ilMDTaxonPath.php.

References null.

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

getSourceLanguageCode()

ilMDTaxonPath::getSourceLanguageCode

(

)

Definition at line 86 of file class.ilMDTaxonPath.php.

Referenced by __getFields(), and toXML().

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

Here is the caller graph for this function:

getTaxon()

ilMDTaxonPath::getTaxon

(

int

$a_taxon_id

)

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

References null.

Referenced by delete(), and toXML().

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

        return $tax;
    }

Here is the caller graph for this function:

getTaxonIds()

ilMDTaxonPath::getTaxonIds

(

)

Returns

int[]

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

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

Referenced by delete(), and toXML().

                                 : array
    {
        if (!$this->getMetaId()) {
            return [];
        }
        return ilMDTaxon::_getIds($this->getRBACId(), $this->getObjId(), $this->getMetaId(), 'meta_taxon_path');
    }

Here is the call graph for this function:

Here is the caller graph for this function:

read()

ilMDTaxonPath::read

(

)

Definition at line 145 of file class.ilMDTaxonPath.php.

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

                          : bool
    {
        if ($this->getMetaId()) {
            $query = "SELECT * FROM il_meta_taxon_path " .
                "WHERE meta_taxon_path_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->setSource($row->source ?? '');
                $this->source_language = new ilMDLanguageItem($row->source_language ?? '');
            }
        }
        return true;
    }

Here is the call graph for this function:

save()

ilMDTaxonPath::save

(

)

Definition at line 91 of file class.ilMDTaxonPath.php.

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

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

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

Here is the call graph for this function:

setSource()

ilMDTaxonPath::setSource

(

string

$a_source

)

Definition at line 66 of file class.ilMDTaxonPath.php.

Referenced by read().

                                               : void
    {
        $this->source = $a_source;
    }

Here is the caller graph for this function:

setSourceLanguage()

ilMDTaxonPath::setSourceLanguage

(

ilMDLanguageItem

$lng_obj

)

Definition at line 76 of file class.ilMDTaxonPath.php.

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

toXML()

ilMDTaxonPath::toXML

(

ilXmlWriter

$writer

)

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

References $id, ilMDBase\getObjId(), ilMDBase\getRBACId(), getSource(), getSourceLanguageCode(), getTaxon(), getTaxonIds(), ilXmlWriter\xmlElement(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

                                              : void
    {
        $writer->xmlStartTag('TaxonPath');

        $writer->xmlElement(
            'Source',
            array(
                'Language' => $this->getSourceLanguageCode() ?: 'en'
            ),
            $this->getSource()
        );

        // Taxon
        $taxs = $this->getTaxonIds();
        foreach ($taxs as $id) {
            $tax = $this->getTaxon($id);
            $tax->toXML($writer);
        }
        if (!count($taxs)) {
            $tax = new ilMDTaxon($this->getRBACId(), $this->getObjId());
            $tax->toXML($writer);
        }

        $writer->xmlEndTag('TaxonPath');
    }

Here is the call graph for this function:

update()

ilMDTaxonPath::update

(

)

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

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

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

Here is the call graph for this function:

Field Documentation

$source

string ilMDTaxonPath::$source = ''

private

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

Referenced by getSource().

$source_language

ilMDLanguageItem ilMDTaxonPath::$source_language = null

private

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

---

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

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