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

StatementSerializer::deserializeStatements() A
last analyzed 2016-03-21 15:55 UTC

↳ Parent: StatementSerializer

Complexity

Conditions	1
Paths	1

Size

Total Lines	8
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	8
rs	9.4285
cc	1
eloc	5
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\Statement;

/**
 * Serialize and deserialize {@link Statement statements}.
 *
 * @author Christian Flothmann <[email protected]>
 */
class StatementSerializer implements StatementSerializerInterface
{
    /**
     * @var SerializerInterface The underlying serializer
     */
    private $serializer;

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

    /**
     * {@inheritDoc}
     */
    public function serializeStatement(Statement $statement)
    {
        return $this->serializer->serialize($statement, 'json');
    }

    /**
     * {@inheritDoc}
     */
    public function serializeStatements(array $statements)
    {
        return $this->serializer->serialize($statements, 'json');
    }

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

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


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\Statement;
16
17			/**
18			* Serialize and deserialize {@link Statement statements}.
19			*
20			* @author Christian Flothmann <[email protected]>
21			*/
22			class StatementSerializer implements StatementSerializerInterface
23			{
24			/**
25			* @var SerializerInterface The underlying serializer
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 serializeStatement(Statement $statement)
38			{
39			return $this->serializer->serialize($statement, 'json');
40			}
41
42			/**
43			* {@inheritDoc}
44			*/
45			public function serializeStatements(array $statements)
46			{
47			return $this->serializer->serialize($statements, 'json');
48			}
49
50			/**
51			* {@inheritDoc}
52			*/
53			public function deserializeStatement($data)
54			{
55			return $this->serializer->deserialize(
			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...l\\Statement', 'json');` (`object\|array\|integer\|double\|string\|boolean`) is incompatible with the return type declared by the interface `Xabbuh\XApi\Serializer\S...e::deserializeStatement` of type `Xabbuh\XApi\Model\Statement`. 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...
56			$data,
57			'Xabbuh\XApi\Model\Statement',
58			'json'
59			);
60			}
61
62			/**
63			* {@inheritDoc}
64			*/
65			public function deserializeStatements($data)
66			{
67			return $this->serializer->deserialize(
			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...\\Statement>', 'json');` (`object\|array\|integer\|double\|string\|boolean`) is incompatible with the return type declared by the interface `Xabbuh\XApi\Serializer\S...::deserializeStatements` of type `Xabbuh\XApi\Model\Statement[]`. 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...
68			$data,
69			'array<Xabbuh\XApi\Model\Statement>',
70			'json'
71			);
72			}
73			}
74

php-xapi / xapi-serializer

StatementSerializer::deserializeStatements() A last analyzed 2016-03-21 15:55 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

StatementSerializer::deserializeStatements() A
last analyzed 2016-03-21 15:55 UTC