ForumExport::createForumXml() - Code Metrics - Inspection of "Maintenance: Implement MBZ file generation for Moo..." - chamilo/chamilo-lms - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — 1.11.x ( 120e79...41af88 )

by Yannick

created 2024-09-17 21:53 UTC

ForumExport::createForumXml() B

↳ Parent: ForumExport

Complexity

Conditions	3
Paths	3

Size

Total Lines	83
Code Lines	74

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
eloc	74
c	1
b	0
f	0
dl	0
loc	83
rs	8.5672
cc	3
nc	3
nop	2

How to fix Long Method

<?php

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

namespace moodleexport;

/**
 * Class ForumExport.
 *
 * Handles the export of forums within a course.
 */
class ForumExport extends ActivityExport
{
    /**
     * Export all forum data into a single Moodle forum activity.
     *
     * @param int $activityId The ID of the forum.
     * @param string $exportDir The directory where the forum will be exported.
     * @param int $moduleId The ID of the module.
     * @param int $sectionId The ID of the section.
     */
    public function export($activityId, $exportDir, $moduleId, $sectionId): void
    {
        // Prepare the directory where the forum export will be saved
        $forumDir = $this->prepareActivityDirectory($exportDir, 'forum', $moduleId);

        // Retrieve forum data
        $forumData = $this->getData($activityId, $sectionId);

        // Generate XML files for the forum
        $this->createForumXml($forumData, $forumDir);
        $this->createModuleXml($forumData, $forumDir);
        $this->createGradesXml($forumData, $forumDir);
        $this->createGradeHistoryXml($forumData, $forumDir);
        $this->createInforefXml($forumData, $forumDir);
        $this->createRolesXml($forumData, $forumDir);
        $this->createCalendarXml($forumData, $forumDir);
        $this->createCommentsXml($forumData, $forumDir);
        $this->createCompetenciesXml($forumData, $forumDir);
        $this->createFiltersXml($forumData, $forumDir);
    }

