Event::getData() - Code Metrics - fwk/Events - Measure and Improve Code Quality continuously with Scrutinizer

Event::getData() A
last analyzed 2016-06-15 21:12 UTC

↳ Parent: Event

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes	4
Bugs	2	Features	1

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

<?php
/**
 * Fwk
 *
 * Copyright (c) 2011-2012, Julien Ballestracci <[email protected]>.
 * All rights reserved.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 * PHP Version 5.3
 *
 * @category  EventDispatcher
 * @package   Fwk\Events
 * @author    Julien Ballestracci <[email protected]>
 * @copyright 2011-2014 Julien Ballestracci <[email protected]>
 * @license   http://www.opensource.org/licenses/bsd-license.php  BSD License
 * @link      http://www.nitronet.org/fwk
 */
namespace Fwk\Events;

use \ArrayObject;

/**
 * Event
 * 
 * This class represents an Event to be triggered into an EventDispatcher
 *
 * @category Event
 * @package  Fwk\Events
 * @author   Julien Ballestracci <[email protected]>
 * @license  http://www.opensource.org/licenses/bsd-license.php  BSD License
 * @link     http://www.nitronet.org/fwk
 */
class Event extends ArrayObject
{
    /**
     * This event's name
     * @var string
     */
    protected $name;

    /**
     * Tells if this event has been processed
     * @var boolean
     */
    protected $processed = false;

    /**
     * Stop propagation ?
     * @var boolean
     */
    protected $stopped = false;

    /**
     * Creates the event and attach some data
     *
     * @param string $name Event name
     * @param array  $data Event data
     * 
     * @return void

     */
    public function __construct($name, $data = array())
    {
        parent::__construct($data);
        $this->setFlags(\ArrayObject::ARRAY_AS_PROPS);
        $this->name = $name;
    }

    /**
     * Returns this event name
     *
     * @return string
     */
    public function getName()
    {
        return $this->name;
    }

    /**
     * Returns the data
     *
     * @return array
     */
    public function getData()
    {
        return $this->getArrayCopy();
    }

    /**
     * Sets the processed flag
     *
     * @param boolean $processed Processed or not
     * 
     * @return Event
     */
    public function setProcessed($processed)
    {
        $this->processed = (boolean)$processed;

        return $this;
    }

    /**
     * Stops event propagation
     *
     * @return void
     */
    public function stop()
    {
        $this->stopped = true;
    }

    /**
     * Tells if the event is stopped
     *
     * @return boolean
     */
    public function isStopped()
    {
        return $this->stopped;
    }

    /**
     * Tells if this event is processed
     *
     * @return boolean
     */
    public function isProcessed()
    {
        return $this->processed;
    }

    /**
     * Retrieve the $key parameter
     *
     * @param string $key Parameter name
     * 
     * @return mixed
     */
    public function __get($key)
    {
        return $this->offsetGet($key);
    }

    /**
     * Sets a parameter for this event
     *
     * @param string $key   Parameter name
     * @param mixed  $value Parameter value
     * 
     * @return void
     */
    public function __set($key, $value)
    {
        return $this->offsetSet($key, $value);
    }

    /**
     * Tells if the $key parameter is defined for this event
     *
     * @param string $key Parameter name
     * 
     * @return boolean
     */
    public function __isset($key)

    {
        return $this->offsetExists($key);
    }
}

