moodleexport\ActivityExport

Complexity

Total Complexity

43

Size/Duplication

Total Lines	292
Duplicated Lines	0 %

Importance

Changes

0

15 Methods

Rating	Name	Duplication	Size	Complexity
A	prepareActivityDirectory()	0	8	2
A	createCompetenciesXml()	0	10	1
A	createCommentsXml()	0	11	1
B	lpItemTitle()	0	17	9
A	createGradesXml()	0	8	1
A	createCompletionXml()	0	13	1
A	createGradeHistoryXml()	0	9	1
B	createInforefXml()	0	31	7
A	createXmlFile()	0	5	2
A	__construct()	0	3	1
C	getSectionIdForActivity()	0	41	13
A	createCalendarXml()	0	11	1
A	createModuleXml()	0	26	1
A	createFiltersXml()	0	11	1
A	createRolesXml()	0	6	1

<?php

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

namespace moodleexport;

use Exception;

/**
 * Class ActivityExport.
 *
 * Base class for exporting common activities.
 */
abstract class ActivityExport
{
    protected $course;
    public const DOCS_MODULE_ID = 1000000;

    public function __construct($course)
    {
        $this->course = $course;
    }

    /**
     * Abstract method for exporting the activity.
     * Must be implemented by child classes.
     */
    abstract public function export($activityId, $exportDir, $moduleId, $sectionId);

    /**
     * Get the section ID (learnpath source_id) for a given activity.
     */
    public function getSectionIdForActivity(int $activityId, string $itemType): int
    {
        if (empty($this->course->resources[RESOURCE_LEARNPATH])) {
            return 0;
        }

        foreach ($this->course->resources[RESOURCE_LEARNPATH] as $learnpath) {
            if (empty($learnpath->items)) {
                continue;
            }

            foreach ($learnpath->items as $item) {
                $normalizedType = $item['item_type'] === 'student_publication'
                    ? 'work'
                    : $item['item_type'];

                if ($normalizedType !== $itemType) {
                    continue;
                }

                // Classic case: LP stores the numeric id in "path"
                if (ctype_digit((string) $item['path']) && (int) $item['path'] === $activityId) {
                    return (int) $learnpath->source_id;
                }

                // Fallback for documents when LP stores the path instead of the id
                if ($itemType === RESOURCE_DOCUMENT) {
                    $doc = \DocumentManager::get_document_data_by_id($activityId, $this->course->code);
                    if (!empty($doc['path'])) {
                        $p = (string) $doc['path'];
                        foreach ([$p, 'document/'.$p, '/'.$p] as $candidate) {
                            if ((string) $item['path'] === $candidate) {
                                return (int) $learnpath->source_id;
                            }
                        }
                    }
                }
            }
        }

        return 0;
    }

    /**
     * Prepares the directory for the activity.
     */
    protected function prepareActivityDirectory(string $exportDir, string $activityType, int $moduleId): string
    {
        $activityDir = "{$exportDir}/activities/{$activityType}_{$moduleId}";
        if (!is_dir($activityDir)) {
            mkdir($activityDir, 0777, true);
        }

        return $activityDir;
    }

    /**
     * Creates a generic XML file.
     */
    protected function createXmlFile(string $fileName, string $xmlContent, string $directory): void
    {
        $filePath = $directory.'/'.$fileName.'.xml';
        if (file_put_contents($filePath, $xmlContent) === false) {
            throw new Exception("Error creating {$fileName}.xml");
        }
    }

