ilMDContribute Class Reference

Inheritance diagram for ilMDContribute:

Collaboration diagram for ilMDContribute:

Public Member Functions
	getEntityIds ()
	getEntity (int $a_entity_id)
	addEntity ()
	setRole (string $a_role)
	getRole ()
	setDate (string $a_date)
	getDate ()
	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)
static	_lookupAuthors (int $a_rbac_id, int $a_obj_id, string $a_obj_type)

Private Attributes
const	ROLE_TRANSLATION
	Compatibility fix for legacy MD classes for new db tables. More...
const string	$date = ''
string	$role = ''

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

Detailed Description

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

Member Function Documentation

__getFields()

ilMDContribute::__getFields

(

)

Returns

array<string, array<string, mixed>>

Compatibility fix for legacy MD classes for new db tables

Definition at line 168 of file class.ilMDContribute.php.

References getDate(), ilMDBase\getObjId(), ilMDBase\getObjType(), ilMDBase\getParentId(), ilMDBase\getParentType(), ilMDBase\getRBACId(), and getRole().

Referenced by save(), and update().

                                 : array
    {
        $role = (string) array_search(
            $this->getRole(),
            self::ROLE_TRANSLATION
        );

        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()),
            'role' => array('text', $role),
            'c_date' => array('text', $this->getDate())
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_getIds()

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

static

Returns

int[]

Definition at line 242 of file class.ilMDContribute.php.

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

Referenced by ilMDLifecycle\getContributeIds(), and ilMDMetaMetadata\getContributeIds().

                                                                                                          : array
    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        $query = "SELECT meta_contribute_id FROM il_meta_contribute " .
            "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_contribute_id;
        }
        return $ids;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_lookupAuthors()

static ilMDContribute::_lookupAuthors ( int  $a_rbac_id, int  $a_obj_id, string  $a_obj_type  )

static

Returns

string[]

Definition at line 265 of file class.ilMDContribute.php.

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

Referenced by ilMDUtils\_fillHTMLMetaTags().

                                                                                            : array
    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        // Ask for 'author' later to use indexes
        $authors = [];
        $query = "SELECT entity,ent.parent_type,role FROM il_meta_entity ent " .
            "JOIN il_meta_contribute con ON ent.parent_id = con.meta_contribute_id " .
            "WHERE  ent.rbac_id = " . $ilDB->quote($a_rbac_id, 'integer') . " " .
            "AND ent.obj_id = " . $ilDB->quote($a_obj_id, 'integer') . " ";
        $res = $ilDB->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            if ($row->role === 'Author' && $row->parent_type === 'meta_contribute') {
                $authors[] = trim($row->entity);
            }
        }
        return $authors;
    }

Here is the caller graph for this function:

addEntity()

ilMDContribute::addEntity

(

)

Definition at line 75 of file class.ilMDContribute.php.

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

                               : ilMDEntity
    {
        $ent = new ilMDEntity($this->getRBACId(), $this->getObjId(), $this->getObjType());
        $ent->setParentId($this->getMetaId());
        $ent->setParentType('meta_contribute');

        return $ent;
    }

Here is the call graph for this function:

delete()

ilMDContribute::delete

(

)

Definition at line 149 of file class.ilMDContribute.php.

References $id, $res, getEntity(), getEntityIds(), and ilMDBase\getMetaId().

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

            foreach ($this->getEntityIds() as $id) {
                $ent = $this->getEntity($id);
                $ent->delete();
            }
            return true;
        }
        return false;
    }

Here is the call graph for this function:

getDate()

ilMDContribute::getDate

(

)

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

References $date.

Referenced by __getFields(), and toXML().

                             : string
    {
        return $this->date;
    }

Here is the caller graph for this function:

getEntity()

ilMDContribute::getEntity

(

int

$a_entity_id

)

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

References null.

Referenced by delete(), and toXML().

                                               : ?ilMDEntity
    {
        if (!$a_entity_id) {
            return null;
        }
        $ent = new ilMDEntity();
        $ent->setMetaId($a_entity_id);

        return $ent;
    }

Here is the caller graph for this function:

getEntityIds()

ilMDContribute::getEntityIds

(

)

Returns

int[]

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

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

Referenced by delete(), and toXML().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getRole()

ilMDContribute::getRole

(

)

Definition at line 113 of file class.ilMDContribute.php.

References $role.

Referenced by __getFields(), and toXML().

                             : string
    {
        return $this->role;
    }

Here is the caller graph for this function:

read()

ilMDContribute::read

(

)

Compatibility fix for legacy MD classes for new db tables

Definition at line 189 of file class.ilMDContribute.php.

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

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

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

                $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->setRole($row->role ?? '');
                $this->setDate($row->c_date ?? '');
            }
        }
        return true;
    }

Here is the call graph for this function:

save()

ilMDContribute::save

(

)

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

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

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

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

Here is the call graph for this function:

setDate()

ilMDContribute::setDate

(

string

$a_date

)

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

Referenced by read().

                                           : void
    {
        $this->date = $a_date;
    }

Here is the caller graph for this function:

setRole()

ilMDContribute::setRole

(

string

$a_role

)

Definition at line 85 of file class.ilMDContribute.php.

Referenced by read().

                                           : bool
    {
        switch ($a_role) {
            case 'Author':
            case 'Publisher':
            case 'Unknown':
            case 'Initiator':
            case 'Terminator':
            case 'Editor':
            case 'GraphicalDesigner':
            case 'TechnicalImplementer':
            case 'ContentProvider':
            case 'TechnicalValidator':
            case 'EducationalValidator':
            case 'ScriptWriter':
            case 'InstructionalDesigner':
            case 'SubjectMatterExpert':
            case 'Creator':
            case 'Validator':
            case 'PointOfContact':
                $this->role = $a_role;
                return true;

            default:
                return false;
        }
    }

Here is the caller graph for this function:

toXML()

ilMDContribute::toXML

(

ilXmlWriter

$writer

)

Definition at line 216 of file class.ilMDContribute.php.

References $id, getDate(), getEntity(), getEntityIds(), ilMDBase\getObjId(), ilMDBase\getRBACId(), getRole(), null, ilXmlWriter\xmlElement(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

                                              : void
    {
        $writer->xmlStartTag('Contribute', array(
            'Role' => $this->getRole() ?: 'Author'
        ));

        // Entities
        $entities = $this->getEntityIds();
        foreach ($entities as $id) {
            $ent = $this->getEntity($id);
            $ent->toXML($writer);
        }
        if (!count($entities)) {
            $ent = new ilMDEntity($this->getRBACId(), $this->getObjId());
            $ent->toXML($writer);
        }

        $writer->xmlElement('Date', null, $this->getDate());
        $writer->xmlEndTag('Contribute');
    }

Here is the call graph for this function:

update()

ilMDContribute::update

(

)

Definition at line 140 of file class.ilMDContribute.php.

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

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

Here is the call graph for this function:

Field Documentation

$date

const string ilMDContribute::$date = ''

private

Definition at line 53 of file class.ilMDContribute.php.

Referenced by getDate().

$role

string ilMDContribute::$role = ''

private

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

Referenced by getRole().

ROLE_TRANSLATION

const ilMDContribute::ROLE_TRANSLATION

private

Initial value:

= [
        'author' => 'Author'

Compatibility fix for legacy MD classes for new db tables.

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

---

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

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