AframeDOMDocument - Code Metrics - Inspection of "A-Frame examples using this library closes #53" - mkungla/aframe-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#66)

by Marko

created 2016-07-23 23:34 UTC

AframeDOMDocument A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	343
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

100%

Importance

Changes

Metric	Value
wmc	34
c	0
b	0
f	0
lcom	1
cbo	3
dl	0
loc	343
ccs	62
cts	62
cp	1
rs	9.2

17 Methods

Rating	Name	Size	Complexity
A	appendEntity()	5	1
A	__construct()	14	1
A	render()	15	3
A	setTitle()	4	1
A	setDescription()	4	1
A	appendEntities()	8	3
A	appendAssets()	13	4
A	registerScripts()	4	1
A	appendScripts()	6	3
A	appendScript()	7	1
A	appendAsset()	5	1
A	renderSceneOnly()	9	2
A	appendSceneComponents()	11	3
A	appendSceneAttributes()	8	4
A	appendSceneAttribute()	7	3
A	configOptions()	7	1
A	setConfigurationOption()	4	1

<?php
/** @formatter:off
 * ******************************************************************
 * Created by   Marko Kungla on Jun 27, 2016 - 9:55:09 PM
 * Contact      [email protected]
 * @copyright   2016 Marko Kungla - https://github.com/mkungla
 * @license     The MIT License (MIT)
 *
 * @category       AframeVR
 * @package        aframe-php
 *
 * Lang         PHP (php version >= 7)
 * Encoding     UTF-8
 * File         AframeDOMDocument.php
 * Code format  PSR-2 and 12
 * @link        https://github.com/mkungla/aframe-php
 * @issues      https://github.com/mkungla/aframe-php/issues
 * ********************************************************************
 * Contributors:
 * @author Marko Kungla <[email protected]>
 * ********************************************************************
 * Comments:
 * @formatter:on */
namespace AframeVR\Core\DOM;

use \AframeVR\Core\Config;
use \DOMImplementation;
use \DOMDocumentType;
use \DOMDocument;
use \AframeVR\Core\Entity;
use \AframeVR\Interfaces\AssetsInterface;

final class AframeDOMDocument extends DOMImplementation
{
    use AframeDOMProcessor;

    /**
     * A-Frame DOM Document type
     *
     * @var \DOMDocumentType
     */
    protected $doctypeObj;

    /**
     * A-Frame DOM Document
     *
     * @var \DOMDocument
     */
    protected $docObj;

    /**
     * Scene meta tile
     *
     * @var string $scene_title
     */
    protected $scene_title = 'Untitled';

    /**
     * Scene meta description
     *
     * @var string $scene_description
     */
    protected $scene_description = '';

    /**
     * <head>
     *
     * @var \DOMElement
     */
    protected $head;

    /**
     * <body>
     *
     * @var \DOMElement
     */
    protected $body;

    /**
     * <a-scene>
     *
     * @var \DOMElement
     */
    protected $scene;

    /**
     * <a-assets>
     *
     * @var \DOMElement
     */
    protected $assets;

    /************
     * CONFIG
     ***********/

    /**
     * Nicely formats output with indentation and extra space.
     *
     * @var bool
     */
    protected $format_output = false;

    /**
     * CDN Of aframe.js
     *
     * @var string
     */
    protected $cdn_url;

    /**
     * Whether to use CDN
     *
     * @var bool $use_cdn
     */
    protected $use_cdn = false;

    /**
     * aframe assets URI relative to App's base URL / domain
     *
     * @var string assets_uri
     */
    protected $assets_uri;

    /**
     * Extra scrits to add into head
     *
     * Like components and shaders
     *
     * @var array $scripts
     */
    protected $scripts = array();

    /**
     * A-Frame DOM
     *
     * @param Config $config
     */
    public function __construct(Config $config)
    {
        /* Config */
        $this->configOptions($config);

        /* Create HTML5 Document type */
        $this->createDocType('html');

        /* Create A-Frame DOM Document */
        $this->createAframeDocument();

        /* Create boostrap elements */
        $this->documentBootstrap();
    }

    /**
     * Render scene this DOM Object is attached to
     *
     * @return string
     */
    public function render(): string
    {
        $html = $this->docObj->getElementsByTagName('html')->item(0);
        /* Make sure we do not add duplicates when render is called multiple times */
        if (! $html->hasChildNodes()) {
            $this->renderHead();

            $html->appendChild($this->head);

            $this->renderBody();

            $html->appendChild($this->body);
        }
        return $this->format_output ? $this->correctOutputFormat($this->docObj->saveHTML()) : $this->docObj->saveHTML();
    }

    /**
     * Set Scene meta title
     *
     * @param string $title
     */
    public function setTitle(string $title)
    {
        $this->scene_title = $title;
    }

