driverStatistic::getPublicDesc() - Code Metrics - Inspection of "Updated driverStatistic entity" - PHPSocialNetwork/phpfastcache - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — v5 ( d83136...3408cd )

by Georges

created 2016-05-15 16:45 UTC

driverStatistic::getPublicDesc() A

↳ Parent: driverStatistic

Complexity

Conditions	1
Paths	1

Size

Total Lines	9
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	6
c	1
b	0
f	0
nc	1
nop	0
dl	0
loc	9
rs	9.6666

<?php
/**
 *
 * This file is part of phpFastCache.
 *
 * @license MIT License (MIT)
 *
 * For full copyright and license information, please see the docs/CREDITS.txt file.
 *
 * @author Khoa Bui (khoaofgod)  <[email protected]> http://www.phpfastcache.com
 * @author Georges.L (Geolim4)  <[email protected]>
 *
 */
namespace phpFastCache\Entities;

use ArrayAccess;
use InvalidArgumentException;
use LogicException;

/**
 * Class driverStatistic
 * @package phpFastCache\Entities
 */
class driverStatistic implements ArrayAccess
{
    /**
     * @var string
     */
    protected $info = '';

    /**
     * @var string
     */
    protected $size = '';

    /**
     * @var string
     */
    protected $data = '';

    /**
     * @var mixed
     */
    protected $rawData;

    /**
     * @return string|bool Return infos or false if no information available
     */
    public function getInfo()
    {
        return $this->info;
    }

    /**
     * @return int|bool Return size in octet or false if no information available
     */
    public function getSize()
    {
        return $this->size;
    }

    /**
     * @return mixed
     */
    public function getData()
    {
        return $this->data;
    }

    /**
     * @param $info
     * @return $this
     */
    public function setInfo($info)
    {
        $this->info = ($info ?: false);

        return $this;
    }


    /**
     * @param int $size
     * @return $this
     */
    public function setSize($size)
    {
        $this->size = ($size ?: false);


        return $this;
    }

    /**
     * @param mixed $data
     * @return $this
     */
    public function setData($data)
    {
        $this->data = ($data ?: false);

        return $this;
    }

    /**
     * @return mixed
     */
    public function getRawData()
    {
        return $this->rawData;
    }

    /**
     * @param mixed $raw
     * @return $this
     */
    public function setRawData($raw)
    {
        $this->rawData = $raw;

        return $this;
    }

    /**
     * @return array
     */
    public function getPublicDesc()
    {
        return[
            'Info' => 'Cache Information',
            'Size' => 'Cache Size',
            'Data' => 'Cache items keys',
            'RawData' => 'Cache raw data',
        ];
    }

    /*****************
     * ArrayAccess
     *****************/

    /**
     * @param string $offset
     * @param string $value
     * @throws InvalidArgumentException
     * @throws LogicException
     */
    public function offsetSet($offset, $value)

    {
        trigger_error($this->getDeprecatedMsg(), E_USER_DEPRECATED);
        if (!is_string($offset)) {
            throw new InvalidArgumentException('$offset must be a string');
        } else {
            if (property_exists($this, $offset)) {
                $this->{$offset} = $value;
            } else {
                throw new LogicException("Property {$offset} does not exists");
            }
        }
    }

    /**
     * @param string $offset
     * @return bool
     * @throws InvalidArgumentException
     * @throws LogicException
     */
    public function offsetExists($offset)

    {
        trigger_error($this->getDeprecatedMsg(), E_USER_DEPRECATED);
        if (!is_string($offset)) {
            throw new InvalidArgumentException('$offset must be a string');
        } else {
            if (property_exists($this, $offset)) {
                return isset($this->{$offset});
            } else {
                throw new LogicException("Property {$offset} does not exists");
            }
        }
    }

    /**
     * @param string $offset
     * @throws InvalidArgumentException
     * @throws LogicException
     */
    public function offsetUnset($offset)

    {
        trigger_error($this->getDeprecatedMsg(), E_USER_DEPRECATED);
        if (!is_string($offset)) {
            throw new InvalidArgumentException('$offset must be a string');
        } else {
            if (property_exists($this, $offset)) {
                unset($this->{$offset});
            } else {
                throw new LogicException("Property {$offset} does not exists");
            }
        }
    }

    /**
     * @param string $offset
     * @return string
     * @throws InvalidArgumentException
     * @throws LogicException
     */
    public function offsetGet($offset)

    {
        trigger_error($this->getDeprecatedMsg(), E_USER_DEPRECATED);
        if (!is_string($offset)) {
            throw new InvalidArgumentException('$offset must be a string');
        } else {
            if (property_exists($this, $offset)) {
                return isset($this->{$offset}) ? $this->{$offset} : null;
            } else {
                throw new LogicException("Property {$offset} does not exists");
            }
        }
    }

    /**
     * @return string
     */
    private function getDeprecatedMsg()
    {
        return 'You should consider upgrading your code and treat the statistic array as an object. 
        The arrayAccess compatibility will be removed in the next major release';
    }
}

