Response::getKey() - Code Metrics - Inspection of "CI fix" - stephanecoinon/sendgrid-activity - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 52ef0c...b4ceaf )

by Stéphane

created 2019-08-05 20:58 UTC

Response::getKey() A

↳ Parent: Response

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	0

<?php

namespace StephaneCoinon\SendGridActivity\Responses;

use Carbon\Carbon;
use StephaneCoinon\SendGridActivity\Support\Collection;

/**
 * Data model for API response results.
 */
class Response
{
    /**
     * Name of the key containing the unique resource id.
     *
     * @var string
     */
    protected $key = 'id';

    /**
     * Attributes to cast to a native type.
     *
     * @var array
     */
    protected $casts = [];

    /**
     * Name of key under which multiple results are nested.
     *
     * @var string
     */
    protected $dataKey = '';

    /**
     * API client.
     *
     * @var \StephaneCoinon\SendGridActivity\SendGrid
     */
    protected $api = null;

    /**
     * Make a new Response instance.
     *
     * @param array $attributes
     */
    public function __construct(array $attributes = [])
    {
        $this->fill($attributes);
    }

    /**
     * Build a collection of Response models from an array.
     *
     * @param  array $items raw array of results from API response
     * @param  array $apiContext
     * @return static[]|Collection
     */
    public static function collection(array $items = [], array $apiContext = [])
    {
        return Collection::make($items)->map(function ($item) use ($apiContext) {
            return (new static($item))->fill($apiContext);
        });
    }

    /**
     * Fill the response with an array of attributes.
     *
     * @param  array $attributes
     * @return self
     */
    public function fill(array $attributes = []): self
    {
        foreach ($attributes as $key => $value) {
            $this->setAttribute($key, $value);
        }

        return $this;
    }

    /**
     * Get the value of an attribute.
     *
     * @param  string $name
     * @return mixed
     */
    public function getAttribute(string $name)
    {
        return $this->$name ?? null;
    }

    /**
     * Set the value of an attribute.
     *
     * @param  string $name
     * @param  mixed $value
     * @return self
     */
    public function setAttribute(string $name, $value): self
    {
        $this->$name = $this->castAttribute($name, $value);

        return $this;
    }

    /**
     * Get the name of the resource unique identifier key.
     *
     * @return string
     */
    public function getKeyName()
    {
        return $this->key;
    }

    /**
     * Get the value of the resource unique identifer.
     *
     * @return mixed
     */
    public function getKey()
    {
        return $this->getAttribute($this->getKeyName());
    }

    /**
     * Cast an attribute to its native type.
     *
     * This method uses the types declared in static::$casts.
     *
     * @param  string $key
     * @param  mixed $value
     * @return self
     */
    public function castAttribute($key, $value)
    {
        switch ($this->casts[$key] ?? null) {
            case 'datetime':
                return Carbon::parse($value);
        }

        return $value;
    }

    /**
     * Cast a JSON-decoded API response to Response instance(s)
     *
     * @param  array $apiResponse
     * @param  array $apiContext
     * @return static|static[]
     */
    public static function createFromApiResponse($apiResponse, array $apiContext = [])
    {
        $dataKey = (new static)->dataKey;

        return isset($apiResponse[$dataKey])
            // Collection of items nested under the data key
            ? static::collection($apiResponse[$dataKey], $apiContext)
            // Single item
            : (new static($apiResponse))->fill($apiContext);
    }

    /**
     * Fetch a fresh resource.
     *
     * @return self
     */
    public function fresh()
    {
        return $this->api->request($this->request::find($this->getKey()));
class MyClass { }

$x = new MyClass();
$x->foo = true;
    }
}


1			<?php
2
3			namespace StephaneCoinon\SendGridActivity\Responses;
4
5			use Carbon\Carbon;
6			use StephaneCoinon\SendGridActivity\Support\Collection;
7
8			/**
9			* Data model for API response results.
10			*/
11			class Response
12			{
13			/**
14			* Name of the key containing the unique resource id.
15			*
16			* @var string
17			*/
18			protected $key = 'id';
19
20			/**
21			* Attributes to cast to a native type.
22			*
23			* @var array
24			*/
25			protected $casts = [];
26
27			/**
28			* Name of key under which multiple results are nested.
29			*
30			* @var string
31			*/
32			protected $dataKey = '';
33
34			/**
35			* API client.
36			*
37			* @var \StephaneCoinon\SendGridActivity\SendGrid
38			*/
39			protected $api = null;
40
41			/**
42			* Make a new Response instance.
43			*
44			* @param array $attributes
45			*/
46			public function __construct(array $attributes = [])
47			{
48			$this->fill($attributes);
49			}
50
51			/**
52			* Build a collection of Response models from an array.
53			*
54			* @param array $items raw array of results from API response
55			* @param array $apiContext
56			* @return static[]\|Collection
57			*/
58			public static function collection(array $items = [], array $apiContext = [])
59			{
60			return Collection::make($items)->map(function ($item) use ($apiContext) {
61			return (new static($item))->fill($apiContext);
62			});
63			}
64
65			/**
66			* Fill the response with an array of attributes.
67			*
68			* @param array $attributes
69			* @return self
70			*/
71			public function fill(array $attributes = []): self
72			{
73			foreach ($attributes as $key => $value) {
74			$this->setAttribute($key, $value);
75			}
76
77			return $this;
78			}
79
80			/**
81			* Get the value of an attribute.
82			*
83			* @param string $name
84			* @return mixed
85			*/
86			public function getAttribute(string $name)
87			{
88			return $this->$name ?? null;
89			}
90
91			/**
92			* Set the value of an attribute.
93			*
94			* @param string $name
95			* @param mixed $value
96			* @return self
97			*/
98			public function setAttribute(string $name, $value): self
99			{
100			$this->$name = $this->castAttribute($name, $value);
101
102			return $this;
103			}
104
105			/**
106			* Get the name of the resource unique identifier key.
107			*
108			* @return string
109			*/
110			public function getKeyName()
111			{
112			return $this->key;
113			}
114
115			/**
116			* Get the value of the resource unique identifer.
117			*
118			* @return mixed
119			*/
120			public function getKey()
121			{
122			return $this->getAttribute($this->getKeyName());
123			}
124
125			/**
126			* Cast an attribute to its native type.
127			*
128			* This method uses the types declared in static::$casts.
129			*
130			* @param string $key
131			* @param mixed $value
132			* @return self
133			*/
134			public function castAttribute($key, $value)
135			{
136			switch ($this->casts[$key] ?? null) {
137			case 'datetime':
138			return Carbon::parse($value);
139			}
140
141			return $value;
142			}
143
144			/**
145			* Cast a JSON-decoded API response to Response instance(s)
146			*
147			* @param array $apiResponse
148			* @param array $apiContext
149			* @return static\|static[]
150			*/
151			public static function createFromApiResponse($apiResponse, array $apiContext = [])
152			{
153			$dataKey = (new static)->dataKey;
154
155			return isset($apiResponse[$dataKey])
156			// Collection of items nested under the data key
157			? static::collection($apiResponse[$dataKey], $apiContext)
158			// Single item
159			: (new static($apiResponse))->fill($apiContext);
160			}
161
162			/**
163			* Fetch a fresh resource.
164			*
165			* @return self
166			*/
167			public function fresh()
168			{
169			return $this->api->request($this->request::find($this->getKey()));
			0 ignored issues – show Bug introduced 2019-08-05 19:30 UTC by Report Bug Copy Issue Report The property `request` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
170			}
171			}
172

stephanecoinon / sendgrid-activity

Push — master ( 52ef0c...b4ceaf )

Response::getKey() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like