FullNameEmbeddable::getPrefix() - Code Metrics - Inspection of "Creating a non binary UUID field" - edmondscommerce/doctrine-static-meta - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#139)

by joseph

created 2018-09-11 15:12 UTC

FullNameEmbeddable::getPrefix() A

↳ Parent: FullNameEmbeddable

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

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

<?php declare(strict_types=1);

namespace EdmondsCommerce\DoctrineStaticMeta\Entity\Embeddable\Objects\Identity;

use Doctrine\ORM\Mapping\ClassMetadata;
use EdmondsCommerce\DoctrineStaticMeta\Entity\Embeddable\Interfaces\Identity\HasFullNameEmbeddableInterface;
use EdmondsCommerce\DoctrineStaticMeta\Entity\Embeddable\Interfaces\Objects\Identity\FullNameEmbeddableInterface;
use EdmondsCommerce\DoctrineStaticMeta\Entity\Embeddable\Objects\AbstractEmbeddableObject;
use EdmondsCommerce\DoctrineStaticMeta\MappingHelper;

class FullNameEmbeddable extends AbstractEmbeddableObject implements FullNameEmbeddableInterface
{
    /**
     * The title or Honorific Prefix, for example Mr, Dr
     *
     * @var string
     */
    private $title;

    /**
     * The first or given name
     *
     * @var string
     */
    private $firstName;

    /**
     * An array of middle names
     *
     * @var array
     */
    private $middleNames;

    /**
     * The last or surname
     *
     * @var string
     */
    private $lastName;

    /**
     * The honorific suffix, for example Jr
     *
     * @var string
     */
    private $suffix;

    /**
     * @param ClassMetadata $metadata
     * @SuppressWarnings(PHPMD.StaticAccess)
     */
    public static function loadMetadata(ClassMetadata $metadata): void
    {
        $builder = self::setEmbeddableAndGetBuilder($metadata);
        MappingHelper::setSimpleFields(
            [
                FullNameEmbeddableInterface::EMBEDDED_PROP_TITLE       => MappingHelper::TYPE_STRING,
                FullNameEmbeddableInterface::EMBEDDED_PROP_FIRSTNAME   => MappingHelper::TYPE_STRING,
                FullNameEmbeddableInterface::EMBEDDED_PROP_MIDDLENAMES => MappingHelper::TYPE_JSON,
                FullNameEmbeddableInterface::EMBEDDED_PROP_LASTNAME    => MappingHelper::TYPE_STRING,
                FullNameEmbeddableInterface::EMBEDDED_PROP_SUFFIX      => MappingHelper::TYPE_STRING,
            ],
            $builder
        );
    }

    /**
     * Get the full name as a single string
     *
     * @return string
     */
    public function getFormatted(): string
    {
        return $this->format(
            [
                $this->getTitle(),
                $this->getFirstName(),
                $this->format($this->middleNames),
                $this->getLastName(),
                $this->getSuffix(),
            ]
        );
    }

    /**
     * Convert the array into a single space separated list
     *
     * @param array $items
     *
     * @return string
     */
    private function format(array $items): string
    {
        return trim(
            implode(
                ' ',
                array_map(
                    'trim',
                    array_filter(
                        $items
                    )
                )
            )
        );
    }

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

    /**
     * @param string $title
     *
     * @return FullNameEmbeddableInterface
     */
    public function setTitle(string $title): FullNameEmbeddableInterface
    {
        $this->notifyEmbeddablePrefixedProperties(
            'title',
            $this->title,
            $title
        );
        $this->title = $title;

        return $this;
    }

    /**
     * @return string
     */
    public function getFirstName(): string
    {
        return $this->firstName ?? '';
    }

    /**
     * @param string $firstName
     *
     * @return FullNameEmbeddableInterface
     */
    public function setFirstName(string $firstName): FullNameEmbeddableInterface
    {
        $this->notifyEmbeddablePrefixedProperties(
            'firstName',
            $this->firstName,
            $firstName
        );
        $this->firstName = $firstName;

        return $this;
    }

    /**
     * @return string
     */
    public function getLastName(): string
    {
        return $this->lastName ?? '';
    }

    /**
     * @param string $lastName
     *
     * @return FullNameEmbeddableInterface
     */
    public function setLastName(string $lastName): FullNameEmbeddableInterface
    {
        $this->notifyEmbeddablePrefixedProperties(
            'lastName',
            $this->lastName,
            $lastName
        );
        $this->lastName = $lastName;

        return $this;
    }