    /**
     * Creates the module.xml file.
     */
    protected function createModuleXml(array $data, string $directory): void
    {
        $xmlContent = '<?xml version="1.0" encoding="UTF-8"?>'.PHP_EOL;
        $xmlContent .= '<module id="'.$data['moduleid'].'" version="2021051700">'.PHP_EOL;
        $xmlContent .= '  <modulename>'.$data['modulename'].'</modulename>'.PHP_EOL;
        $xmlContent .= '  <sectionid>'.$data['sectionid'].'</sectionid>'.PHP_EOL;
        $xmlContent .= '  <sectionnumber>'.$data['sectionnumber'].'</sectionnumber>'.PHP_EOL;
        $xmlContent .= '  <idnumber></idnumber>'.PHP_EOL;
        $xmlContent .= '  <added>'.time().'</added>'.PHP_EOL;
        $xmlContent .= '  <score>0</score>'.PHP_EOL;
        $xmlContent .= '  <indent>0</indent>'.PHP_EOL;
        $xmlContent .= '  <visible>1</visible>'.PHP_EOL;
        $xmlContent .= '  <visibleoncoursepage>1</visibleoncoursepage>'.PHP_EOL;
        $xmlContent .= '  <visibleold>1</visibleold>'.PHP_EOL;
        $xmlContent .= '  <groupmode>0</groupmode>'.PHP_EOL;
        $xmlContent .= '  <groupingid>0</groupingid>'.PHP_EOL;
        $xmlContent .= '  <completion>1</completion>'.PHP_EOL;
        $xmlContent .= '  <completiongradeitemnumber>$@NULL@$</completiongradeitemnumber>'.PHP_EOL;
        $xmlContent .= '  <completionview>0</completionview>'.PHP_EOL;
        $xmlContent .= '  <completionexpected>0</completionexpected>'.PHP_EOL;
        $xmlContent .= '  <availability>$@NULL@$</availability>'.PHP_EOL;
        $xmlContent .= '  <showdescription>0</showdescription>'.PHP_EOL;
        $xmlContent .= '  <tags></tags>'.PHP_EOL;
        $xmlContent .= '</module>'.PHP_EOL;

        $this->createXmlFile('module', $xmlContent, $directory);
    }

    /**
     * Creates the grades.xml file.
     */
    protected function createGradesXml(array $data, string $directory): void
    {
        $xmlContent = '<?xml version="1.0" encoding="UTF-8"?>'.PHP_EOL;
        $xmlContent .= '<activity_gradebook>'.PHP_EOL;
        $xmlContent .= '  <grade_items></grade_items>'.PHP_EOL;
        $xmlContent .= '</activity_gradebook>'.PHP_EOL;

        $this->createXmlFile('grades', $xmlContent, $directory);
    }

    /**
     * Creates the inforef.xml file, referencing users and files associated with the activity.
     */
    protected function createInforefXml(array $references, string $directory): void
    {
        // Start the XML content
        $xmlContent = '<?xml version="1.0" encoding="UTF-8"?>'.PHP_EOL;
        $xmlContent .= '<inforef>'.PHP_EOL;

        // Add user references if provided
        if (isset($references['users']) && is_array($references['users'])) {
            $xmlContent .= '  <userref>'.PHP_EOL;
            foreach ($references['users'] as $userId) {
                $xmlContent .= '    <user>'.PHP_EOL;
                $xmlContent .= '      <id>'.htmlspecialchars($userId).'</id>'.PHP_EOL;
                $xmlContent .= '    </user>'.PHP_EOL;
            }
            $xmlContent .= '  </userref>'.PHP_EOL;
        }

        // Add file references if provided
        if (isset($references['files']) && is_array($references['files'])) {
            $xmlContent .= '  <fileref>'.PHP_EOL;
            foreach ($references['files'] as $file) {
                $xmlContent .= '    <file>'.PHP_EOL;
                $xmlContent .= '      <id>'.htmlspecialchars($file['id']).'</id>'.PHP_EOL;
                $xmlContent .= '    </file>'.PHP_EOL;
            }
            $xmlContent .= '  </fileref>'.PHP_EOL;
        }

        $xmlContent .= '</inforef>'.PHP_EOL;

        $this->createXmlFile('inforef', $xmlContent, $directory);
    }

    /**
     * Creates the roles.xml file.
     */
    protected function createRolesXml(array $activityData, string $directory): void
    {
        $xmlContent = '<?xml version="1.0" encoding="UTF-8"?>'.PHP_EOL;
        $xmlContent .= '<roles></roles>'.PHP_EOL;

        $this->createXmlFile('roles', $xmlContent, $directory);
    }

    /**
     * Creates the filters.xml file for the activity.
     */
    protected function createFiltersXml(array $activityData, string $destinationDir): void
    {
        $xmlContent = '<?xml version="1.0" encoding="UTF-8"?>'.PHP_EOL;
        $xmlContent .= '<filters>'.PHP_EOL;
        $xmlContent .= '  <filter_actives>'.PHP_EOL;
        $xmlContent .= '  </filter_actives>'.PHP_EOL;
        $xmlContent .= '  <filter_configs>'.PHP_EOL;
        $xmlContent .= '  </filter_configs>'.PHP_EOL;
        $xmlContent .= '</filters>'.PHP_EOL;

        $this->createXmlFile('filters', $xmlContent, $destinationDir);
    }

