Entity::DOMElement() - Code Metrics - Inspection of "Added tests and modified examples" - mkungla/aframe-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 94f348...ce557b )

by Marko

created 2016-06-24 17:29 UTC

Entity::DOMElement() A

↳ Parent: Entity

Complexity

Conditions	3
Paths	3

Size

Total Lines	18
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	12

Importance

Changes

Metric	Value
dl	0
loc	18
ccs	0
cts	7
cp	0
rs	9.4285
c	0
b	0
f	0
cc	3
eloc	7
nc	3
nop	1
crap	12

<?php
/** @formatter:off
 * ******************************************************************
 * Created by   Marko Kungla on Jun 20, 2016 - 9:11:10 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         Entity.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\Core\Exceptions\BadComponentCallException;
use \AframeVR\Interfaces\{
    ComponentInterface,
    EntityInterface
};
use \DOMElement;

class Entity implements EntityInterface
{

    protected $components = array();

    public function __construct()
    {
        /* Components which All entities inherently have */
        $this->component('Position');
        $this->component('Rotation');
        
        /*
         * We initialize common entity components here since
         * init and defaults are most cases overwritten by extending class
         */
        $this->position();
        $this->rotation();
        
        /* Extending entity components and init */
        $this->init();
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
        
        /* Extending entity defaults */
        $this->defaults();
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
    }

    /**
     * Position component
     * 
     * All entities inherently have the position component.
     * 
     * @param number $x

     * @param number $y

     * @param number $z

     * @return Entity
     */
    public function position($x = 0, $y = 0, $z = 0): EntityInterface
    {
        $this->component('Position')->update($x, $y, $z);
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        return $this;
    }

    /**
     * Rotation component
     * 
     * All entities inherently have the rotation component.
     * 
     * @param number $x

     * @param number $y

     * @param number $z

     * @return EntityInterface

     */
    public function rotation($x = 0, $y = 0, $z = 0): EntityInterface
    {
        $this->component('Rotation')->update($x, $y, $z);
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        return $this;
    }
    
    /**
     * Scale component
     *
     * All entities inherently have the scale component.
     *
     * @param number $x

     * @param number $y

     * @param number $z

     * @return EntityInterface

     */
    public function scale($x = 0, $y = 0, $z = 0): EntityInterface
    {
        $this->component('Scale')->update($x, $y, $z);
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        return $this;
    }
    
    /**
     * Load component for this entity
     *
     * @param string $component_name            
     * @throws BadComponentCallException
     * @return ComponentInterface

     */
    public function component(string $component_name): ComponentInterface
    {
        $component_name = strtolower($component_name);
        
        if (! array_key_exists($component_name, $this->components)) {
            try {
                $component = sprintf('\AframeVR\Components\%s', ucfirst($component_name));
                if (class_exists($component)) {
                    $this->components[$component_name] = new $component();
                } else {
                    throw new BadComponentCallException($component_name);
                }
            } catch (BadComponentCallException $e) {
                die($e->getMessage());
            }
        }
        
        return $this->components[$component_name];
    }

    /**
     * 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 __call(string $component_name, array $args)
    {
        return call_user_func_array($this->{$component_name}->bindTo($this), $args);
    }

    /**
     * Create and add DOM element of the entity
     *
     * @param unknown $aframe_dom            
     * @return DOMElement
     */
    public function DOMElement(&$aframe_dom): DOMElement
    {
        /* Create entity DOMElement */
        $a_entity = $aframe_dom->createElement('a-entity', "\n");
        foreach ($this->components as $component) {
            /**
             * Remeve component default properties which are not needed
             */
            $component->removeDefaultDOMAttributes();
            /*
             * Check does component has any attributes to add to DOM element.
             * default attributes most of cases are ommited so we might not have any attributes to add
             */
            if ($component->hasDOMAttributes())
                $a_entity->setAttributeNode($component->getDOMAttributes());
        }
        return $a_entity;
    }
}