    /**
     * @return string
     */
    public function getSuffix(): string
    {
        return $this->suffix ?? '';
    }

    /**
     * @param string $suffix
     *
     * @return FullNameEmbeddableInterface
     */
    public function setSuffix(string $suffix): FullNameEmbeddableInterface
    {
        $this->notifyEmbeddablePrefixedProperties(
            'suffix',
            $this->suffix,
            $suffix
        );
        $this->suffix = $suffix;

        return $this;
    }

    public function __toString(): string
    {
        return (string)print_r(
            [
                'fullNameEmbeddabled' => [
                    FullNameEmbeddableInterface::EMBEDDED_PROP_TITLE       => $this->getTitle(),
                    FullNameEmbeddableInterface::EMBEDDED_PROP_FIRSTNAME   => $this->getFirstName(),
                    FullNameEmbeddableInterface::EMBEDDED_PROP_MIDDLENAMES => $this->getMiddleNames(),
                    FullNameEmbeddableInterface::EMBEDDED_PROP_LASTNAME    => $this->getLastName(),
                    FullNameEmbeddableInterface::EMBEDDED_PROP_SUFFIX      => $this->getSuffix(),
                ],
            ],
            true
        );
    }

    /**
     * @return array
     */
    public function getMiddleNames(): array
    {
        return $this->middleNames ?? [];
    }

    /**
     * @param array $middleNames
     *
     * @return FullNameEmbeddableInterface
     */
    public function setMiddleNames(array $middleNames): FullNameEmbeddableInterface
    {
        $this->notifyEmbeddablePrefixedProperties(
            'middleNames',
            $this->middleNames,
            $middleNames
        );
        $this->middleNames = $middleNames;

        return $this;
    }

    protected function getPrefix(): string
    {
        return HasFullNameEmbeddableInterface::PROP_FULL_NAME_EMBEDDABLE;
    }
}


