Scene::description() - Code Metrics - Inspection of "A-Frame version is 0.2.0 not 0.0.2" - mkungla/aframe-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( f87c77...be4ea7 )

by Marko

created 2016-07-19 03:42 UTC

Scene::description() A

↳ Parent: Scene

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	4
ccs	3
cts	3
cp	1
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	1
crap	1

<?php
/** @formatter:off
 * ******************************************************************
 * Created by   Marko Kungla on Jun 20, 2016 - 9:01:22 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         Scene.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;

use \AframeVR\Extras\Primitives;
use \AframeVR\Core\Entity;
use \AframeVR\Core\DOM\AframeDOMDocument;
use \AframeVR\Core\Assets;
use \Closure;
use \AframeVR\Core\Exceptions\BadComponentCallException;

final class Scene
{
    /* All scenes can use primitives */
    use Primitives;
    
    /**
     * Name with what you can retrieve this scene while working with multiple scenes
     *
     * @var string $name
     */
    private $keyword;
    
    /**
     * Is scene prepared for rendering
     *
     * @var bool
     */
    private $prepared;
    
    /**
     * Assets
     *
     * @var \AframeVR\Core\Assets
     */
    protected $assets;
    
    /**
     * Aframe Document Object Model
     *
     * @var \AframeVR\Core\DOM\AframeDOMDocument
     */
    protected $aframeDomObj;
    
    /**
     * A-Frame scene entities
     *
     * @var array $entities
     */
    protected $entities = array();
    
    /**
     * Scene components
     *
     * @var array $components
     */
    protected $components = array();

    /**
     * Scene constructor
     *
     * @param string $keyword            
     * @param Config $config            
     */
    public function __construct(string $keyword, Config $config)
    {
        $this->keyword = $keyword;
$a = "a";
$ab = "ab";
$abc = "abc";
        $this->aframeDomObj = new AframeDOMDocument($config);
        /* Initialize assests manager */
        $this->asset();
    }

    /**
     * Aframe Document Object Model
     *
     * @api
     *
     * @return \AframeVR\Core\DOM\AframeDOMDocument
     */
    public function dom()
    {
        return $this->aframeDomObj;
    }

    /**
     * Entity
     *
     * @api
     *
     * @param string $id            
     * @return \AframeVR\Core\Entity
     */
    public function entity(string $id = 'untitled'): Entity
    {
        return $this->entities[$id] ?? $this->entities[$id] = new Entity($id);
    }

    /**
     * Assets
     *
     * @api
     *
     * @return \AframeVR\Core\Assets
     */
    public function asset(): Assets
    {
        return $this->assets ?? $this->assets = new Assets();
    }

    /**
     * Render the A-Frame scene and return the HTML
     *
     * @api
     *
     * @param bool $only_scene            
     * @return string
     */
    public function save($only_scene = false, string $file = null): string
    {
        $this->prepare();
        $html = ! $only_scene ? $this->aframeDomObj->render() : $this->aframeDomObj->renderSceneOnly();
        if (! empty($file) && is_writable(dirname($file))) {
            file_put_contents($file, $html);
        }
        
        return $html;
    }

    /**
     * Render the A-Frame scene and passthru HTML
     *
     * @api
     *
     * @param bool $only_scene            
     * @return void
     */
    public function render($only_scene = false)
    {
        print $this->save($only_scene);
    }

    /**
     * Alias of AframeDOMDocument::setTitle(string)
     *
     * Set <title> tag
     * $this->dom()->setTitle(string);
     *
     * @api
     *
     * @param string $title            
     */
    public function title(string $title)
    {
        $this->dom()->setTitle($title);
    }

    /**
     * Alias of AframeDOMDocument::setDescription(string)
     *
     * Set <meta name="description"> tag
     * $this->dom()->setDescription(string);
     *
     * @api
     *
     * @param string $description            
     */
    public function description(string $description)
    {
        $this->dom()->setDescription($description);
    }

    /**
     * Get scenes keyword
     *
     * @return string
     */
    public function getKeyword()
    {
        return $this->keyword;
    }

    /**
     * Load component for this entity
     *
     * @param string $component_name            
     * @throws \AframeVR\Core\Exceptions\BadComponentCallException
     * @return object|null
     */
    public function component(string $component_name)
    {
        if (! array_key_exists($component_name, $this->components)) {
            $component = sprintf('\AframeVR\Core\Components\ascene\%s\%sComponent', ucfirst($component_name), 
                ucfirst($component_name));
            if (class_exists($component)) {
                $this->components[$component_name] = new $component();
            } else {
                throw new BadComponentCallException($component_name);
            }
        }
        
        return $this->components[$component_name] ?? null;
    }

    /**
     * Call
     *
     * @param string $method            
     * @param array $args            
     * @throws BadShaderCallException
     * @return Entity|\AframeVR\Interfaces\ComponentInterface
     */
    public function __call(string $method, array $args)
    {
        $id = $args[0] ?? 0;
$a = "a";
$ab = "ab";
$abc = "abc";
        $primitive = sprintf('\AframeVR\Extras\Primitives\%s', ucfirst($method));
        
        if (class_exists($primitive)) {
            return $this->childrens[$id] ?? (is_int($id) ? $this->childrens[array_push($this->childrens, 
                new $primitive($id)) - 1] : $this->childrens[$id] = new $primitive($id));
        } else {
            return $this->callComponent($method, $args);
        }
    }

    /**
     * Handle entity components
     *
     * Since we might need to customize these to have
     * custom components loaded as $this->methosd aswell therefore
     * we have these placeholder magic methods here
     *
     * @param string $component_name            
     * @param array $args            
     */
    public function callComponent(string $component_name, array $args)
    {
        if (! method_exists($this, $component_name)) {
            $this->{$component_name} = Closure::bind(
                function () use ($component_name) {
                    return $this->component($component_name);
                }, $this, get_class());
        }
        
        return call_user_func($this->{$component_name}, $args);
    }

    /**
     * Add everyting to DOM
     *
     * @return void
     */
    protected function prepare()
    {
        if ($this->prepared)
            return;
            
            /* Append all assets */
        $assets = $this->assets->getAssets();
        (! $assets) ?: $this->aframeDomObj->appendAssets($assets);
        /* Append all primitives */
        $this->preparePrimitives();
        
        /* Append all entities */
        $this->aframeDomObj->appendEntities($this->entities);
        $this->aframeDomObj->appendSceneComponents($this->components);
        $this->prepared = true;
    }
}


