ilMDFormat Class Reference

Inheritance diagram for ilMDFormat:

Collaboration diagram for ilMDFormat:

Public Member Functions
	setFormat (string $a_format)
	getFormat ()
	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
string	$format = ''

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

Detailed Description

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

Member Function Documentation

__getFields()

ilMDFormat::__getFields

(

)

Returns

array<string, array<string, mixed>>

Definition at line 79 of file class.ilMDFormat.php.

References getFormat(), ilMDBase\getObjId(), ilMDBase\getObjType(), 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()),
            'format' => array('text', $this->getFormat())
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_getIds()

static ilMDFormat::_getIds ( int  $a_rbac_id, int  $a_obj_id  )

static

Returns

int[]

Definition at line 118 of file class.ilMDFormat.php.

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

Referenced by ilMDTechnical\getFormatIds().

                                                                 : array
    {
        global $DIC;

        $ilDB = $DIC->database();

        $query = "SELECT meta_format_id FROM il_meta_format " .
            "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_format_id;
        }
        return $ids;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

delete()

ilMDFormat::delete

(

)

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

References $res, and ilMDBase\getMetaId().

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

            return true;
        }
        return false;
    }

Here is the call graph for this function:

getFormat()

ilMDFormat::getFormat

(

)

Definition at line 38 of file class.ilMDFormat.php.

References $format.

Referenced by __getFields(), and toXML().

                               : string
    {
        return $this->format;
    }

Here is the caller graph for this function:

read()

ilMDFormat::read

(

)

Definition at line 89 of file class.ilMDFormat.php.

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

                          : bool
    {
        if ($this->getMetaId()) {
            $query = "SELECT * FROM il_meta_format " .
                "WHERE meta_format_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->setFormat($row->format ?? '');
            }
        }
        return true;
    }

Here is the call graph for this function:

save()

ilMDFormat::save

(

)

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

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

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

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

Here is the call graph for this function:

setFormat()

ilMDFormat::setFormat

(

string

$a_format

)

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

Referenced by read().

                                               : void
    {
        $this->format = $a_format;
    }

Here is the caller graph for this function:

toXML()

ilMDFormat::toXML

(

ilXmlWriter

$writer

)

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

References getFormat(), null, and ilXmlWriter\xmlElement().

                                              : void
    {
        if ($this->getFormat()) {
            $writer->xmlElement('Format', null, $this->getFormat());
        }
    }

Here is the call graph for this function:

update()

ilMDFormat::update

(

)

Definition at line 55 of file class.ilMDFormat.php.

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

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

Here is the call graph for this function:

Field Documentation

$format

string ilMDFormat::$format = ''

private

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

Referenced by getFormat().

---

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

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