Collaboration diagram for ilMDCopyrightSelectionEntry:

Public Member Functions
	__construct (int $a_entry_id)

	getUsage ()

	getEntryId ()

	getIsDefault ()
	Get if the entry is default No setter for this. More...

	setOutdated (bool $a_value)

	getOutdated ()

	setTitle (string $a_title)

	getTitle ()

	setDescription (string $a_desc)

	getDescription ()

	setCopyright (string $a_copyright)

	getCopyright ()

	setOrderPosition (int $a_position)

	getOrderPosition ()

	add ()

	update ()

	delete ()

	validate ()

Static Public Member Functions
static	_getEntries ()

static	lookupCopyyrightTitle (string $a_cp_string)

static	_lookupCopyright (string $a_cp_string)

static	_lookupCopyrightForExport (string $a_cp_string)

static	lookupCopyrightFromImport (string $copyright_text)

static	_extractEntryId (string $a_cp_string)

static	isEntry ($a_cp_string)

static	getDefault ()

static	createIdentifier (int $a_entry_id)

Protected Member Functions
	getNextOrderPosition ()

Protected Attributes
ilLogger	$logger

ilDBInterface	$db

RendererInterface	$renderer

RepositoryInterface	$repository

UIRenderer	$ui_renderer

bool	$outdated = false

int	$order_position = 0

Private Member Functions
	read ()

Private Attributes
int	$entry_id

string	$title = ''

string	$description = ''

string	$copyright = ''

int	$usage = null

Detailed Description

Deprecated:: will be removed with ILIAS 11, please use the new API (see {

See also: ../docs/api.md})

Author: Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

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

Constructor & Destructor Documentation

◆ __construct()

ilMDCopyrightSelectionEntry::__construct ( int $a_entry_id )

Definition at line 52 of file class.ilMDCopyrightSelectionEntry.php.

References $DIC, ILIAS\Repository\logger(), read(), and ILIAS\UI\examples\Deck\repository().

     {
         global $DIC;
 
         $this->renderer = new Renderer(
             $DIC->ui()->factory(),
             $DIC->resourceStorage()
         );
         $this->repository = new DatabaseRepository(new Wrapper($DIC->database()));
         $this->ui_renderer = $DIC->ui()->renderer();
         $this->logger = $DIC->logger()->meta();
         $this->db = $DIC->database();
         $this->entry_id = $a_entry_id;
         $this->read();
     }

Here is the call graph for this function:

Member Function Documentation

◆ _extractEntryId()

static ilMDCopyrightSelectionEntry::_extractEntryId ( string $a_cp_string )

static

Definition at line 171 of file class.ilMDCopyrightSelectionEntry.php.

References IL_INST_ID.

                                                                : int
     {
         if (!preg_match('/il_copyright_entry__([0-9]+)__([0-9]+)/', $a_cp_string, $matches)) {
             return 0;
         }
         if ($matches[1] != IL_INST_ID) {
             return 0;
         }
         return (int) ($matches[2] ?? 0);
     }

◆ _getEntries()

static ilMDCopyrightSelectionEntry::_getEntries ( )

static

Returns: ilMDCopyrightSelectionEntry[]

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

References $DIC, $ilDB, and $res.

                                         : array
     {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         $query = "SELECT entry_id FROM il_md_cpr_selections ORDER BY is_default DESC, position ASC";
         $res = $ilDB->query($query);
 
         $entries = [];
         while ($row = $ilDB->fetchObject($res)) {
             $entries[] = new ilMDCopyrightSelectionEntry((int) $row->entry_id);
         }
         return $entries;
     }

◆ _lookupCopyright()

static ilMDCopyrightSelectionEntry::_lookupCopyright ( string $a_cp_string )

static

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

References $components, $DIC, and ILIAS\MetaData\Copyright\RendererInterface\toUIComponents().

