Animation::__construct() - Code Metrics - Inspection of "Added setAttribute to Animation" - mkungla/aframe-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 0.3.x ( c37298...efb292 )

by Marko

created 2016-07-06 21:42 UTC

Animation::__construct() A

↳ Parent: Animation

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	1
Bugs	0	Features	0

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

<?php
/** @formatter:off
 * ******************************************************************
 * Created by   Marko Kungla on Jun 20, 2016 - 9:07:01 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         Animation.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\Interfaces\AnimationInterface;
use \DOMElement;

final class Animation implements AnimationInterface
{
    /**
     * Animation DOM attributes array
     * 
     * @var array
     */
    protected $attrs;
    
    /**
     * Constructor
     *
     * @param string $id            
     */
    public function __construct(string $id = 'untitled')
    {
        $this->attrs['id'] = $id;
    }

    /**
     * Attribute to animate
     *
     * Attribute to animate. To specify a component attribute, use componentName.property syntax (e.g.,
     * light.intensity).
     *
     * @param string $attr            
     * @return AnimationInterface
     */
    public function attribute(string $attr = 'rotation'): AnimationInterface
    {
        $this->attrs['attribute'] = $attr;
        return $this;
    }

    /**
     * Delay (in milliseconds)
     *
     * Delay (in milliseconds) or event name to wait on before beginning animation
     *
     * @param int|string $ms            

     * @return AnimationInterface
     */
    public function begin($ms = 0): AnimationInterface
    {
        $this->attrs['begin'] = $ms;
        return $this;
    }

    /**
     * Direction of the animation
     *
     * Direction of the animation (between from and to). One of alternate, alternateReverse, normal, reverse.
     *
     * @param string $direction            
     * @return AnimationInterface
     */
    public function direction(string $direction = 'normal'): AnimationInterface
    {
        $this->attrs['direction'] = $direction;
        return $this;
    }

    /**
     * Duration in (milliseconds)
     *
     * Duration in (milliseconds) of the animation.
     *
     * @param int $ms            
     * @return AnimationInterface
     */
    public function dur(int $ms = 1000): AnimationInterface
    {
        $this->attrs['dur'] = $ms;
        return $this;
    }

    /**
     * Easing function
     *
     * Easing function of the animation. There are very many to choose from.
     *
     * @param string $func            
     * @return AnimationInterface
     */
    public function easing(string $func = 'ease'): AnimationInterface
    {
        $this->attrs['easing'] = $func;
        return $this;
    }

    /**
     * Determines effect of animation when not actively in play
     *
     * One of backwards, both, forwards, none.
     *
     * @param string $effect            
     * @return AnimationInterface
     */
    public function fill(string $effect = 'forwards'): AnimationInterface
    {
        $this->attrs['fill'] = $effect;
        return $this;
    }

    /**
     * Starting value.
     *
     * @param string $val            
     * @return AnimationInterface
     */
    public function from(string $val = 'Current'): AnimationInterface
    {
        $this->attrs['from'] = $val;
        return $this;
    }

    /**
     * Repeat count or indefinite.
     *
     * @param int $count            
     * @return AnimationInterface
     */
    public function repeat(int $count = 0): AnimationInterface
    {
        $this->attrs['repeat'] = $count;
        return $this;
    }

    /**
     * Ending value.
     * Must be specified.
     *
     * @param string $val            
     * @return AnimationInterface
     */
    public function to(string $val = 'true'): AnimationInterface
    {
        $this->attrs['to'] = $val;
        return $this;
    }

    /**
     * Create and add DOM element of the entity
     *
     * @param \DOMDocument $aframe_dom            
     * @return \DOMElement
     */
    public function domElement(\DOMDocument &$aframe_dom): DOMElement
    {
        $a_entity = $aframe_dom->createElement('a-animation');
        $this->appendAttributes($a_entity);
        return $a_entity;
    }

    /**
     * Append DOM attributes no set by components
     *
     * @param \DOMElement $a_entity            
     */
    private function appendAttributes(\DOMElement &$a_entity)
    {
        foreach ($this->attrs as $attribute => $val) {
            $this->setAttribute($a_entity, $attribute, $val);
        }
    }
    
    private function setAttribute(&$a_entity, $attribute, $val)
    {
        if ($attribute === 'id' && ($val === 'untitled' || is_numeric($val)))
            return;
    
        $a_entity->setAttribute($attribute, $val);
    }
    
}


