Location::getDisplayNameAttribute() - Code Metrics - Inspection of "Merge pull request #6 from ARCANEDEV/develop" - ARCANEDEV/GeoIP - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( d0dd0d...df62c5 )

by ARCANEDEV

created 2016-12-10 21:17 UTC

Location::getDisplayNameAttribute() A

↳ Parent: Location

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

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

<?php namespace Arcanedev\GeoIP;

use ArrayAccess;
use Illuminate\Contracts\Support\Arrayable;
use Illuminate\Contracts\Support\Jsonable;
use Illuminate\Support\Arr;
use Illuminate\Support\Str;

/**
 * Class     Location
 *
 * @package  Arcanedev\GeoIP
 * @author   ARCANEDEV <[email protected]>
 *
 * @property  string     ip
 * @property  string     iso_code
 * @property  string     country
 * @property  string     city
 * @property  string     state
 * @property  string     state_code
 * @property  string     postal_code
 * @property  float      latitude
 * @property  float      longitude
 * @property  string     timezone
 * @property  string     continent
 *
 * @property  bool       display_name
 * @property  bool       default
 * @property  bool|null  cached
 * @property  string     currency
 */
class Location implements ArrayAccess, Arrayable, Jsonable
{
    /* ------------------------------------------------------------------------------------------------
     |  Properties
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * The location's attributes
     *
     * @var array
     */
    protected $attributes = [];

    /* ------------------------------------------------------------------------------------------------
     |  Constructor
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Create a new location instance.
     *
     * @param array $attributes
     */
    public function __construct(array $attributes = [])
    {
        $this->attributes = $attributes;
    }

    /* ------------------------------------------------------------------------------------------------
     |  Getters & Setters
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Get all attributes.
     *
     * @return array
     */
    public function attributes()
    {
        return $this->attributes;
    }

    /**
     * Get an attribute from the $attributes array.
     *
     * @param  string  $key
     *
     * @return mixed
     */
    public function getAttribute($key)
    {
        $value = Arr::get($this->attributes(), $key);

        return method_exists($this, $method = 'get'.Str::studly($key).'Attribute')
            ? $this->{$method}($value)
            : $value;
    }

    /**
     * Set a given attribute on the location.
     *
     * @param  string  $key
     * @param  mixed   $value
     *
     * @return $this
     */
    public function setAttribute($key, $value)
    {
        $this->attributes[$key] = $value;

        return $this;
    }

    /**
     * Return the display name of the location.
     *
     * @return string
     */
    public function getDisplayNameAttribute()
    {
        return preg_replace('/^,\s/', '', "{$this->city}, {$this->state_code}");
    }

    /**
     * Is the location the default.
     *
     * @param  mixed  $value
     *
     * @return mixed
     */
    public function getDefaultAttribute($value)
    {
        return is_null($value) ? false : $value;
    }

    /**
     * Get the instance as an array.
     *
     * @return array
     */
    public function toArray()
    {
        return $this->attributes();
    }

    /**
     * Convert the object to its JSON representation.
     *
     * @param  int  $options
     *
     * @return string
     */
    public function toJson($options = 0)
    {
        return json_encode($this->toArray(), $options);
    }

    /* ------------------------------------------------------------------------------------------------
     |  Check Functions
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Determine if the location is for the same IP address.
     *
     * @param  string  $ip
     *
     * @return bool
     */
    public function same($ip)
    {
        return $this->getAttribute('ip') === $ip;
    }

    /* ------------------------------------------------------------------------------------------------
     |  Other Functions
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Determine if the given attribute exists.
     *
     * @param  mixed  $offset
     *
     * @return bool
     */
    public function offsetExists($offset)
    {
        return isset($this->$offset);
    }

    /**
     * Get the value for a given offset.
     *
     * @param  string  $offset
     *
     * @return mixed
     */
    public function offsetGet($offset)
    {
        return $this->__get($offset);
    }

    /**
     * Set the value for a given offset.
     *
     * @param  string  $offset
     * @param  mixed   $value
     */
    public function offsetSet($offset, $value)
    {
        $this->__set($offset, $value);
    }

    /**
     * Get the location's attribute
     *
     * @param  string  $key
     *
     * @return mixed
     */
    public function __get($key)
    {
        return $this->getAttribute($key);
    }

    /**
     * Set the location's attribute
     *
     * @param  string  $key
     * @param  mixed   $value
     */
    public function __set($key, $value)
    {
        $this->setAttribute($key, $value);
    }

    /**
     * Check if the location's attribute is set
     *
     * @param  string  $key
     *
     * @return bool
     */
    public function __isset($key)
    {
        return array_key_exists($key, $this->attributes);
    }

    /**
     * Unset the value for a given offset.
     *
     * @param  string  $offset
     */
    public function offsetUnset($offset)
    {
        $this->__unset($offset);
    }

    /**
     * Unset an attribute on the location.
     *
     * @param  string  $key
     */
    public function __unset($key)
    {
        unset($this->attributes[$key]);
    }
}