1		<?php
2		/** @formatter:off
3		* ******************************************************************
4		* Created by Marko Kungla on Jun 20, 2016 - 9:01:22 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 Scene.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;
25
26		use \AframeVR\Extras\Primitives;
27		use \AframeVR\Core\Entity;
28		use \AframeVR\Core\DOM\AframeDOMDocument;
29		use \AframeVR\Core\Assets;
30		use \Closure;
31		use \AframeVR\Core\Exceptions\BadComponentCallException;
32
33		final class Scene
34		{
35		/* All scenes can use primitives */
36		use Primitives;
37
38		/**
39		* Name with what you can retrieve this scene while working with multiple scenes
40		*
41		* @var string $name
42		*/
43		private $keyword;
44
45		/**
46		* Is scene prepared for rendering
47		*
48		* @var bool
49		*/
50		private $prepared;
51
52		/**
53		* Assets
54		*
55		* @var \AframeVR\Core\Assets
56		*/
57		protected $assets;
58
59		/**
60		* Aframe Document Object Model
61		*
62		* @var \AframeVR\Core\DOM\AframeDOMDocument
63		*/
64		protected $aframeDomObj;
65
66		/**
67		* A-Frame scene entities
68		*
69		* @var array $entities
70		*/
71		protected $entities = array();
72
73		/**
74		* Scene components
75		*
76		* @var array $components
77		*/
78		protected $components = array();
79
80		/**
81		* Scene constructor
82		*
83		* @param string $keyword
84		* @param Config $config
85		*/
86	98	public function __construct(string $keyword, Config $config)
87		{
88	98	$this->keyword = $keyword;
		0 ignored issues – show Coding Style introduced 2016-06-29 02:32 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 6 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
89	98	$this->aframeDomObj = new AframeDOMDocument($config);
90		/* Initialize assests manager */
91	98	$this->asset();
92	98	}
93
94		/**
95		* Aframe Document Object Model
96		*
97		* @api
98		*
99		* @return \AframeVR\Core\DOM\AframeDOMDocument
100		*/
101	2	public function dom()
102		{
103	2	return $this->aframeDomObj;
104		}
105
106		/**
107		* Entity
108		*
109		* @api
110		*
111		* @param string $id
112		* @return \AframeVR\Core\Entity
113		*/
114	51	public function entity(string $id = 'untitled'): Entity
115		{
116	51	return $this->entities[$id] ?? $this->entities[$id] = new Entity($id);
117		}
118
119		/**
120		* Assets
121		*
122		* @api
123		*
124		* @return \AframeVR\Core\Assets
125		*/
126	98	public function asset(): Assets
127		{
128	98	return $this->assets ?? $this->assets = new Assets();
129		}
130
131		/**
132		* Render the A-Frame scene and return the HTML
133		*
134		* @api
135		*
136		* @param bool $only_scene
137		* @return string
138		*/
139	19	public function save($only_scene = false, string $file = null): string
140		{
141	19	$this->prepare();
142	19	$html = ! $only_scene ? $this->aframeDomObj->render() : $this->aframeDomObj->renderSceneOnly();
143	19	if (! empty($file) && is_writable(dirname($file))) {
144	1	file_put_contents($file, $html);
145		}
146
147	19	return $html;
148		}
149
150		/**
151		* Render the A-Frame scene and passthru HTML
152		*
153		* @api
154		*
155		* @param bool $only_scene
156		* @return void
157		*/
158	1	public function render($only_scene = false)
159		{
160	1	print $this->save($only_scene);
161	1	}
162
163		/**
164		* Alias of AframeDOMDocument::setTitle(string)
165		*
166		* Set <title> tag
167		* $this->dom()->setTitle(string);
168		*
169		* @api
170		*
171		* @param string $title
172		*/
173	1	public function title(string $title)
174		{
175	1	$this->dom()->setTitle($title);
176	1	}
177
178		/**
179		* Alias of AframeDOMDocument::setDescription(string)
180		*
181		* Set <meta name="description"> tag
182		* $this->dom()->setDescription(string);
183		*
184		* @api
185		*
186		* @param string $description
187		*/
188	1	public function description(string $description)
189		{
190	1	$this->dom()->setDescription($description);
191	1	}
192
193		/**
194		* Get scenes keyword
195		*
196		* @return string
197		*/
198	1	public function getKeyword()
199		{
200	1	return $this->keyword;
201		}
202
203		/**
204		* Load component for this entity
205		*
206		* @param string $component_name
207		* @throws \AframeVR\Core\Exceptions\BadComponentCallException
208		* @return object\|null
209		*/
210	2	public function component(string $component_name)
211		{
212	2	if (! array_key_exists($component_name, $this->components)) {
213	2	$component = sprintf('\AframeVR\Core\Components\ascene\%s\%sComponent', ucfirst($component_name),
214		ucfirst($component_name));
215	2	if (class_exists($component)) {
216	1	$this->components[$component_name] = new $component();
217		} else {
218	1	throw new BadComponentCallException($component_name);
219		}
220		}
221
222	1	return $this->components[$component_name] ?? null;
223		}
224
225		/**
226		* Call
227		*
228		* @param string $method
229		* @param array $args
230		* @throws BadShaderCallException
231		* @return Entity\|\AframeVR\Interfaces\ComponentInterface
232		*/
233	28	public function __call(string $method, array $args)
234		{
235	28	$id = $args[0] ?? 0;
		0 ignored issues – show Coding Style introduced 2016-07-11 23:19 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 8 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
236	28	$primitive = sprintf('\AframeVR\Extras\Primitives\%s', ucfirst($method));
237
238	28	if (class_exists($primitive)) {
239	26	return $this->childrens[$id] ?? (is_int($id) ? $this->childrens[array_push($this->childrens,
240	26	new $primitive($id)) - 1] : $this->childrens[$id] = new $primitive($id));
241		} else {
242	2	return $this->callComponent($method, $args);
243		}
244		}
245
246		/**
247		* Handle entity components
248		*
249		* Since we might need to customize these to have
250		* custom components loaded as $this->methosd aswell therefore
251		* we have these placeholder magic methods here
252		*
253		* @param string $component_name
254		* @param array $args
255		*/
256	2	public function callComponent(string $component_name, array $args)
257		{
258	2	if (! method_exists($this, $component_name)) {
259	2	$this->{$component_name} = Closure::bind(
260	2	function () use ($component_name) {
261	2	return $this->component($component_name);
262	2	}, $this, get_class());
263		}
264
265	2	return call_user_func($this->{$component_name}, $args);
266		}
267
268		/**
269		* Add everyting to DOM
270		*
271		* @return void
272		*/
273	19	protected function prepare()
274		{
275	19	if ($this->prepared)
276	1	return;
277
278		/* Append all assets */
279	19	$assets = $this->assets->getAssets();
280	19	(! $assets) ?: $this->aframeDomObj->appendAssets($assets);
281		/* Append all primitives */
282	19	$this->preparePrimitives();
283
284		/* Append all entities */
285	19	$this->aframeDomObj->appendEntities($this->entities);
286	19	$this->aframeDomObj->appendSceneComponents($this->components);
287	19	$this->prepared = true;
288	19	}
289		}
290

mkungla / aframe-php

Push — master ( f87c77...be4ea7 )

Scene::description() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like