BaseUser::getCreatedBy() - Code Metrics - Inspection of "[AdminBundle][UserManagementBundle] Improve audit..." - Kunstmaan/KunstmaanBundlesCMS - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#2720)

by Jeroen

created 2020-09-02 19:32 UTC

BaseUser::getCreatedBy() A

↳ Parent: BaseUser

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

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

<?php

namespace Kunstmaan\AdminBundle\Entity;

use Doctrine\Common\Collections\ArrayCollection;
use Doctrine\ORM\Mapping as ORM;
use FOS\UserBundle\Model\GroupInterface;
use FOS\UserBundle\Model\User as AbstractUser;
use Kunstmaan\AdminBundle\Validator\Constraints\PasswordRestrictions;
use Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity;
use Symfony\Component\Validator\Constraints\Email;
use Symfony\Component\Validator\Constraints\NotBlank;
use Symfony\Component\Validator\Mapping\ClassMetadata;

abstract class BaseUser extends AbstractUser
{
    /**
     * @ORM\Id
     * @ORM\Column(type="integer")
     * @ORM\GeneratedValue(strategy="AUTO")
     */
    protected $id;

    /**
     * The doctrine metadata is set dynamically in Kunstmaan\AdminBundle\EventListener\MappingListener
     */
    protected $groups;

    /**
     * @ORM\Column(type="string", name="admin_locale", length=5, nullable=true)
     */
    protected $adminLocale;

    /**
     * @ORM\Column(type="boolean", name="password_changed", nullable=true)
     */
    protected $passwordChanged;

    /**
     * @ORM\Column(name="google_id", type="string", length=255, nullable=true)
     */
    protected $googleId;

    /**
     * @var \DateTimeImmutable|null
     * @ORM\Column(name="created_at", type="datetime_immutable", nullable=true)
     */
    protected $createdAt;

    /**
     * @var string|null
     * @ORM\Column(name="created_by", type="string", nullable=true)
     */
    protected $createdBy;

    /**
     * Construct a new user
     */
    public function __construct()
    {
        parent::__construct();
        $this->groups = new ArrayCollection();
        $this->createdAt = new \DateTimeImmutable();
    }

    /**
     * Get id
     *
     * @return int
     */
    public function getId()
    {
        return $this->id;
    }

    /**
     * Set id
     *
     * @param int $id
     *
     * @return BaseUser
     */
    public function setId($id)
    {
        $this->id = $id;

        return $this;
    }

    /**
     * Gets the groupIds for the user.
     *
     * @return array
     */
    public function getGroupIds()
    {
        $groups = $this->groups;

        $groupIds = array();
        if (\count($groups) > 0) {
            /* @var $group GroupInterface */
            foreach ($groups as $group) {
                $groupIds[] = $group->getId();
            }
        }

        return $groupIds;
    }

    /**
     * Gets the groups the user belongs to.
     *
     * @return ArrayCollection
     */
    public function getGroups()
    {
        return $this->groups;
    }

    /**
     * Get adminLocale
     *
     * @return string
     */
    public function getAdminLocale()
    {
        return $this->adminLocale;
    }

    /**
     * Set adminLocale
     *
     * @param string $adminLocale
     *
     * @return BaseUser
     */
    public function setAdminLocale($adminLocale)
    {
        $this->adminLocale = $adminLocale;

        return $this;
    }

    /**
     * is passwordChanged
     *
     * @return bool
     */
    public function isPasswordChanged()
    {
        return $this->passwordChanged;
    }

    /**
     * Set passwordChanged
     *
     * @param bool $passwordChanged
     *
     * @return User
     */
    public function setPasswordChanged($passwordChanged)
    {
        $this->passwordChanged = $passwordChanged;

        return $this;
    }

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

    /**
     * @param mixed $googleId
     */
    public function setGoogleId($googleId)
    {
        $this->googleId = $googleId;
    }

    /**
     * @param ClassMetadata $metadata
     */
    public static function loadValidatorMetadata(ClassMetadata $metadata)
    {
        $metadata->addPropertyConstraint('username', new NotBlank());
        $metadata->addPropertyConstraints(
            'plainPassword',
            array(
                new NotBlank(array('groups' => array('Registration'))),
                new PasswordRestrictions(array('groups' => array('Registration', 'Default'))),
            )
        );
        $metadata->addPropertyConstraint('email', new NotBlank());
        $metadata->addPropertyConstraint('email', new Email());
        $metadata->addConstraint(new UniqueEntity(array(
            'fields' => 'username',
            'message' => 'errors.user.loginexists',
        )));
        $metadata->addConstraint(new UniqueEntity(array(
            'fields' => 'email',
            'message' => 'errors.user.emailexists',
        )));
    }

    /**
     * Return class name of form type used to add & edit users
     *
     * @return string
     */
    abstract public function getFormTypeClass();

    /**
     * {@inheritdoc}
     */
    public function isAccountNonLocked()
    {
        return $this->isEnabled();
    }

    public function getCreatedAt(): ?\DateTimeImmutable
    {
        return $this->createdAt;
    }

    public function getCreatedBy(): ?string
    {
        return $this->createdBy;
    }

    public function setCreatedBy(string $createdBy): void
    {
        $this->createdBy = $createdBy;
    }
}


