MetaProperties::toArray() - Code Metrics - Inspection of "Added simple property data test" - apparat/object - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 3e0d05...5aac82 )

by Joschi

created 2016-02-25 20:46 UTC

MetaProperties::toArray() A

↳ Parent: MetaProperties

Complexity

Conditions	1
Paths	1

Size

Total Lines	15
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	12
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	15
ccs	12
cts	12
cp	1
rs	9.4285
cc	1
eloc	10
nc	1
nop	0
crap	1

<?php

/**
 * apparat-object
 *
 * @category    Apparat
 * @package     Apparat\Object
 * @subpackage  Apparat\Object\Application
 * @author      Joschi Kuphal <[email protected]> / @jkphl
 * @copyright   Copyright © 2016 Joschi Kuphal <[email protected]> / @jkphl
 * @license     http://opensource.org/licenses/MIT	The MIT License (MIT)

 */

/***********************************************************************************
 *  The MIT License (MIT)
 *
 *  Copyright © 2016 Joschi Kuphal <[email protected]> / @jkphl
 *
 *  Permission is hereby granted, free of charge, to any person obtaining a copy of
 *  this software and associated documentation files (the "Software"), to deal in
 *  the Software without restriction, including without limitation the rights to
 *  use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 *  the Software, and to permit persons to whom the Software is furnished to do so,
 *  subject to the following conditions:
 *
 *  The above copyright notice and this permission notice shall be included in all
 *  copies or substantial portions of the Software.
 *
 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 *  FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 *  COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 *  IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 *  CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 ***********************************************************************************/

namespace Apparat\Object\Domain\Model\Properties;

use Apparat\Object\Domain\Factory\AuthorFactory;
use Apparat\Object\Domain\Model\Author\AuthorInterface;
use Apparat\Object\Domain\Model\Object\ObjectInterface;

/**
 * Meta object properties collection
 *
 * @package Apparat\Object
 * @subpackage Apparat\Object\Application
 */
class MetaProperties extends AbstractProperties
{
    /**
     * Collection name
     *
     * @var string
     */
    const COLLECTION = 'meta';
    /**
     * Description property
     *
     * @var string
     */
    const PROPERTY_DESCRIPTION = 'description';
    /**
     * Abstract property
     *
     * @var string
     */
    const PROPERTY_ABSTRACT = 'abstract';
    /**
     * Keywords property
     *
     * @var string
     */
    const PROPERTY_KEYWORDS = 'keywords';
    /**
     * Categories property
     *
     * @var string
     */
    const PROPERTY_CATEGORIES = 'categories';
    /**
     * Authors property
     *
     * @var string
     */
    const PROPERTY_AUTHORS = 'authors';
    /**
     * Object description
     *
     * @var string
     */
    protected $description = '';
    /**
     * Object abstract
     *
     * @var string
     */
    protected $abstract = '';
    /**
     * Object keywords
     *
     * @var array
     */
    protected $keywords = [];
    /**
     * Object categories
     *
     * @var array
     */
    protected $categories = [];
    /**
     * Object authors
     *
     * @var AuthorInterface[]
     */
    protected $_authors = [];

    /*******************************************************************************
     * PUBLIC METHODS
     *******************************************************************************/

    /**
     * Meta properties constructor
     *
     * @param array $data Property data
     * @param ObjectInterface $object Owner object
     */
    public function __construct(array $data, ObjectInterface $object)
    {
        parent::__construct($data, $object);

        // Initialize the description
        if (array_key_exists(self::PROPERTY_DESCRIPTION, $data)) {
            $this->setDescription($data[self::PROPERTY_DESCRIPTION]);
        }

        // Initialize the abstract
        if (array_key_exists(self::PROPERTY_ABSTRACT, $data)) {
            $this->setAbstract($data[self::PROPERTY_ABSTRACT]);
        }

        // Initialize the keywords
        if (array_key_exists(self::PROPERTY_KEYWORDS, $data)) {
            $this->setKeywords((array)$data[self::PROPERTY_KEYWORDS]);
        }

        // Initialize the categories
        if (array_key_exists(self::PROPERTY_CATEGORIES, $data)) {
            $this->setCategories((array)$data[self::PROPERTY_CATEGORIES]);
        }

        // Initialize the authors
        if (array_key_exists(self::PROPERTY_AUTHORS, $data)) {
            $this->setAuthors($data[self::PROPERTY_AUTHORS]);
        }
    }

