Chamilo\CourseBundle\Component\CourseCopy\Moodle\Activities\GlossaryExport

Complexity

Total Complexity

32

Size/Duplication

Total Lines	219
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
B	createGlossaryXml()	0	79	6
A	export()	0	18	1
F	getData()	0	101	25

<?php

declare(strict_types=1);

/* For licensing terms, see /license.txt */

namespace Chamilo\CourseBundle\Component\CourseCopy\Moodle\Activities;

use Chamilo\CourseBundle\Component\CourseCopy\Moodle\Builder\MoodleExport;

use const PHP_EOL;

/**
 * Handles the export of glossaries within a course.
 */
class GlossaryExport extends ActivityExport
{
    /**
     * Export all glossary terms into a single Moodle glossary.
     *
     * @param int    $activityId the ID of the glossary (logical wrapper id)
     * @param string $exportDir  destination base directory for the export
     * @param int    $moduleId   module id used to name the activity folder
     * @param int    $sectionId  moodle section id where the activity will live
     */
    public function export($activityId, $exportDir, $moduleId, $sectionId): void
    {
        $glossaryDir = $this->prepareActivityDirectory($exportDir, 'glossary', (int) $moduleId);

        $glossaryData = $this->getData((int) $activityId, (int) $sectionId, (int) $moduleId);

        $this->createGlossaryXml($glossaryData, $glossaryDir);
        $this->createModuleXml($glossaryData, $glossaryDir);
        $this->createGradesXml($glossaryData, $glossaryDir);
        $this->createGradeHistoryXml($glossaryData, $glossaryDir);
        $this->createInforefXml($glossaryData, $glossaryDir);
        $this->createRolesXml($glossaryData, $glossaryDir);
        $this->createCalendarXml($glossaryData, $glossaryDir);
        $this->createCommentsXml($glossaryData, $glossaryDir);
        $this->createCompetenciesXml($glossaryData, $glossaryDir);
        $this->createFiltersXml($glossaryData, $glossaryDir);

        MoodleExport::flagActivityUserinfo('glossary', (int) $moduleId, true);
    }

    /**
     * Gather all terms and build a single glossary activity dataset.
     */
    public function getData(int $glossaryId, int $sectionId, ?int $moduleId = null): array
    {
        if ($moduleId === null) {
            $moduleId = $glossaryId;
        }

        $adminData = MoodleExport::getAdminUserData();
        $adminId   = (int) ($adminData['id'] ?? 0);

        $res  = \is_array($this->course->resources ?? null) ? $this->course->resources : [];
        $bags = [];
        if (\defined('RESOURCE_GLOSSARY') && !empty($res[RESOURCE_GLOSSARY]) && \is_array($res[RESOURCE_GLOSSARY])) {
            $bags[] = $res[RESOURCE_GLOSSARY];
        }
        foreach (['glossary', 'glossary_definition', 'glossary_terms'] as $k) {
            if (!empty($res[$k]) && \is_array($res[$k])) {
                $bags[] = $res[$k];
            }
        }

        $entries   = [];
        $seen      = [];
        $nextId    = 1;
        $userIds   = [];

        $norm = static function (string $s): string {
            $s = trim($s);
            $s = mb_strtolower($s, 'UTF-8');
            return $s;
        };

        foreach ($bags as $bag) {
            foreach ($bag as $g) {
                $o = (\is_object($g) && isset($g->obj) && \is_object($g->obj)) ? $g->obj : $g;
                if (!\is_object($o)) {
                    continue;
                }

                $concept = '';
                foreach (['name', 'term', 'title'] as $k) {
                    if (!empty($o->{$k}) && \is_string($o->{$k})) {
                        $concept = trim((string) $o->{$k});
                        break;
                    }
                }
                if ($concept === '') {
                    continue;
                }

                $key = $norm($concept);
                if (isset($seen[$key])) {
                    continue;
                }
                $seen[$key] = true;

                $definition = '';
                foreach (['description','definition','comment','text'] as $k) {
                    if (isset($o->{$k}) && \is_string($o->{$k})) {
                        $definition = (string) $o->{$k};
                        break;
                    }
                }

                $aliases = [];
                $lc = mb_strtolower($concept, 'UTF-8');
                if ($lc !== $concept) {
                    $aliases[] = $lc;
                }

                $entries[] = [
                    'id'           => $nextId++,
                    'userid'       => $adminId,
                    'concept'      => $concept,
                    'definition'   => $definition,
                    'timecreated'  => time(),
                    'timemodified' => time(),
                    'aliases'      => $aliases,
                ];
            }
        }

        if ($adminId > 0) {
            $userIds[$adminId] = true;
        }

        return [
            'id'               => $glossaryId,
            'moduleid'         => (int) $moduleId,
            'modulename'       => 'glossary',
            'contextid'        => (int) ($this->course->info['real_id'] ?? 0),
            'name'             => get_lang('Glossary'),
            'description'      => '',
            'timecreated'      => time(),
            'timemodified'     => time(),
            'sectionid'        => $sectionId,
            'sectionnumber'    => 0,
            'userid'           => $adminId,
            'entries'          => $entries,
            'users'            => array_map('intval', array_keys($userIds)),
            'files'            => [],
            'include_userinfo' => true,
        ];
    }