1		<?php
2		/** @formatter:off
3		* ******************************************************************
4		* Created by Marko Kungla on Jun 20, 2016 - 9:11:10 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 Entity.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\Core\Exceptions\BadComponentCallException;
27		use \AframeVR\Interfaces\{
28		ComponentInterface,
29		EntityInterface
30		};
31		use \DOMElement;
32
33		class Entity implements EntityInterface
34		{
35
36		protected $components = array();
37
38	8	public function __construct()
39		{
40		/* Components which All entities inherently have */
41	8	$this->component('Position');
42	8	$this->component('Rotation');
43
44		/*
45		* We initialize common entity components here since
46		* init and defaults are most cases overwritten by extending class
47		*/
48	8	$this->position();
49	8	$this->rotation();
50
51		/* Extending entity components and init */
52	8	$this->init();
		0 ignored issues – show Documentation Bug introduced 2016-06-24 12:48 UTC by Report Bug Copy Issue Report The method `init` does not exist on `object<AframeVR\Core\Entity>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
53
54		/* Extending entity defaults */
55	8	$this->defaults();
		0 ignored issues – show Documentation Bug introduced 2016-06-24 12:48 UTC by Report Bug Copy Issue Report The method `defaults` does not exist on `object<AframeVR\Core\Entity>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
