ProfileEntity::toArray() - Code Metrics - Inspection of "CS Fixes" - bobalazek/web-application-starter-kit - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( b704c5...ad0cea )

by Borut

created 2016-01-01 19:12 UTC

ProfileEntity::toArray() A

↳ Parent: ProfileEntity

Complexity

Conditions	2
Paths	2

Size

Total Lines	16
Code Lines	13

Duplication

Lines	0
Ratio	0 %

Importance

Changes	3
Bugs	1	Features	0

Metric	Value
c	3
b	1
f	0
dl	0
loc	16
rs	9.4286
cc	2
eloc	13
nc	2
nop	0

<?php

namespace Application\Entity;

use Doctrine\ORM\Mapping as ORM;
use Cocur\Slugify\Slugify;

/**
 * Profile Entity
 *
 * @ORM\Table(name="profiles")
 * @ORM\Entity(repositoryClass="Application\Repository\ProfileRepository")
 * @ORM\HasLifecycleCallbacks()
 *
 * @author Borut Balažek <[email protected]>
 */
class ProfileEntity
    extends AbstractImageUpload

{
    /**
     * @var integer
     *
     * @ORM\Column(name="id", type="integer")
     * @ORM\Id
     * @ORM\GeneratedValue(strategy="IDENTITY")
     */
    protected $id;

    /**
     * Mr., Mrs., Ms., Ing., ...
     *
     * @var string
     *
     * @ORM\Column(name="title", type="string", length=8, nullable=true)
     */
    protected $title;

    /**
     * @var string
     *
     * @ORM\Column(name="first_name", type="string", length=32, nullable=true)
     */
    protected $firstName;

    /**
     * @var string
     *
     * @ORM\Column(name="middle_name", type="string", length=32, nullable=true)
     */
    protected $middleName;

    /**
     * @var string
     *
     * @ORM\Column(name="last_name", type="string", length=32, nullable=true)
     */
    protected $lastName;

    /**
     * male or female?
     *
     * @var string
     *
     * @ORM\Column(name="gender", type="string", length=8, nullable=true)
     */
    protected $gender;

    /**
     * @var \DateTime
     *
     * @ORM\Column(name="birthdate", type="datetime", nullable=true)
     */
    protected $birthdate;

    /**
     * @var string
     *
     * @ORM\Column(name="image_url", type="text", nullable=true)
     */
    protected $imageUrl;

    /**
     * @ORM\OneToOne(targetEntity="Application\Entity\UserEntity", inversedBy="profile")
     * @ORM\JoinColumn(name="user_id", referencedColumnName="id")
     */
    protected $user;

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

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

        return $this;
    }

    /*** Title ***/
    /**
     * @return string
     */
    public function getTitle()
    {
        return $this->title;
    }

    /**
     * @param $title
     *
     * @return ProfileEntity
     */
    public function setTitle($title)
    {
        $this->title = $title;

        return $this;
    }

    /*** Name ***/
    /**
     * @return string
     */
    public function getName()
    {
        return $this->getFirstName().' '.$this->getLastName();
    }

    /*** First name ***/
    /**
     * @return string
     */
    public function getFirstName()
    {
        return $this->firstName;
    }

    /**
     * @param $firstName
     *
     * @return ProfileEntity
     */
    public function setFirstName($firstName)
    {
        $this->firstName = $firstName;

        return $this;
    }

    /*** Middle name ***/
    /**
     * @return string
     */
    public function getMiddleName()
    {
        return $this->middleName;
    }

    /**
     * @param $middleName
     *
     * @return ProfileEntity
     */
    public function setMiddleName($middleName)
    {
        $this->middleName = $middleName;

        return $this;
    }

    /*** Last name ***/
    /**
     * @return string
     */
    public function getLastName()
    {
        return $this->lastName;
    }

    /**
     * @param $lastName
     *
     * @return ProfileEntity
     */
    public function setLastName($lastName)
    {
        $this->lastName = $lastName;

        return $this;
    }

    /*** Full name ***/
    /**
     * @return string
     */
    public function getFullName()
    {
        return trim(
            $this->getTitle().' '.
            $this->getFirstName().' '.
            $this->getMiddleName().' '.
            $this->getLastName()
        );
    }

    /*** Gender ***/
    /**
     * @return string
     */
    public function getGender()
    {
        return $this->gender;
    }

    /**
     * @param $gender
     *
     * @return ProfileEntity
     */
    public function setGender($gender)
    {
        $this->gender = $gender;

        return $this;
    }

    /*** Birthdate ***/
    /**
     * @return string
     */
    public function getBirthdate()
    {
        return $this->birthdate;
    }

    /**
     * @param mixed $birthdate
     *
     * @return ProfileEntity
     */
    public function setBirthdate($birthdate = null)
    {
        if ($birthdate === null) {
            $this->birthdate = null;
        } elseif ($birthdate instanceof \DateTime) {
            $this->birthdate = $birthdate;
        } else {
            $this->birthdate = new \DateTime($birthdate);
        }

        return $this;
    }

    /*** Age ***/
    /**
     * @return string
     */
    public function getAge($format = '%y')
    {
        return $this->getBirthdate()
            ? $this->getBirthdate()->diff(new \DateTime())->format($format)
            : null
        ;
    }

    /*** Image upload ***/
    /**
     * @return ProfileEntity
     *
     * @throws \Exception If upload dir and path are not set
     */
    public function imageUpload()

    {
        if (null !== $this->getImage()) {
            $uploadDir = $this->getImageUploadDir();
            $uploadPath = $this->getImageUploadPath();

            if (!($uploadDir && $uploadPath)) {
                throw new \Exception('You must define the image upload dir and path!');
            }

            $slugify = new Slugify();

            $filename = $slugify->slugify(
                $this->getImage()->getClientOriginalName()
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
            );

            $filename .= '_'.sha1(uniqid(mt_rand(), true)).'.'.
                $this->getImage()->guessExtension()
            ;

            $this->getImage()->move(
                $uploadDir,
                $filename
            );

            $this->setImageUrl($uploadPath.$filename);

            $this->setImage(null);
        }

        return $this;
    }

    /*** User ***/
    /**
     * @return UserEntity
     */
    public function getUser()
    {
        return $this->user;
    }

    /**
     * @param UserEntity $user
     *
     * @return ProfileEntity
     */
    public function setUser(UserEntity $user)
    {
        $this->user = $user;

        return $this;
    }

    /**
     * @return array
     */
    public function toArray()
    {
        return array(
            'id' => $this->getId(),
            'title' => $this->getTitle(),
            'full_name' => $this->getFullName(),
            'first_name' => $this->getFirstName(),
            'middle_name' => $this->getMiddleName(),
            'last_name' => $this->getLastName(),
            'gender' => $this->getGender(),
            'birthdate' => $this->getBirthdate()
                ? $this->getBirthdate()->format(DATE_ATOM)
                : null,
            'image_url' => $this->getImageUrl(),
        );
    }
}


