DataUser::email() - Code Metrics - bristol-su/control - Measure and Improve Code Quality continuously with Scrutinizer

DataUser::email() A
last analyzed 2021-01-12 19:14 UTC

↳ Parent: DataUser

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

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

<?php



namespace BristolSU\ControlDB\Models;


use BristolSU\ControlDB\AdditionalProperties\HasAdditionalProperties;
use BristolSU\ControlDB\Traits\DataUserTrait;
use DateTime;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\SoftDeletes;

/**
 * Handles attributes belonging to a user
 */

class DataUser extends Model implements \BristolSU\ControlDB\Contracts\Models\DataUser
{
    use SoftDeletes, HasAdditionalProperties, DataUserTrait {
        setFirstName as baseSetFirstName;
        setLastName as baseSetLastName;
        setEmail as baseSetEmail;
        setDob as baseSetDob;
        setPreferredName as baseSetPreferredName;
    }

    /**
     * The table to use
     * 
     * @var string 
     */
    protected $table = 'control_data_user';

    /**
     * Attributes that are fillable
     * 
     * @var array 
     */
    protected $fillable = [
        'first_name', 'last_name', 'email', 'dob', 'preferred_name'
    ];

    /**
     * Casted attributes
     * 
     * @var array 
     */
    protected $casts = [
        'dob' => 'datetime'
    ];
    
    /**
     * Get the ID of the user
     * 
     * @return int
     */
    public function id(): int
    {
        return $this->id;
    }

    /**
     * Get the first name for the user
     * 
     * @return string|null
     */
    public function firstName(): ?string
    {
        return $this->first_name;
    }

    /**
     * Get the last name for the user
     * 
     * @return string|null
     */
    public function lastName(): ?string
    {
        return $this->last_name;
    }

    /**
     * Get the email for the user
     * 
     * @return string|null
     */
    public function email(): ?string
    {
        return $this->email;
    }

    /**
     * Get the date of birth for the user
     * 
     * @return DateTime|null
     */
    public function dob(): ?DateTime
    {
        return $this->dob;

    }

    /**
     * Get the preferred name for the user
     * 
     * @return string|null
     */
    public function preferredName(): ?string
    {
        return $this->preferred_name;
    }

    /**
     * Set the users first name
     *
     * @param string|null $firstName

     */

    public function setFirstName(?string $firstName): void
    {
        $this->baseSetFirstName($firstName);
        $this->refresh();
    }

    /**
     * Set the users last name
     *
     * @param string|null $lastName

     */

    public function setLastName(?string $lastName): void
    {
        $this->baseSetLastName($lastName);
        $this->refresh();
    }

    /**
     * Set the users email
     *
     * @param string|null $email

     */

    public function setEmail(?string $email): void
    {
        $this->baseSetEmail($email);
        $this->refresh();
    }

    /**
     * Set the date of birth attribute
     *
     * @param DateTime|null $dob

     */

    public function setDob(?DateTime $dob): void
    {
        $this->baseSetDob($dob);
        $this->refresh();
    }

    /**
     * Set the preferred name for the user
     *
     * @param string|null $name

     */

    public function setPreferredName(?string $name): void
    {
        $this->baseSetPreferredName($name);
        $this->refresh();
    }


}


1		<?php
2
		0 ignored issues – show Coding Style introduced 2020-01-29 23:13 UTC by Report Bug Copy Issue Report Missing file doc comment Loading history...
3
4		namespace BristolSU\ControlDB\Models;
5
6
7		use BristolSU\ControlDB\AdditionalProperties\HasAdditionalProperties;
8		use BristolSU\ControlDB\Traits\DataUserTrait;
9		use DateTime;
10		use Illuminate\Database\Eloquent\Model;
11		use Illuminate\Database\Eloquent\SoftDeletes;
12
13		/**
14		* Handles attributes belonging to a user
15		*/
		0 ignored issues – show Coding Style introduced 2020-01-29 23:13 UTC by Report Bug Copy Issue Report Missing @category tag in class comment Loading history... Coding Style introduced 2020-01-29 23:13 UTC by Report Bug Copy Issue Report Missing @package tag in class comment Loading history... Coding Style introduced 2020-01-29 23:13 UTC by Report Bug Copy Issue Report Missing @author tag in class comment Loading history... Coding Style introduced 2020-01-29 23:13 UTC by Report Bug Copy Issue Report Missing @license tag in class comment Loading history... Coding Style introduced 2020-01-29 23:13 UTC by Report Bug Copy Issue Report Missing @link tag in class comment Loading history...
