Inheritance diagram for ilMDRights:

Collaboration diagram for ilMDRights:

Public Member Functions
	setCosts (string $a_costs)

	getCosts ()

	setCopyrightAndOtherRestrictions (string $a_caor)

	getCopyrightAndOtherRestrictions ()

	setDescription (string $a_description)

	getDescription ()

	setDescriptionLanguage (ilMDLanguageItem $lng_obj)

	getDescriptionLanguage ()

	getDescriptionLanguageCode ()

	save ()

	update ()

	delete ()

	__getFields ()

	read ()

	toXML (ilXmlWriter $writer)

	parseDescriptionFromImport (string $a_description)

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	lookupRightsByTypeAndCopyright (array $a_types, array $a_copyright)

static	_lookupDescription (int $a_rbac_id, int $a_obj_id)

static	_getId (int $a_rbac_id, int $a_obj_id)

Private Attributes
string	$costs = ''

string	$caor = ''

string	$description = ''

ilMDLanguageItem	$description_language = null

Additional Inherited Members
Protected Attributes inherited from ilMDBase
ilLogger	$log

ilDBInterface	$db

Detailed Description

Definition at line 25 of file class.ilMDRights.php.

Member Function Documentation

◆ __getFields()

ilMDRights::__getFields ( )

Returns: array<string, array<string, mixed>>

Definition at line 156 of file class.ilMDRights.php.

                                 : array
    {
        return array(
            'rbac_id' => array('integer', $this->getRBACId()),
            'obj_id' => array('integer', $this->getObjId()),
            'obj_type' => array('text', $this->getObjType()),
            'costs' => array('text', $this->getCosts()),
            'cpr_and_or' => array('text', $this->getCopyrightAndOtherRestrictions()),
            'description' => array('text', $this->getDescription()),
            'description_language' => array('text', $this->getDescriptionLanguageCode())
        );
    }

References getCopyrightAndOtherRestrictions(), getCosts(), getDescription(), getDescriptionLanguageCode(), ilMDBase\getObjId(), ilMDBase\getObjType(), and ilMDBase\getRBACId().

Referenced by save(), and update().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _getId()

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

static

Definition at line 236 of file class.ilMDRights.php.

                                                                : int
    {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        $query = "SELECT meta_rights_id FROM il_meta_rights " .
            "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_rights_id;
        }
        return 0;
    }

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

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

Here is the caller graph for this function:

◆ _lookupDescription()

static ilMDRights::_lookupDescription	(	int	$a_rbac_id,
		int	$a_obj_id
	)

static

Definition at line 217 of file class.ilMDRights.php.

                                                                            : string
    {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        $query = "SELECT description FROM il_meta_rights " .
            "WHERE rbac_id = " . $ilDB->quote($a_rbac_id, 'integer') . " " .
            "AND obj_id = " . $ilDB->quote($a_obj_id, 'integer') . " ";
        $res = $ilDB->query($query);
        $row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT);
 
        if (isset($row) && isset($row->description)) {
            return $row->description;
        }
        return '';
    }

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

Referenced by ilOerHarvester\deleteDeprecated(), ilMDCopyrightSelectionGUI\fillTemplate(), and ilMDEditorGUI\listQuickEditCopyright().

Here is the caller graph for this function:

◆ delete()

ilMDRights::delete ( )

Reimplemented from ilMDBase.

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

                            : bool
    {
        if ($this->getMetaId()) {
            $query = "DELETE FROM il_meta_rights " .
                "WHERE meta_rights_id = " . $this->db->quote($this->getMetaId(), 'integer');
 
            $this->db->query($query);
 
            return true;
        }
        return false;
    }

References $query, and ilMDBase\getMetaId().

Here is the call graph for this function:

◆ getCopyrightAndOtherRestrictions()

ilMDRights::getCopyrightAndOtherRestrictions ( )

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

                                                      : string
    {
        return $this->caor;
    }