    /**
     * Set Scene meta description
     *
     * @param string $description
     */
    public function setDescription(string $description)
    {
        $this->scene_description = $description;
    }

    /**
     * Append entities
     *
     * @param array $entities
     * @return void
     */
    public function appendEntities(array $entities)
    {
        if (! empty($entities)) {
            foreach ($entities as $entity) {
                $this->appendEntity($entity);
            }
        }
    }

    /**
     * Append assets
     *
     * @param array $assets
     * @return void
     */
    public function appendAssets(array $assets)
    {
        if (! empty($assets)) {
            if ($this->format_output) {
                $com = $this->docObj->createComment('');
                $this->scene->appendChild($com);
            }
            foreach ($assets as $asset) {
                $this->appendAsset($asset);
            }
            $this->scene->appendChild($this->assets);
        }
    }

    /**
     * Register scripts to be added to DOM
     *
     * @param array $scripts
     * @return void
     */
    public function registerScripts(array $scripts)
    {
        $this->scripts = array_merge($this->scripts, $scripts);
    }
    /**
     * Append scripts
     *
     * @param array $scripts
     * @return void
     */
    public function appendScripts(array $scripts)
    {
        foreach($scripts as $url => $use) {
            (!$use)?:$this->appendScript($url);
        }
    }

    /**
     * Append script
     *
     * @param string $script_uri
     * @return void
     */
    public function appendScript(string $script_uri)
    {
        $extra_script_url = sprintf('%s%s',$this->assets_uri, $script_uri);
        $extra_script     = $this->docObj->createElement('script');
        $extra_script->setAttribute('src', $extra_script_url);
        $this->head->appendChild($extra_script);
    }
    /**
     * Append asset
     *
     * Create asset DOMElement
     *
     * @param AssetsInterface $asset
     */
    public function appendAsset(AssetsInterface $asset)
    {
        $this->appendFormatComment('assets', "\n\t");
        $this->assets->appendChild($asset->domElement($this->docObj));
    }

    /**
     * Create entity DOMElement
     *
     * Created entity and append it to scene
     *
     * @param Entity $entity
     * @return void
     */
    public function appendEntity(Entity $entity)
    {
        $this->appendFormatComment('scene', "\n");
        $this->scene->appendChild($entity->domElement($this->docObj));
    }

    /**
     * Get HTML of Scene only
     *
     * @return string
     */
    public function renderSceneOnly()
    {
        $html               = new DOMDocument();
        $html->formatOutput = $this->format_output;

        $html_scene = $html->importNode($this->scene, true);
        $html->appendChild($html_scene);
        return $this->format_output ? $this->correctOutputFormat($html->saveHTML()) : $html->saveHTML();
    }

    /**
     * Add scene components
     *
     * @param array $components
     * @return void
     */
    public function appendSceneComponents(array $components)
    {
        foreach ($components as $component) {
            /*
             * Check does component has any attributes to add to scene DOM element.
             * default attributes most of cases are ommited so we might not have any attributes to add
             */
            if ($component->hasDOMAttributes())
                $this->scene->setAttributeNode($component->getDOMAttr());
        }
    }

    /**
     * Append DOM attributes no set by components
     *
     * @param \DOMElement $a_entity
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     */
    public function appendSceneAttributes(array $attrs)
    {
        foreach ($attrs as $attr => $val) {
            if(is_bool($val))
                $val = $val ? '' : 'false';
                $this->appendSceneAttribute($attr, $val);
        }
    }

    private function appendSceneAttribute($attr, $val)
    {
        if ($attr === 'id' && is_numeric($val))
            return;

            $this->scene->setAttribute($attr, $val);
    }


    /**
     * Set configuration option related to DOM
     *
     * @param Config $config
     * @return void
     */
    protected function configOptions(Config $config)
    {
        $this->setConfigurationOption($config, 'format_output', false);
        $this->setConfigurationOption($config, 'cdn_url', null);
        $this->setConfigurationOption($config, 'use_cdn', false);
        $this->setConfigurationOption($config, 'assets_uri', '/aframe');
    }

    /**
     * Set individual option
     *
     * @param Config $config
     * @param string $opt
     * @param mixed $default
     * @return void
     */
    protected function setConfigurationOption(Config $config, string $opt, $default)
    {
        $this->{$opt} = $config->get($opt) ?? $default;
    }
}


