ObjectProxy::addAuthor() - Code Metrics - Inspection of "Added meta property setters" - apparat/object - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 68c6f3...91ba10 )

by Joschi

created 2016-04-30 21:13 UTC

ObjectProxy::addAuthor() A

↳ Parent: ObjectProxy

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

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

<?php

/**
 * apparat-object
 *
 * @category    Apparat
 * @package     Apparat\Object
 * @subpackage  Apparat\Object\Domain
 * @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\Object;

use Apparat\Kernel\Ports\Kernel;
use Apparat\Object\Domain\Model\Author\AuthorInterface;
use Apparat\Object\Domain\Model\Path\ApparatUrl;
use Apparat\Object\Domain\Model\Path\PathInterface;
use Apparat\Object\Domain\Repository\Service;

/**
 * Object proxy (lazy loading)
 *
 * @package Apparat\Object
 * @subpackage Apparat\Object\Domain
 */
class ObjectProxy implements ObjectInterface
{
    /**
     * Apparat object URL
     *
     * @var ApparatUrl
     */
    protected $url = null;
    /**
     * Object
     *
     * @var ObjectInterface
     */
    protected $object = null;

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

    /**
     * Object proxy constructor
     *
     * @param ApparatUrl $url Apparat object URL
     */
    public function __construct(ApparatUrl $url)
    {
        $this->url = $url;
    }

    /**
     * Return the object repository path
     *
     * @return PathInterface Object repository path
     */
    public function getRepositoryPath()
    {
        // If the object has already been instantiated
        if ($this->object instanceof ObjectInterface) {
            return $this->object->getRepositoryPath();

            // Else
        } else {
            return $this->url->getLocalPath();
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
        }
    }

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

    /**
     * Return the enclosed remote object
     *
     * @return ObjectInterface Remote object
     */
    protected function object()
    {
        // Lazy-load the remote object if necessary
        if (!$this->object instanceof ObjectInterface) {
            // Instantiate the local object repository, load and return the object
            $this->object = Kernel::create(Service::class)->get($this->url)->loadObject($this->url->getLocalPath());
        }

        return $this->object;
    }

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

    /**
     * Return the object ID
     *
     * @return Id Object ID
     */
    public function getId()
    {
        return $this->object()->getId();
    }

    /**
     * Return the object type
     *
     * @return Type Object type
     */
    public function getType()
    {
        return $this->object()->getType();
    }

    /**
     * Return the object revision
     *
     * @return Revision Object revision
     */
    public function getRevision()
    {
        return $this->object()->getRevision();
    }

    /**
     * Return the object draft mode
     *
     * @return boolean Object draft mode
     */
    public function isDraft()
    {
        return $this->object()->isDraft();
    }

    /**
     * Return the creation date & time
     *
     * @return \DateTimeImmutable Creation date & time
     */
    public function getCreated()
    {
        return $this->object()->getCreated();
    }

    /**
     * Return the publication date & time
     *
     * @return \DateTimeImmutable Publication date & time
     */
    public function getPublished()
    {
        return $this->object()->getPublished();
    }

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

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

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

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

    /**
     * Set the abstract
     *
     * @param string $Abstract
/**
 * @param array $germany
 * @param array $ireland
 */
function finale($germany, $island) {
    return "2:1";
}
     * @return ObjectInterface Self reference
     */
    public function setAbstract($abstract)
    {
        return $this->object()->setAbstract($abstract);
    }

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

    /**
     * Set the keywords
     *
     * @param array $keywords Keywords
     * @return ObjectInterface Self reference
     */
    public function setKeywords(array $keywords)
    {
        return $this->object()->setKeywords($keywords);
    }

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

    /**
     * Set the categories
     *
     * @param array $categories Categories
     * @return ObjectInterface Self reference
     */
    public function setCategories(array $categories)
    {
        return $this->object()->setCategories($categories);
    }

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

    /**
     * Add an object author
     *
     * @param AuthorInterface $author Author
     * @return ObjectInterface Self reference
     */
    public function addAuthor(AuthorInterface $author)
    {
        return $this->object()->addAuthor($author);
    }

    /**
     * Get a particular property value
     *
     * Multi-level properties might be traversed by property name paths separated with colons (":").
     *
     * @param string $property Property name
     * @return mixed Property value
     */
    public function getDomainProperty($property)
    {
        return $this->object()->getDomainProperty($property);
    }

    /**
     * Return the absolute object URL
     *
     * @return string
     */
    public function getAbsoluteUrl()
    {
        return strval($this->url);
    }