References $caor.

Referenced by __getFields(), and toXML().

Here is the caller graph for this function:

◆ getCosts()

ilMDRights::getCosts ( )

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

                              : string
    {
        return $this->costs;
    }

References $costs.

Referenced by __getFields(), and toXML().

Here is the caller graph for this function:

◆ getDescription()

ilMDRights::getDescription ( )

Definition at line 99 of file class.ilMDRights.php.

                                    : string
    {
        return $this->description;
    }

References $description.

Referenced by __getFields(), and toXML().

Here is the caller graph for this function:

◆ getDescriptionLanguage()

ilMDRights::getDescriptionLanguage ( )

Definition at line 109 of file class.ilMDRights.php.

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

◆ getDescriptionLanguageCode()

ilMDRights::getDescriptionLanguageCode ( )

Definition at line 114 of file class.ilMDRights.php.

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

Referenced by __getFields(), and toXML().

Here is the caller graph for this function:

◆ lookupRightsByTypeAndCopyright()

static ilMDRights::lookupRightsByTypeAndCopyright	(	array	$a_types,
		array	$a_copyright
	)

static

Parameters

string[]	$a_types
string[]	$a_copyright

Returns: int[]

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

                                                                                             : array
    {
        global $DIC;
 
        $db = $DIC->database();
 
        $query = 'SELECT rbac_id FROM il_meta_rights ' .
            'WHERE ' . $db->in('obj_type', $a_types, false, 'text') . ' ' .
            'AND ' . $db->in('description', $a_copyright, false, 'text');
        $res = $db->query($query);
 
        ilLoggerFactory::getLogger('meta')->info($query);
 
        $obj_ids = [];
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $obj_ids[] = (int) $row->rbac_id;
        }
        return $obj_ids;
    }

References ilMDBase\$db, $DIC, $query, $res, ilDBConstants\FETCHMODE_OBJECT, ilLoggerFactory\getLogger(), ilDBInterface\in(), ILIAS\Repository\int(), and ilDBInterface\query().

Referenced by ilOerHarvester\collect().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parseDescriptionFromImport()

ilMDRights::parseDescriptionFromImport ( string $a_description )

Definition at line 207 of file class.ilMDRights.php.

                                                                     : void
    {
        $entry_id = ilMDCopyrightSelectionEntry::lookupCopyrightFromImport($a_description);
        if (!$entry_id) {
            $this->setDescription($a_description);
        } else {
            $this->setDescription(ilMDCopyrightSelectionEntry::createIdentifier($entry_id));
        }
    }

References ilMDCopyrightSelectionEntry\createIdentifier(), ilMDCopyrightSelectionEntry\lookupCopyrightFromImport(), and setDescription().

Here is the call graph for this function:

◆ read()

ilMDRights::read ( )

Reimplemented from ilMDBase.

Definition at line 169 of file class.ilMDRights.php.

                          : bool
    {
        if ($this->getMetaId()) {
            $query = "SELECT * FROM il_meta_rights " .
                "WHERE meta_rights_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->setDescription((string) $row->description);
                $this->setDescriptionLanguage(new ilMDLanguageItem((string) $row->description_language));
                $this->setCosts((string) $row->costs);
                $this->setCopyrightAndOtherRestrictions((string) $row->cpr_and_or);
            }
            return true;
        }
        return false;
    }

References $query, $res, ilDBConstants\FETCHMODE_OBJECT, ilMDBase\getMetaId(), setCopyrightAndOtherRestrictions(), setCosts(), setDescription(), setDescriptionLanguage(), ilMDBase\setObjId(), ilMDBase\setObjType(), and ilMDBase\setRBACId().

Here is the call graph for this function:

◆ save()

ilMDRights::save ( )

Reimplemented from ilMDBase.