GitHub Access Token became invalid

Push — develop ( b704c5...ad0cea )

ProfileEntity::toArray() A

Complexity

Size

Duplication

Importance

Available Fixes

1		<?php
2
3		namespace Application\Entity;
4
5		use Doctrine\ORM\Mapping as ORM;
6		use Cocur\Slugify\Slugify;
7
8		/**
9		* Profile Entity
10		*
11		* @ORM\Table(name="profiles")
12		* @ORM\Entity(repositoryClass="Application\Repository\ProfileRepository")
13		* @ORM\HasLifecycleCallbacks()
14		*
15		* @author Borut Balažek <[email protected]>
16		*/
17		class ProfileEntity
18		extends AbstractImageUpload
		0 ignored issues – show Coding Style introduced 2016-01-01 19:15 UTC by Report Bug Copy Issue Report The extends keyword must be on the same line as the class name Loading history...
19		{
20		/**
21		* @var integer
22		*
23		* @ORM\Column(name="id", type="integer")
24		* @ORM\Id
25		* @ORM\GeneratedValue(strategy="IDENTITY")
26		*/
27		protected $id;
28
29		/**
30		* Mr., Mrs., Ms., Ing., ...
31		*
32		* @var string
33		*
34		* @ORM\Column(name="title", type="string", length=8, nullable=true)
35		*/
36		protected $title;
37
38		/**
39		* @var string
40		*
41		* @ORM\Column(name="first_name", type="string", length=32, nullable=true)
42		*/
43		protected $firstName;
44
45		/**
46		* @var string
47		*
48		* @ORM\Column(name="middle_name", type="string", length=32, nullable=true)
49		*/
50		protected $middleName;
51
52		/**
53		* @var string
54		*
55		* @ORM\Column(name="last_name", type="string", length=32, nullable=true)
56		*/
57		protected $lastName;
58
59		/**
60		* male or female?
61		*
62		* @var string
63		*
64		* @ORM\Column(name="gender", type="string", length=8, nullable=true)
65		*/
66		protected $gender;
67
68		/**
69		* @var \DateTime
70		*
71		* @ORM\Column(name="birthdate", type="datetime", nullable=true)
72		*/
73		protected $birthdate;
74
75		/**
76		* @var string
77		*
78		* @ORM\Column(name="image_url", type="text", nullable=true)
79		*/
80		protected $imageUrl;
81
82		/**
83		* @ORM\OneToOne(targetEntity="Application\Entity\UserEntity", inversedBy="profile")
84		* @ORM\JoinColumn(name="user_id", referencedColumnName="id")
85		*/
86		protected $user;
87
88		/* Id */
89		/**
90		* @return integer
91		*/
92		public function getId()
93		{
94		return $this->id;
95		}
96
97		/**
98		* @param $id
99		*
100		* @return ProfileEntity
101		*/
102		public function setId($id)
103		{
104		$this->id = $id;
105
106		return $this;
107		}
108
109		/* Title */
110		/**
111		* @return string
112		*/
113		public function getTitle()
114		{
115		return $this->title;
116		}
117
118		/**
119		* @param $title
120		*
121		* @return ProfileEntity
122		*/
123		public function setTitle($title)
124		{
125		$this->title = $title;
126
127		return $this;
128		}
129
130		/* Name */
131		/**
132		* @return string
133		*/
134		public function getName()
135		{
136		return $this->getFirstName().' '.$this->getLastName();
137		}
138
139		/* First name */
140		/**
141		* @return string
142		*/
143		public function getFirstName()
144		{
145		return $this->firstName;
146		}
147
148		/**
149		* @param $firstName
150		*
151		* @return ProfileEntity
152		*/
153		public function setFirstName($firstName)
154		{
155		$this->firstName = $firstName;
156
157		return $this;
158		}
159
160		/* Middle name */
161		/**
162		* @return string
163		*/
164		public function getMiddleName()
165		{
166		return $this->middleName;
167		}
168
169		/**
170		* @param $middleName
171		*
172		* @return ProfileEntity
173		*/
174		public function setMiddleName($middleName)
175		{
176		$this->middleName = $middleName;
177
178		return $this;
179		}
180
181		/* Last name */
182		/**
183		* @return string
184		*/
185		public function getLastName()
186		{
187		return $this->lastName;
188		}
189
190		/**
191		* @param $lastName
192		*
193		* @return ProfileEntity
194		*/
195		public function setLastName($lastName)
196		{
197		$this->lastName = $lastName;
198
199		return $this;
200		}
201
202		/* Full name */
203		/**
204		* @return string
205		*/
206		public function getFullName()
207		{
208		return trim(
209		$this->getTitle().' '.
210		$this->getFirstName().' '.
211		$this->getMiddleName().' '.
212		$this->getLastName()
213		);
214		}
215
216		/* Gender */
217		/**
218		* @return string
219		*/
220		public function getGender()
221		{
222		return $this->gender;
223		}
224
225		/**
226		* @param $gender
227		*
228		* @return ProfileEntity
229		*/
230		public function setGender($gender)
231		{
232		$this->gender = $gender;
233
234		return $this;
235		}
236
237		/* Birthdate */
238		/**
239		* @return string
240		*/
241		public function getBirthdate()
242		{
243		return $this->birthdate;
244		}
245
246		/**
247		* @param mixed $birthdate
248		*
249		* @return ProfileEntity
250		*/
251		public function setBirthdate($birthdate = null)
252		{
253		if ($birthdate === null) {
254		$this->birthdate = null;
255		} elseif ($birthdate instanceof \DateTime) {
256		$this->birthdate = $birthdate;
257		} else {
258		$this->birthdate = new \DateTime($birthdate);
259		}
260
261		return $this;
262		}
263
264		/* Age */
265		/**
266		* @return string
267		*/
268		public function getAge($format = '%y')
269		{
270		return $this->getBirthdate()
271		? $this->getBirthdate()->diff(new \DateTime())->format($format)
272		: null
273		;
274		}
275
276		/* Image upload */
277		/**
278		* @return ProfileEntity
279		*
280		* @throws \Exception If upload dir and path are not set
281		*/
282	View Code Duplication	public function imageUpload()
		0 ignored issues – show Duplication introduced 2016-01-01 16:44 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
283		{
284		if (null !== $this->getImage()) {
285		$uploadDir = $this->getImageUploadDir();
286		$uploadPath = $this->getImageUploadPath();
287
288		if (!($uploadDir && $uploadPath)) {
289		throw new \Exception('You must define the image upload dir and path!');
290		}
291
292		$slugify = new Slugify();
293
294		$filename = $slugify->slugify(
295		$this->getImage()->getClientOriginalName()
		0 ignored issues – show Bug introduced 2016-01-01 16:44 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Symfony\Component\HttpFoundation\File\File` as the method `getClientOriginalName()` does only exist in the following sub-classes of `Symfony\Component\HttpFoundation\File\File`: `Symfony\Component\HttpFoundation\File\UploadedFile`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
296		);
297
298		$filename .= '_'.sha1(uniqid(mt_rand(), true)).'.'.
299		$this->getImage()->guessExtension()
300		;
301
302		$this->getImage()->move(
303		$uploadDir,
304		$filename
305		);
306
307		$this->setImageUrl($uploadPath.$filename);
308
309		$this->setImage(null);
310		}
311
312		return $this;
313		}
314
315		/* User */
316		/**
317		* @return UserEntity
318		*/
319		public function getUser()
320		{
321		return $this->user;
322		}
323
324		/**
325		* @param UserEntity $user
326		*
327		* @return ProfileEntity
328		*/
329		public function setUser(UserEntity $user)
330		{
331		$this->user = $user;
332
333		return $this;
334		}
335
336		/**
337		* @return array
338		*/
339		public function toArray()
340		{
341		return array(
342		'id' => $this->getId(),
343		'title' => $this->getTitle(),
344		'full_name' => $this->getFullName(),
345		'first_name' => $this->getFirstName(),
346		'middle_name' => $this->getMiddleName(),
347		'last_name' => $this->getLastName(),
348		'gender' => $this->getGender(),
349		'birthdate' => $this->getBirthdate()
350		? $this->getBirthdate()->format(DATE_ATOM)
351		: null,
352		'image_url' => $this->getImageUrl(),
353		);
354		}
355		}
356

bobalazek / web-application-starter-kit

GitHub Access Token became invalid

Push — develop ( b704c5...ad0cea )

ProfileEntity::toArray() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like