    /**
     * Generic caller
     *
     * @param string $name Method name
     * @param array $arguments Method arguments
     */
    public function __call($name, $arguments)
    {
        $object = $this->object();
        if (is_callable(array($object, $name))) {
            return $object->$name(...$arguments);
        }

        throw new InvalidArgumentException(
            sprintf('Invalid object proxy method "%s"', $name),
            InvalidArgumentException::INVALID_OBJECT_PROXY_METHOD
        );
    }

    /**
     * Use a specific object revision
     *
     * @param Revision $revision Revision to be used
     * @return ObjectInterface Object
     */
    public function useRevision(Revision $revision)
    {
        return $this->object()->useRevision($revision);
    }
}


1		<?php
2
3		/**
4		* apparat-object
5		*
6		* @category Apparat
7		* @package Apparat\Object
8		* @subpackage Apparat\Object\Domain
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)
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\Object;
38
39		use Apparat\Kernel\Ports\Kernel;
40		use Apparat\Object\Domain\Model\Author\AuthorInterface;
41		use Apparat\Object\Domain\Model\Path\ApparatUrl;
42		use Apparat\Object\Domain\Model\Path\PathInterface;
43		use Apparat\Object\Domain\Repository\Service;
44
45		/**
46		* Object proxy (lazy loading)
47		*
48		* @package Apparat\Object
49		* @subpackage Apparat\Object\Domain
50		*/
51		class ObjectProxy implements ObjectInterface
52		{
53		/**
54		* Apparat object URL
55		*
56		* @var ApparatUrl
57		*/
58		protected $url = null;
59		/**
60		* Object
61		*
62		* @var ObjectInterface
63		*/
64		protected $object = null;
65
66		/*******************************************************************************
67		* PUBLIC METHODS
68		*******************************************************************************/
69
70		/**
71		* Object proxy constructor
72		*
73		* @param ApparatUrl $url Apparat object URL
74		*/
75	13	public function __construct(ApparatUrl $url)
76		{
77	13	$this->url = $url;
78	13	}
79
80		/**
81		* Return the object repository path
82		*
83		* @return PathInterface Object repository path
84		*/
85		public function getRepositoryPath()
86		{
87		// If the object has already been instantiated
88		if ($this->object instanceof ObjectInterface) {
89		return $this->object->getRepositoryPath();
90
91		// Else
92		} else {
93		return $this->url->getLocalPath();
		0 ignored issues – show Bug Best Practice introduced 2016-02-26 22:01 UTC by Report Bug Copy Issue Report The return type of `return $this->url->getLocalPath();` (`Apparat\Object\Domain\Model\Path\LocalPath`) is incompatible with the return type declared by the interface `Apparat\Object\Domain\Mo...face::getRepositoryPath` of type `Apparat\Object\Domain\Mo...RepositoryPathInterface`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
94		}
95		}
96
97		/**
98		* Return the object property data
99		*
100		* @return array Object property data
101		*/
102		public function getPropertyData()
103		{
104		return $this->object()->getPropertyData();
105		}
106
107		/**
108		* Return the enclosed remote object
109		*
110		* @return ObjectInterface Remote object
111		*/
112		protected function object()
113		{
114		// Lazy-load the remote object if necessary
115		if (!$this->object instanceof ObjectInterface) {
116		// Instantiate the local object repository, load and return the object
117		$this->object = Kernel::create(Service::class)->get($this->url)->loadObject($this->url->getLocalPath());
118		}
119
120		return $this->object;
121		}
122
123		/**
124		* Return the object payload
125		*
126		* @return string Object payload
127		*/
128		public function getPayload()
129		{
130		return $this->object()->getPayload();
131		}
132
133		/**
134		* Return the object ID
135		*
136		* @return Id Object ID
137		*/
138		public function getId()
139		{
140		return $this->object()->getId();
141		}
142
143		/**
144		* Return the object type
145		*
146		* @return Type Object type
147		*/
148		public function getType()
149		{
150		return $this->object()->getType();
151		}
152
153		/**
154		* Return the object revision
155		*
156		* @return Revision Object revision
157		*/
158		public function getRevision()
159		{
160		return $this->object()->getRevision();
161		}
162
163		/**
164		* Return the object draft mode
165		*
166		* @return boolean Object draft mode
167		*/
168		public function isDraft()
169		{
170		return $this->object()->isDraft();
171		}
172
173		/**
174		* Return the creation date & time
175		*
176		* @return \DateTimeImmutable Creation date & time
177		*/
178		public function getCreated()
179		{
180		return $this->object()->getCreated();
181		}
182
183		/**
184		* Return the publication date & time
185		*
186		* @return \DateTimeImmutable Publication date & time
187		*/
188		public function getPublished()
189		{
190		return $this->object()->getPublished();
191		}
192
193		/**
194		* Return the object hash
195		*
196		* @return string Object hash
197		*/
198		public function getHash()
199		{
200		return $this->object()->getHash();
201		}
202
203		/**
204		* Return the object description
205		*
206		* @return string Object description
207		*/
208		public function getDescription()
209		{
210		return $this->object()->getDescription();
211		}
212
213		/**
214		* Set the description
215		*
216		* @param string $description Description
217		* @return ObjectInterface Self reference
218		*/
219		public function setDescription($description)
220		{
221		return $this->object()->setDescription($description);
222		}
223
224		/**
225		* Return the object abstract
226		*
227		* @return string Object abstract
228		*/
229		public function getAbstract()
230		{
231		return $this->object()->getAbstract();
232		}
233
234		/**
235		* Set the abstract
236		*
237		* @param string $Abstract
		0 ignored issues – show Documentation introduced 2016-04-30 21:15 UTC by Report Bug Copy Issue Report There is no parameter named `$Abstract`. Did you maybe mean `$abstract`? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. It has, however, found a similar but not annotated parameter which might be a good fit. Consider the following example. The parameter `$ireland` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $ireland */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was changed, but the annotation was not. Loading history...
238		* @return ObjectInterface Self reference
239		*/
240		public function setAbstract($abstract)
241		{
242		return $this->object()->setAbstract($abstract);
243		}
244
245		/**
246		* Return all object keywords
247		*
248		* @return array Object keywords
249		*/
250		public function getKeywords()
251		{
252		return $this->object()->getKeywords();
253		}
254
255		/**
256		* Set the keywords
257		*
258		* @param array $keywords Keywords
259		* @return ObjectInterface Self reference
260		*/
261		public function setKeywords(array $keywords)
262		{
263		return $this->object()->setKeywords($keywords);
264		}
265
266		/**
267		* Return all object categories
268		*
269		* @return array Object categories
270		*/
271		public function getCategories()
272		{
273		return $this->object()->getCategories();
274		}
275
276		/**
277		* Set the categories
278		*
279		* @param array $categories Categories
280		* @return ObjectInterface Self reference
281		*/
282		public function setCategories(array $categories)
283		{
284		return $this->object()->setCategories($categories);
285		}
286
287		/**
288		* Return all object authors
289		*
290		* @return AuthorInterface[] Authors
291		*/
292		public function getAuthors()
293		{
294		return $this->object()->getAuthors();
295		}
296
297		/**
298		* Add an object author
299		*
300		* @param AuthorInterface $author Author
301		* @return ObjectInterface Self reference
302		*/
303		public function addAuthor(AuthorInterface $author)
304		{
305		return $this->object()->addAuthor($author);
306		}
307
308		/**
309		* Get a particular property value
310		*
311		* Multi-level properties might be traversed by property name paths separated with colons (":").
312		*
313		* @param string $property Property name
314		* @return mixed Property value
315		*/
316		public function getDomainProperty($property)
317		{
318		return $this->object()->getDomainProperty($property);
319		}
320
321		/**
322		* Return the absolute object URL
323		*
324		* @return string
325		*/
326	12	public function getAbsoluteUrl()
327		{
328	12	return strval($this->url);
329		}
330
331		/**
332		* Generic caller
333		*
334		* @param string $name Method name
335		* @param array $arguments Method arguments
336		*/
337		public function __call($name, $arguments)
338		{
339		$object = $this->object();
340		if (is_callable(array($object, $name))) {
341		return $object->$name(...$arguments);
342		}
343
344		throw new InvalidArgumentException(
345		sprintf('Invalid object proxy method "%s"', $name),
346		InvalidArgumentException::INVALID_OBJECT_PROXY_METHOD
347		);
348		}
349
350		/**
351		* Use a specific object revision
352		*
353		* @param Revision $revision Revision to be used
354		* @return ObjectInterface Object
355		*/
356		public function useRevision(Revision $revision)
357		{
358		return $this->object()->useRevision($revision);
359		}
360		}
361

apparat / object

Push — master ( 68c6f3...91ba10 )

ObjectProxy::addAuthor() A

Complexity

Size

Duplication

Code Coverage

Duplication Side-by-Side

Filter issues like