    /**
     * Return the object description
     *
     * @return string Object description
     */
    public function getDescription()
    {
        return $this->description;
    }

    /**
     * Set the object description
     *
     * @param string $description Object description
     * @return MetaProperties Self reference
     */
    public function setDescription($description)
    {
        $this->description = $description;
        return $this;
    }

    /**
     * Return the object abstract
     *
     * @return string Object abstract
     */
    public function getAbstract()
    {
        return $this->abstract;
    }

    /**
     * Set the object abstract
     *
     * @param string $abstract Object abstract
     * @return MetaProperties Self reference
     */
    public function setAbstract($abstract)
    {
        $this->abstract = $abstract;
        return $this;
    }

    /**
     * Return the object keywords
     *
     * @return array Object keywords
     */
    public function getKeywords()
    {
        return $this->keywords;
    }

    /**
     * Set the object keywords
     *
     * @param array $keywords Object keywords
     * @return MetaProperties Self reference
     */
    public function setKeywords(array $keywords)
    {
        $this->keywords = array_unique($keywords);
        sort($this->keywords, SORT_NATURAL);
        return $this;
    }

    /**
     * Return the object categories
     *
     * @return array Object categories
     */
    public function getCategories()
    {
        return $this->categories;
    }

    /**
     * Set the object categories
     *
     * @param array $categories Object categories
     * @return MetaProperties Self reference
     */
    public function setCategories(array $categories)
    {
        $this->categories = array_unique($categories);
        sort($this->categories, SORT_NATURAL);
        return $this;
    }

    /**
     * Return the object authors
     *
     * @return AuthorInterface[]
     */
    public function getAuthors()
    {
        return $this->_authors;
    }

    /**
     * Set the object authors
     *
     * @param array $authors Object authors
     * @return MetaProperties Self reference
     * @throws InvalidArgumentException If an author is invalid
     */
    public function setAuthors(array $authors)
    {
        $newAuthors = [];

        // Run through and validate all authors
        foreach ($authors as $author) {

            // If the author is invalid
            if (is_string($author)) {
                $author = AuthorFactory::createFromString(
                    $author,
                    $this->getObject()->getRepositoryPath()->getRepository()
                );
            }

            // If the author is invalid
            if (!$author instanceof AuthorInterface) {
                throw new InvalidArgumentException(
                    'Invalid object author',
                    InvalidArgumentException::INVALID_OBJECT_AUTHOR
                );
            }

            $newAuthors[$author->getSignature()] = $author;
        }

        $this->_authors = array_values($newAuthors);

        return $this;
    }

    /**
     * Return the property values as array
     *
     * @return array Property values
     */
    public function toArray()
    {
        return [
            self::PROPERTY_DESCRIPTION => $this->description,
            self::PROPERTY_ABSTRACT => $this->abstract,
            self::PROPERTY_KEYWORDS => $this->keywords,
            self::PROPERTY_CATEGORIES => $this->categories,
            self::PROPERTY_AUTHORS => array_map(
                function (AuthorInterface $author) {
                    return $author->serialize();
                },
                $this->_authors
            )
        ];
    }
}


