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
const	YES_NO_TRANSLATION
	Compatibility fix for legacy MD classes for new db tables. More...

const 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 26 of file class.ilMDRights.php.

Member Function Documentation

◆ __getFields()

ilMDRights::__getFields ( )

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

Compatibility fix for legacy MD classes for new db tables

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

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

Referenced by save(), and update().

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

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 267 of file class.ilMDRights.php.

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

Referenced by ilMD\getRights().

                                                                 : 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;
     }

Here is the caller graph for this function:

◆ _lookupDescription()

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

static

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

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

Referenced by ilOerHarvester\deleteDeprecated().

                                                                             : 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 '';
     }

Here is the caller graph for this function:

◆ delete()

ilMDRights::delete ( )

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

References ilMDBase\getMetaId().

                             : 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;
     }

Here is the call graph for this function:

◆ getCopyrightAndOtherRestrictions()

ilMDRights::getCopyrightAndOtherRestrictions ( )

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

References $caor.

Referenced by __getFields(), and toXML().

                                                       : string
     {
         return $this->caor;
     }

Here is the caller graph for this function:

◆ getCosts()

ilMDRights::getCosts ( )

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

References $costs.

Referenced by __getFields(), and toXML().

                               : string
     {
         return $this->costs;
     }

Here is the caller graph for this function:

◆ getDescription()

ilMDRights::getDescription ( )

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

References $description.

Referenced by __getFields(), and toXML().

                                     : string
     {
         return $this->description;
     }

Here is the caller graph for this function:

◆ getDescriptionLanguage()

ilMDRights::getDescriptionLanguage ( )

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

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

◆ getDescriptionLanguageCode()

ilMDRights::getDescriptionLanguageCode ( )

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

Referenced by __getFields(), and toXML().

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

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 46 of file class.ilMDRights.php.

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

Referenced by ilOerHarvester\collect().

                                                                                              : 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;
     }

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 238 of file class.ilMDRights.php.

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

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

Here is the call graph for this function:

◆ read()

ilMDRights::read ( )

Compatibility fix for legacy MD classes for new db tables

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

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

                           : 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)) {
                 if (key_exists($row->costs ?? '', self::YES_NO_TRANSLATION)) {
                     $row->costs = self::YES_NO_TRANSLATION[$row->costs ?? ''];
                 }
                 if (key_exists($row->cpr_and_or ?? '', self::YES_NO_TRANSLATION)) {
                     $row->cpr_and_or = self::YES_NO_TRANSLATION[$row->cpr_and_or ?? ''];
                 }
 
                 $this->setRBACId((int) $row->rbac_id);
                 $this->setObjId((int) $row->obj_id);
                 $this->setObjType($row->obj_type ?? '');
                 $this->setDescription($row->description ?? '');
                 $this->setDescriptionLanguage(new ilMDLanguageItem($row->description_language ?? ''));
                 $this->setCosts($row->costs ?? '');
                 $this->setCopyrightAndOtherRestrictions($row->cpr_and_or ?? '');
             }
             return true;
         }
         return false;
     }

Here is the call graph for this function:

◆ save()

ilMDRights::save ( )

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

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

                           : 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;
     }

Here is the call graph for this function:

◆ setCopyrightAndOtherRestrictions()

ilMDRights::setCopyrightAndOtherRestrictions ( string $a_caor )

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

Referenced by read().

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

Here is the caller graph for this function:

◆ setCosts()

ilMDRights::setCosts ( string $a_costs )

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

Referenced by read().

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

Here is the caller graph for this function:

◆ setDescription()

ilMDRights::setDescription ( string $a_description )

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

Referenced by parseDescriptionFromImport(), and read().

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

Here is the caller graph for this function:

◆ setDescriptionLanguage()

ilMDRights::setDescriptionLanguage ( ilMDLanguageItem $lng_obj )

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

Referenced by read().

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

Here is the caller graph for this function:

◆ toXML()

ilMDRights::toXML ( ilXmlWriter $writer )

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

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

                                               : 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');
     }

Here is the call graph for this function:

◆ update()

ilMDRights::update ( )

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

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

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

Here is the call graph for this function:

Field Documentation

◆ $caor

string ilMDRights::$caor = ''

private

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

Referenced by getCopyrightAndOtherRestrictions().

◆ $costs

const string ilMDRights::$costs = ''

private

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

Referenced by getCosts().

◆ $description

string ilMDRights::$description = ''

private

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

Referenced by getDescription().

◆ $description_language

ilMDLanguageItem ilMDRights::$description_language = null

private

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

◆ YES_NO_TRANSLATION

const ilMDRights::YES_NO_TRANSLATION

private

Initial value:

= [

'yes' => 'Yes'

Compatibility fix for legacy MD classes for new db tables.

Definition at line 31 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

◆ YES_NO_TRANSLATION