    /**
     * Create the forum.xml file with all forum data.
     */
    private function createForumXml(array $forumData, string $forumDir): void
    {
        $xmlContent = '<?xml version="1.0" encoding="UTF-8"?>' . PHP_EOL;
        $xmlContent .= '<activity id="' . $forumData['id'] . '" moduleid="' . $forumData['moduleid'] . '" modulename="'.$forumData['modulename'].'" contextid="' . $forumData['contextid'] . '">' . PHP_EOL;
        $xmlContent .= '  <forum id="' . $forumData['id'] . '">' . PHP_EOL;
        $xmlContent .= '    <type>general</type>' . PHP_EOL;
        $xmlContent .= '    <name>' . htmlspecialchars($forumData['name']) . '</name>' . PHP_EOL;
        $xmlContent .= '    <intro>' . htmlspecialchars($forumData['description']) . '</intro>' . PHP_EOL;
        $xmlContent .= '    <introformat>1</introformat>' . PHP_EOL;
        $xmlContent .= '    <duedate>0</duedate>' . PHP_EOL;
        $xmlContent .= '    <cutoffdate>0</cutoffdate>' . PHP_EOL;
        $xmlContent .= '    <assessed>0</assessed>' . PHP_EOL;
        $xmlContent .= '    <assesstimestart>0</assesstimestart>' . PHP_EOL;
        $xmlContent .= '    <assesstimefinish>0</assesstimefinish>' . PHP_EOL;
        $xmlContent .= '    <scale>100</scale>' . PHP_EOL;
        $xmlContent .= '    <maxbytes>512000</maxbytes>' . PHP_EOL;
        $xmlContent .= '    <maxattachments>9</maxattachments>' . PHP_EOL;
        $xmlContent .= '    <forcesubscribe>0</forcesubscribe>' . PHP_EOL;
        $xmlContent .= '    <trackingtype>1</trackingtype>' . PHP_EOL;
        $xmlContent .= '    <rsstype>0</rsstype>' . PHP_EOL;
        $xmlContent .= '    <rssarticles>0</rssarticles>' . PHP_EOL;
        $xmlContent .= '    <timemodified>' . $forumData['timemodified'] . '</timemodified>' . PHP_EOL;
        $xmlContent .= '    <warnafter>0</warnafter>' . PHP_EOL;
        $xmlContent .= '    <blockafter>0</blockafter>' . PHP_EOL;
        $xmlContent .= '    <blockperiod>0</blockperiod>' . PHP_EOL;
        $xmlContent .= '    <completiondiscussions>0</completiondiscussions>' . PHP_EOL;
        $xmlContent .= '    <completionreplies>0</completionreplies>' . PHP_EOL;
        $xmlContent .= '    <completionposts>0</completionposts>' . PHP_EOL;
        $xmlContent .= '    <displaywordcount>0</displaywordcount>' . PHP_EOL;
        $xmlContent .= '    <lockdiscussionafter>0</lockdiscussionafter>' . PHP_EOL;
        $xmlContent .= '    <grade_forum>0</grade_forum>' . PHP_EOL;

        // Add forum threads
        $xmlContent .= '    <discussions>' . PHP_EOL;
        foreach ($forumData['threads'] as $thread) {
            $xmlContent .= '      <discussion id="' . $thread['id'] . '">' . PHP_EOL;
            $xmlContent .= '        <name>' . htmlspecialchars($thread['title']) . '</name>' . PHP_EOL;
            $xmlContent .= '        <firstpost>' . $thread['firstpost'] . '</firstpost>' . PHP_EOL;
            $xmlContent .= '        <userid>' . $thread['userid'] . '</userid>' . PHP_EOL;
            $xmlContent .= '        <groupid>-1</groupid>' . PHP_EOL;
            $xmlContent .= '        <assessed>0</assessed>' . PHP_EOL;
            $xmlContent .= '        <timemodified>' . $thread['timemodified'] . '</timemodified>' . PHP_EOL;
            $xmlContent .= '        <usermodified>' . $thread['usermodified'] . '</usermodified>' . PHP_EOL;
            $xmlContent .= '        <timestart>0</timestart>' . PHP_EOL;
            $xmlContent .= '        <timeend>0</timeend>' . PHP_EOL;
            $xmlContent .= '        <pinned>0</pinned>' . PHP_EOL;
            $xmlContent .= '        <timelocked>0</timelocked>' . PHP_EOL;

            // Add forum posts to the thread
            $xmlContent .= '        <posts>' . PHP_EOL;
            foreach ($thread['posts'] as $post) {
                $xmlContent .= '          <post id="' . $post['id'] . '">' . PHP_EOL;
                $xmlContent .= '            <parent>' . $post['parent'] . '</parent>' . PHP_EOL;
                $xmlContent .= '            <userid>' . $post['userid'] . '</userid>' . PHP_EOL;
                $xmlContent .= '            <created>' . $post['created'] . '</created>' . PHP_EOL;
                $xmlContent .= '            <modified>' . $post['modified'] . '</modified>' . PHP_EOL;
                $xmlContent .= '            <mailed>' . $post['mailed'] . '</mailed>' . PHP_EOL;
                $xmlContent .= '            <subject>' . htmlspecialchars($post['subject']) . '</subject>' . PHP_EOL;
                $xmlContent .= '            <message>' . htmlspecialchars($post['message']) . '</message>' . PHP_EOL;
                $xmlContent .= '            <messageformat>1</messageformat>' . PHP_EOL;
                $xmlContent .= '            <messagetrust>0</messagetrust>' . PHP_EOL;
                $xmlContent .= '            <attachment></attachment>' . PHP_EOL;
                $xmlContent .= '            <totalscore>0</totalscore>' . PHP_EOL;
                $xmlContent .= '            <mailnow>0</mailnow>' . PHP_EOL;
                $xmlContent .= '            <privatereplyto>0</privatereplyto>' . PHP_EOL;
                $xmlContent .= '            <ratings>' . PHP_EOL;
                $xmlContent .= '            </ratings>' . PHP_EOL;
                $xmlContent .= '          </post>' . PHP_EOL;
            }
            $xmlContent .= '        </posts>' . PHP_EOL;
            $xmlContent .= '        <discussion_subs>' . PHP_EOL;
            $xmlContent .= '            <discussion_sub id="'.$thread['id'].'">' . PHP_EOL;
            $xmlContent .= '              <userid>' . $thread['userid'] . '</userid>' . PHP_EOL;
            $xmlContent .= '              <preference>' . $thread['timemodified'] . '</preference>' . PHP_EOL;
            $xmlContent .= '            </discussion_sub>' . PHP_EOL;
            $xmlContent .= '        </discussion_subs>' . PHP_EOL;
            $xmlContent .= '      </discussion>' . PHP_EOL;
        }
        $xmlContent .= '    </discussions>' . PHP_EOL;
        $xmlContent .= '  </forum>' . PHP_EOL;
        $xmlContent .= '</activity>';

        $this->createXmlFile('forum', $xmlContent, $forumDir);
    }