1		<?php
2		/**
3		* Fwk
4		*
5		* Copyright (c) 2011-2012, Julien Ballestracci <[email protected]>.
6		* All rights reserved.
7		*
8		* For the full copyright and license information, please view the LICENSE
9		* file that was distributed with this source code.
10		*
11		* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
12		* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
13		* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
14		* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
15		* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
16		* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
17		* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
18		* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
19		* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
20		* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
21		* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
22		* POSSIBILITY OF SUCH DAMAGE.
23		*
24		* PHP Version 5.3
25		*
26		* @category EventDispatcher
27		* @package Fwk\Events
28		* @author Julien Ballestracci <[email protected]>
29		* @copyright 2011-2014 Julien Ballestracci <[email protected]>
30		* @license http://www.opensource.org/licenses/bsd-license.php BSD License
31		* @link http://www.nitronet.org/fwk
32		*/
33		namespace Fwk\Events;
34
35		use \ArrayObject;
36
37		/**
38		* Event
39		*
40		* This class represents an Event to be triggered into an EventDispatcher
41		*
42		* @category Event
43		* @package Fwk\Events
44		* @author Julien Ballestracci <[email protected]>
45		* @license http://www.opensource.org/licenses/bsd-license.php BSD License
46		* @link http://www.nitronet.org/fwk
47		*/
48		class Event extends ArrayObject
49		{
50		/**
51		* This event's name
52		* @var string
53		*/
54		protected $name;
55
56		/**
57		* Tells if this event has been processed
58		* @var boolean
59		*/
60		protected $processed = false;
61
62		/**
63		* Stop propagation ?
64		* @var boolean
65		*/
66		protected $stopped = false;
67
68		/**
69		* Creates the event and attach some data
70		*
71		* @param string $name Event name
72		* @param array $data Event data
73		*
74		* @return void
		0 ignored issues – show Comprehensibility Best Practice introduced 2016-06-15 20:35 UTC by Report Bug Copy Issue Report Adding a `@return` annotation to constructors is generally not recommended as a constructor does not have a meaningful return value. Adding a `@return` annotation to a constructor is not recommended, since a constructor does not have a meaningful return value. Please refer to the PHP core documentation on constructors. Loading history...
75		*/
76	10	public function __construct($name, $data = array())
77		{
78	10	parent::__construct($data);
79	10	$this->setFlags(\ArrayObject::ARRAY_AS_PROPS);
80	10	$this->name = $name;
81	10	}
82
83		/**
84		* Returns this event name
85		*
86		* @return string
87		*/
88	7	public function getName()
89		{
90	7	return $this->name;
91		}
92
93		/**
94		* Returns the data
95		*
96		* @return array
97		*/
98	1	public function getData()
99		{
100	1	return $this->getArrayCopy();
101		}
102
103		/**
104		* Sets the processed flag
105		*
106		* @param boolean $processed Processed or not
107		*
108		* @return Event
109		*/
110	6	public function setProcessed($processed)
111		{
112	6	$this->processed = (boolean)$processed;
113
114	6	return $this;
115		}
116
117		/**
118		* Stops event propagation
119		*
120		* @return void
121		*/
122	1	public function stop()
123		{
124	1	$this->stopped = true;
125	1	}
126
127		/**
128		* Tells if the event is stopped
129		*
130		* @return boolean
131		*/
132	5	public function isStopped()
133		{
134	5	return $this->stopped;
135		}
136
137		/**
138		* Tells if this event is processed
139		*
140		* @return boolean
141		*/
142	3	public function isProcessed()
143		{
144	3	return $this->processed;
145		}
146
147		/**
148		* Retrieve the $key parameter
149		*
150		* @param string $key Parameter name
151		*
152		* @return mixed
153		*/
154	1	public function __get($key)
155		{
156	1	return $this->offsetGet($key);
157		}
158
159		/**
160		* Sets a parameter for this event
161		*
162		* @param string $key Parameter name
163		* @param mixed $value Parameter value
164		*
165		* @return void
166		*/
167	1	public function __set($key, $value)
168		{
169	1	return $this->offsetSet($key, $value);
170		}
171
172		/**
173		* Tells if the $key parameter is defined for this event
174		*
175		* @param string $key Parameter name
176		*
177		* @return boolean
178		*/
179	1	public function __isset($key)
		0 ignored issues – show Coding Style introduced 2016-06-15 20:35 UTC by Report Bug Copy Issue Report `function __isset()` does not seem to conform to the naming convention (`^(?:is\|has\|should\|may\|su...ster\|unregister\|exists)`). This check examines a number of code elements and verifies that they conform to the given naming conventions. You can set conventions for local variables, abstract classes, utility classes, constant, properties, methods, parameters, interfaces, classes, exceptions and special methods. Loading history...
180		{
181	1	return $this->offsetExists($key);
182		}
183		}

fwk / Events

Event::getData() A last analyzed 2016-06-15 21:12 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

Event::getData() A
last analyzed 2016-06-15 21:12 UTC