1		<?php
2
3		namespace Kunstmaan\AdminBundle\Entity;
4
5		use Doctrine\Common\Collections\ArrayCollection;
6		use Doctrine\ORM\Mapping as ORM;
7		use FOS\UserBundle\Model\GroupInterface;
8		use FOS\UserBundle\Model\User as AbstractUser;
9		use Kunstmaan\AdminBundle\Validator\Constraints\PasswordRestrictions;
10		use Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity;
11		use Symfony\Component\Validator\Constraints\Email;
12		use Symfony\Component\Validator\Constraints\NotBlank;
13		use Symfony\Component\Validator\Mapping\ClassMetadata;
14
15		abstract class BaseUser extends AbstractUser
16		{
17		/**
18		* @ORM\Id
19		* @ORM\Column(type="integer")
20		* @ORM\GeneratedValue(strategy="AUTO")
21		*/
22		protected $id;
23
24		/**
25		* The doctrine metadata is set dynamically in Kunstmaan\AdminBundle\EventListener\MappingListener
26		*/
27		protected $groups;
28
29		/**
30		* @ORM\Column(type="string", name="admin_locale", length=5, nullable=true)
31		*/
32		protected $adminLocale;
33
34		/**
35		* @ORM\Column(type="boolean", name="password_changed", nullable=true)
36		*/
37		protected $passwordChanged;
38
39		/**
40		* @ORM\Column(name="google_id", type="string", length=255, nullable=true)
41		*/
42		protected $googleId;
43
44		/**
45		* @var \DateTimeImmutable\|null
46		* @ORM\Column(name="created_at", type="datetime_immutable", nullable=true)
47		*/
48		protected $createdAt;
49
50		/**
51		* @var string\|null
52		* @ORM\Column(name="created_by", type="string", nullable=true)
53		*/
54		protected $createdBy;
55
56		/**
57		* Construct a new user
58		*/
59	35	public function __construct()
60		{
61	35	parent::__construct();
62	35	$this->groups = new ArrayCollection();
63	35	$this->createdAt = new \DateTimeImmutable();
64	35	}
65
66		/**
67		* Get id
68		*
69		* @return int
70		*/
71	3	public function getId()
72		{
73	3	return $this->id;
74		}
75
76		/**
77		* Set id
78		*
79		* @param int $id
80		*
81		* @return BaseUser
82		*/
83	8	public function setId($id)
84		{
85	8	$this->id = $id;
86
87	8	return $this;
88		}
89
90		/**
91		* Gets the groupIds for the user.
92		*
93		* @return array
94		*/
95	1	public function getGroupIds()
96		{
97	1	$groups = $this->groups;
98
99	1	$groupIds = array();
100	1	if (\count($groups) > 0) {
101		/* @var $group GroupInterface */
102	1	foreach ($groups as $group) {
103	1	$groupIds[] = $group->getId();
104		}
105		}
106
107	1	return $groupIds;
108		}
109
110		/**
111		* Gets the groups the user belongs to.
112		*
113		* @return ArrayCollection
114		*/
115	6	public function getGroups()
116		{
117	6	return $this->groups;
118		}
119
120		/**
121		* Get adminLocale
122		*
123		* @return string
124		*/
125	1	public function getAdminLocale()
126		{
127	1	return $this->adminLocale;
128		}
129
130		/**
131		* Set adminLocale
132		*
133		* @param string $adminLocale
134		*
135		* @return BaseUser
136		*/
137	2	public function setAdminLocale($adminLocale)
138		{
139	2	$this->adminLocale = $adminLocale;
140
141	2	return $this;
142		}
143
144		/**
145		* is passwordChanged
146		*
147		* @return bool
148		*/
149	1	public function isPasswordChanged()
150		{
151	1	return $this->passwordChanged;
152		}
153
154		/**
155		* Set passwordChanged
156		*
157		* @param bool $passwordChanged
158		*
159		* @return User
160		*/
161	2	public function setPasswordChanged($passwordChanged)
162		{
163	2	$this->passwordChanged = $passwordChanged;
164
165	2	return $this;
166		}
167
168		/**
169		* @return mixed
170		*/
171	1	public function getGoogleId()
172		{
173	1	return $this->googleId;
174		}
175
176		/**
177		* @param mixed $googleId
178		*/
179	3	public function setGoogleId($googleId)
180		{
181	3	$this->googleId = $googleId;
182	3	}
183
184		/**
185		* @param ClassMetadata $metadata
186		*/
187	1	public static function loadValidatorMetadata(ClassMetadata $metadata)
188		{
189	1	$metadata->addPropertyConstraint('username', new NotBlank());
190	1	$metadata->addPropertyConstraints(
191	1	'plainPassword',
192		array(
193	1	new NotBlank(array('groups' => array('Registration'))),
194	1	new PasswordRestrictions(array('groups' => array('Registration', 'Default'))),
195		)
196		);
197	1	$metadata->addPropertyConstraint('email', new NotBlank());
198	1	$metadata->addPropertyConstraint('email', new Email());
199	1	$metadata->addConstraint(new UniqueEntity(array(
200	1	'fields' => 'username',
201		'message' => 'errors.user.loginexists',
202		)));
203	1	$metadata->addConstraint(new UniqueEntity(array(
204	1	'fields' => 'email',
205		'message' => 'errors.user.emailexists',
206		)));
207	1	}
208
209		/**
210		* Return class name of form type used to add & edit users
211		*
212		* @return string
213		*/
214		abstract public function getFormTypeClass();
215
216		/**
217		* {@inheritdoc}
218		*/
219	1	public function isAccountNonLocked()
220		{
221	1	return $this->isEnabled();
222		}
223
224		public function getCreatedAt(): ?\DateTimeImmutable
225		{
226		return $this->createdAt;
227		}
228
229		public function getCreatedBy(): ?string
230		{
231		return $this->createdBy;
232		}
233
234		public function setCreatedBy(string $createdBy): void
235		{
236		$this->createdBy = $createdBy;
237		}
238		}
239

Kunstmaan / KunstmaanBundlesCMS

Pull Request — master (#2720)

BaseUser::getCreatedBy() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like