16		class DataUser extends Model implements \BristolSU\ControlDB\Contracts\Models\DataUser
17		{
18		use SoftDeletes, HasAdditionalProperties, DataUserTrait {
19		setFirstName as baseSetFirstName;
20		setLastName as baseSetLastName;
21		setEmail as baseSetEmail;
22		setDob as baseSetDob;
23		setPreferredName as baseSetPreferredName;
24		}
25
26		/**
27		* The table to use
28		*
29		* @var string
30		*/
31		protected $table = 'control_data_user';
32
33		/**
34		* Attributes that are fillable
35		*
36		* @var array
37		*/
38		protected $fillable = [
39		'first_name', 'last_name', 'email', 'dob', 'preferred_name'
40		];
41
42		/**
43		* Casted attributes
44		*
45		* @var array
46		*/
47		protected $casts = [
48		'dob' => 'datetime'
49		];
50
51		/**
52		* Get the ID of the user
53		*
54		* @return int
55		*/
56	35	public function id(): int
57		{
58	35	return $this->id;
59		}
60
61		/**
62		* Get the first name for the user
63		*
64		* @return string\|null
65		*/
66	16	public function firstName(): ?string
67		{
68	16	return $this->first_name;
69		}
70
71		/**
72		* Get the last name for the user
73		*
74		* @return string\|null
75		*/
76	16	public function lastName(): ?string
77		{
78	16	return $this->last_name;
79		}
80
81		/**
82		* Get the email for the user
83		*
84		* @return string\|null
85		*/
86	16	public function email(): ?string
87		{
88	16	return $this->email;
89		}
90
91		/**
92		* Get the date of birth for the user
93		*
94		* @return DateTime\|null
95		*/
96	13	public function dob(): ?DateTime
97		{
98	13	return $this->dob;
		0 ignored issues – show Bug Best Practice introduced 2020-01-29 23:13 UTC by Report Bug Copy Issue Report The expression `return $this->dob` returns the type `string` which is incompatible with the type-hinted return `DateTime\|null`. Loading history...
99		}
100
101		/**
102		* Get the preferred name for the user
103		*
104		* @return string\|null
105		*/
106	16	public function preferredName(): ?string
107		{
108	16	return $this->preferred_name;
109		}
110
111		/**
112		* Set the users first name
113		*
114		* @param string\|null $firstName
		0 ignored issues – show Coding Style introduced 2020-04-24 16:49 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
115		*/
		0 ignored issues – show Coding Style introduced 2020-04-24 16:49 UTC by Report Bug Copy Issue Report Missing @return tag in function comment Loading history...
116	2	public function setFirstName(?string $firstName): void
117		{
118	2	$this->baseSetFirstName($firstName);
119	2	$this->refresh();
120	2	}
121
122		/**
123		* Set the users last name
124		*
125		* @param string\|null $lastName
		0 ignored issues – show Coding Style introduced 2020-04-24 16:49 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
126		*/
		0 ignored issues – show Coding Style introduced 2020-04-24 16:49 UTC by Report Bug Copy Issue Report Missing @return tag in function comment Loading history...
127	2	public function setLastName(?string $lastName): void
128		{
129	2	$this->baseSetLastName($lastName);
130	2	$this->refresh();
131	2	}
132
133		/**
134		* Set the users email
135		*
136		* @param string\|null $email
		0 ignored issues – show Coding Style introduced 2020-04-24 16:49 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
137		*/
		0 ignored issues – show Coding Style introduced 2020-04-24 16:49 UTC by Report Bug Copy Issue Report Missing @return tag in function comment Loading history...
138	2	public function setEmail(?string $email): void
139		{
140	2	$this->baseSetEmail($email);
141	2	$this->refresh();
142	2	}
143
144		/**
145		* Set the date of birth attribute
146		*
147		* @param DateTime\|null $dob
		0 ignored issues – show Coding Style introduced 2020-04-24 16:49 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
148		*/
		0 ignored issues – show Coding Style introduced 2020-04-24 16:49 UTC by Report Bug Copy Issue Report Missing @return tag in function comment Loading history...
149	2	public function setDob(?DateTime $dob): void
150		{
151	2	$this->baseSetDob($dob);
152	2	$this->refresh();
153	2	}
154
155		/**
156		* Set the preferred name for the user
157		*
158		* @param string\|null $name
		0 ignored issues – show Coding Style introduced 2020-04-24 16:49 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
159		*/
		0 ignored issues – show Coding Style introduced 2020-04-24 16:49 UTC by Report Bug Copy Issue Report Missing @return tag in function comment Loading history...
160	2	public function setPreferredName(?string $name): void
161		{
162	2	$this->baseSetPreferredName($name);
163	2	$this->refresh();
164	2	}
165
166
167		}
168

bristol-su / control

GitHub Access Token became invalid

DataUser::email() A last analyzed 2021-01-12 19:14 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

DataUser::email() A
last analyzed 2021-01-12 19:14 UTC