Inheritance diagram for ilMDCopyrightMigration:

Collaboration diagram for ilMDCopyrightMigration:

Public Member Functions
	getLabel ()

	getDefaultAmountOfStepsPerRun ()

	getPreconditions (Environment $environment)

	prepare (Environment $environment)

	step (Environment $environment)

	getRemainingAmountOfSteps ()

Protected Member Functions
	extractFields (string $copyright)

	translatePreInstalledLinksToSVG (string $image_link)

Protected Attributes
ilDBInterface	$db

Detailed Description

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

Member Function Documentation

◆ extractFields()

ilMDCopyrightMigration::extractFields ( string $copyright )

protected

Definition at line 83 of file class.ilMDCopyrightMigration.php.

                                                       : array
    {
        $full_name = '';
        $link = '';
        $image_link = '';
        $alt_text = '';
 
        //find the image
        if (preg_match('/<\s*img((?:.|\n)*?)\/>/i', $copyright, $img_matches)) {
            if (preg_match('/src\s*=\s*(?:"|\')(.*?)(?:"|\')/i', $img_matches[1], $src_matches)) {
                $image_link = strip_tags($src_matches[1]);
            }
            if (preg_match('/alt\s*=\s*(?:"|\')(.*?)(?:"|\')/i', $img_matches[1], $alt_matches)) {
                $alt_text = strip_tags($alt_matches[1]);
            }
        }
 
        //find the link
        if (preg_match('/<\s*a((?:.|\n)[^<]*?)<\s*\/a>/i', $copyright, $link_matches)) {
            if (preg_match('/href\s*=\s*(?:"|\')(.*?)(?:"|\')/i', $link_matches[1], $name_matches)) {
                $link = strip_tags($name_matches[1]);
            }
            if (preg_match('/>((?:\n|.)*)/i', $link_matches[1], $href_matches)) {
                $full_name = strip_tags($href_matches[1]);
            }
        } else {
            $full_name = strip_tags($copyright);
        }
 
        $image_link = $this->translatePreInstalledLinksToSVG($image_link);
 
        return [
            'full_name' => [\ilDBConstants::T_TEXT, $full_name],
            'link' => [\ilDBConstants::T_TEXT, $link],
            'image_link' => [\ilDBConstants::T_TEXT, $image_link],
            'alt_text' => [\ilDBConstants::T_TEXT, $alt_text]
        ];
    }

References ilDBConstants\T_TEXT, and translatePreInstalledLinksToSVG().

Referenced by step().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDefaultAmountOfStepsPerRun()

ilMDCopyrightMigration::getDefaultAmountOfStepsPerRun ( )

Definition at line 34 of file class.ilMDCopyrightMigration.php.

                                                   : int
    {
        return Migration::INFINITE;
    }

◆ getLabel()

ilMDCopyrightMigration::getLabel ( )

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

                              : string
    {
        return "Migration of available copyrights.";
    }

◆ getPreconditions()

ilMDCopyrightMigration::getPreconditions ( Environment $environment )

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

                                                              : array
    {
        return [
            new ilIniFilesLoadedObjective(),
            new ilDatabaseInitializedObjective(),
            new ilDatabaseUpdatedObjective(),
        ];
    }

◆ getRemainingAmountOfSteps()

ilMDCopyrightMigration::getRemainingAmountOfSteps ( )

Definition at line 73 of file class.ilMDCopyrightMigration.php.

                                               : int
    {
        $res = $this->db->query(
            'SELECT COUNT(*) AS count FROM il_md_cpr_selections WHERE migrated = 0'
        );
 
        $row = $this->db->fetchAssoc($res);
        return (int) $row['count'];
    }

References $res.

◆ prepare()

ilMDCopyrightMigration::prepare ( Environment $environment )

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

                                                     : void
    {
        $this->db = $environment->getResource(Environment::RESOURCE_DATABASE);
    }

References ILIAS\Setup\Environment\getResource().

Here is the call graph for this function:

◆ step()

ilMDCopyrightMigration::step ( Environment $environment )

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

                                                  : void
    {
        $res = $this->db->query(
            'SELECT entry_id, copyright FROM il_md_cpr_selections WHERE migrated = 0 LIMIT 1'
        );
 
        if ($row = $this->db->fetchAssoc($res)) {
            if (!isset($row['entry_id'])) {
                return;
            }
            $fields = $this->extractFields((string) ($row['copyright'] ?? ''));
            $fields['migrated'] = [\ilDBConstants::T_INTEGER, 1];
            $this->db->update(
                'il_md_cpr_selections',
                $fields,
                ['entry_id' => [\ilDBConstants::T_INTEGER, (int) $row['entry_id']]]
            );
        }
    }

References $res, extractFields(), and ilDBConstants\T_INTEGER.

Here is the call graph for this function:

◆ translatePreInstalledLinksToSVG()

ilMDCopyrightMigration::translatePreInstalledLinksToSVG ( string $image_link )

protected

Definition at line 122 of file class.ilMDCopyrightMigration.php.

                                                                          : string
    {
        $mapping = [
            // 4.0
            'https://i.creativecommons.org/l/by-nc-nd/4.0/88x31.png' => 'https://mirrors.creativecommons.org/presskit/buttons/88x31/svg/by-nc-nd.svg',
            'https://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png' => 'https://mirrors.creativecommons.org/presskit/buttons/88x31/svg/by-nc-sa.svg',
            'https://i.creativecommons.org/l/by-nc/4.0/88x31.png' => 'https://mirrors.creativecommons.org/presskit/buttons/88x31/svg/by-nc.svg',
            'https://i.creativecommons.org/l/by-nd/4.0/88x31.png' => 'https://mirrors.creativecommons.org/presskit/buttons/88x31/svg/by-nd.svg',
            'https://i.creativecommons.org/l/by-sa/4.0/88x31.png' => 'https://mirrors.creativecommons.org/presskit/buttons/88x31/svg/by-sa.svg',
            'https://i.creativecommons.org/l/by/4.0/88x31.png' => 'https://mirrors.creativecommons.org/presskit/buttons/88x31/svg/by.svg',
            // 3.0
            'http://i.creativecommons.org/l/by-nc-nd/3.0/88x31.png' => 'https://mirrors.creativecommons.org/presskit/buttons/88x31/svg/by-nc-nd.svg',
            'http://i.creativecommons.org/l/by-nc-sa/3.0/88x31.png' => 'https://mirrors.creativecommons.org/presskit/buttons/88x31/svg/by-nc-sa.svg',
            'http://i.creativecommons.org/l/by-nc/3.0/88x31.png' => 'https://mirrors.creativecommons.org/presskit/buttons/88x31/svg/by-nc.svg',
            'http://i.creativecommons.org/l/by-nd/3.0/88x31.png' => 'https://mirrors.creativecommons.org/presskit/buttons/88x31/svg/by-nd.svg',
            'http://i.creativecommons.org/l/by-sa/3.0/88x31.png' => 'https://mirrors.creativecommons.org/presskit/buttons/88x31/svg/by-sa.svg',
            'http://i.creativecommons.org/l/by/3.0/88x31.png' => 'https://mirrors.creativecommons.org/presskit/buttons/88x31/svg/by.svg'
        ];
 
        if (key_exists($image_link, $mapping)) {
            return $mapping[$image_link];
        }
        return $image_link;
    }