1		<?php declare(strict_types=1);
2
3		namespace EdmondsCommerce\DoctrineStaticMeta\Entity\Embeddable\Objects\Identity;
4
5		use Doctrine\ORM\Mapping\ClassMetadata;
6		use EdmondsCommerce\DoctrineStaticMeta\Entity\Embeddable\Interfaces\Identity\HasFullNameEmbeddableInterface;
7		use EdmondsCommerce\DoctrineStaticMeta\Entity\Embeddable\Interfaces\Objects\Identity\FullNameEmbeddableInterface;
8		use EdmondsCommerce\DoctrineStaticMeta\Entity\Embeddable\Objects\AbstractEmbeddableObject;
9		use EdmondsCommerce\DoctrineStaticMeta\MappingHelper;
10
11		class FullNameEmbeddable extends AbstractEmbeddableObject implements FullNameEmbeddableInterface
12		{
13		/**
14		* The title or Honorific Prefix, for example Mr, Dr
15		*
16		* @var string
17		*/
18		private $title;
19
20		/**
21		* The first or given name
22		*
23		* @var string
24		*/
25		private $firstName;
26
27		/**
28		* An array of middle names
29		*
30		* @var array
31		*/
32		private $middleNames;
33
34		/**
35		* The last or surname
36		*
37		* @var string
38		*/
39		private $lastName;
40
41		/**
42		* The honorific suffix, for example Jr
43		*
44		* @var string
45		*/
46		private $suffix;
47
48		/**
49		* @param ClassMetadata $metadata
50		* @SuppressWarnings(PHPMD.StaticAccess)
51		*/
52		public static function loadMetadata(ClassMetadata $metadata): void
53		{
54		$builder = self::setEmbeddableAndGetBuilder($metadata);
55		MappingHelper::setSimpleFields(
56		[
57		FullNameEmbeddableInterface::EMBEDDED_PROP_TITLE => MappingHelper::TYPE_STRING,
58		FullNameEmbeddableInterface::EMBEDDED_PROP_FIRSTNAME => MappingHelper::TYPE_STRING,
59		FullNameEmbeddableInterface::EMBEDDED_PROP_MIDDLENAMES => MappingHelper::TYPE_JSON,
60		FullNameEmbeddableInterface::EMBEDDED_PROP_LASTNAME => MappingHelper::TYPE_STRING,
61		FullNameEmbeddableInterface::EMBEDDED_PROP_SUFFIX => MappingHelper::TYPE_STRING,
62		],
63		$builder
64		);
65		}
66
67		/**
68		* Get the full name as a single string
69		*
70		* @return string
71		*/
72	1	public function getFormatted(): string
73		{
74	1	return $this->format(
75		[
76	1	$this->getTitle(),
77	1	$this->getFirstName(),
78	1	$this->format($this->middleNames),
79	1	$this->getLastName(),
80	1	$this->getSuffix(),
81		]
82		);
83		}
84
85		/**
86		* Convert the array into a single space separated list
87		*
88		* @param array $items
89		*
90		* @return string
91		*/
92		private function format(array $items): string
93		{
94		return trim(
95		implode(
96		' ',
97		array_map(
98		'trim',
99		array_filter(
100		$items
101		)
102		)
103		)
104		);
105		}
106
107		/**
108		* @return string
109		*/
110	1	public function getTitle(): string
111		{
112	1	return $this->title ?? '';
113		}
114
115		/**
116		* @param string $title
117		*
118		* @return FullNameEmbeddableInterface
119		*/
120	1	public function setTitle(string $title): FullNameEmbeddableInterface
121		{
122	1	$this->notifyEmbeddablePrefixedProperties(
123	1	'title',
124	1	$this->title,
125	1	$title
126		);
127	1	$this->title = $title;
128
129	1	return $this;
130		}
131
132		/**
133		* @return string
134		*/
135	1	public function getFirstName(): string
136		{
137	1	return $this->firstName ?? '';
138		}
139
140		/**
141		* @param string $firstName
142		*
143		* @return FullNameEmbeddableInterface
144		*/
145	1	public function setFirstName(string $firstName): FullNameEmbeddableInterface
146		{
147	1	$this->notifyEmbeddablePrefixedProperties(
148	1	'firstName',
149	1	$this->firstName,
150	1	$firstName
151		);
152	1	$this->firstName = $firstName;
153
154	1	return $this;
155		}
156
157		/**
158		* @return string
159		*/
160	1	public function getLastName(): string
161		{
162	1	return $this->lastName ?? '';
163		}
164
165		/**
166		* @param string $lastName
167		*
168		* @return FullNameEmbeddableInterface
169		*/
170	1	public function setLastName(string $lastName): FullNameEmbeddableInterface
171		{
172	1	$this->notifyEmbeddablePrefixedProperties(
173	1	'lastName',
174	1	$this->lastName,
175	1	$lastName
176		);
177	1	$this->lastName = $lastName;
178
179	1	return $this;
180		}
181
182		/**
183		* @return string
184		*/
185	1	public function getSuffix(): string
186		{
187	1	return $this->suffix ?? '';
188		}
189
190		/**
191		* @param string $suffix
192		*
193		* @return FullNameEmbeddableInterface
194		*/
195	1	public function setSuffix(string $suffix): FullNameEmbeddableInterface
196		{
197	1	$this->notifyEmbeddablePrefixedProperties(
198	1	'suffix',
199	1	$this->suffix,
200	1	$suffix
201		);
202	1	$this->suffix = $suffix;
203
204	1	return $this;
205		}
206
207		public function __toString(): string
208		{
209		return (string)print_r(
210		[
211		'fullNameEmbeddabled' => [
212		FullNameEmbeddableInterface::EMBEDDED_PROP_TITLE => $this->getTitle(),
213		FullNameEmbeddableInterface::EMBEDDED_PROP_FIRSTNAME => $this->getFirstName(),
214		FullNameEmbeddableInterface::EMBEDDED_PROP_MIDDLENAMES => $this->getMiddleNames(),
215		FullNameEmbeddableInterface::EMBEDDED_PROP_LASTNAME => $this->getLastName(),
216		FullNameEmbeddableInterface::EMBEDDED_PROP_SUFFIX => $this->getSuffix(),
217		],
218		],
219		true
220		);
221		}
222
223		/**
224		* @return array
225		*/
226	1	public function getMiddleNames(): array
227		{
228	1	return $this->middleNames ?? [];
229		}
230
231		/**
232		* @param array $middleNames
233		*
234		* @return FullNameEmbeddableInterface
235		*/
236	1	public function setMiddleNames(array $middleNames): FullNameEmbeddableInterface
237		{
238	1	$this->notifyEmbeddablePrefixedProperties(
239	1	'middleNames',
240	1	$this->middleNames,
241	1	$middleNames
242		);
243	1	$this->middleNames = $middleNames;
244
245	1	return $this;
246		}
247
248		protected function getPrefix(): string
249		{
250		return HasFullNameEmbeddableInterface::PROP_FULL_NAME_EMBEDDABLE;
251		}
252		}
253

edmondscommerce / doctrine-static-meta

GitHub Access Token became invalid

Pull Request — master (#139)

FullNameEmbeddable::getPrefix() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like