Cc13Convert::processSequence() - Code Metrics - Inspection of "Plugin: IMS/LTI Provider: Implement quizzes as too..." - chamilo/chamilo-lms - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — 1.11.x ( 47915c...7101db )

by Yannick

created 2021-08-24 22:10 UTC

Cc13Convert::processSequence() A

↳ Parent: Cc13Convert

Complexity

Conditions	5
Paths	5

Size

Total Lines	12
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	5
eloc	10
c	1
b	0
f	0
nc	5
nop	5
dl	0
loc	12
rs	9.6111

<?php
/* For licensing terms, see /license.txt */

class Cc13Convert
{
    public static function convert($packagedir, $outdir, $objCourse)
    {
        $dir = realpath($packagedir);
        if (empty($dir)) {
            throw new InvalidArgumentException('Directory does not exist!');
        }
        $odir = realpath($outdir);
        if (empty($odir)) {
            throw new InvalidArgumentException('Directory does not exist!');
        }

        if (!empty($objCourse)) {
            //Initialize the manifest metadata class
            $meta = new CcMetadataManifest();

            //Package metadata
            $metageneral = new CcMetadataGeneral();
            $metageneral->setLanguage($objCourse->info['language']);
            $metageneral->setTitle($objCourse->info['title'], $objCourse->info['language']);
            $metageneral->setDescription('', $objCourse->info['language']);
            $metageneral->setCatalog('category');
            $metageneral->setEntry($objCourse->info['categoryName']);
            $meta->addMetadataGeneral($metageneral);

            // Create the manifest
            $manifest = new CcManifest();

            $manifest->addMetadataManifest($meta);

            $organization = null;

            //Get the course structure - this will be transformed into organization
            //Step 1 - Get the list and order of sections/topics

            $count = 1;
            $sections = [];
            $resources = $objCourse->resources;

            // We check the quiz sections
            if (isset($resources['quiz'])) {
                $quizSections = self::getItemSections($resources['quiz'], 'quiz', $count, $objCourse->info['code'], $resources['Exercise_Question']);
                $sections = array_merge($sections, $quizSections);
            }

            // We check the document sections
            if (isset($resources['document'])) {
                $documentSections = self::getItemSections($resources['document'], 'document', $count, $objCourse->info['code']);
                $sections = array_merge($sections, $documentSections);
            }

            // We check the wiki sections
            if (isset($resources['wiki'])) {
                $wikiSections = self::getItemSections($resources['wiki'], 'wiki', $count, $objCourse->info['code']);
                $sections = array_merge($sections, $wikiSections);
            }

            // We check the forum sections
            if (isset($resources['forum'])) {
                $forumSections = self::getItemSections($resources['forum'], 'forum', $count, $objCourse->info['code'], $resources['Forum_Category']);
                $sections = array_merge($sections, $forumSections);
            }

            // We check the link sections
            if (isset($resources['link'])) {
                $linkSections = self::getItemSections($resources['link'], 'link', $count, $objCourse->info['code'], $resources['Link_Category']);
                $sections = array_merge($sections, $linkSections);
            }

            //organization title
            $organization = new CcOrganization();
            foreach ($sections as $sectionid => $values) {
                $item = new CcItem();
                $item->title = $values[0];
                self::processSequence($item, $manifest, $values[1], $dir, $odir);
                $organization->addItem($item);
            }
            $manifest->putNodes();

            if (!empty($organization)) {
                $manifest->addNewOrganization($organization);
            }

            $manifestpath = $outdir.DIRECTORY_SEPARATOR.'imsmanifest.xml';
            $saved = $manifest->saveTo($manifestpath);

            return $saved;
        }

        return false;
    }