1		<?php
2		/** @formatter:off
3		* ******************************************************************
4		* Created by Marko Kungla on Jun 27, 2016 - 9:55:09 PM
5		* Contact [email protected]
6		* @copyright 2016 Marko Kungla - https://github.com/mkungla
7		* @license The MIT License (MIT)
8		*
9		* @category AframeVR
10		* @package aframe-php
11		*
12		* Lang PHP (php version >= 7)
13		* Encoding UTF-8
14		* File AframeDOMDocument.php
15		* Code format PSR-2 and 12
16		* @link https://github.com/mkungla/aframe-php
17		* @issues https://github.com/mkungla/aframe-php/issues
18		* ********************************************************************
19		* Contributors:
20		* @author Marko Kungla <[email protected]>
21		* ********************************************************************
22		* Comments:
23		* @formatter:on */
24		namespace AframeVR\Core\DOM;
25
26		use \AframeVR\Core\Config;
27		use \DOMImplementation;
28		use \DOMDocumentType;
29		use \DOMDocument;
30		use \AframeVR\Core\Entity;
31		use \AframeVR\Interfaces\AssetsInterface;
32
33		final class AframeDOMDocument extends DOMImplementation
34		{
35		use AframeDOMProcessor;
36
37		/**
38		* A-Frame DOM Document type
39		*
40		* @var \DOMDocumentType
41		*/
42		protected $doctypeObj;
43
44		/**
45		* A-Frame DOM Document
46		*
47		* @var \DOMDocument
48		*/
49		protected $docObj;
50
51		/**
52		* Scene meta tile
53		*
54		* @var string $scene_title
55		*/
56		protected $scene_title = 'Untitled';
57
58		/**
59		* Scene meta description
60		*
61		* @var string $scene_description
62		*/
63		protected $scene_description = '';
64
65		/**
66		* <head>
67		*
68		* @var \DOMElement
69		*/
70		protected $head;
71
72		/**
73		* <body>
74		*
75		* @var \DOMElement
76		*/
77		protected $body;
78
79		/**
80		* <a-scene>
81		*
82		* @var \DOMElement
83		*/
84		protected $scene;
85
86		/**
87		* <a-assets>
88		*
89		* @var \DOMElement
90		*/
91		protected $assets;
92
93		/************
94		* CONFIG
95		***********/
96
97		/**
98		* Nicely formats output with indentation and extra space.
99		*
100		* @var bool
101		*/
102		protected $format_output = false;
103
104		/**
105		* CDN Of aframe.js
106		*
107		* @var string
108		*/
109		protected $cdn_url;
110
111		/**
112		* Whether to use CDN
113		*
114		* @var bool $use_cdn
115		*/
116		protected $use_cdn = false;
117
118		/**
119		* aframe assets URI relative to App's base URL / domain
120		*
121		* @var string assets_uri
122		*/
123		protected $assets_uri;
124
125		/**
126		* Extra scrits to add into head
127		*
128		* Like components and shaders
129		*
130	98	* @var array $scripts
131		*/
132		protected $scripts = array();
133	98
134		/**
135		* A-Frame DOM
136	98	*
137		* @param Config $config
138		*/
139	98	public function __construct(Config $config)
140		{
141		/* Config */
142	98	$this->configOptions($config);
143	98
144		/* Create HTML5 Document type */
145		$this->createDocType('html');
146
147		/* Create A-Frame DOM Document */
148		$this->createAframeDocument();
149
150	8	/* Create boostrap elements */
151		$this->documentBootstrap();
152	8	}
153
154	8	/**
155	8	* Render scene this DOM Object is attached to
156		*
157	8	* @return string
158		*/
159	8	public function render(): string
160		{
161	8	$html = $this->docObj->getElementsByTagName('html')->item(0);
162		/* Make sure we do not add duplicates when render is called multiple times */
163	8	if (! $html->hasChildNodes()) {
164		$this->renderHead();
165
166		$html->appendChild($this->head);
167
168		$this->renderBody();
169
170		$html->appendChild($this->body);
171	1	}
172		return $this->format_output ? $this->correctOutputFormat($this->docObj->saveHTML()) : $this->docObj->saveHTML();
173	1	}
174	1
175		/**
176		* Set Scene meta title
177		*
178		* @param string $title
179		*/
180		public function setTitle(string $title)
181	1	{
182		$this->scene_title = $title;
183	1	}
184	1
185		/**
186		* Set Scene meta description
187		*
188		* @param string $description
189		*/
190		public function setDescription(string $description)
191		{
192	19	$this->scene_description = $description;
193		}
194	19
195	11	/**
196	11	* Append entities
197		*
198		* @param array $entities
199	19	* @return void
200		*/
201		public function appendEntities(array $entities)
202		{
203		if (! empty($entities)) {
204		foreach ($entities as $entity) {
205		$this->appendEntity($entity);
206		}
207	2	}
208		}
209	2
210	2	/**
211	2	* Append assets
212	2	*
213		* @param array $assets
214	2	* @return void
215	2	*/
216		public function appendAssets(array $assets)
217	2	{
218		if (! empty($assets)) {
219	2	if ($this->format_output) {
220		$com = $this->docObj->createComment('');
221		$this->scene->appendChild($com);
222		}
223		foreach ($assets as $asset) {
224		$this->appendAsset($asset);
225		}
226		$this->scene->appendChild($this->assets);
227		}
228	2	}
229
230	2	/**
231	2	* Register scripts to be added to DOM
232	2	*
233		* @param array $scripts
234		* @return void
235		*/
236		public function registerScripts(array $scripts)
237		{
238		$this->scripts = array_merge($this->scripts, $scripts);
239		}
240		/**
241		* Append scripts
242	13	*
243		* @param array $scripts
244	13	* @return void
245	13	*/
246	13	public function appendScripts(array $scripts)
247		{
248		foreach($scripts as $url => $use) {
249		(!$use)?:$this->appendScript($url);
250		}
251		}
252
253	12	/**
254		* Append script
255	12	*
256	12	* @param string $script_uri
257		* @return void
258	12	*/
259	12	public function appendScript(string $script_uri)
260	12	{
261		$extra_script_url = sprintf('%s%s',$this->assets_uri, $script_uri);
262		$extra_script = $this->docObj->createElement('script');
263		$extra_script->setAttribute('src', $extra_script_url);
264		$this->head->appendChild($extra_script);
265		}
266		/**
267		* Append asset
268		*
269	19	* Create asset DOMElement
270		*
271	19	* @param AssetsInterface $asset
272		*/
273		public function appendAsset(AssetsInterface $asset)
274		{
275		$this->appendFormatComment('assets', "\n\t");
276	1	$this->assets->appendChild($asset->domElement($this->docObj));
277	1	}
278
279	19	/**
280		* Create entity DOMElement
281		*
282		* Created entity and append it to scene
283		*
284		* @param Entity $entity
285		* @return void
286		*/
287	98	public function appendEntity(Entity $entity)
288		{
289	98	$this->appendFormatComment('scene', "\n");
290	98	$this->scene->appendChild($entity->domElement($this->docObj));
291	98	}
292	98
293	98	/**
294		* Get HTML of Scene only
295		*
296		* @return string
297		*/
298		public function renderSceneOnly()
299		{
300		$html = new DOMDocument();
301		$html->formatOutput = $this->format_output;
302
303	98	$html_scene = $html->importNode($this->scene, true);
304		$html->appendChild($html_scene);
305	98	return $this->format_output ? $this->correctOutputFormat($html->saveHTML()) : $html->saveHTML();
306	98	}
307
308		/**
309		* Add scene components
310		*
311		* @param array $components
312		* @return void
313		*/
314		public function appendSceneComponents(array $components)
315		{
316		foreach ($components as $component) {
317		/*
318		* Check does component has any attributes to add to scene DOM element.
319		* default attributes most of cases are ommited so we might not have any attributes to add
320		*/
321		if ($component->hasDOMAttributes())
322		$this->scene->setAttributeNode($component->getDOMAttr());
323		}
324		}
325
326		/**
327		* Append DOM attributes no set by components
328		*
329		* @param \DOMElement $a_entity
		0 ignored issues – show Bug introduced 2016-07-23 23:40 UTC by Report Bug Copy Issue Report There is no parameter named `$a_entity`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
330		*/
331		public function appendSceneAttributes(array $attrs)
332		{
333		foreach ($attrs as $attr => $val) {
334		if(is_bool($val))
335		$val = $val ? '' : 'false';
336		$this->appendSceneAttribute($attr, $val);
337		}
338		}
339
340		private function appendSceneAttribute($attr, $val)
341		{
342		if ($attr === 'id' && is_numeric($val))
343		return;
344
345		$this->scene->setAttribute($attr, $val);
346		}
347
348
349		/**
350		* Set configuration option related to DOM
351		*
352		* @param Config $config
353		* @return void
354		*/
355		protected function configOptions(Config $config)
356		{
357		$this->setConfigurationOption($config, 'format_output', false);
358		$this->setConfigurationOption($config, 'cdn_url', null);
359		$this->setConfigurationOption($config, 'use_cdn', false);
360		$this->setConfigurationOption($config, 'assets_uri', '/aframe');
361		}
362
363		/**
364		* Set individual option
365		*
366		* @param Config $config
367		* @param string $opt
368		* @param mixed $default
369		* @return void
370		*/
371		protected function setConfigurationOption(Config $config, string $opt, $default)
372		{
373		$this->{$opt} = $config->get($opt) ?? $default;
374		}
375		}
376

mkungla / aframe-php

Pull Request — master (#66)

AframeDOMDocument A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

17 Methods

Duplication Side-by-Side

Filter issues like