Definition at line 119 of file class.ilMDRights.php.

                          : int
    {
        $fields = $this->__getFields();
        $fields['meta_rights_id'] = array('integer', $next_id = $this->db->nextId('il_meta_rights'));
 
        if ($this->db->insert('il_meta_rights', $fields)) {
            $this->setMetaId($next_id);
            return $this->getMetaId();
        }
        return 0;
    }

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

Here is the call graph for this function:

◆ setCopyrightAndOtherRestrictions()

ilMDRights::setCopyrightAndOtherRestrictions ( string $a_caor )

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

                                                                    : bool
    {
        switch ($a_caor) {
            case 'Yes':
            case 'No':
                $this->caor = $a_caor;
                return true;
 
            default:
                return false;
        }
    }

Referenced by read().

Here is the caller graph for this function:

◆ setCosts()

ilMDRights::setCosts ( string $a_costs )

Definition at line 58 of file class.ilMDRights.php.

                                             : bool
    {
        switch ($a_costs) {
            case 'Yes':
            case 'No':
                $this->costs = $a_costs;
                return true;
 
            default:
                return false;
        }
    }

Referenced by read().

Here is the caller graph for this function:

◆ setDescription()

ilMDRights::setDescription ( string $a_description )

Definition at line 94 of file class.ilMDRights.php.

                                                         : void
    {
        $this->description = $a_description;
    }

Referenced by parseDescriptionFromImport(), and read().

Here is the caller graph for this function:

◆ setDescriptionLanguage()

ilMDRights::setDescriptionLanguage ( ilMDLanguageItem $lng_obj )

Definition at line 104 of file class.ilMDRights.php.

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

Referenced by read().

Here is the caller graph for this function:

◆ toXML()

ilMDRights::toXML ( ilXmlWriter $writer )

Reimplemented from ilMDBase.

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

                                              : void
    {
        $writer->xmlStartTag('Rights', array(
            'Cost' => $this->getCosts() ?: 'No',
            'CopyrightAndOtherRestrictions' => $this->getCopyrightAndOtherRestrictions() ?: 'No'
        ));
 
        $writer->xmlElement(
            'Description',
            [
                'Language' => $this->getDescriptionLanguageCode() ?: 'en'
            ],
            ilMDCopyrightSelectionEntry::_lookupCopyrightForExport($this->getDescription())
        );
        $writer->xmlEndTag('Rights');
    }

References ilMDCopyrightSelectionEntry\_lookupCopyrightForExport(), getCopyrightAndOtherRestrictions(), getCosts(), getDescription(), getDescriptionLanguageCode(), ilXmlWriter\xmlElement(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

Here is the call graph for this function:

◆ update()

ilMDRights::update ( )

Reimplemented from ilMDBase.

Definition at line 131 of file class.ilMDRights.php.

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

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

Here is the call graph for this function:

Field Documentation

◆ $caor

string ilMDRights::$caor = ''

private

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

Referenced by getCopyrightAndOtherRestrictions().

◆ $costs

string ilMDRights::$costs = ''

private

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

Referenced by getCosts().

◆ $description

string ilMDRights::$description = ''

private

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

Referenced by getDescription().

◆ $description_language

ilMDLanguageItem ilMDRights::$description_language = null

private

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

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

Services/MetaData/classes/class.ilMDRights.php

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ __getFields()

◆ _getId()

◆ _lookupDescription()

◆ delete()

◆ getCopyrightAndOtherRestrictions()

◆ getCosts()

◆ getDescription()

◆ getDescriptionLanguage()

◆ getDescriptionLanguageCode()

◆ lookupRightsByTypeAndCopyright()

◆ parseDescriptionFromImport()

◆ read()

◆ save()

◆ setCopyrightAndOtherRestrictions()

◆ setCosts()

◆ setDescription()

◆ setDescriptionLanguage()

◆ toXML()

◆ update()

Field Documentation

◆ $caor

◆ $costs

◆ $description

◆ $description_language