    /**
     * Get all forum data from the course.
     */
    public function getData(int $forumId, int $sectionId): ?array
    {
        $forum = $this->course->resources['forum'][$forumId]->obj;

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

        $threads = [];
        foreach ($this->course->resources['thread'] as $threadId => $thread) {
            if ($thread->obj->forum_id == $forumId) {
                // Get the posts for each thread
                $posts = [];
                foreach ($this->course->resources['post'] as $postId => $post) {
                    if ($post->obj->thread_id == $threadId) {
                        $posts[] = [
                            'id' => $post->obj->post_id,
                            'userid' => $adminId,
                            'message' => $post->obj->post_text,
                            'created' => strtotime($post->obj->post_date),
                            'modified' => strtotime($post->obj->post_date),
                        ];
                    }
                }

                $threads[] = [
                    'id' => $thread->obj->thread_id,
                    'title' => $thread->obj->thread_title,
                    'userid' => $adminId,
                    'timemodified' => strtotime($thread->obj->thread_date),
                    'usermodified' => $adminId,
                    'posts' => $posts,
                ];
            }
        }

        $fileIds = [];

        return [
            'id' => $forumId,
            'moduleid' => $forumId,
            'modulename' => 'forum',
            'contextid' => $this->course->info['real_id'],
            'name' => $forum->forum_title,
            'description' => $forum->forum_comment,
            'timecreated' => time(),
            'timemodified' => time(),
            'sectionid' => $sectionId,
            'sectionnumber' => 1,
            'userid' => $adminId,
            'threads' => $threads,
            'users' => [$adminId],
            'files' => $fileIds,
        ];
    }
}