    protected static function getItemSections($itemData, $itemType, &$count, $courseCode, $itmesExtraData = null)
    {
        $sections = [];
        switch ($itemType) {
            case 'quiz':
            case 'document':
            case 'wiki':
                $convertType = $itemType;
                if ($itemType == 'wiki') {
                    $convertType = 'Page';
                }
                $sectionid = $count;
                $sectiontitle = ucfirst($itemType);
                $sequence = self::getSequence($itemData, 0, $convertType, $courseCode, $itmesExtraData);
                $sections[$sectionid] = [$sectiontitle, $sequence];
                $count++;
                break;
            case 'link':
                $links = self::getSequence($itemData, null, $itemType);
                foreach ($links as $categoryId => $sequence) {
                    $sectionid = $count;
                    if (isset($itmesExtraData[$categoryId])) {
                        $sectiontitle = $itmesExtraData[$categoryId]->title;
                    } else {
                        $sectiontitle = 'General';
                    }
                    $sections[$sectionid] = [$sectiontitle, $sequence];
                    $count++;
                }
                break;
            case 'forum':
                if (isset($itmesExtraData)) {
                    foreach ($itmesExtraData as $fcategory) {
                        if (isset($fcategory->obj)) {
                            $objCategory = $fcategory->obj;
                            $sectionid = $count;
                            $sectiontitle = $objCategory->cat_title;
                            $sequence = self::getSequence($itemData, $objCategory->iid, $itemType);
                            $sections[$sectionid] = [$sectiontitle, $sequence];
                            $count++;
                        }
                    }
                }
                break;
        }

        return $sections;
    }

    protected static function getSequence($objItems, $categoryId = null, $itemType = null, $coursecode = null, $itemQuestions = null)
    {
        $sequences = [];
        switch ($itemType) {
            case 'quiz':
                $sequence = [];
                foreach ($objItems as $objItem) {
                    if ($categoryId === 0) {
                        $questions = [];
                        foreach ($objItem->obj->question_ids as $questionId) {
                            if (isset($itemQuestions[$questionId])) {
                                $questions[$questionId] = $itemQuestions[$questionId];
                            }
                        }
                        $sequence[$categoryId][$objItem->obj->iid] = [
                            'title' => $objItem->obj->title,
                            'comment' => $objItem->obj->description,
                            'cc_type' => 'quiz',
                            'source_id' => $objItem->obj->iid,
                            'questions' => $questions,
                            'max_attempt' => $objItem->obj->max_attempt,
                            'expired_time' => $objItem->obj->expired_time,
                            'pass_percentage' => $objItem->obj->pass_percentage,
                            'random_answers' => $objItem->obj->random_answers,
                            'course_code' => $coursecode,
                        ];
                    }
                }
                $sequences = $sequence[$categoryId];
                break;
            case 'document':
                $sequence = [];
                foreach ($objItems as $objItem) {
                    if ($categoryId === 0) {
                        $sequence[$categoryId][$objItem->source_id] = [
                            'title' => $objItem->title,
                            'comment' => $objItem->comment,
                            'cc_type' => ($objItem->file_type == 'folder' ? 'folder' : 'resource'),
                            'source_id' => $objItem->source_id,
                            'path' => $objItem->path,
                            'file_type' => $objItem->file_type,
                            'course_code' => $coursecode,
                        ];
                    }
                }
                $sequences = $sequence[$categoryId];
                break;
            case 'forum':
                foreach ($objItems as $objItem) {
                    if ($categoryId == $objItem->obj->forum_category) {
                        $sequence[$categoryId][$objItem->obj->forum_id] = [
                            'title' => $objItem->obj->forum_title,
                            'comment' => $objItem->obj->forum_comment,
                            'cc_type' => 'forum',
                            'source_id' => $objItem->obj->iid,
                        ];
                    }
                }
                $sequences = $sequence[$categoryId];

                break;
            case 'page':
                foreach ($objItems as $objItem) {
                    if ($categoryId === 0) {
                        $sequence[$categoryId][$objItem->page_id] = [
                            'title' => $objItem->title,
                            'comment' => $objItem->content,
                            'cc_type' => 'page',
                            'source_id' => $objItem->page_id,
                            'reflink' => $objItem->reflink,
                        ];
                    }
                }
                $sequences = $sequence[$categoryId];
                break;
            case 'link':
                if (!isset($categoryId)) {
                    $categories = [];
                    foreach ($objItems as $objItem) {
                        $categories[$objItem->category_id] = self::getSequence($objItems, $objItem->category_id, $itemType);
                    }
                    $sequences = $categories;
                } else {
                    foreach ($objItems as $objItem) {
                        if ($categoryId == $objItem->category_id) {
                            $sequence[$categoryId][$objItem->source_id] = [
                                'title' => $objItem->title,
                                'comment' => $objItem->description,
                                'cc_type' => 'url',
                                'source_id' => $objItem->source_id,
                                'url' => $objItem->url,
                                'target' => $objItem->target,
                            ];
                        }
                    }
                    $sequences = $sequence[$categoryId];
                }
                break;
        }

        return $sequences;
    }

