MetaProperties::getDescription() - Code Metrics - Inspection of "Improved test coverage" - apparat/object - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 2689ec...25953d )

by Joschi

created 2016-02-16 20:07 UTC

MetaProperties::getDescription() A

↳ Parent: MetaProperties

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
c	2
b	0
f	0
dl	0
loc	4
ccs	2
cts	2
cp	1
rs	10
cc	1
eloc	2
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
{
    /**
     * 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 = [];

    /**
     * Collection name
     *
     * @var string
     */
    const COLLECTION = 'meta';

    /*******************************************************************************
     * 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('description', $data)) {
            $this->setDescription($data['description']);
        }

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

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

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

        // Initialize the authors
        if (array_key_exists('authors', $data)) {
            $this->setAuthors($data['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;
    }
}


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		* Object description
53		*
54		* @var string
55		*/
56		protected $_description = '';
57
58		/**
59		* Object abstract
60		*
61		* @var string
62		*/
63		protected $_abstract = '';
64
65		/**
66		* Object keywords
67		*
68		* @var array
69		*/
70		protected $_keywords = [];
71
72		/**
73		* Object categories
74		*
75		* @var array
76		*/
77		protected $_categories = [];
78
79		/**
80		* Object authors
81		*
82		* @var AuthorInterface[]
83		*/
84		protected $_authors = [];
85
86		/**
87		* Collection name
88		*
89		* @var string
90		*/
91		const COLLECTION = 'meta';
92
93		/*******************************************************************************
94		* PUBLIC METHODS
95		*******************************************************************************/
96
97		/**
98		* Meta properties constructor
99		*
100		* @param array $data Property data
101		* @param ObjectInterface $object Owner object
102		*/
103	2	public function __construct(array $data, ObjectInterface $object)
104		{
105	2	parent::__construct($data, $object);
106
107		// Initialize the description
108	2	if (array_key_exists('description', $data)) {
109	2	$this->setDescription($data['description']);
110	2	}
111
112		// Initialize the abstract
113	2	if (array_key_exists('abstract', $data)) {
114	2	$this->setAbstract($data['abstract']);
115	2	}
116
117		// Initialize the keywords
118	2	if (array_key_exists('keywords', $data)) {
119	1	$this->setKeywords((array)$data['keywords']);
120	1	}
121
122		// Initialize the categories
123	2	if (array_key_exists('categories', $data)) {
124	1	$this->setCategories((array)$data['categories']);
125	1	}
126
127		// Initialize the authors
128	2	if (array_key_exists('authors', $data)) {
129	2	$this->setAuthors($data['authors']);
130	1	}
131	1	}
132
133		/**
134		* Return the object description
135		*
136		* @return string Object description
137		*/
138	1	public function getDescription()
139		{
140	1	return $this->_description;
141		}
142
143		/**
144		* Set the object description
145		*
146		* @param string $description Object description
147		* @return MetaProperties Self reference
148		*/
149	2	public function setDescription($description)
150		{
151	2	$this->_description = $description;
152	2	return $this;
153		}
154
155		/**
156		* Return the object abstract
157		*
158		* @return string Object abstract
159		*/
160	1	public function getAbstract()
161		{
162	1	return $this->_abstract;
163		}
164
165		/**
166		* Set the object abstract
167		*
168		* @param string $abstract Object abstract
169		* @return MetaProperties Self reference
170		*/
171	2	public function setAbstract($abstract)
172		{
173	2	$this->_abstract = $abstract;
174	2	return $this;
175		}
176
177		/**
178		* Return the object keywords
179		*
180		* @return array Object keywords
181		*/
182	1	public function getKeywords()
183		{
184	1	return $this->_keywords;
185		}
186
187		/**
188		* Set the object keywords
189		*
190		* @param array $keywords Object keywords
191		* @return MetaProperties Self reference
192		*/
193	1	public function setKeywords(array $keywords)
194		{
195	1	$this->_keywords = array_unique($keywords);
196	1	sort($this->_keywords, SORT_NATURAL);
197	1	return $this;
198		}
199
200		/**
201		* Return the object categories
202		*
203		* @return array Object categories
204		*/
205	1	public function getCategories()
206		{
207	1	return $this->_categories;
208		}
209
210		/**
211		* Set the object categories
212		*
213		* @param array $categories Object categories
214		* @return MetaProperties Self reference
215		*/
216	1	public function setCategories(array $categories)
217		{
218	1	$this->_categories = array_unique($categories);
219	1	sort($this->_categories, SORT_NATURAL);
220	1	return $this;
221		}
222
223		/**
224		* Return the object authors
225		*
226		* @return AuthorInterface[]
227		*/
228	1	public function getAuthors()
229		{
230	1	return $this->_authors;
231		}
232
233		/**
234		* Set the object authors
235		*
236		* @param array $authors Object authors
237		* @return MetaProperties Self reference
238		* @throws InvalidArgumentException If an author is invalid
239		*/
240	2	public function setAuthors(array $authors)
241		{
242	2	$newAuthors = [];
243
244		// Run through and validate all authors
245	2	foreach ($authors as $author) {
246
247		// If the author is invalid
248	2	if (is_string($author)) {
249	1	$author = AuthorFactory::createFromString(
250	1	$author,
251	1	$this->getObject()->getRepositoryPath()->getRepository()
252	1	);
253	1	}
254
255		// If the author is invalid
256	2	if (!$author instanceof AuthorInterface) {
257	1	throw new InvalidArgumentException(
258	1	'Invalid object author',
259		InvalidArgumentException::INVALID_OBJECT_AUTHOR
260	1	);
261		}
262
263	1	$newAuthors[$author->getSignature()] = $author;
264	1	}
265
266	1	$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...
267	1	return $this;
268		}
269		}
270

apparat / object

Push — master ( 2689ec...25953d )

MetaProperties::getDescription() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like