    /**
     * Creates the grade_history.xml file for the activity.
     */
    protected function createGradeHistoryXml(array $activityData, string $destinationDir): void
    {
        $xmlContent = '<?xml version="1.0" encoding="UTF-8"?>'.PHP_EOL;
        $xmlContent .= '<grade_history>'.PHP_EOL;
        $xmlContent .= '  <grade_grades>'.PHP_EOL;
        $xmlContent .= '  </grade_grades>'.PHP_EOL;
        $xmlContent .= '</grade_history>'.PHP_EOL;

        $this->createXmlFile('grade_history', $xmlContent, $destinationDir);
    }

    /**
     * Creates the completion.xml file.
     */
    protected function createCompletionXml(array $activityData, string $destinationDir): void
    {
        $xmlContent = '<?xml version="1.0" encoding="UTF-8"?>'.PHP_EOL;
        $xmlContent .= '<completion>'.PHP_EOL;
        $xmlContent .= '  <completiondata>'.PHP_EOL;
        $xmlContent .= '    <completion>'.PHP_EOL;
        $xmlContent .= '      <timecompleted>0</timecompleted>'.PHP_EOL;
        $xmlContent .= '      <completionstate>1</completionstate>'.PHP_EOL;
        $xmlContent .= '    </completion>'.PHP_EOL;
        $xmlContent .= '  </completiondata>'.PHP_EOL;
        $xmlContent .= '</completion>'.PHP_EOL;

        $this->createXmlFile('completion', $xmlContent, $destinationDir);
    }

    /**
     * Creates the comments.xml file.
     */
    protected function createCommentsXml(array $activityData, string $destinationDir): void
    {
        $xmlContent = '<?xml version="1.0" encoding="UTF-8"?>'.PHP_EOL;
        $xmlContent .= '<comments>'.PHP_EOL;
        $xmlContent .= '  <comment>'.PHP_EOL;
        $xmlContent .= '    <content>This is a sample comment</content>'.PHP_EOL;
        $xmlContent .= '    <author>Professor</author>'.PHP_EOL;
        $xmlContent .= '  </comment>'.PHP_EOL;
        $xmlContent .= '</comments>'.PHP_EOL;

        $this->createXmlFile('comments', $xmlContent, $destinationDir);
    }

    /**
     * Creates the competencies.xml file.
     */
    protected function createCompetenciesXml(array $activityData, string $destinationDir): void
    {
        $xmlContent = '<?xml version="1.0" encoding="UTF-8"?>'.PHP_EOL;
        $xmlContent .= '<competencies>'.PHP_EOL;
        $xmlContent .= '  <competency>'.PHP_EOL;
        $xmlContent .= '    <name>Sample Competency</name>'.PHP_EOL;
        $xmlContent .= '  </competency>'.PHP_EOL;
        $xmlContent .= '</competencies>'.PHP_EOL;

        $this->createXmlFile('competencies', $xmlContent, $destinationDir);
    }

    /**
     * Creates the calendar.xml file.
     */
    protected function createCalendarXml(array $activityData, string $destinationDir): void
    {
        $xmlContent = '<?xml version="1.0" encoding="UTF-8"?>'.PHP_EOL;
        $xmlContent .= '<calendar>'.PHP_EOL;
        $xmlContent .= '  <event>'.PHP_EOL;
        $xmlContent .= '    <name>Due Date</name>'.PHP_EOL;
        $xmlContent .= '    <timestart>'.time().'</timestart>'.PHP_EOL;
        $xmlContent .= '  </event>'.PHP_EOL;
        $xmlContent .= '</calendar>'.PHP_EOL;

        $this->createXmlFile('calendar', $xmlContent, $destinationDir);
    }

    /**
     * Returns the title of the item in the LP (if it exists); otherwise, $fallback.
     */
    protected function lpItemTitle(int $sectionId, string $itemType, int $resourceId, ?string $fallback): string
    {
        if (!isset($this->course->resources[RESOURCE_LEARNPATH])) {
            return $fallback ?? '';
        }
        foreach ($this->course->resources[RESOURCE_LEARNPATH] as $lp) {
            if ((int) $lp->source_id !== $sectionId || empty($lp->items)) {
                continue;
            }
            foreach ($lp->items as $it) {
                $type = $it['item_type'] === 'student_publication' ? 'work' : $it['item_type'];
                if ($type === $itemType && (int) $it['path'] === $resourceId) {
                    return $it['title'] ?? ($fallback ?? '');
                }
            }
        }
        return $fallback ?? '';
    }
}