CcManifest::onSave() - 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

CcManifest::onSave() A

↳ Parent: CcManifest

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	1
c	1
b	0
f	0
nc	1
nop	0
dl	0
loc	3
rs	10

<?php
/* Source: https://github.com/moodle/moodle/blob/MOODLE_310_STABLE/backup/cc/cc_lib/cc_manifest.php under GNU/GPL license */

class CcManifest extends XMLGenericDocument implements CcIManifest
{
    private $ccversion = null;
    private $ccobj = null;
    private $rootmanifest = null;
    private $activemanifest = null;
    private $parentmanifest = null;
    private $parentparentmanifest = null;
    private $ares = [];

    private $mainidentifier = null;


    public function __construct($ccver = 13, $activemanifest = null,
                        $parentmanifest = null, $parentparentmanifest = null)
    {
        $this->ccversion = $ccver;
        $this->ccobj = new CcVersion13();
        parent::__construct('UTF-8', true);
    }

    /**
     * Register Namespace for use XPATH.
     */
    public function registerNamespacesForXpath()
    {
        $scnam = $this->activemanifest->getCcNamespaces();
        foreach ($scnam as $key => $value) {
            $this->registerNS($key, $value);
        }
    }

    /**
     * Add Metadata For Manifest.
     */
    public function addMetadataManifest(CcIMetadataManifest $met)
    {
        $metanode = $this->node("//imscc:manifest[@identifier='".
                                $this->activemanifest->manifestID().
                                "']/imscc:metadata");
        $nmeta = $this->activemanifest->createMetadataNode($met, $this->doc, $metanode);
        $metanode->appendChild($nmeta);
    }

    /**
     * Add Metadata For Resource.
     *
     * @param string $identifier
     */
    public function addMetadataResource(CcIMetadataResource $met, $identifier)
    {
        $metanode = $this->node("//imscc:resource".
            "[@identifier='".
            $identifier.
            "']");
        $metanode2 = $this->node("//imscc:resource".
            "[@identifier='".
            $identifier.
            "']/imscc:file");
        $nspaces = $this->activemanifest->getCcNamespaces();
        $dnode = $this->appendNewElementNs($metanode2, $nspaces['imscc'], 'metadata');
        $this->activemanifest->createMetadataResourceNode($met, $this->doc, $dnode);
    }

    /**
     * Add Metadata For File.
     *
     * @param string $identifier
     * @param string $filename
     */
    public function addMetadataFile(CcIMetadataFile $met, $identifier, $filename)
    {
        if (empty($met) || empty($identifier) || empty($filename)) {
            throw new Exception('Try to add a metadata file with nulls values given!');
        }

        $metanode = $this->node("//imscc:resource".
            "[@identifier='".
            $identifier.
            "']/imscc:file".
            "[@href='".
            $filename.
            "']");

        $nspaces = $this->activemanifest->getCcNamespaces();
        $dnode = $this->doc->createElementNS($nspaces['imscc'], "metadata");

        $metanode->appendChild($dnode);

        $this->activemanifest->createMetadataFileNode($met, $this->doc, $dnode);
    }

    public function onCreate()
    {
        $this->activemanifest = new CcVersion13();
        $this->rootmanifest = $this->activemanifest;
        $result = $this->activemanifest->createManifest($this->doc);
        $this->registerNamespacesForXpath();

        return $result;
    }

    public function getRelativeBasePath()
    {
        return $this->activemanifest->base();
    }

    public function parentManifest()
    {
        return new CcManifest($this, $this->parentmanifest, $this->parentparentmanifest);
    }

    public function rootManifest()
    {
        return new CcManifest($this, $this->rootmanifest);
    }

    public function manifestID()
    {
        return $this->activemanifest->manifestID();
    }

    public function getManifestNamespaces()
    {
        return $this->rootmanifest->getCcNamespaces();
    }

    /**
     * Add a new organization.
     */
    public function addNewOrganization(CcIOrganization &$org)
    {
        $norg = $this->activemanifest->createOrganizationNode($org, $this->doc);
        $orgnode = $this->node("//imscc:manifest[@identifier='".
            $this->activemanifest->manifestID().
            "']/imscc:organizations");
        $orgnode->appendChild($norg);
    }