56	8	}
57
58		/**
59		* Position component
60		*
61		* All entities inherently have the position component.
62		*
63		* @param number $x
		0 ignored issues – show Documentation introduced 2016-06-24 17:19 UTC by Report Bug Copy Issue Report Consider making the type for parameter `$x` a bit more specific; maybe use `integer`. Loading history...
64		* @param number $y
		0 ignored issues – show Documentation introduced 2016-06-24 17:19 UTC by Report Bug Copy Issue Report Consider making the type for parameter `$y` a bit more specific; maybe use `integer`. Loading history...
65		* @param number $z
		0 ignored issues – show Documentation introduced 2016-06-24 17:19 UTC by Report Bug Copy Issue Report Consider making the type for parameter `$z` a bit more specific; maybe use `integer`. Loading history...
66		* @return Entity
67		*/
68	8	public function position($x = 0, $y = 0, $z = 0): EntityInterface
69		{
70	8	$this->component('Position')->update($x, $y, $z);
		0 ignored issues – show Bug introduced 2016-06-24 17:19 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `AframeVR\Interfaces\ComponentInterface` as the method `update()` does only exist in the following implementations of said interface: `AframeVR\Components\Position`, `AframeVR\Components\Rotation`, `AframeVR\Components\Scale`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
71	8	return $this;
72		}
73
74		/**
75		* Rotation component
76		*
77		* All entities inherently have the rotation component.
78		*
79		* @param number $x
		0 ignored issues – show Documentation introduced 2016-06-24 17:19 UTC by Report Bug Copy Issue Report Consider making the type for parameter `$x` a bit more specific; maybe use `integer`. Loading history...
80		* @param number $y
		0 ignored issues – show Documentation introduced 2016-06-24 17:19 UTC by Report Bug Copy Issue Report Consider making the type for parameter `$y` a bit more specific; maybe use `integer`. Loading history...
81		* @param number $z
		0 ignored issues – show Documentation introduced 2016-06-24 17:19 UTC by Report Bug Copy Issue Report Consider making the type for parameter `$z` a bit more specific; maybe use `integer`. Loading history...
82		* @return EntityInterface
		0 ignored issues – show Documentation introduced 2016-06-24 17:19 UTC by Report Bug Copy Issue Report Should the return type not be `\AframeVR\Interfaces\EntityInterface`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
83		*/
84	8	public function rotation($x = 0, $y = 0, $z = 0): EntityInterface
85		{
86	8	$this->component('Rotation')->update($x, $y, $z);
		0 ignored issues – show Bug introduced 2016-06-24 17:19 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `AframeVR\Interfaces\ComponentInterface` as the method `update()` does only exist in the following implementations of said interface: `AframeVR\Components\Position`, `AframeVR\Components\Rotation`, `AframeVR\Components\Scale`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
87	8	return $this;
88		}
89
90		/**
91		* Scale component
92		*
93		* All entities inherently have the scale component.
94		*
95		* @param number $x
		0 ignored issues – show Documentation introduced 2016-06-24 17:19 UTC by Report Bug Copy Issue Report Consider making the type for parameter `$x` a bit more specific; maybe use `integer`. Loading history...
96		* @param number $y
		0 ignored issues – show Documentation introduced 2016-06-24 17:19 UTC by Report Bug Copy Issue Report Consider making the type for parameter `$y` a bit more specific; maybe use `integer`. Loading history...
97		* @param number $z
		0 ignored issues – show Documentation introduced 2016-06-24 17:19 UTC by Report Bug Copy Issue Report Consider making the type for parameter `$z` a bit more specific; maybe use `integer`. Loading history...
98		* @return EntityInterface
		0 ignored issues – show Documentation introduced 2016-06-24 17:19 UTC by Report Bug Copy Issue Report Should the return type not be `\AframeVR\Interfaces\EntityInterface`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
99		*/
100	1	public function scale($x = 0, $y = 0, $z = 0): EntityInterface
101		{
102	1	$this->component('Scale')->update($x, $y, $z);
		0 ignored issues – show Bug introduced 2016-06-24 17:19 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `AframeVR\Interfaces\ComponentInterface` as the method `update()` does only exist in the following implementations of said interface: `AframeVR\Components\Position`, `AframeVR\Components\Rotation`, `AframeVR\Components\Scale`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
103	1	return $this;
104		}
105
106		/**
107		* Load component for this entity
108		*
109		* @param string $component_name
110		* @throws BadComponentCallException
111		* @return ComponentInterface
		0 ignored issues – show Documentation introduced 2016-06-24 17:19 UTC by Report Bug Copy Issue Report Should the return type not be `\AframeVR\Interfaces\ComponentInterface`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
112		*/
113	8	public function component(string $component_name): ComponentInterface
114		{
115	8	$component_name = strtolower($component_name);
116
117	8	if (! array_key_exists($component_name, $this->components)) {
118		try {
119	8	$component = sprintf('\AframeVR\Components\%s', ucfirst($component_name));
120	8	if (class_exists($component)) {
121	8	$this->components[$component_name] = new $component();
122		} else {
123	8	throw new BadComponentCallException($component_name);
124		}
125		} catch (BadComponentCallException $e) {
126		die($e->getMessage());
127		}
128		}
129
130	8	return $this->components[$component_name];
131		}
132
133		/**
134		* Handle entity components
135		*
136		* Since we might need to customize these to have
137		* custom components loaded as $this->methosd aswell therefore
138		* we have these placeholder magic methods here
139		*
140		* @param string $component_name
141		* @param array $args
142		*/
143		public function __call(string $component_name, array $args)
144		{
145		return call_user_func_array($this->{$component_name}->bindTo($this), $args);
146		}
147
148		/**
149		* Create and add DOM element of the entity
150		*
151		* @param unknown $aframe_dom
152		* @return DOMElement
153		*/
154		public function DOMElement(&$aframe_dom): DOMElement
155		{
156		/* Create entity DOMElement */
157		$a_entity = $aframe_dom->createElement('a-entity', "\n");
158		foreach ($this->components as $component) {
159		/**
160		* Remeve component default properties which are not needed
161		*/
162		$component->removeDefaultDOMAttributes();
163		/*
164		* Check does component has any attributes to add to DOM element.
165		* default attributes most of cases are ommited so we might not have any attributes to add
166		*/
167		if ($component->hasDOMAttributes())
168		$a_entity->setAttributeNode($component->getDOMAttributes());
169		}
170		return $a_entity;
171		}
172		}
173

mkungla / aframe-php

Push — master ( 94f348...ce557b )

Entity::DOMElement() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like