1		<?php
2		/** @formatter:off
3		* ******************************************************************
4		* Created by Marko Kungla on Jun 20, 2016 - 9:07:01 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 Animation.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\Interfaces\AnimationInterface;
27		use \DOMElement;
28
29		final class Animation implements AnimationInterface
30		{
31		/**
32		* Animation DOM attributes array
33		*
34		* @var array
35		*/
36		protected $attrs;
37
38		/**
39		* Constructor
40		*
41		* @param string $id
42		*/
43	5	public function __construct(string $id = 'untitled')
44		{
45	5	$this->attrs['id'] = $id;
46	5	}
47
48		/**
49		* Attribute to animate
50		*
51		* Attribute to animate. To specify a component attribute, use componentName.property syntax (e.g.,
52		* light.intensity).
53		*
54		* @param string $attr
55		* @return AnimationInterface
56		*/
57	4	public function attribute(string $attr = 'rotation'): AnimationInterface
58		{
59	4	$this->attrs['attribute'] = $attr;
60	4	return $this;
61		}
62
63		/**
64		* Delay (in milliseconds)
65		*
66		* Delay (in milliseconds) or event name to wait on before beginning animation
67		*
68		* @param int\|string $ms
		0 ignored issues – show Documentation introduced 2016-07-06 21:10 UTC by Report Bug Copy Issue Report Consider making the type for parameter `$ms` a bit more specific; maybe use `integer`. Loading history...
69		* @return AnimationInterface
70		*/
71	4	public function begin($ms = 0): AnimationInterface
72		{
73	4	$this->attrs['begin'] = $ms;
74	4	return $this;
75		}
76
77		/**
78		* Direction of the animation
79		*
80		* Direction of the animation (between from and to). One of alternate, alternateReverse, normal, reverse.
81		*
82		* @param string $direction
83		* @return AnimationInterface
84		*/
85	1	public function direction(string $direction = 'normal'): AnimationInterface
86		{
87	1	$this->attrs['direction'] = $direction;
88	1	return $this;
89		}
90
91		/**
92		* Duration in (milliseconds)
93		*
94		* Duration in (milliseconds) of the animation.
95		*
96		* @param int $ms
97		* @return AnimationInterface
98		*/
99	4	public function dur(int $ms = 1000): AnimationInterface
100		{
101	4	$this->attrs['dur'] = $ms;
102	4	return $this;
103		}
104
105		/**
106		* Easing function
107		*
108		* Easing function of the animation. There are very many to choose from.
109		*
110		* @param string $func
111		* @return AnimationInterface
112		*/
113	4	public function easing(string $func = 'ease'): AnimationInterface
114		{
115	4	$this->attrs['easing'] = $func;
116	4	return $this;
117		}
118
119		/**
120		* Determines effect of animation when not actively in play
121		*
122		* One of backwards, both, forwards, none.
123		*
124		* @param string $effect
125		* @return AnimationInterface
126		*/
127	4	public function fill(string $effect = 'forwards'): AnimationInterface
128		{
129	4	$this->attrs['fill'] = $effect;
130	4	return $this;
131		}
132
133		/**
134		* Starting value.
135		*
136		* @param string $val
137		* @return AnimationInterface
138		*/
139	4	public function from(string $val = 'Current'): AnimationInterface
140		{
141	4	$this->attrs['from'] = $val;
142	4	return $this;
143		}
144
145		/**
146		* Repeat count or indefinite.
147		*
148		* @param int $count
149		* @return AnimationInterface
150		*/
151	1	public function repeat(int $count = 0): AnimationInterface
152		{
153	1	$this->attrs['repeat'] = $count;
154	1	return $this;
155		}
156
157		/**
158		* Ending value.
159		* Must be specified.
160		*
161		* @param string $val
162		* @return AnimationInterface
163		*/
164	4	public function to(string $val = 'true'): AnimationInterface
165		{
166	4	$this->attrs['to'] = $val;
167	4	return $this;
168		}
169
170		/**
171		* Create and add DOM element of the entity
172		*
173		* @param \DOMDocument $aframe_dom
174		* @return \DOMElement
175		*/
176	2	public function domElement(\DOMDocument &$aframe_dom): DOMElement
177		{
178	2	$a_entity = $aframe_dom->createElement('a-animation');
179	2	$this->appendAttributes($a_entity);
180	2	return $a_entity;
181		}
182
183		/**
184		* Append DOM attributes no set by components
185		*
186		* @param \DOMElement $a_entity
187		*/
188	2	private function appendAttributes(\DOMElement &$a_entity)
189		{
190	2	foreach ($this->attrs as $attribute => $val) {
191	2	$this->setAttribute($a_entity, $attribute, $val);
192		}
193	2	}
194
195	2	private function setAttribute(&$a_entity, $attribute, $val)
196		{
197	2	if ($attribute === 'id' && ($val === 'untitled' \|\| is_numeric($val)))
198	2	return;
199
200	2	$a_entity->setAttribute($attribute, $val);
201	2	}
202
203		}
204

mkungla / aframe-php

Push — 0.3.x ( c37298...efb292 )

Animation::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like