    protected static function processSequence(CcIItem &$item, CcIManifest &$manifest, array $sequence, $packageroot, $outdir)
    {
        if (!empty($sequence)) {
            foreach ($sequence as $seq) {
                $activity_type = ucfirst($seq['cc_type']);
                $activity_indentation = 0;
                $aitem = self::itemIndenter($item, $activity_indentation);
                $caller = "CcConverter{$activity_type}";
                if (class_exists($caller)) {
                    $obj = new $caller($aitem, $manifest, $packageroot, $path);

                    if (!$obj->convert($outdir, $seq)) {
                        throw new RuntimeException("failed to convert {$activity_type}");
                    }
                }
            }
        }
    }

    protected static function itemIndenter(CcIItem &$item, $level = 0)
    {
        $indent = (int) $level;
        $indent = ($indent) <= 0 ? 0 : $indent;
        $nprev = null;
        $nfirst = null;
        for ($pos = 0, $size = $indent; $pos < $size; $pos++) {
            $nitem = new CcItem();
            $nitem->title = '';
            if (empty($nfirst)) {
                $nfirst = $nitem;
            }
            if (!empty($nprev)) {
                $nprev->addChildItem($nitem);
            }
            $nprev = $nitem;
        }
        $result = $item;
        if (!empty($nfirst)) {
            $item->addChildItem($nfirst);
            $result = $nprev;
        }

        return $result;
    }
}


