DataTransferObject::getAttribute() - Code Metrics - tzurbaev/dto - Measure and Improve Code Quality continuously with Scrutinizer

DataTransferObject::getAttribute() A
last analyzed 2017-08-25 13:33 UTC

↳ Parent: DataTransferObject

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

namespace Zurbaev\DataTransferObjects;

use Zurbaev\DataTransferObjects\Exceptions\DtoMethodNotFoundException;
use Illuminate\Support\Facades\Validator;
use Illuminate\Support\Str;

abstract class DataTransferObject
{
    /**
     * DTO attributes.
     *
     * @var array
     */
    protected $attributes = [];

    /**
     * DTO validation rules.
     *
     * @var array
     */
    protected $rules = [];

    /**
     * Validation errors bag.
     *
     * @var \Illuminate\Support\MessageBag
     */
    protected $errors;

    /**
     * Get DTO attribute value.
     *
     * @param $name
     *
     * @return mixed
     */
    public function __get($name)
    {
        if (!isset($this->attributes[$name])) {
            return null;
        }

        return $this->attributes[$name];
    }

    /**
     * Set DTO attribute value.
     *
     * @param $name
     * @param $value
     */
    public function __set($name, $value)
    {
        $this->attributes[$name] = $value;
    }

    /**
     * Check if DTO attribute exists.
     *
     * @param $name
     *
     * @return bool
     */
    public function __isset($name)
    {
        return $this->hasAttribute($name);
    }

    /**
     * Call virtual getter or setter.
     *
     * @param $method
     * @param $arguments
     *
     * @throws DtoMethodNotFoundException
     *
     * @return $this|mixed
     */
    public function __call($method, $arguments)
    {
        if (Str::startsWith($method, 'set')) {
            return $this->virtualSetter($method, $arguments);
        } elseif (Str::startsWith($method, 'get')) {
            return $this->virtualGetter($method);
        }

        throw DtoMethodNotFoundException::make($this, $method);
    }

    /**
     * Creates new DTO instance from given array.
     *
     * @param array $data
     *
     * @return static
     */
    public static function fromArray(array $data)
    {
        $instance = new static;

        foreach ($data as $key => $value) {
            $instance->{$key} = $value;
        }

        return $instance;
    }

    /**
     * @param string $method
     *
     * @return mixed
     */
    protected function virtualGetter(string $method)
    {
        $attribute = Str::snake(Str::substr($method, 3));

        return $this->getAttribute($attribute);
    }

    /**
     * @param string $method
     * @param array  $arguments
     *
     * @return $this
     */
    protected function virtualSetter(string $method, array $arguments)
    {
        $attribute = Str::snake(Str::substr($method, 3));

        $this->{$attribute} = array_get($arguments, 0);

        return $this;
    }

    /**
     * Check if given attribute exists in current DTO.
     *
     * @param string $attribute
     *
     * @return bool
     */
    public function hasAttribute(string $attribute): bool
    {
        return isset($this->attributes[$attribute]);
    }

    /**
     * Check if given attribute exists in current DTO & has not-NULL value.
     *
     * @param string $attribute
     *
     * @return bool
     */
    public function hasNotNullAttribute(string $attribute): bool
    {
        return $this->hasAttribute($attribute) && !is_null($this->attributes[$attribute]);
    }

    /**
     * Get attribute value.
     *
     * @param string $attribute
     *
     * @return mixed
     */
    public function getAttribute(string $attribute)
    {
        return $this->attributes[$attribute];
    }

    /**
     * Validates DTO.
     *
     * @return bool
     */
    public function validate(): bool
    {
        /**
         * @var \Illuminate\Validation\Validator $validator
         */
        $validator = Validator::make($this->attributes, $this->rules());

        $result = $validator->passes();

        if (!$result) {
            $this->errors = $validator->errors();
        }

        return $result;
    }

    /**
     * Get validation errors bag.
     *
     * @return \Illuminate\Support\MessageBag
     */
    public function errors()
    {
        return $this->errors;
    }

    /**
     * Validation rules.
     *
     * @return array
     */
    public function rules()
    {
        return $this->rules;
    }

    /**
     * Set validation rules from external source.
     *
     * @param array $rules
     *
     * @return $this
     */
    public function setRules(array $rules)
    {
        $this->rules = $rules;

        return $this;
    }

    /**
     * Merge existed validation rules with given rules.
     *
     * @param array $rules
     *
     * @return $this
     */
    public function mergeRules(array $rules)
    {
        $this->rules = array_merge($this->rules, $rules);

        return $this;
    }
}