1			<?php
2
3			/* For licensing terms, see /license.txt */
4
5			namespace moodleexport;
6
7			/**
8			* Class ForumExport.
9			*
10			* Handles the export of forums within a course.
11			*/
12			class ForumExport extends ActivityExport
13			{
14			/**
15			* Export all forum data into a single Moodle forum activity.
16			*
17			* @param int $activityId The ID of the forum.
18			* @param string $exportDir The directory where the forum will be exported.
19			* @param int $moduleId The ID of the module.
20			* @param int $sectionId The ID of the section.
21			*/
22			public function export($activityId, $exportDir, $moduleId, $sectionId): void
23			{
24			// Prepare the directory where the forum export will be saved
25			$forumDir = $this->prepareActivityDirectory($exportDir, 'forum', $moduleId);
26
27			// Retrieve forum data
28			$forumData = $this->getData($activityId, $sectionId);
29
30			// Generate XML files for the forum
31			$this->createForumXml($forumData, $forumDir);
32			$this->createModuleXml($forumData, $forumDir);
33			$this->createGradesXml($forumData, $forumDir);
34			$this->createGradeHistoryXml($forumData, $forumDir);
35			$this->createInforefXml($forumData, $forumDir);
36			$this->createRolesXml($forumData, $forumDir);
37			$this->createCalendarXml($forumData, $forumDir);
38			$this->createCommentsXml($forumData, $forumDir);
39			$this->createCompetenciesXml($forumData, $forumDir);
40			$this->createFiltersXml($forumData, $forumDir);
41			}
42
43			/**
44			* Create the forum.xml file with all forum data.
45			*/
46			private function createForumXml(array $forumData, string $forumDir): void
47			{
48			$xmlContent = '<?xml version="1.0" encoding="UTF-8"?>' . PHP_EOL;
49			$xmlContent .= '<activity id="' . $forumData['id'] . '" moduleid="' . $forumData['moduleid'] . '" modulename="'.$forumData['modulename'].'" contextid="' . $forumData['contextid'] . '">' . PHP_EOL;
50			$xmlContent .= ' <forum id="' . $forumData['id'] . '">' . PHP_EOL;
51			$xmlContent .= ' <type>general</type>' . PHP_EOL;
52			$xmlContent .= ' <name>' . htmlspecialchars($forumData['name']) . '</name>' . PHP_EOL;
53			$xmlContent .= ' <intro>' . htmlspecialchars($forumData['description']) . '</intro>' . PHP_EOL;
54			$xmlContent .= ' <introformat>1</introformat>' . PHP_EOL;
55			$xmlContent .= ' <duedate>0</duedate>' . PHP_EOL;
56			$xmlContent .= ' <cutoffdate>0</cutoffdate>' . PHP_EOL;
57			$xmlContent .= ' <assessed>0</assessed>' . PHP_EOL;
58			$xmlContent .= ' <assesstimestart>0</assesstimestart>' . PHP_EOL;
59			$xmlContent .= ' <assesstimefinish>0</assesstimefinish>' . PHP_EOL;
60			$xmlContent .= ' <scale>100</scale>' . PHP_EOL;
61			$xmlContent .= ' <maxbytes>512000</maxbytes>' . PHP_EOL;
62			$xmlContent .= ' <maxattachments>9</maxattachments>' . PHP_EOL;
63			$xmlContent .= ' <forcesubscribe>0</forcesubscribe>' . PHP_EOL;
64			$xmlContent .= ' <trackingtype>1</trackingtype>' . PHP_EOL;
65			$xmlContent .= ' <rsstype>0</rsstype>' . PHP_EOL;
66			$xmlContent .= ' <rssarticles>0</rssarticles>' . PHP_EOL;
67			$xmlContent .= ' <timemodified>' . $forumData['timemodified'] . '</timemodified>' . PHP_EOL;
68			$xmlContent .= ' <warnafter>0</warnafter>' . PHP_EOL;
69			$xmlContent .= ' <blockafter>0</blockafter>' . PHP_EOL;
70			$xmlContent .= ' <blockperiod>0</blockperiod>' . PHP_EOL;
71			$xmlContent .= ' <completiondiscussions>0</completiondiscussions>' . PHP_EOL;
72			$xmlContent .= ' <completionreplies>0</completionreplies>' . PHP_EOL;
73			$xmlContent .= ' <completionposts>0</completionposts>' . PHP_EOL;
74			$xmlContent .= ' <displaywordcount>0</displaywordcount>' . PHP_EOL;
75			$xmlContent .= ' <lockdiscussionafter>0</lockdiscussionafter>' . PHP_EOL;
76			$xmlContent .= ' <grade_forum>0</grade_forum>' . PHP_EOL;
77
78			// Add forum threads
79			$xmlContent .= ' <discussions>' . PHP_EOL;
80			foreach ($forumData['threads'] as $thread) {
81			$xmlContent .= ' <discussion id="' . $thread['id'] . '">' . PHP_EOL;
82			$xmlContent .= ' <name>' . htmlspecialchars($thread['title']) . '</name>' . PHP_EOL;
83			$xmlContent .= ' <firstpost>' . $thread['firstpost'] . '</firstpost>' . PHP_EOL;
84			$xmlContent .= ' <userid>' . $thread['userid'] . '</userid>' . PHP_EOL;
85			$xmlContent .= ' <groupid>-1</groupid>' . PHP_EOL;
86			$xmlContent .= ' <assessed>0</assessed>' . PHP_EOL;
87			$xmlContent .= ' <timemodified>' . $thread['timemodified'] . '</timemodified>' . PHP_EOL;
88			$xmlContent .= ' <usermodified>' . $thread['usermodified'] . '</usermodified>' . PHP_EOL;
89			$xmlContent .= ' <timestart>0</timestart>' . PHP_EOL;
90			$xmlContent .= ' <timeend>0</timeend>' . PHP_EOL;
91			$xmlContent .= ' <pinned>0</pinned>' . PHP_EOL;
92			$xmlContent .= ' <timelocked>0</timelocked>' . PHP_EOL;
93
94			// Add forum posts to the thread
95			$xmlContent .= ' <posts>' . PHP_EOL;
96			foreach ($thread['posts'] as $post) {
97			$xmlContent .= ' <post id="' . $post['id'] . '">' . PHP_EOL;
98			$xmlContent .= ' <parent>' . $post['parent'] . '</parent>' . PHP_EOL;
99			$xmlContent .= ' <userid>' . $post['userid'] . '</userid>' . PHP_EOL;
100			$xmlContent .= ' <created>' . $post['created'] . '</created>' . PHP_EOL;
101			$xmlContent .= ' <modified>' . $post['modified'] . '</modified>' . PHP_EOL;
102			$xmlContent .= ' <mailed>' . $post['mailed'] . '</mailed>' . PHP_EOL;
103			$xmlContent .= ' <subject>' . htmlspecialchars($post['subject']) . '</subject>' . PHP_EOL;
104			$xmlContent .= ' <message>' . htmlspecialchars($post['message']) . '</message>' . PHP_EOL;
105			$xmlContent .= ' <messageformat>1</messageformat>' . PHP_EOL;
106			$xmlContent .= ' <messagetrust>0</messagetrust>' . PHP_EOL;
107			$xmlContent .= ' <attachment></attachment>' . PHP_EOL;
108			$xmlContent .= ' <totalscore>0</totalscore>' . PHP_EOL;
109			$xmlContent .= ' <mailnow>0</mailnow>' . PHP_EOL;
110			$xmlContent .= ' <privatereplyto>0</privatereplyto>' . PHP_EOL;
111			$xmlContent .= ' <ratings>' . PHP_EOL;
112			$xmlContent .= ' </ratings>' . PHP_EOL;
113			$xmlContent .= ' </post>' . PHP_EOL;
114			}
115			$xmlContent .= ' </posts>' . PHP_EOL;
116			$xmlContent .= ' <discussion_subs>' . PHP_EOL;
117			$xmlContent .= ' <discussion_sub id="'.$thread['id'].'">' . PHP_EOL;
118			$xmlContent .= ' <userid>' . $thread['userid'] . '</userid>' . PHP_EOL;
119			$xmlContent .= ' <preference>' . $thread['timemodified'] . '</preference>' . PHP_EOL;
120			$xmlContent .= ' </discussion_sub>' . PHP_EOL;
121			$xmlContent .= ' </discussion_subs>' . PHP_EOL;
122			$xmlContent .= ' </discussion>' . PHP_EOL;
123			}
124			$xmlContent .= ' </discussions>' . PHP_EOL;
125			$xmlContent .= ' </forum>' . PHP_EOL;
126			$xmlContent .= '</activity>';
127
128			$this->createXmlFile('forum', $xmlContent, $forumDir);
129			}
130
131			/**
132			* Get all forum data from the course.
133			*/
134			public function getData(int $forumId, int $sectionId): ?array
135			{
136			$forum = $this->course->resources['forum'][$forumId]->obj;
137
138			$adminData = MoodleExport::getAdminUserData();
139			$adminId = $adminData['id'];
140
141			$threads = [];
142			foreach ($this->course->resources['thread'] as $threadId => $thread) {
143			if ($thread->obj->forum_id == $forumId) {
144			// Get the posts for each thread
145			$posts = [];
146			foreach ($this->course->resources['post'] as $postId => $post) {
147			if ($post->obj->thread_id == $threadId) {
148			$posts[] = [
149			'id' => $post->obj->post_id,
150			'userid' => $adminId,
151			'message' => $post->obj->post_text,
152			'created' => strtotime($post->obj->post_date),
153			'modified' => strtotime($post->obj->post_date),
154			];
155			}
156			}
157
158			$threads[] = [
159			'id' => $thread->obj->thread_id,
160			'title' => $thread->obj->thread_title,
161			'userid' => $adminId,
162			'timemodified' => strtotime($thread->obj->thread_date),
163			'usermodified' => $adminId,
164			'posts' => $posts,
165			];
166			}
167			}
168
169			$fileIds = [];
170
171			return [
172			'id' => $forumId,
173			'moduleid' => $forumId,
174			'modulename' => 'forum',
175			'contextid' => $this->course->info['real_id'],
176			'name' => $forum->forum_title,
177			'description' => $forum->forum_comment,
178			'timecreated' => time(),
179			'timemodified' => time(),
180			'sectionid' => $sectionId,
181			'sectionnumber' => 1,
182			'userid' => $adminId,
183			'threads' => $threads,
184			'users' => [$adminId],
185			'files' => $fileIds,
186			];
187			}
188			}
189

chamilo / chamilo-lms

Push — 1.11.x ( 120e79...41af88 )

ForumExport::createForumXml() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like