    public function getResources($searchspecific = '')
    {
        $reslist = $this->getResourceList($searchspecific);
        $resourcelist = [];
        foreach ($reslist as $resourceitem) {
            $resourcelist[] = new CcResources($this, $resourceitem);
        }

        return $resourcelist;
    }

    public function getCcNamespacePath($nsname)
    {
        if (is_string($nsname) && (!empty($nsname))) {
            $scnam = $this->activemanifest->getCcNamespaces();

            return $scnam[$nsname];
        }

        return null;
    }

    public function getResourceList($searchspecific = '')
    {
        return $this->nodeList("//imscc:manifest[@identifier='".
                            $this->activemanifest->manifestID().
                            "']/imscc:resources/imscc:resource".$searchspecific);
    }

    public function onLoad()
    {
        $this->registerNamespacesForXpath();
        $this->fillManifest();

        return true;
    }

    public function onSave()
    {
        return true;
    }

    /**
     * Add a resource to the manifest.
     *
     * @param string $identifier
     * @param string $type
     *
     * @return array
     */
    public function addResource(CcIResource $res, $identifier = null, $type = 'webcontent')
    {
        if (!$this->ccobj->valid($type)) {
            throw new Exception("Type invalid...");
        }

        if ($res == null) {
            throw new Exception('Invalid Resource or dont give it');
        }
        $rst = $res;

        // TODO: This has to be reviewed since it does not handle multiple files properly.
        // Dependencies.
        if (is_object($identifier)) {
            $this->activemanifest->createResourceNode($rst, $this->doc, $identifier);
        } else {
            $nresnode = null;

            $rst->type = $type;

            if (!CcHelpers::isHtml($rst->filename)) {

                $rst->href = null;

            }

            $this->activemanifest->createResourceNode($rst, $this->doc, $nresnode);
            foreach ($rst->files as $file) {

                $ident = $this->getIdentifierByFilename($file);
                if ($ident == null) {
                    $newres = new CcResources($rst->manifestroot, $file);

                    if (!CcHelpers::isHtml($file)) {
                        $newres->href = null;
                    }
                    $newres->type = 'webcontent';
                    $this->activemanifest->createResourceNode($newres, $this->doc, $nresnode);
                }
            }
        }

        $tmparray = [$rst->identifier, $rst->files[0]];


        return $tmparray;
    }

    public function updateInstructoronly($identifier, $value = false)
    {
        if (isset($this->activemanifest->resources[$identifier])) {
            $resource = $this->activemanifest->resources[$identifier];
            $resource->instructoronly = $value;
        }
    }

    /**
     * Append the resources nodes in the Manifest.
     *
     * @return DOMNode
     */
    public function putNodes()
    {
        $resnodestr = "//imscc:manifest[@identifier='".$this->activemanifest->manifestID().
            "']/imscc:resources";
        $resnode = $this->node($resnodestr);

        foreach ($this->activemanifest->resources as $k => $v) {
            ($k);
            $depen = $this->checkIfExistInOther($v->files[0], $v->identifier);
            if (!empty($depen)) {
                $this->replaceFileXDependency($depen, $v->files[0]);
                $v->type = 'webcontent';
            }
        }

        foreach ($this->activemanifest->resources as $node) {
            $rnode = $this->activemanifest->createResourceNode($node, $this->doc, null);
            $resnode->appendChild($rnode);
            if ($node->instructoronly) {
                $metafileceduc = new CcMetadataResourceEducational();
                $metafileceduc->setValue(intended_user_role::INSTRUCTOR);
                $metafile = new CcMetadataResource();
                $metafile->addMetadataResourceEducational($metafileceduc);
                $this->activemanifest->createMetadataEducational($metafile, $this->doc, $rnode);
            }
        }

        return $resnode;
    }

    /**
     * TODO - implement this method - critical
     */
    private function fillManifest()
    {
    }

    private function checkIfExistInOther($name, $identifier)
    {
        $status = [];
        foreach ($this->activemanifest->resources as $value) {
            if (($value->identifier != $identifier) && isset($value->files[$name])) {
                $status[] = $value->identifier;
            }
        }

        return $status;
    }

    private function replaceFileXDependency($depen, $name)
    {
        foreach ($depen as $key => $value) {
            ($key);
            $ident = $this->getIdentifierByFilename($name);
            $this->activemanifest->resources[$value]->files =
                $this->arrayRemoveByValue($this->activemanifest->resources[$value]->files, $name);
            if (!in_array($ident, $this->activemanifest->resources[$value]->dependency)) {
                array_push($this->activemanifest->resources[$value]->dependency, $ident);
            }
        }

        return true;
    }