Referenced by ilMDUtils\_parseCopyright().

                                                                 : string
     {
         global $DIC;
 
         $renderer = new Renderer(
             $DIC->ui()->factory(),
             $DIC->resourceStorage()
         );
         $repository = new DatabaseRepository(new Wrapper($DIC->database()));
         $ui_renderer = $DIC->ui()->renderer();
 
         if (!$entry_id = self::_extractEntryId($a_cp_string)) {
             return $a_cp_string;
         }
 
         $entry = $repository->getEntry($entry_id);
         $components = $renderer->toUIComponents($entry->copyrightData());
 
         return $ui_renderer->render($components);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _lookupCopyrightForExport()

static ilMDCopyrightSelectionEntry::_lookupCopyrightForExport ( string $a_cp_string )

static

Definition at line 125 of file class.ilMDCopyrightSelectionEntry.php.

References $data, $DIC, and ILIAS\MetaData\Copyright\RepositoryInterface\getEntry().

Referenced by ilMDRights\toXML().

                                                                          : string
     {
         global $DIC;
 
         $repository = new DatabaseRepository(new Wrapper($DIC->database()));
 
         if (!$entry_id = self::_extractEntryId($a_cp_string)) {
             return $a_cp_string;
         }
 
         $data = $repository->getEntry($entry_id)->copyrightData();
 
         return (string) ($data->link() ?? $data->fullName());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ add()

ilMDCopyrightSelectionEntry::add ( )

Definition at line 302 of file class.ilMDCopyrightSelectionEntry.php.

References getDescription(), getNextOrderPosition(), getOutdated(), and getTitle().

                          : bool
     {
         $next_id = $this->db->nextId('il_md_cpr_selections');
 
         $this->db->insert('il_md_cpr_selections', array(
             'entry_id' => array('integer', $next_id),
             'title' => array('text', $this->getTitle()),
             'description' => array('clob', $this->getDescription()),
             //'copyright' => array('clob', $this->getCopyright()),
             'outdated' => array('integer', $this->getOutdated()),
             'position' => array('integer', $this->getNextOrderPosition())
         ));
         $this->entry_id = $next_id;
         return true;
     }

Here is the call graph for this function:

◆ createIdentifier()

static ilMDCopyrightSelectionEntry::createIdentifier ( int $a_entry_id )

static

Definition at line 359 of file class.ilMDCopyrightSelectionEntry.php.

References IL_INST_ID.

Referenced by ilMDUtils\_getDefaultCopyright(), and ilMDRights\parseDescriptionFromImport().

                                                             : string
     {
         return 'il_copyright_entry__' . IL_INST_ID . '__' . $a_entry_id;
     }

Here is the caller graph for this function:

◆ delete()

ilMDCopyrightSelectionEntry::delete ( )

Definition at line 332 of file class.ilMDCopyrightSelectionEntry.php.

                             : void
     {
         /*$query = "DELETE FROM il_md_cpr_selections " .
             "WHERE entry_id = " . $this->db->quote($this->getEntryId(), 'integer') . " ";
         $res = $this->db->manipulate($query);*/
     }

◆ getCopyright()

ilMDCopyrightSelectionEntry::getCopyright ( )

Definition at line 278 of file class.ilMDCopyrightSelectionEntry.php.

References $copyright.

                                   : string
     {
         return $this->copyright;
     }

◆ getDefault()

static ilMDCopyrightSelectionEntry::getDefault ( )

static

Definition at line 238 of file class.ilMDCopyrightSelectionEntry.php.

References $DIC, $res, ilDBInterface\fetchAssoc(), ilDBInterface\query(), and ilDBInterface\quote().

Referenced by ilMDUtils\_getDefaultCopyright().

                                        : int
     {
         global $DIC;
 
         $db = $DIC->database();
 
         $query = "SELECT entry_id FROM il_md_cpr_selections " .
             "WHERE is_default = " . $db->quote(1, 'integer');
 
         $res = $db->query($query);
         $row = $db->fetchAssoc($res);
 
         return (int) $row['entry_id'];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDescription()

ilMDCopyrightSelectionEntry::getDescription ( )

Definition at line 268 of file class.ilMDCopyrightSelectionEntry.php.

References $description.

Referenced by add(), and update().

                                     : string
     {
         return $this->description;
     }

Here is the caller graph for this function:

◆ getEntryId()

ilMDCopyrightSelectionEntry::getEntryId ( )

Definition at line 208 of file class.ilMDCopyrightSelectionEntry.php.

References $entry_id.

Referenced by getUsage(), and update().

                                 : int
     {
         return $this->entry_id;
     }

Here is the caller graph for this function:

◆ getIsDefault()

ilMDCopyrightSelectionEntry::getIsDefault ( )

Get if the entry is default No setter for this.

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

References $res.

                                   : bool
     {
         $query = "SELECT is_default FROM il_md_cpr_selections " .
             "WHERE entry_id = " . $this->db->quote($this->entry_id, 'integer');
 
         $res = $this->db->query($query);
         $row = $this->db->fetchAssoc($res);
 
         return (bool) ($row['is_default'] ?? false);
     }

◆ getNextOrderPosition()

ilMDCopyrightSelectionEntry::getNextOrderPosition ( )

protected

Definition at line 293 of file class.ilMDCopyrightSelectionEntry.php.

References $res.

Referenced by add().

                                              : int
     {
         $query = "SELECT count(entry_id) total FROM il_md_cpr_selections";
         $res = $this->db->query($query);
         $row = $this->db->fetchAssoc($res);
 
         return $row['total'] + 1;
     }

Here is the caller graph for this function:

◆ getOrderPosition()

ilMDCopyrightSelectionEntry::getOrderPosition ( )

Definition at line 288 of file class.ilMDCopyrightSelectionEntry.php.

References $order_position.

Referenced by update().

                                       : int
     {
         return $this->order_position;
     }

Here is the caller graph for this function:

◆ getOutdated()

ilMDCopyrightSelectionEntry::getOutdated ( )

Definition at line 233 of file class.ilMDCopyrightSelectionEntry.php.

References $outdated.

Referenced by add(), and update().

                                  : bool
     {
         return $this->outdated;
     }

Here is the caller graph for this function:

◆ getTitle()

ilMDCopyrightSelectionEntry::getTitle ( )

Definition at line 258 of file class.ilMDCopyrightSelectionEntry.php.

References $title.

Referenced by add(), update(), and validate().

                               : string
     {
         return $this->title;
     }

Here is the caller graph for this function:

◆ getUsage()

ilMDCopyrightSelectionEntry::getUsage ( )

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

References $res, $usage, getEntryId(), IL_INST_ID, and ILIAS\Repository\int().

                               : int
     {
         // do a time-consuming usage count on demand
         if ($this->usage === null) {
             $query = "SELECT count(meta_rights_id) used FROM il_meta_rights " .
                 "WHERE description = " . $this->db->quote(
                     'il_copyright_entry__' . IL_INST_ID . '__' . $this->getEntryId(),
                     'text'
                 );
 
             $res = $this->db->query($query);
             $row = $this->db->fetchObject($res);
             $this->usage = (int) $row->used;
         }
 
         return $this->usage;
     }

Here is the call graph for this function:

◆ isEntry()

static ilMDCopyrightSelectionEntry::isEntry ( $a_cp_string )

static

Definition at line 182 of file class.ilMDCopyrightSelectionEntry.php.

Referenced by ilMDUtils\_parseCopyright().

                                                 : bool
     {
         if (!preg_match('/il_copyright_entry__([0-9]+)__([0-9]+)/', $a_cp_string)) {
             return false;
         }
         return true;
     }

Here is the caller graph for this function:

◆ lookupCopyrightFromImport()

static ilMDCopyrightSelectionEntry::lookupCopyrightFromImport ( string $copyright_text )

static

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

References $DIC, and ILIAS\MetaData\Copyright\RepositoryInterface\getAllEntries().

Referenced by ilMDRights\parseDescriptionFromImport().

                                                                             : int
     {
         global $DIC;
 
         $repository = new DatabaseRepository(new Wrapper($DIC->database()));
 
         // url should be made to match regardless of scheme
         $normalized_copyright = str_replace('https://', 'http://', $copyright_text);
 
         $matches_by_name = null;
         foreach ($repository->getAllEntries() as $entry) {
             $entry_link = (string) $entry->copyrightData()->link();
             $normalized_link = str_replace('https://', 'http://', $entry_link);
             if ($normalized_link !== '' && str_contains($normalized_copyright, $normalized_link)) {
                 return $entry->id();
             }
 
             if (
                 is_null($matches_by_name) &&
                 trim($copyright_text) === trim($entry->copyrightData()->fullName())
             ) {
                 $matches_by_name = $entry->id();
             }
         }
 
         if (!is_null($matches_by_name)) {
             return $matches_by_name;
         }
         return 0;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ lookupCopyyrightTitle()

static ilMDCopyrightSelectionEntry::lookupCopyyrightTitle ( string $a_cp_string )

static

Definition at line 87 of file class.ilMDCopyrightSelectionEntry.php.

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

                                                                      : string
     {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         if (!$entry_id = self::_extractEntryId($a_cp_string)) {
             return $a_cp_string;
         }
 
         $query = "SELECT title FROM il_md_cpr_selections " .
             "WHERE entry_id = " . $ilDB->quote($entry_id, ilDBConstants::T_INTEGER) . " ";
         $res = $ilDB->query($query);
         $row = $ilDB->fetchObject($res);
         return $row->title ?? '';
     }

◆ read()

ilMDCopyrightSelectionEntry::read ( )

private

Definition at line 344 of file class.ilMDCopyrightSelectionEntry.php.

References ILIAS\UI\examples\Deck\repository(), setCopyright(), setDescription(), setOrderPosition(), setOutdated(), and setTitle().

Referenced by __construct().

                            : void
     {
         $entry = $this->repository->getEntry($this->entry_id);
 
         $rendered_cp = $this->ui_renderer->render(
             $this->renderer->toUIComponents($entry->copyrightData())
         );
 
         $this->setTitle($entry->title());
         $this->setDescription($entry->description());
         $this->setCopyright($rendered_cp);
         $this->setOutdated($entry->isOutdated());
         $this->setOrderPosition($entry->position());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setCopyright()

ilMDCopyrightSelectionEntry::setCopyright ( string $a_copyright )

Definition at line 273 of file class.ilMDCopyrightSelectionEntry.php.

Referenced by read().

                                                      : void
     {
         $this->copyright = $a_copyright;
     }

Here is the caller graph for this function:

◆ setDescription()

ilMDCopyrightSelectionEntry::setDescription ( string $a_desc )

Definition at line 263 of file class.ilMDCopyrightSelectionEntry.php.

Referenced by read().

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

Here is the caller graph for this function:

◆ setOrderPosition()

ilMDCopyrightSelectionEntry::setOrderPosition ( int $a_position )

Definition at line 283 of file class.ilMDCopyrightSelectionEntry.php.

Referenced by read().

                                                      : void
     {
         $this->order_position = $a_position;
     }

Here is the caller graph for this function:

◆ setOutdated()

ilMDCopyrightSelectionEntry::setOutdated ( bool $a_value )

Definition at line 228 of file class.ilMDCopyrightSelectionEntry.php.

Referenced by read().

                                               : void
     {
         $this->outdated = $a_value;
     }

Here is the caller graph for this function:

◆ setTitle()

ilMDCopyrightSelectionEntry::setTitle ( string $a_title )

Definition at line 253 of file class.ilMDCopyrightSelectionEntry.php.

Referenced by read().

                                              : void
     {
         $this->title = $a_title;
     }

Here is the caller graph for this function:

◆ update()

ilMDCopyrightSelectionEntry::update ( )

Definition at line 318 of file class.ilMDCopyrightSelectionEntry.php.

References getDescription(), getEntryId(), getOrderPosition(), getOutdated(), and getTitle().

                             : bool
     {
         $this->db->update('il_md_cpr_selections', array(
             'title' => array('text', $this->getTitle()),
             'description' => array('clob', $this->getDescription()),
             //'copyright' => array('clob', $this->getCopyright()),
             'outdated' => array('integer', $this->getOutdated()),
             'position' => array('integer', $this->getOrderPosition())
         ), array(
             'entry_id' => array('integer', $this->getEntryId())
         ));
         return true;
     }

Here is the call graph for this function:

◆ validate()

ilMDCopyrightSelectionEntry::validate ( )

Definition at line 339 of file class.ilMDCopyrightSelectionEntry.php.

References getTitle().

                               : bool
     {
         return $this->getTitle() !== '';
     }

Here is the call graph for this function:

Field Documentation

◆ $copyright

string ilMDCopyrightSelectionEntry::$copyright = ''

private

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

Referenced by getCopyright().

◆ $db

ilDBInterface ilMDCopyrightSelectionEntry::$db

protected

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

◆ $description

string ilMDCopyrightSelectionEntry::$description = ''

private

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

Referenced by getDescription().

◆ $entry_id

int ilMDCopyrightSelectionEntry::$entry_id

private

Definition at line 41 of file class.ilMDCopyrightSelectionEntry.php.

Referenced by getEntryId().

◆ $logger

ilLogger ilMDCopyrightSelectionEntry::$logger

protected

Definition at line 35 of file class.ilMDCopyrightSelectionEntry.php.

◆ $order_position

int ilMDCopyrightSelectionEntry::$order_position = 0

protected

Definition at line 50 of file class.ilMDCopyrightSelectionEntry.php.

Referenced by getOrderPosition().

◆ $outdated

bool ilMDCopyrightSelectionEntry::$outdated = false

protected

Definition at line 48 of file class.ilMDCopyrightSelectionEntry.php.

Referenced by getOutdated().

◆ $renderer

RendererInterface ilMDCopyrightSelectionEntry::$renderer

protected

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

◆ $repository

RepositoryInterface ilMDCopyrightSelectionEntry::$repository

protected

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

◆ $title

string ilMDCopyrightSelectionEntry::$title = ''

private

Definition at line 42 of file class.ilMDCopyrightSelectionEntry.php.

Referenced by getTitle().

◆ $ui_renderer

UIRenderer ilMDCopyrightSelectionEntry::$ui_renderer

protected

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

◆ $usage

int ilMDCopyrightSelectionEntry::$usage = null

private

Definition at line 46 of file class.ilMDCopyrightSelectionEntry.php.

Referenced by getUsage().

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

components/ILIAS/MetaData/classes/Settings/Copyright/class.ilMDCopyrightSelectionEntry.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _extractEntryId()

◆ _getEntries()

◆ _lookupCopyright()

◆ _lookupCopyrightForExport()

◆ add()

◆ createIdentifier()

◆ delete()

◆ getCopyright()

◆ getDefault()

◆ getDescription()

◆ getEntryId()

◆ getIsDefault()

◆ getNextOrderPosition()

◆ getOrderPosition()

◆ getOutdated()

◆ getTitle()

◆ getUsage()

◆ isEntry()

◆ lookupCopyrightFromImport()

◆ lookupCopyyrightTitle()

◆ read()

◆ setCopyright()

◆ setDescription()

◆ setOrderPosition()

◆ setOutdated()

◆ setTitle()

◆ update()

◆ validate()

Field Documentation

◆ $copyright

◆ $db

◆ $description

◆ $entry_id

◆ $logger

◆ $order_position

◆ $outdated

◆ $renderer

◆ $repository

◆ $title

◆ $ui_renderer

◆ $usage