1		<?php
2		/**
3		*
4		* This file is part of phpFastCache.
5		*
6		* @license MIT License (MIT)
7		*
8		* For full copyright and license information, please see the docs/CREDITS.txt file.
9		*
10		* @author Khoa Bui (khoaofgod) <[email protected]> http://www.phpfastcache.com
11		* @author Georges.L (Geolim4) <[email protected]>
12		*
13		*/
14		namespace phpFastCache\Entities;
15
16		use ArrayAccess;
17		use InvalidArgumentException;
18		use LogicException;
19
20		/**
21		* Class driverStatistic
22		* @package phpFastCache\Entities
23		*/
24		class driverStatistic implements ArrayAccess
25		{
26		/**
27		* @var string
28		*/
29		protected $info = '';
30
31		/**
32		* @var string
33		*/
34		protected $size = '';
35
36		/**
37		* @var string
38		*/
39		protected $data = '';
40
41		/**
42		* @var mixed
43		*/
44		protected $rawData;
45
46		/**
47		* @return string\|bool Return infos or false if no information available
48		*/
49		public function getInfo()
50		{
51		return $this->info;
52		}
53
54		/**
55		* @return int\|bool Return size in octet or false if no information available
56		*/
57		public function getSize()
58		{
59		return $this->size;
60		}
61
62		/**
63		* @return mixed
64		*/
65		public function getData()
66		{
67		return $this->data;
68		}
69
70		/**
71		* @param $info
72		* @return $this
73		*/
74		public function setInfo($info)
75		{
76		$this->info = ($info ?: false);
77
78		return $this;
79		}
80
81
82		/**
83		* @param int $size
84		* @return $this
85		*/
86		public function setSize($size)
87		{
88		$this->size = ($size ?: false);
		0 ignored issues – show Documentation Bug introduced 2016-05-15 02:30 UTC by Report Bug Copy Issue Report It seems like `$size ?: false` of type `integer` or `false` is incompatible with the declared type `string` of property `$size`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
89
90		return $this;
91		}
92
93		/**
94		* @param mixed $data
95		* @return $this
96		*/
97		public function setData($data)
98		{
99		$this->data = ($data ?: false);
100
101		return $this;
102		}
103
104		/**
105		* @return mixed
106		*/
107		public function getRawData()
108		{
109		return $this->rawData;
110		}
111
112		/**
113		* @param mixed $raw
114		* @return $this
115		*/
116		public function setRawData($raw)
117		{
118		$this->rawData = $raw;
119
120		return $this;
121		}
122
123		/**
124		* @return array
125		*/
126		public function getPublicDesc()
127		{
128		return[
129		'Info' => 'Cache Information',
130		'Size' => 'Cache Size',
131		'Data' => 'Cache items keys',
132		'RawData' => 'Cache raw data',
133		];
134		}
135
136		/*****************
137		* ArrayAccess
138		*****************/
139
140		/**
141		* @param string $offset
142		* @param string $value
143		* @throws InvalidArgumentException
144		* @throws LogicException
145		*/
146	View Code Duplication	public function offsetSet($offset, $value)
		1 ignored issue – show Duplication introduced 2016-05-12 20:38 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
147		{
148		trigger_error($this->getDeprecatedMsg(), E_USER_DEPRECATED);
149		if (!is_string($offset)) {
150		throw new InvalidArgumentException('$offset must be a string');
151		} else {
152		if (property_exists($this, $offset)) {
153		$this->{$offset} = $value;
154		} else {
155		throw new LogicException("Property {$offset} does not exists");
156		}
157		}
158		}
159
160		/**
161		* @param string $offset
162		* @return bool
163		* @throws InvalidArgumentException
164		* @throws LogicException
165		*/
166	View Code Duplication	public function offsetExists($offset)
		1 ignored issue – show Duplication introduced 2016-05-12 20:38 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
167		{
168		trigger_error($this->getDeprecatedMsg(), E_USER_DEPRECATED);
169		if (!is_string($offset)) {
170		throw new InvalidArgumentException('$offset must be a string');
171		} else {
172		if (property_exists($this, $offset)) {
173		return isset($this->{$offset});
174		} else {
175		throw new LogicException("Property {$offset} does not exists");
176		}
177		}
178		}
179
180		/**
181		* @param string $offset
182		* @throws InvalidArgumentException
183		* @throws LogicException
184		*/
185	View Code Duplication	public function offsetUnset($offset)
		1 ignored issue – show Duplication introduced 2016-05-12 20:38 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
186		{
187		trigger_error($this->getDeprecatedMsg(), E_USER_DEPRECATED);
188		if (!is_string($offset)) {
189		throw new InvalidArgumentException('$offset must be a string');
190		} else {
191		if (property_exists($this, $offset)) {
192		unset($this->{$offset});
193		} else {
194		throw new LogicException("Property {$offset} does not exists");
195		}
196		}
197		}
198
199		/**
200		* @param string $offset
201		* @return string
202		* @throws InvalidArgumentException
203		* @throws LogicException
204		*/
205	View Code Duplication	public function offsetGet($offset)
		1 ignored issue – show Duplication introduced 2016-05-12 20:38 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
206		{
207		trigger_error($this->getDeprecatedMsg(), E_USER_DEPRECATED);
208		if (!is_string($offset)) {
209		throw new InvalidArgumentException('$offset must be a string');
210		} else {
211		if (property_exists($this, $offset)) {
212		return isset($this->{$offset}) ? $this->{$offset} : null;
213		} else {
214		throw new LogicException("Property {$offset} does not exists");
215		}
216		}
217		}
218
219		/**
220		* @return string
221		*/
222		private function getDeprecatedMsg()
223		{
224		return 'You should consider upgrading your code and treat the statistic array as an object.
225		The arrayAccess compatibility will be removed in the next major release';
226		}
227		}

PHPSocialNetwork / phpfastcache

Push — v5 ( d83136...3408cd )

driverStatistic::getPublicDesc() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like