1		<?php namespace Arcanedev\GeoIP;
2
3		use ArrayAccess;
4		use Illuminate\Contracts\Support\Arrayable;
5		use Illuminate\Contracts\Support\Jsonable;
6		use Illuminate\Support\Arr;
7		use Illuminate\Support\Str;
8
9		/**
10		* Class Location
11		*
12		* @package Arcanedev\GeoIP
13		* @author ARCANEDEV <[email protected]>
14		*
15		* @property string ip
16		* @property string iso_code
17		* @property string country
18		* @property string city
19		* @property string state
20		* @property string state_code
21		* @property string postal_code
22		* @property float latitude
23		* @property float longitude
24		* @property string timezone
25		* @property string continent
26		*
27		* @property bool display_name
28		* @property bool default
29		* @property bool\|null cached
30		* @property string currency
31		*/
32		class Location implements ArrayAccess, Arrayable, Jsonable
33		{
34		/* ------------------------------------------------------------------------------------------------
35		\| Properties
36		\| ------------------------------------------------------------------------------------------------
37		*/
38		/**
39		* The location's attributes
40		*
41		* @var array
42		*/
43		protected $attributes = [];
44
45		/* ------------------------------------------------------------------------------------------------
46		\| Constructor
47		\| ------------------------------------------------------------------------------------------------
48		*/
49		/**
50		* Create a new location instance.
51		*
52		* @param array $attributes
53		*/
54	30	public function __construct(array $attributes = [])
55		{
56	30	$this->attributes = $attributes;
57	30	}
58
59		/* ------------------------------------------------------------------------------------------------
60		\| Getters & Setters
61		\| ------------------------------------------------------------------------------------------------
62		*/
63		/**
64		* Get all attributes.
65		*
66		* @return array
67		*/
68	30	public function attributes()
69		{
70	30	return $this->attributes;
71		}
72
73		/**
74		* Get an attribute from the $attributes array.
75		*
76		* @param string $key
77		*
78		* @return mixed
79		*/
80	30	public function getAttribute($key)
81		{
82	30	$value = Arr::get($this->attributes(), $key);
83
84	30	return method_exists($this, $method = 'get'.Str::studly($key).'Attribute')
85	30	? $this->{$method}($value)
86	30	: $value;
87		}
88
89		/**
90		* Set a given attribute on the location.
91		*
92		* @param string $key
93		* @param mixed $value
94		*
95		* @return $this
96		*/
97	6	public function setAttribute($key, $value)
98		{
99	6	$this->attributes[$key] = $value;
100
101	6	return $this;
102		}
103
104		/**
105		* Return the display name of the location.
106		*
107		* @return string
108		*/
109	30	public function getDisplayNameAttribute()
110		{
111	30	return preg_replace('/^,\s/', '', "{$this->city}, {$this->state_code}");
112		}
113
114		/**
115		* Is the location the default.
116		*
117		* @param mixed $value
118		*
119		* @return mixed
120		*/
121	30	public function getDefaultAttribute($value)
122		{
123	30	return is_null($value) ? false : $value;
124		}
125
126		/**
127		* Get the instance as an array.
128		*
129		* @return array
130		*/
131	30	public function toArray()
132		{
133	30	return $this->attributes();
134		}
135
136		/**
137		* Convert the object to its JSON representation.
138		*
139		* @param int $options
140		*
141		* @return string
142		*/
143		public function toJson($options = 0)
144		{
145		return json_encode($this->toArray(), $options);
146		}
147
148		/* ------------------------------------------------------------------------------------------------
149		\| Check Functions
150		\| ------------------------------------------------------------------------------------------------
151		*/
152		/**
153		* Determine if the location is for the same IP address.
154		*
155		* @param string $ip
156		*
157		* @return bool
158		*/
159		public function same($ip)
160		{
161		return $this->getAttribute('ip') === $ip;
162		}
163
164		/* ------------------------------------------------------------------------------------------------
165		\| Other Functions
166		\| ------------------------------------------------------------------------------------------------
167		*/
168		/**
169		* Determine if the given attribute exists.
170		*
171		* @param mixed $offset
172		*
173		* @return bool
174		*/
175		public function offsetExists($offset)
176		{
177		return isset($this->$offset);
178		}
179
180		/**
181		* Get the value for a given offset.
182		*
183		* @param string $offset
184		*
185		* @return mixed
186		*/
187		public function offsetGet($offset)
188		{
189		return $this->__get($offset);
190		}
191
192		/**
193		* Set the value for a given offset.
194		*
195		* @param string $offset
196		* @param mixed $value
197		*/
198		public function offsetSet($offset, $value)
199		{
200		$this->__set($offset, $value);
201		}
202
203		/**
204		* Get the location's attribute
205		*
206		* @param string $key
207		*
208		* @return mixed
209		*/
210	30	public function __get($key)
211		{
212	30	return $this->getAttribute($key);
213		}
214
215		/**
216		* Set the location's attribute
217		*
218		* @param string $key
219		* @param mixed $value
220		*/
221		public function __set($key, $value)
222		{
223		$this->setAttribute($key, $value);
224		}
225
226		/**
227		* Check if the location's attribute is set
228		*
229		* @param string $key
230		*
231		* @return bool
232		*/
233		public function __isset($key)
234		{
235		return array_key_exists($key, $this->attributes);
236		}
237
238		/**
239		* Unset the value for a given offset.
240		*
241		* @param string $offset
242		*/
243		public function offsetUnset($offset)
244		{
245		$this->__unset($offset);
246		}
247
248		/**
249		* Unset an attribute on the location.
250		*
251		* @param string $key
252		*/
253		public function __unset($key)
254		{
255		unset($this->attributes[$key]);
256		}
257		}
258

ARCANEDEV / GeoIP

Push — master ( d0dd0d...df62c5 )

Location::getDisplayNameAttribute() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like