    /**
     * Create glossary.xml with all entries combined.
     */
    private function createGlossaryXml(array $glossaryData, string $glossaryDir): void
    {
        $esc = static function (?string $html): string {
            return htmlspecialchars((string) $html, ENT_QUOTES | ENT_SUBSTITUTE, 'UTF-8');
        };

        $introHtml = $glossaryData['description'] !== ''
            ? $glossaryData['description']
            : '<p>'.get_lang('Glossary').'</p>';

        $xml  = '<?xml version="1.0" encoding="UTF-8"?>'.PHP_EOL;
        $xml .= '<activity id="'.$glossaryData['id'].'" moduleid="'.$glossaryData['moduleid'].'" modulename="'.$glossaryData['modulename'].'" contextid="'.$glossaryData['contextid'].'">'.PHP_EOL;
        $xml .= '  <glossary id="'.$glossaryData['id'].'">'.PHP_EOL;
        $xml .= '    <name>'.$esc((string) $glossaryData['name']).'</name>'.PHP_EOL;
        $xml .= '    <intro>'.$esc($introHtml).'</intro>'.PHP_EOL;
        $xml .= '    <introformat>1</introformat>'.PHP_EOL;
        $xml .= '    <allowduplicatedentries>0</allowduplicatedentries>'.PHP_EOL;
        $xml .= '    <displayformat>dictionary</displayformat>'.PHP_EOL;
        $xml .= '    <mainglossary>0</mainglossary>'.PHP_EOL;
        $xml .= '    <showspecial>1</showspecial>'.PHP_EOL;
        $xml .= '    <showalphabet>1</showalphabet>'.PHP_EOL;
        $xml .= '    <showall>1</showall>'.PHP_EOL;
        $xml .= '    <allowcomments>0</allowcomments>'.PHP_EOL;
        $xml .= '    <allowprintview>1</allowprintview>'.PHP_EOL;
        $xml .= '    <usedynalink>1</usedynalink>'.PHP_EOL;
        $xml .= '    <defaultapproval>1</defaultapproval>'.PHP_EOL;
        $xml .= '    <globalglossary>0</globalglossary>'.PHP_EOL;
        $xml .= '    <entbypage>10</entbypage>'.PHP_EOL;
        $xml .= '    <editalways>0</editalways>'.PHP_EOL;
        $xml .= '    <rsstype>0</rsstype>'.PHP_EOL;
        $xml .= '    <rssarticles>0</rssarticles>'.PHP_EOL;
        $xml .= '    <assessed>0</assessed>'.PHP_EOL;
        $xml .= '    <assesstimestart>0</assesstimestart>'.PHP_EOL;
        $xml .= '    <assesstimefinish>0</assesstimefinish>'.PHP_EOL;
        $xml .= '    <scale>100</scale>'.PHP_EOL;
        $xml .= '    <timecreated>'.$glossaryData['timecreated'].'</timecreated>'.PHP_EOL;
        $xml .= '    <timemodified>'.$glossaryData['timemodified'].'</timemodified>'.PHP_EOL;
        $xml .= '    <completionentries>0</completionentries>'.PHP_EOL;

        // Entries
        $xml .= '    <entries>'.PHP_EOL;
        foreach ($glossaryData['entries'] as $entry) {
            $xml .= '      <entry id="'.$entry['id'].'">'.PHP_EOL;
            $xml .= '        <userid>'.$entry['userid'].'</userid>'.PHP_EOL;
            $xml .= '        <concept>'.$esc((string) $entry['concept']).'</concept>'.PHP_EOL;
            $xml .= '        <definition>'.$esc((string) $entry['definition']).'</definition>'.PHP_EOL;
            $xml .= '        <definitionformat>1</definitionformat>'.PHP_EOL;
            $xml .= '        <definitiontrust>0</definitiontrust>'.PHP_EOL;
            $xml .= '        <attachment></attachment>'.PHP_EOL;
            $xml .= '        <timecreated>'.$entry['timecreated'].'</timecreated>'.PHP_EOL;
            $xml .= '        <timemodified>'.$entry['timemodified'].'</timemodified>'.PHP_EOL;
            $xml .= '        <teacherentry>1</teacherentry>'.PHP_EOL;
            $xml .= '        <sourceglossaryid>0</sourceglossaryid>'.PHP_EOL;
            $xml .= '        <usedynalink>1</usedynalink>'.PHP_EOL;
            $xml .= '        <casesensitive>0</casesensitive>'.PHP_EOL;
            $xml .= '        <fullmatch>0</fullmatch>'.PHP_EOL;
            $xml .= '        <approved>1</approved>'.PHP_EOL;
            $xml .= '        <aliases>'.PHP_EOL;
            $aliasId = 1;
            if (!empty($entry['aliases']) && \is_array($entry['aliases'])) {
                foreach ($entry['aliases'] as $a) {
                    $xml .= '          <alias id="'.$aliasId.'">'.PHP_EOL;
                    $xml .= '            <alias_text>'.$esc((string) $a).'</alias_text>'.PHP_EOL;
                    $xml .= '          </alias>'.PHP_EOL;
                    $aliasId++;
                }
            }
            $xml .= '        </aliases>'.PHP_EOL;
            $xml .= '        <ratings></ratings>'.PHP_EOL;
            $xml .= '      </entry>'.PHP_EOL;
        }
        $xml .= '    </entries>'.PHP_EOL;

        $xml .= '    <entriestags></entriestags>'.PHP_EOL;
        $xml .= '    <categories></categories>'.PHP_EOL;
        $xml .= '  </glossary>'.PHP_EOL;
        $xml .= '</activity>';

        $this->createXmlFile('glossary', $xml, $glossaryDir);
    }
}