DocumentDataSerializer::__construct() - Code Metrics - php-xapi/xapi-serializer - Measure and Improve Code Quality continuously with Scrutinizer

DocumentDataSerializer::__construct() A
last analyzed 2016-03-21 15:55 UTC

↳ Parent: DocumentDataSerializer

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	4
Ratio	100 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	4
loc	4
rs	10
cc	1
eloc	2
nc	1
nop	1

<?php

/*
 * This file is part of the xAPI package.
 *
 * (c) Christian Flothmann <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Xabbuh\XApi\Serializer;

use JMS\Serializer\SerializerInterface;
use Xabbuh\XApi\Model\DocumentData;

/**
 * Serialize and deserialize {@link Document documents}.
 *
 * @author Christian Flothmann <[email protected]>
 */
class DocumentDataSerializer implements DocumentDataSerializerInterface

{
    /**
     * @var SerializerInterface
     */
    private $serializer;

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

    /**
     * {@inheritDoc}
     */
    public function serializeDocumentData(DocumentData $data)
    {
        return $this->serializer->serialize($data, 'json');
    }

    /**
     * {@inheritDoc}
     */
    public function deserializeDocumentData($data)
    {
        return $this->serializer->deserialize($data, 'Xabbuh\XApi\Model\DocumentData', 'json');
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());
}
    }
}


1		<?php
2
3		/*
4		* This file is part of the xAPI package.
5		*
6		* (c) Christian Flothmann <[email protected]>
7		*
8		* For the full copyright and license information, please view the LICENSE
9		* file that was distributed with this source code.
10		*/
11
12		namespace Xabbuh\XApi\Serializer;
13
14		use JMS\Serializer\SerializerInterface;
15		use Xabbuh\XApi\Model\DocumentData;
16
17		/**
18		* Serialize and deserialize {@link Document documents}.
19		*
20		* @author Christian Flothmann <[email protected]>
21		*/
22	View Code Duplication	class DocumentDataSerializer implements DocumentDataSerializerInterface
		0 ignored issues – show Duplication introduced 2016-03-18 15:14 UTC by Report Bug Copy Issue Report This class 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...
23		{
24		/**
25		* @var SerializerInterface
26		*/
27		private $serializer;
28
29		public function __construct(SerializerInterface $serializer)
30		{
31		$this->serializer = $serializer;
32		}
33
34		/**
35		* {@inheritDoc}
36		*/
37		public function serializeDocumentData(DocumentData $data)
38		{
39		return $this->serializer->serialize($data, 'json');
40		}
41
42		/**
43		* {@inheritDoc}
44		*/
45		public function deserializeDocumentData($data)
46		{
47		return $this->serializer->deserialize($data, 'Xabbuh\XApi\Model\DocumentData', 'json');
		0 ignored issues – show Bug Best Practice introduced 2016-03-18 15:14 UTC by Report Bug Copy Issue Report The return type of `return $this->serializer...DocumentData', 'json');` (`object\|array\|integer\|double\|string\|boolean`) is incompatible with the return type declared by the interface `Xabbuh\XApi\Serializer\D...deserializeDocumentData` of type `Xabbuh\XApi\Model\DocumentData`. 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...
48		}
49		}
50

php-xapi / xapi-serializer

DocumentDataSerializer::__construct() A last analyzed 2016-03-21 15:55 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

DocumentDataSerializer::__construct() A
last analyzed 2016-03-21 15:55 UTC