ILIAS\MetaData\Copyright\DatabaseRepository Class Reference

Inheritance diagram for ILIAS\MetaData\Copyright\DatabaseRepository:

Collaboration diagram for ILIAS\MetaData\Copyright\DatabaseRepository:

Public Member Functions
	__construct (WrapperInterface $db_wrapper)
	getEntry (int $id)
	getAllEntries ()
	The default entry is returned first, and the remaining entries are returned according to their position. More...
	getActiveEntries ()
	The default entry is returned first, and the remaining entries are returned according to their position. More...
	getDefaultEntry ()
	deleteEntry (int $id)
	createEntry (string $title, string $description='', bool $is_outdated=false, string $full_name='', ?URI $link=null, URI|string $image='', string $alt_text='')
	Returns the ID of the newly created entry. More...
	updateEntry (int $id, string $title, string $description='', bool $is_outdated=false, string $full_name='', ?URI $link=null, URI|string $image='', string $alt_text='')
	reorderEntries (int ... $ids)
	Updates the position of entries according to the order their IDs are passed. More...

Protected Member Functions
	entryFromRow (array $row)
	getURI (string $uri)
	getNextPosition ()
	checkTitle (string $title)
	getDefaultID ()
	updatePosition (int $id, int $position)

Protected Attributes
WrapperInterface	$db_wrapper

Detailed Description

Definition at line 26 of file DatabaseRepository.php.

Constructor & Destructor Documentation

__construct()

ILIAS\MetaData\Copyright\DatabaseRepository::__construct

(

WrapperInterface

$db_wrapper

)

Definition at line 30 of file DatabaseRepository.php.

References ILIAS\MetaData\Copyright\DatabaseRepository\$db_wrapper.

    {
        $this->db_wrapper = $db_wrapper;
    }

Member Function Documentation

checkTitle()

ILIAS\MetaData\Copyright\DatabaseRepository::checkTitle ( string  $title )

protected

Definition at line 209 of file DatabaseRepository.php.

Referenced by ILIAS\MetaData\Copyright\DatabaseRepository\createEntry(), and ILIAS\MetaData\Copyright\DatabaseRepository\updateEntry().

                                                : void
    {
        if ($title === '') {
            throw new \ilMDCopyrightException(
                'Copyright entries can not have an empty title'
            );
        }
    }

Here is the caller graph for this function:

createEntry()

ILIAS\MetaData\Copyright\DatabaseRepository::createEntry	(	string	$title,
		string	$description = '',
		bool	$is_outdated = false,
		string	$full_name = '',
		?URI	$link = null,
		URI|string	$image = '',
		string	$alt_text = ''
	)

Returns the ID of the newly created entry.

Implements ILIAS\MetaData\Copyright\RepositoryInterface.

Definition at line 119 of file DatabaseRepository.php.

References ILIAS\MetaData\Copyright\DatabaseRepository\checkTitle(), ILIAS\MetaData\Copyright\DatabaseRepository\getNextPosition(), ilDBConstants\T_INTEGER, and ilDBConstants\T_TEXT.

     : int {
        $this->checkTitle($title);

        $next_id = $this->db_wrapper->nextId('il_md_cpr_selections');
        if (is_string($image)) {
            $image_link = '';
            $image_file = $image;
        } else {
            $image_link = (string) $image;
            $image_file = '';
        }

        $this->db_wrapper->insert(
            'il_md_cpr_selections',
            [
                'entry_id' => [\ilDBConstants::T_INTEGER, $next_id],
                'title' => [\ilDBConstants::T_TEXT, $title],
                'description' => [\ilDBConstants::T_TEXT, $description],
                'is_default' => [\ilDBConstants::T_INTEGER, 0],
                'outdated' => [\ilDBConstants::T_INTEGER, (int) $is_outdated],
                'position' => [\ilDBConstants::T_INTEGER, $this->getNextPosition()],
                'full_name' => [\ilDBConstants::T_TEXT, $full_name],
                'link' => [\ilDBConstants::T_TEXT, (string) $link],
                'image_link' => [\ilDBConstants::T_TEXT, $image_link],
                'image_file' => [\ilDBConstants::T_TEXT, $image_file],
                'alt_text' => [\ilDBConstants::T_TEXT, $alt_text],
                'migrated' => [\ilDBConstants::T_INTEGER, 1]
            ]
        );

        return $next_id;
    }

Here is the call graph for this function:

deleteEntry()

ILIAS\MetaData\Copyright\DatabaseRepository::deleteEntry

(

int

$id

)

Implements ILIAS\MetaData\Copyright\RepositoryInterface.

