ilMDTaxon Class Reference

Inheritance diagram for ilMDTaxon:

Collaboration diagram for ilMDTaxon:

Public Member Functions
	setTaxon (string $a_taxon)
	getTaxon ()
	setTaxonLanguage (ilMDLanguageItem $lng_obj)
	getTaxonLanguage ()
	getTaxonLanguageCode ()
	setTaxonId (string $a_taxon_id)
	getTaxonId ()
	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	$taxon = ''
ilMDLanguageItem	$taxon_language = null
string	$taxon_id = ''

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

Detailed Description

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

Member Function Documentation

__getFields()

ilMDTaxon::__getFields

(

)

Returns

array<string, array<string, mixed>>

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

References ilMDBase\getObjId(), ilMDBase\getObjType(), ilMDBase\getParentId(), ilMDBase\getParentType(), ilMDBase\getRBACId(), getTaxon(), getTaxonId(), and getTaxonLanguageCode().

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()),
            'taxon' => array('text', $this->getTaxon()),
            'taxon_language' => array('text', $this->getTaxonLanguageCode()),
            'taxon_id' => array('text', $this->getTaxonId())
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_getIds()

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

static

Returns

int[]

Definition at line 159 of file class.ilMDTaxon.php.

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

Referenced by ilMDTaxonPath\getTaxonIds().

                                                                                                          : array
    {
        global $DIC;

        $ilDB = $DIC->database();

        $query = "SELECT meta_taxon_id FROM il_meta_taxon " .
            "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_id;
        }
        return $ids;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

delete()

ilMDTaxon::delete

(

)

Definition at line 90 of file class.ilMDTaxon.php.

References ilMDBase\getMetaId().

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

            $this->db->query($query);

            return true;
        }
        return false;
    }

Here is the call graph for this function:

getTaxon()

ilMDTaxon::getTaxon

(

)

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

References $taxon.

Referenced by __getFields(), and toXML().

                              : string
    {
        return $this->taxon;
    }

Here is the caller graph for this function:

getTaxonId()

ilMDTaxon::getTaxonId

(

)

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

References $taxon_id.

Referenced by __getFields(), and toXML().

                                : string
    {
        return $this->taxon_id;
    }

Here is the caller graph for this function:

getTaxonLanguage()

ilMDTaxon::getTaxonLanguage

(

)

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

References null.

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

getTaxonLanguageCode()

ilMDTaxon::getTaxonLanguageCode

(

)

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

Referenced by __getFields(), and toXML().

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

Here is the caller graph for this function:

read()

ilMDTaxon::read

(

)

Definition at line 120 of file class.ilMDTaxon.php.

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

                          : bool
    {
        if ($this->getMetaId()) {
            $query = "SELECT * FROM il_meta_taxon " .
                "WHERE meta_taxon_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->setTaxon($row->taxon ?? '');
                $this->taxon_language = new ilMDLanguageItem($row->taxon_language ?? '');
                $this->setTaxonId($row->taxon_id ?? '');
            }
        }
        return true;
    }

Here is the call graph for this function:

save()

ilMDTaxon::save

(

)

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

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

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

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

Here is the call graph for this function:

setTaxon()

ilMDTaxon::setTaxon

(

string

$a_taxon

)

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

Referenced by read().

                                             : void
    {
        $this->taxon = $a_taxon;
    }

Here is the caller graph for this function:

setTaxonId()

ilMDTaxon::setTaxonId

(

string

$a_taxon_id

)

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

Referenced by read().

                                                  : void
    {
        $this->taxon_id = $a_taxon_id;
    }

Here is the caller graph for this function:

setTaxonLanguage()

ilMDTaxon::setTaxonLanguage

(

ilMDLanguageItem

$lng_obj

)

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

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

toXML()

ilMDTaxon::toXML

(

ilXmlWriter

$writer

)

Definition at line 141 of file class.ilMDTaxon.php.

References getTaxon(), getTaxonId(), getTaxonLanguageCode(), and ilXmlWriter\xmlElement().

                                              : void
    {
        $random = new \Random\Randomizer();
        $writer->xmlElement(
            'Taxon',
            array(
                'Language' => $this->getTaxonLanguageCode() ?: 'en',
                'Id' => $this->getTaxonId() ?: ("ID" . $random->nextInt())
            ),
            $this->getTaxon()
        );
    }

Here is the call graph for this function:

update()

ilMDTaxon::update

(

)

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

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

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

Here is the call graph for this function:

Field Documentation

$taxon

string ilMDTaxon::$taxon = ''

private

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

Referenced by getTaxon().

$taxon_id

string ilMDTaxon::$taxon_id = ''

private

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

Referenced by getTaxonId().

$taxon_language

ilMDLanguageItem ilMDTaxon::$taxon_language = null

private

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

---

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

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