    private function getIdentifierByFilename($name)
    {
        $result = null;
        if (isset($this->activemanifest->resourcesInd[$name])) {
            $result = $this->activemanifest->resourcesInd[$name];
        }

        return $result;
    }

    private function arrayRemoveByValue($arr, $value)
    {
        return array_values(array_diff($arr, [$value]));
    }

    private function arrayRemoveByKey($arr, $key)

    {
        return array_values(array_diff_key($arr, [$key]));
    }
}


1			<?php
2			/* Source: https://github.com/moodle/moodle/blob/MOODLE_310_STABLE/backup/cc/cc_lib/cc_manifest.php under GNU/GPL license */
3
4			class CcManifest extends XMLGenericDocument implements CcIManifest
5			{
6			private $ccversion = null;
7			private $ccobj = null;
8			private $rootmanifest = null;
9			private $activemanifest = null;
10			private $parentmanifest = null;
11			private $parentparentmanifest = null;
12			private $ares = [];
			0 ignored issues – show introduced 2021-07-02 08:32 UTC by Report Bug Copy Issue Report The private property `$ares` is not used, and could be removed. Loading history...
13			private $mainidentifier = null;
			0 ignored issues – show introduced 2021-07-02 08:32 UTC by Report Bug Copy Issue Report The private property `$mainidentifier` is not used, and could be removed. Loading history...
14
15			public function __construct($ccver = 13, $activemanifest = null,
16			$parentmanifest = null, $parentparentmanifest = null)
17			{
18			$this->ccversion = $ccver;
19			$this->ccobj = new CcVersion13();
20			parent::__construct('UTF-8', true);
21			}
22
23			/**
24			* Register Namespace for use XPATH.
25			*/
26			public function registerNamespacesForXpath()
27			{
28			$scnam = $this->activemanifest->getCcNamespaces();
29			foreach ($scnam as $key => $value) {
30			$this->registerNS($key, $value);
31			}
32			}
33
34			/**
35			* Add Metadata For Manifest.
36			*/
37			public function addMetadataManifest(CcIMetadataManifest $met)
38			{
39			$metanode = $this->node("//imscc:manifest[@identifier='".
40			$this->activemanifest->manifestID().
41			"']/imscc:metadata");
42			$nmeta = $this->activemanifest->createMetadataNode($met, $this->doc, $metanode);
43			$metanode->appendChild($nmeta);
44			}
45
46			/**
47			* Add Metadata For Resource.
48			*
49			* @param string $identifier
50			*/
51			public function addMetadataResource(CcIMetadataResource $met, $identifier)
52			{
53			$metanode = $this->node("//imscc:resource".
54			"[@identifier='".
55			$identifier.
56			"']");
57			$metanode2 = $this->node("//imscc:resource".
58			"[@identifier='".
59			$identifier.
60			"']/imscc:file");
61			$nspaces = $this->activemanifest->getCcNamespaces();
62			$dnode = $this->appendNewElementNs($metanode2, $nspaces['imscc'], 'metadata');
63			$this->activemanifest->createMetadataResourceNode($met, $this->doc, $dnode);
64			}
65
66			/**
67			* Add Metadata For File.
68			*
69			* @param string $identifier
70			* @param string $filename
71			*/
72			public function addMetadataFile(CcIMetadataFile $met, $identifier, $filename)
73			{
74			if (empty($met) \|\| empty($identifier) \|\| empty($filename)) {
75			throw new Exception('Try to add a metadata file with nulls values given!');
76			}
77
78			$metanode = $this->node("//imscc:resource".
79			"[@identifier='".
80			$identifier.
81			"']/imscc:file".
82			"[@href='".
83			$filename.
84			"']");
85
86			$nspaces = $this->activemanifest->getCcNamespaces();
87			$dnode = $this->doc->createElementNS($nspaces['imscc'], "metadata");
88
89			$metanode->appendChild($dnode);
90
91			$this->activemanifest->createMetadataFileNode($met, $this->doc, $dnode);
92			}
93
94			public function onCreate()
95			{
96			$this->activemanifest = new CcVersion13();
97			$this->rootmanifest = $this->activemanifest;
98			$result = $this->activemanifest->createManifest($this->doc);
99			$this->registerNamespacesForXpath();
100
101			return $result;
102			}
103
104			public function getRelativeBasePath()
105			{
106			return $this->activemanifest->base();
107			}
108
109			public function parentManifest()
110			{
111			return new CcManifest($this, $this->parentmanifest, $this->parentparentmanifest);
112			}
113
114			public function rootManifest()
115			{
116			return new CcManifest($this, $this->rootmanifest);
117			}
118
119			public function manifestID()
120			{
121			return $this->activemanifest->manifestID();
122			}
123
124			public function getManifestNamespaces()
125			{
126			return $this->rootmanifest->getCcNamespaces();
127			}
128
129			/**
130			* Add a new organization.
131			*/
132			public function addNewOrganization(CcIOrganization &$org)
133			{
134			$norg = $this->activemanifest->createOrganizationNode($org, $this->doc);
135			$orgnode = $this->node("//imscc:manifest[@identifier='".
136			$this->activemanifest->manifestID().
137			"']/imscc:organizations");
138			$orgnode->appendChild($norg);
139			}
140
141			public function getResources($searchspecific = '')
142			{
143			$reslist = $this->getResourceList($searchspecific);
144			$resourcelist = [];
145			foreach ($reslist as $resourceitem) {
146			$resourcelist[] = new CcResources($this, $resourceitem);
147			}
148
149			return $resourcelist;
150			}
151
152			public function getCcNamespacePath($nsname)
153			{
154			if (is_string($nsname) && (!empty($nsname))) {
155			$scnam = $this->activemanifest->getCcNamespaces();
156
157			return $scnam[$nsname];
158			}
159
160			return null;
161			}
162
163			public function getResourceList($searchspecific = '')
164			{
165			return $this->nodeList("//imscc:manifest[@identifier='".
166			$this->activemanifest->manifestID().
167			"']/imscc:resources/imscc:resource".$searchspecific);
168			}
169
170			public function onLoad()
171			{
172			$this->registerNamespacesForXpath();
173			$this->fillManifest();
174
175			return true;
176			}
177
178			public function onSave()
179			{
180			return true;
181			}
182
183			/**
184			* Add a resource to the manifest.
185			*
186			* @param string $identifier
187			* @param string $type
188			*
189			* @return array
190			*/
191			public function addResource(CcIResource $res, $identifier = null, $type = 'webcontent')
192			{
193			if (!$this->ccobj->valid($type)) {
194			throw new Exception("Type invalid...");
195			}
196
197			if ($res == null) {
198			throw new Exception('Invalid Resource or dont give it');
199			}
200			$rst = $res;
201
202			// TODO: This has to be reviewed since it does not handle multiple files properly.
203			// Dependencies.
204			if (is_object($identifier)) {
205			$this->activemanifest->createResourceNode($rst, $this->doc, $identifier);
206			} else {
207			$nresnode = null;
208
209			$rst->type = $type;
			0 ignored issues – show Bug introduced 2021-07-02 08:32 UTC by Report Bug Copy Issue Report Accessing `type` on the interface `CcIResource` suggest that you code against a concrete implementation. How about adding an `instanceof` check? Loading history...
210			if (!CcHelpers::isHtml($rst->filename)) {
			0 ignored issues – show Bug introduced 2021-07-02 08:32 UTC by Report Bug Copy Issue Report Accessing `filename` on the interface `CcIResource` suggest that you code against a concrete implementation. How about adding an `instanceof` check? Loading history...
211			$rst->href = null;
			0 ignored issues – show Bug introduced 2021-07-02 08:32 UTC by Report Bug Copy Issue Report Accessing `href` on the interface `CcIResource` suggest that you code against a concrete implementation. How about adding an `instanceof` check? Loading history...
212			}
213
214			$this->activemanifest->createResourceNode($rst, $this->doc, $nresnode);
215			foreach ($rst->files as $file) {
			0 ignored issues – show Bug introduced 2021-07-02 08:32 UTC by Report Bug Copy Issue Report Accessing `files` on the interface `CcIResource` suggest that you code against a concrete implementation. How about adding an `instanceof` check? Loading history...
216			$ident = $this->getIdentifierByFilename($file);
217			if ($ident == null) {
218			$newres = new CcResources($rst->manifestroot, $file);
			0 ignored issues – show Bug introduced 2021-07-02 08:32 UTC by Report Bug Copy Issue Report Accessing `manifestroot` on the interface `CcIResource` suggest that you code against a concrete implementation. How about adding an `instanceof` check? Loading history...
219			if (!CcHelpers::isHtml($file)) {
220			$newres->href = null;
221			}
222			$newres->type = 'webcontent';
223			$this->activemanifest->createResourceNode($newres, $this->doc, $nresnode);
224			}
225			}
226			}
227
228			$tmparray = [$rst->identifier, $rst->files[0]];
			0 ignored issues – show Bug introduced 2021-07-02 08:32 UTC by Report Bug Copy Issue Report Accessing `identifier` on the interface `CcIResource` suggest that you code against a concrete implementation. How about adding an `instanceof` check? Loading history...
229
230			return $tmparray;
231			}
232
233			public function updateInstructoronly($identifier, $value = false)
234			{
235			if (isset($this->activemanifest->resources[$identifier])) {
236			$resource = $this->activemanifest->resources[$identifier];
237			$resource->instructoronly = $value;
238			}
239			}
240
241			/**
242			* Append the resources nodes in the Manifest.
243			*
244			* @return DOMNode
245			*/
246			public function putNodes()
247			{
248			$resnodestr = "//imscc:manifest[@identifier='".$this->activemanifest->manifestID().
249			"']/imscc:resources";
250			$resnode = $this->node($resnodestr);
251
252			foreach ($this->activemanifest->resources as $k => $v) {
253			($k);
254			$depen = $this->checkIfExistInOther($v->files[0], $v->identifier);
255			if (!empty($depen)) {
256			$this->replaceFileXDependency($depen, $v->files[0]);
257			$v->type = 'webcontent';
258			}
259			}
260
261			foreach ($this->activemanifest->resources as $node) {
262			$rnode = $this->activemanifest->createResourceNode($node, $this->doc, null);
263			$resnode->appendChild($rnode);
264			if ($node->instructoronly) {
265			$metafileceduc = new CcMetadataResourceEducational();
266			$metafileceduc->setValue(intended_user_role::INSTRUCTOR);
267			$metafile = new CcMetadataResource();
268			$metafile->addMetadataResourceEducational($metafileceduc);
269			$this->activemanifest->createMetadataEducational($metafile, $this->doc, $rnode);
270			}
271			}
272
273			return $resnode;
274			}
275
276			/**
277			* TODO - implement this method - critical
278			*/
279			private function fillManifest()
280			{
281			}
282
283			private function checkIfExistInOther($name, $identifier)
284			{
285			$status = [];
286			foreach ($this->activemanifest->resources as $value) {
287			if (($value->identifier != $identifier) && isset($value->files[$name])) {
288			$status[] = $value->identifier;
289			}
290			}
291
292			return $status;
293			}
294
295			private function replaceFileXDependency($depen, $name)
296			{
297			foreach ($depen as $key => $value) {
298			($key);
299			$ident = $this->getIdentifierByFilename($name);
300			$this->activemanifest->resources[$value]->files =
301			$this->arrayRemoveByValue($this->activemanifest->resources[$value]->files, $name);
302			if (!in_array($ident, $this->activemanifest->resources[$value]->dependency)) {
303			array_push($this->activemanifest->resources[$value]->dependency, $ident);
304			}
305			}
306
307			return true;
308			}
309
310			private function getIdentifierByFilename($name)
311			{
312			$result = null;
313			if (isset($this->activemanifest->resourcesInd[$name])) {
314			$result = $this->activemanifest->resourcesInd[$name];
315			}
316
317			return $result;
318			}
319
320			private function arrayRemoveByValue($arr, $value)
321			{
322			return array_values(array_diff($arr, [$value]));
323			}
324
325			private function arrayRemoveByKey($arr, $key)
			0 ignored issues – show Unused Code introduced 2021-08-18 16:39 UTC by Report Bug Copy Issue Report The method `arrayRemoveByKey()` is not used, and could be removed. This check looks for private methods that have been defined, but are not used inside the class. Loading history...
326			{
327			return array_values(array_diff_key($arr, [$key]));
328			}
329			}
330

chamilo / chamilo-lms

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

CcManifest::onSave() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like