Definition at line 111 of file DatabaseRepository.php.

                                        : void
    {
        $this->db_wrapper->manipulate(
            'DELETE FROM il_md_cpr_selections WHERE entry_id = ' .
            $this->db_wrapper->quoteInteger($id)
        );
    }

entryFromRow()

ILIAS\MetaData\Copyright\DatabaseRepository::entryFromRow ( array  $row )

protected

Definition at line 84 of file DatabaseRepository.php.

References $data, ILIAS\MetaData\Copyright\DatabaseRepository\getURI(), and null.

Referenced by ILIAS\MetaData\Copyright\DatabaseRepository\getActiveEntries(), ILIAS\MetaData\Copyright\DatabaseRepository\getAllEntries(), ILIAS\MetaData\Copyright\DatabaseRepository\getDefaultEntry(), and ILIAS\MetaData\Copyright\DatabaseRepository\getEntry().

                                               : EntryInterface
    {
        $data = new CopyrightData(
            (string) ($row['full_name'] ?? ''),
            !empty($row['link'] ?? '') ? $this->getURI((string) $row['link']) : null,
            !empty($row['image_link']) ? $this->getURI((string) $row['image_link']) : null,
            (string) ($row['image_file'] ?? ''),
            (string) ($row['alt_text'] ?? ''),
            $row['is_default'] ? true : false
        );

        return new Entry(
            (int) $row['entry_id'],
            (string) ($row['title'] ?? ''),
            (string) ($row['description'] ?? ''),
            $row['is_default'] ? true : false,
            $row['outdated'] ? true : false,
            (int) ($row['position'] ?? 0),
            $data
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getActiveEntries()

ILIAS\MetaData\Copyright\DatabaseRepository::getActiveEntries

(

)

The default entry is returned first, and the remaining entries are returned according to their position.

Outdated entries are skipped.

Returns

EntryInterface[]

Implements ILIAS\MetaData\Copyright\RepositoryInterface.

Definition at line 60 of file DatabaseRepository.php.

References ILIAS\MetaData\Copyright\DatabaseRepository\entryFromRow().

                                      : \Generator
    {
        $rows = $this->db_wrapper->query(
            'SELECT * FROM il_md_cpr_selections WHERE outdated = 0
            ORDER BY is_default DESC, position ASC'
        );

        foreach ($rows as $row) {
            yield $this->entryFromRow($row);
        }
    }

Here is the call graph for this function:

getAllEntries()

ILIAS\MetaData\Copyright\DatabaseRepository::getAllEntries

(

)

The default entry is returned first, and the remaining entries are returned according to their position.

Returns

EntryInterface[]

Implements ILIAS\MetaData\Copyright\RepositoryInterface.

Definition at line 48 of file DatabaseRepository.php.

References ILIAS\MetaData\Copyright\DatabaseRepository\entryFromRow().

                                   : \Generator
    {
        $rows = $this->db_wrapper->query(
            'SELECT * FROM il_md_cpr_selections
            ORDER BY is_default DESC, position ASC'
        );

        foreach ($rows as $row) {
            yield $this->entryFromRow($row);
        }
    }

Here is the call graph for this function:

getDefaultEntry()

ILIAS\MetaData\Copyright\DatabaseRepository::getDefaultEntry

(

)

Implements ILIAS\MetaData\Copyright\RepositoryInterface.

Definition at line 72 of file DatabaseRepository.php.

References ILIAS\MetaData\Copyright\DatabaseRepository\entryFromRow().

                                     : EntryInterface
    {
        $rows = $this->db_wrapper->query(
            'SELECT * FROM il_md_cpr_selections WHERE is_default = 1'
        );

        foreach ($rows as $row) {
            return $this->entryFromRow($row);
        }
        return new NullEntry();
    }

Here is the call graph for this function:

getDefaultID()

ILIAS\MetaData\Copyright\DatabaseRepository::getDefaultID ( )

protected

Definition at line 231 of file DatabaseRepository.php.

Referenced by ILIAS\MetaData\Copyright\DatabaseRepository\reorderEntries().

                                     : int
    {
        $rows = $this->db_wrapper->query(
            'SELECT entry_id FROM il_md_cpr_selections WHERE is_default = 1'
        );

        foreach ($rows as $row) {
            return (int) ($row['entry_id'] ?? 0);
        }
        return 0;
    }

Here is the caller graph for this function:

getEntry()

ILIAS\MetaData\Copyright\DatabaseRepository::getEntry

(

int

$id

)

Implements ILIAS\MetaData\Copyright\RepositoryInterface.

Definition at line 35 of file DatabaseRepository.php.

References ILIAS\MetaData\Copyright\DatabaseRepository\entryFromRow().

                                     : EntryInterface
    {
        $rows = $this->db_wrapper->query(
            'SELECT * FROM il_md_cpr_selections WHERE entry_id = ' .
            $this->db_wrapper->quoteInteger($id)
        );

        foreach ($rows as $row) {
            return $this->entryFromRow($row);
        }
        return new NullEntry();
    }

Here is the call graph for this function:

getNextPosition()

ILIAS\MetaData\Copyright\DatabaseRepository::getNextPosition ( )

protected

Definition at line 160 of file DatabaseRepository.php.

References ILIAS\Repository\int().

Referenced by ILIAS\MetaData\Copyright\DatabaseRepository\createEntry().

                                        : int
    {
        $rows = $this->db_wrapper->query(
            'SELECT MAX(position) AS max FROM il_md_cpr_selections WHERE is_default = 0'
        );
        foreach ($rows as $row) {
            return isset($row['max']) ? ((int) $row['max']) + 1 : 0;
        }
        return 0;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getURI()

ILIAS\MetaData\Copyright\DatabaseRepository::getURI ( string  $uri )

protected

Definition at line 106 of file DatabaseRepository.php.

Referenced by ILIAS\MetaData\Copyright\DatabaseRepository\entryFromRow().

                                          : URI
    {
        return new URI($uri);
    }

Here is the caller graph for this function:

reorderEntries()

ILIAS\MetaData\Copyright\DatabaseRepository::reorderEntries

(

int ...

$ids

)

Updates the position of entries according to the order their IDs are passed.

Implements ILIAS\MetaData\Copyright\RepositoryInterface.

Definition at line 218 of file DatabaseRepository.php.

References $id, ILIAS\MetaData\Copyright\DatabaseRepository\getDefaultID(), and ILIAS\MetaData\Copyright\DatabaseRepository\updatePosition().

                                               : void
    {
        $pos = 0;
        $default_id = $this->getDefaultID();
        foreach ($ids as $id) {
            if ($id === $default_id) {
                continue;
            }
            $this->updatePosition($id, $pos);
            $pos++;
        }
    }

Here is the call graph for this function:

updateEntry()

ILIAS\MetaData\Copyright\DatabaseRepository::updateEntry	(	int	$id,
		string	$title,
		string	$description = '',
		bool	$is_outdated = false,
		string	$full_name = '',
		?URI	$link = null,
		URI|string	$image = '',
		string	$alt_text = ''
	)

Implements ILIAS\MetaData\Copyright\RepositoryInterface.

Definition at line 171 of file DatabaseRepository.php.

References ILIAS\MetaData\Copyright\DatabaseRepository\checkTitle(), ilDBConstants\T_INTEGER, and ilDBConstants\T_TEXT.

     : void {
        $this->checkTitle($title);

        if (is_string($image)) {
            $image_link = '';
            $image_file = $image;
        } else {
            $image_link = (string) $image;
            $image_file = '';
        }

        $this->db_wrapper->update(
            'il_md_cpr_selections',
            [
                'title' => [\ilDBConstants::T_TEXT, $title],
                'description' => [\ilDBConstants::T_TEXT, $description],
                'outdated' => [\ilDBConstants::T_INTEGER, (int) $is_outdated],
                'full_name' => [\ilDBConstants::T_TEXT, $full_name],
                'link' => [\ilDBConstants::T_TEXT, (string) $link],
                'image_link' => [\ilDBConstants::T_TEXT, $image_link],
                'image_file' => [\ilDBConstants::T_TEXT, $image_file],
                'alt_text' => [\ilDBConstants::T_TEXT, $alt_text]
            ],
            [
                'entry_id' => [\ilDBConstants::T_INTEGER, $id]
            ]
        );
    }

Here is the call graph for this function:

updatePosition()

ILIAS\MetaData\Copyright\DatabaseRepository::updatePosition ( int  $id, int  $position  )

protected

Definition at line 243 of file DatabaseRepository.php.

References ilDBConstants\T_INTEGER.

Referenced by ILIAS\MetaData\Copyright\DatabaseRepository\reorderEntries().

                                                             : void
    {
        $this->db_wrapper->update(
            'il_md_cpr_selections',
            ['position' => [\ilDBConstants::T_INTEGER, $position]],
            ['entry_id' => [\ilDBConstants::T_INTEGER, $id]]
        );
    }

Here is the caller graph for this function:

Field Documentation

$db_wrapper

WrapperInterface ILIAS\MetaData\Copyright\DatabaseRepository::$db_wrapper

protected

Definition at line 28 of file DatabaseRepository.php.

Referenced by ILIAS\MetaData\Copyright\DatabaseRepository\__construct().

---

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

• components/ILIAS/MetaData/classes/Copyright/DatabaseRepository.php