1			<?php
2			/* For licensing terms, see /license.txt */
3
4			class Cc13Convert
5			{
6			public static function convert($packagedir, $outdir, $objCourse)
7			{
8			$dir = realpath($packagedir);
9			if (empty($dir)) {
10			throw new InvalidArgumentException('Directory does not exist!');
11			}
12			$odir = realpath($outdir);
13			if (empty($odir)) {
14			throw new InvalidArgumentException('Directory does not exist!');
15			}
16
17			if (!empty($objCourse)) {
18			//Initialize the manifest metadata class
19			$meta = new CcMetadataManifest();
20
21			//Package metadata
22			$metageneral = new CcMetadataGeneral();
23			$metageneral->setLanguage($objCourse->info['language']);
24			$metageneral->setTitle($objCourse->info['title'], $objCourse->info['language']);
25			$metageneral->setDescription('', $objCourse->info['language']);
26			$metageneral->setCatalog('category');
27			$metageneral->setEntry($objCourse->info['categoryName']);
28			$meta->addMetadataGeneral($metageneral);
29
30			// Create the manifest
31			$manifest = new CcManifest();
32
33			$manifest->addMetadataManifest($meta);
34
35			$organization = null;
36
37			//Get the course structure - this will be transformed into organization
38			//Step 1 - Get the list and order of sections/topics
39
40			$count = 1;
41			$sections = [];
42			$resources = $objCourse->resources;
43
44			// We check the quiz sections
45			if (isset($resources['quiz'])) {
46			$quizSections = self::getItemSections($resources['quiz'], 'quiz', $count, $objCourse->info['code'], $resources['Exercise_Question']);
47			$sections = array_merge($sections, $quizSections);
48			}
49
50			// We check the document sections
51			if (isset($resources['document'])) {
52			$documentSections = self::getItemSections($resources['document'], 'document', $count, $objCourse->info['code']);
53			$sections = array_merge($sections, $documentSections);
54			}
55
56			// We check the wiki sections
57			if (isset($resources['wiki'])) {
58			$wikiSections = self::getItemSections($resources['wiki'], 'wiki', $count, $objCourse->info['code']);
59			$sections = array_merge($sections, $wikiSections);
60			}
61
62			// We check the forum sections
63			if (isset($resources['forum'])) {
64			$forumSections = self::getItemSections($resources['forum'], 'forum', $count, $objCourse->info['code'], $resources['Forum_Category']);
65			$sections = array_merge($sections, $forumSections);
66			}
67
68			// We check the link sections
69			if (isset($resources['link'])) {
70			$linkSections = self::getItemSections($resources['link'], 'link', $count, $objCourse->info['code'], $resources['Link_Category']);
71			$sections = array_merge($sections, $linkSections);
72			}
73
74			//organization title
75			$organization = new CcOrganization();
76			foreach ($sections as $sectionid => $values) {
77			$item = new CcItem();
78			$item->title = $values[0];
79			self::processSequence($item, $manifest, $values[1], $dir, $odir);
80			$organization->addItem($item);
81			}
82			$manifest->putNodes();
83
84			if (!empty($organization)) {
85			$manifest->addNewOrganization($organization);
86			}
87
88			$manifestpath = $outdir.DIRECTORY_SEPARATOR.'imsmanifest.xml';
89			$saved = $manifest->saveTo($manifestpath);
90
91			return $saved;
92			}
93
94			return false;
95			}
96
97			protected static function getItemSections($itemData, $itemType, &$count, $courseCode, $itmesExtraData = null)
98			{
99			$sections = [];
100			switch ($itemType) {
101			case 'quiz':
102			case 'document':
103			case 'wiki':
104			$convertType = $itemType;
105			if ($itemType == 'wiki') {
106			$convertType = 'Page';
107			}
108			$sectionid = $count;
109			$sectiontitle = ucfirst($itemType);
110			$sequence = self::getSequence($itemData, 0, $convertType, $courseCode, $itmesExtraData);
111			$sections[$sectionid] = [$sectiontitle, $sequence];
112			$count++;
113			break;
114			case 'link':
115			$links = self::getSequence($itemData, null, $itemType);
116			foreach ($links as $categoryId => $sequence) {
117			$sectionid = $count;
118			if (isset($itmesExtraData[$categoryId])) {
119			$sectiontitle = $itmesExtraData[$categoryId]->title;
120			} else {
121			$sectiontitle = 'General';
122			}
123			$sections[$sectionid] = [$sectiontitle, $sequence];
124			$count++;
125			}
126			break;
127			case 'forum':
128			if (isset($itmesExtraData)) {
129			foreach ($itmesExtraData as $fcategory) {
130			if (isset($fcategory->obj)) {
131			$objCategory = $fcategory->obj;
132			$sectionid = $count;
133			$sectiontitle = $objCategory->cat_title;
134			$sequence = self::getSequence($itemData, $objCategory->iid, $itemType);
135			$sections[$sectionid] = [$sectiontitle, $sequence];
136			$count++;
137			}
138			}
139			}
140			break;
141			}
142
143			return $sections;
144			}
145
146			protected static function getSequence($objItems, $categoryId = null, $itemType = null, $coursecode = null, $itemQuestions = null)
147			{
148			$sequences = [];
149			switch ($itemType) {
150			case 'quiz':
151			$sequence = [];
152			foreach ($objItems as $objItem) {
153			if ($categoryId === 0) {
154			$questions = [];
155			foreach ($objItem->obj->question_ids as $questionId) {
156			if (isset($itemQuestions[$questionId])) {
157			$questions[$questionId] = $itemQuestions[$questionId];
158			}
159			}
160			$sequence[$categoryId][$objItem->obj->iid] = [
161			'title' => $objItem->obj->title,
162			'comment' => $objItem->obj->description,
163			'cc_type' => 'quiz',
164			'source_id' => $objItem->obj->iid,
165			'questions' => $questions,
166			'max_attempt' => $objItem->obj->max_attempt,
167			'expired_time' => $objItem->obj->expired_time,
168			'pass_percentage' => $objItem->obj->pass_percentage,
169			'random_answers' => $objItem->obj->random_answers,
170			'course_code' => $coursecode,
171			];
172			}
173			}
174			$sequences = $sequence[$categoryId];
175			break;
176			case 'document':
177			$sequence = [];
178			foreach ($objItems as $objItem) {
179			if ($categoryId === 0) {
180			$sequence[$categoryId][$objItem->source_id] = [
181			'title' => $objItem->title,
182			'comment' => $objItem->comment,
183			'cc_type' => ($objItem->file_type == 'folder' ? 'folder' : 'resource'),
184			'source_id' => $objItem->source_id,
185			'path' => $objItem->path,
186			'file_type' => $objItem->file_type,
187			'course_code' => $coursecode,
188			];
189			}
190			}
191			$sequences = $sequence[$categoryId];
192			break;
193			case 'forum':
194			foreach ($objItems as $objItem) {
195			if ($categoryId == $objItem->obj->forum_category) {
196			$sequence[$categoryId][$objItem->obj->forum_id] = [
197			'title' => $objItem->obj->forum_title,
198			'comment' => $objItem->obj->forum_comment,
199			'cc_type' => 'forum',
200			'source_id' => $objItem->obj->iid,
201			];
202			}
203			}
204			$sequences = $sequence[$categoryId];
			0 ignored issues – show Comprehensibility Best Practice introduced 2021-07-06 20:21 UTC by Report Bug Copy Issue Report The variable `$sequence` does not seem to be defined for all execution paths leading up to this point. Loading history...
205			break;
206			case 'page':
207			foreach ($objItems as $objItem) {
208			if ($categoryId === 0) {
209			$sequence[$categoryId][$objItem->page_id] = [
210			'title' => $objItem->title,
211			'comment' => $objItem->content,
212			'cc_type' => 'page',
213			'source_id' => $objItem->page_id,
214			'reflink' => $objItem->reflink,
215			];
216			}
217			}
218			$sequences = $sequence[$categoryId];
219			break;
220			case 'link':
221			if (!isset($categoryId)) {
222			$categories = [];
223			foreach ($objItems as $objItem) {
224			$categories[$objItem->category_id] = self::getSequence($objItems, $objItem->category_id, $itemType);
225			}
226			$sequences = $categories;
227			} else {
228			foreach ($objItems as $objItem) {
229			if ($categoryId == $objItem->category_id) {
230			$sequence[$categoryId][$objItem->source_id] = [
231			'title' => $objItem->title,
232			'comment' => $objItem->description,
233			'cc_type' => 'url',
234			'source_id' => $objItem->source_id,
235			'url' => $objItem->url,
236			'target' => $objItem->target,
237			];
238			}
239			}
240			$sequences = $sequence[$categoryId];
241			}
242			break;
243			}
244
245			return $sequences;
246			}
247
248			protected static function processSequence(CcIItem &$item, CcIManifest &$manifest, array $sequence, $packageroot, $outdir)
249			{
250			if (!empty($sequence)) {
251			foreach ($sequence as $seq) {
252			$activity_type = ucfirst($seq['cc_type']);
253			$activity_indentation = 0;
254			$aitem = self::itemIndenter($item, $activity_indentation);
255			$caller = "CcConverter{$activity_type}";
256			if (class_exists($caller)) {
257			$obj = new $caller($aitem, $manifest, $packageroot, $path);
			0 ignored issues – show Comprehensibility Best Practice introduced 2021-07-02 08:32 UTC by Report Bug Copy Issue Report The variable `$path` seems to be never defined. Loading history...
258			if (!$obj->convert($outdir, $seq)) {
259			throw new RuntimeException("failed to convert {$activity_type}");
260			}
261			}
262			}
263			}
264			}
265
266			protected static function itemIndenter(CcIItem &$item, $level = 0)
267			{
268			$indent = (int) $level;
269			$indent = ($indent) <= 0 ? 0 : $indent;
270			$nprev = null;
271			$nfirst = null;
272			for ($pos = 0, $size = $indent; $pos < $size; $pos++) {
273			$nitem = new CcItem();
274			$nitem->title = '';
275			if (empty($nfirst)) {
276			$nfirst = $nitem;
277			}
278			if (!empty($nprev)) {
279			$nprev->addChildItem($nitem);
280			}
281			$nprev = $nitem;
282			}
283			$result = $item;
284			if (!empty($nfirst)) {
285			$item->addChildItem($nfirst);
286			$result = $nprev;
287			}
288
289			return $result;
290			}
291			}
292

chamilo / chamilo-lms

Push — 1.11.x ( 47915c...7101db )

Cc13Convert::processSequence() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like