1			<?php
2
3			namespace Zurbaev\DataTransferObjects;
4
5			use Zurbaev\DataTransferObjects\Exceptions\DtoMethodNotFoundException;
6			use Illuminate\Support\Facades\Validator;
7			use Illuminate\Support\Str;
8
9			abstract class DataTransferObject
10			{
11			/**
12			* DTO attributes.
13			*
14			* @var array
15			*/
16			protected $attributes = [];
17
18			/**
19			* DTO validation rules.
20			*
21			* @var array
22			*/
23			protected $rules = [];
24
25			/**
26			* Validation errors bag.
27			*
28			* @var \Illuminate\Support\MessageBag
29			*/
30			protected $errors;
31
32			/**
33			* Get DTO attribute value.
34			*
35			* @param $name
36			*
37			* @return mixed
38			*/
39			public function __get($name)
40			{
41			if (!isset($this->attributes[$name])) {
42			return null;
43			}
44
45			return $this->attributes[$name];
46			}
47
48			/**
49			* Set DTO attribute value.
50			*
51			* @param $name
52			* @param $value
53			*/
54			public function __set($name, $value)
55			{
56			$this->attributes[$name] = $value;
57			}
58
59			/**
60			* Check if DTO attribute exists.
61			*
62			* @param $name
63			*
64			* @return bool
65			*/
66			public function __isset($name)
67			{
68			return $this->hasAttribute($name);
69			}
70
71			/**
72			* Call virtual getter or setter.
73			*
74			* @param $method
75			* @param $arguments
76			*
77			* @throws DtoMethodNotFoundException
78			*
79			* @return $this\|mixed
80			*/
81			public function __call($method, $arguments)
82			{
83			if (Str::startsWith($method, 'set')) {
84			return $this->virtualSetter($method, $arguments);
85			} elseif (Str::startsWith($method, 'get')) {
86			return $this->virtualGetter($method);
87			}
88
89			throw DtoMethodNotFoundException::make($this, $method);
90			}
91
92			/**
93			* Creates new DTO instance from given array.
94			*
95			* @param array $data
96			*
97			* @return static
98			*/
99			public static function fromArray(array $data)
100			{
101			$instance = new static;
102
103			foreach ($data as $key => $value) {
104			$instance->{$key} = $value;
105			}
106
107			return $instance;
108			}
109
110			/**
111			* @param string $method
112			*
113			* @return mixed
114			*/
115			protected function virtualGetter(string $method)
116			{
117			$attribute = Str::snake(Str::substr($method, 3));
118
119			return $this->getAttribute($attribute);
120			}
121
122			/**
123			* @param string $method
124			* @param array $arguments
125			*
126			* @return $this
127			*/
128			protected function virtualSetter(string $method, array $arguments)
129			{
130			$attribute = Str::snake(Str::substr($method, 3));
131
132			$this->{$attribute} = array_get($arguments, 0);
133
134			return $this;
135			}
136
137			/**
138			* Check if given attribute exists in current DTO.
139			*
140			* @param string $attribute
141			*
142			* @return bool
143			*/
144			public function hasAttribute(string $attribute): bool
145			{
146			return isset($this->attributes[$attribute]);
147			}
148
149			/**
150			* Check if given attribute exists in current DTO & has not-NULL value.
151			*
152			* @param string $attribute
153			*
154			* @return bool
155			*/
156			public function hasNotNullAttribute(string $attribute): bool
157			{
158			return $this->hasAttribute($attribute) && !is_null($this->attributes[$attribute]);
159			}
160
161			/**
162			* Get attribute value.
163			*
164			* @param string $attribute
165			*
166			* @return mixed
167			*/
168			public function getAttribute(string $attribute)
169			{
170			return $this->attributes[$attribute];
171			}
172
173			/**
174			* Validates DTO.
175			*
176			* @return bool
177			*/
178			public function validate(): bool
179			{
180			/**
181			* @var \Illuminate\Validation\Validator $validator
182			*/
183			$validator = Validator::make($this->attributes, $this->rules());
184
185			$result = $validator->passes();
186
187			if (!$result) {
188			$this->errors = $validator->errors();
189			}
190
191			return $result;
192			}
193
194			/**
195			* Get validation errors bag.
196			*
197			* @return \Illuminate\Support\MessageBag
198			*/
199			public function errors()
200			{
201			return $this->errors;
202			}
203
204			/**
205			* Validation rules.
206			*
207			* @return array
208			*/
209			public function rules()
210			{
211			return $this->rules;
212			}
213
214			/**
215			* Set validation rules from external source.
216			*
217			* @param array $rules
218			*
219			* @return $this
220			*/
221			public function setRules(array $rules)
222			{
223			$this->rules = $rules;
224
225			return $this;
226			}
227
228			/**
229			* Merge existed validation rules with given rules.
230			*
231			* @param array $rules
232			*
233			* @return $this
234			*/
235			public function mergeRules(array $rules)
236			{
237			$this->rules = array_merge($this->rules, $rules);
238
239			return $this;
240			}
241			}
242

tzurbaev / dto

DataTransferObject::getAttribute() A last analyzed 2017-08-25 13:33 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

DataTransferObject::getAttribute() A
last analyzed 2017-08-25 13:33 UTC