1		<?php
2
3		/**
4		* apparat-object
5		*
6		* @category Apparat
7		* @package Apparat\Object
8		* @subpackage Apparat\Object\Application
9		* @author Joschi Kuphal <[email protected]> / @jkphl
10		* @copyright Copyright © 2016 Joschi Kuphal <[email protected]> / @jkphl
11		* @license http://opensource.org/licenses/MIT The MIT License (MIT)
		0 ignored issues – show Coding Style introduced 2016-02-06 22:26 UTC by Report Bug Copy Issue Report Spaces must be used for alignment; tabs are not allowed Loading history...
12		*/
13
14		/***********************************************************************************
15		* The MIT License (MIT)
16		*
17		* Copyright © 2016 Joschi Kuphal <[email protected]> / @jkphl
18		*
19		* Permission is hereby granted, free of charge, to any person obtaining a copy of
20		* this software and associated documentation files (the "Software"), to deal in
21		* the Software without restriction, including without limitation the rights to
22		* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
23		* the Software, and to permit persons to whom the Software is furnished to do so,
24		* subject to the following conditions:
25		*
26		* The above copyright notice and this permission notice shall be included in all
27		* copies or substantial portions of the Software.
28		*
29		* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
30		* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
31		* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
32		* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
33		* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
34		* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
35		***********************************************************************************/
36
37		namespace Apparat\Object\Domain\Model\Properties;
38
39		use Apparat\Object\Domain\Factory\AuthorFactory;
40		use Apparat\Object\Domain\Model\Author\AuthorInterface;
41		use Apparat\Object\Domain\Model\Object\ObjectInterface;
42
43		/**
44		* Meta object properties collection
45		*
46		* @package Apparat\Object
47		* @subpackage Apparat\Object\Application
48		*/
49		class MetaProperties extends AbstractProperties
50		{
51		/**
52		* Collection name
53		*
54		* @var string
55		*/
56		const COLLECTION = 'meta';
57		/**
58		* Description property
59		*
60		* @var string
61		*/
62		const PROPERTY_DESCRIPTION = 'description';
63		/**
64		* Abstract property
65		*
66		* @var string
67		*/
68		const PROPERTY_ABSTRACT = 'abstract';
69		/**
70		* Keywords property
71		*
72		* @var string
73		*/
74		const PROPERTY_KEYWORDS = 'keywords';
75		/**
76		* Categories property
77		*
78		* @var string
79		*/
80		const PROPERTY_CATEGORIES = 'categories';
81		/**
82		* Authors property
83		*
84		* @var string
85		*/
86		const PROPERTY_AUTHORS = 'authors';
87		/**
88		* Object description
89		*
90		* @var string
91		*/
92		protected $description = '';
93		/**
94		* Object abstract
95		*
96		* @var string
97		*/
98		protected $abstract = '';
99		/**
100		* Object keywords
101		*
102		* @var array
103		*/
104		protected $keywords = [];
105		/**
106		* Object categories
107		*
108		* @var array
109		*/
110		protected $categories = [];
111		/**
112		* Object authors
113		*
114		* @var AuthorInterface[]
115		*/
116		protected $_authors = [];
117
118		/*******************************************************************************
119		* PUBLIC METHODS
120		*******************************************************************************/
121
122		/**
123		* Meta properties constructor
124		*
125		* @param array $data Property data
126		* @param ObjectInterface $object Owner object
127		*/
128	2	public function __construct(array $data, ObjectInterface $object)
129		{
130	2	parent::__construct($data, $object);
131
132		// Initialize the description
133	2	if (array_key_exists(self::PROPERTY_DESCRIPTION, $data)) {
134	2	$this->setDescription($data[self::PROPERTY_DESCRIPTION]);
135	2	}
136
137		// Initialize the abstract
138	2	if (array_key_exists(self::PROPERTY_ABSTRACT, $data)) {
139	2	$this->setAbstract($data[self::PROPERTY_ABSTRACT]);
140	2	}
141
142		// Initialize the keywords
143	2	if (array_key_exists(self::PROPERTY_KEYWORDS, $data)) {
144	1	$this->setKeywords((array)$data[self::PROPERTY_KEYWORDS]);
145	1	}
146
147		// Initialize the categories
148	2	if (array_key_exists(self::PROPERTY_CATEGORIES, $data)) {
149	1	$this->setCategories((array)$data[self::PROPERTY_CATEGORIES]);
150	1	}
151
152		// Initialize the authors
153	2	if (array_key_exists(self::PROPERTY_AUTHORS, $data)) {
154	2	$this->setAuthors($data[self::PROPERTY_AUTHORS]);
155	1	}
156	1	}
157
158		/**
159		* Return the object description
160		*
161		* @return string Object description
162		*/
163	1	public function getDescription()
164		{
165	1	return $this->description;
166		}
167
168		/**
169		* Set the object description
170		*
171		* @param string $description Object description
172		* @return MetaProperties Self reference
173		*/
174	2	public function setDescription($description)
175		{
176	2	$this->description = $description;
177	2	return $this;
178		}
179
180		/**
181		* Return the object abstract
182		*
183		* @return string Object abstract
184		*/
185	1	public function getAbstract()
186		{
187	1	return $this->abstract;
188		}
189
190		/**
191		* Set the object abstract
192		*
193		* @param string $abstract Object abstract
194		* @return MetaProperties Self reference
195		*/
196	2	public function setAbstract($abstract)
197		{
198	2	$this->abstract = $abstract;
199	2	return $this;
200		}
201
202		/**
203		* Return the object keywords
204		*
205		* @return array Object keywords
206		*/
207	1	public function getKeywords()
208		{
209	1	return $this->keywords;
210		}
211
212		/**
213		* Set the object keywords
214		*
215		* @param array $keywords Object keywords
216		* @return MetaProperties Self reference
217		*/
218	1	public function setKeywords(array $keywords)
219		{
220	1	$this->keywords = array_unique($keywords);
221	1	sort($this->keywords, SORT_NATURAL);
222	1	return $this;
223		}
224
225		/**
226		* Return the object categories
227		*
228		* @return array Object categories
229		*/
230	1	public function getCategories()
231		{
232	1	return $this->categories;
233		}
234
235		/**
236		* Set the object categories
237		*
238		* @param array $categories Object categories
239		* @return MetaProperties Self reference
240		*/
241	1	public function setCategories(array $categories)
242		{
243	1	$this->categories = array_unique($categories);
244	1	sort($this->categories, SORT_NATURAL);
245	1	return $this;
246		}
247
248		/**
249		* Return the object authors
250		*
251		* @return AuthorInterface[]
252		*/
253	2	public function getAuthors()
254		{
255	2	return $this->_authors;
256		}
257
258		/**
259		* Set the object authors
260		*
261		* @param array $authors Object authors
262		* @return MetaProperties Self reference
263		* @throws InvalidArgumentException If an author is invalid
264		*/
265	3	public function setAuthors(array $authors)
266		{
267	3	$newAuthors = [];
268
269		// Run through and validate all authors
270	3	foreach ($authors as $author) {
271
272		// If the author is invalid
273	3	if (is_string($author)) {
274	1	$author = AuthorFactory::createFromString(
275	1	$author,
276	1	$this->getObject()->getRepositoryPath()->getRepository()
277	1	);
278	1	}
279
280		// If the author is invalid
281	3	if (!$author instanceof AuthorInterface) {
282	1	throw new InvalidArgumentException(
283	1	'Invalid object author',
284		InvalidArgumentException::INVALID_OBJECT_AUTHOR
285	1	);
286		}
287
288	2	$newAuthors[$author->getSignature()] = $author;
289	2	}
290
291	2	$this->_authors = array_values($newAuthors);
		0 ignored issues – show Documentation Bug introduced 2016-02-06 22:26 UTC by Report Bug Copy Issue Report It seems like `array_values($newAuthors)` of type `array<integer,?>` is incompatible with the declared type `array<integer,object<App...uthor\AuthorInterface>>` of property `$_authors`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
292	2	return $this;
293		}
294
295		/**
296		* Return the property values as array
297		*
298		* @return array Property values
299		*/
300	1	public function toArray()
301		{
302		return [
303	1	self::PROPERTY_DESCRIPTION => $this->description,
304	1	self::PROPERTY_ABSTRACT => $this->abstract,
305	1	self::PROPERTY_KEYWORDS => $this->keywords,
306	1	self::PROPERTY_CATEGORIES => $this->categories,
307	1	self::PROPERTY_AUTHORS => array_map(
308	1	function (AuthorInterface $author) {
309	1	return $author->serialize();
310	1	},
311	1	$this->_authors
312	1	)
313	1	];
314		}
315		}
316

apparat / object

Push — master ( 3e0d05...5aac82 )

MetaProperties::toArray() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like