FlatArrayTransformer::flatten() - Code Metrics - nilportugues/serializer - Measure and Improve Code Quality continuously with Scrutinizer

FlatArrayTransformer::flatten() A
last analyzed 2015-12-15 18:10 UTC

↳ Parent: FlatArrayTransformer

Complexity

Conditions	3
Paths	3

Size

Total Lines	13
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	13
rs	9.4286
cc	3
eloc	8
nc	3
nop	2

<?php

/**
 * Author: Nil Portugués Calderó <[email protected]>
 * Date: 8/29/15
 * Time: 2:48 PM.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace NilPortugues\Serializer\Transformer;

class FlatArrayTransformer  extends ArrayTransformer

{
    /**
     * @param mixed $value
     *
     * @return string
     */
    public function serialize($value)
    {
        return $this->flatten(parent::serialize($value));
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());
}
    }

    /**
     * @param array  $array
     * @param string $prefix
     *
     * @return array
     */
    private function flatten(array $array, $prefix = '')
    {
        $result = [];
        foreach ($array as $key => $value) {
            if (\is_array($value)) {
                $result = $result + $this->flatten($value, $prefix.$key.'.');
            } else {
                $result[$prefix.$key] = $value;
            }
        }

        return $result;
    }
}


1			<?php
2
3			/**
4			* Author: Nil Portugués Calderó <[email protected]>
5			* Date: 8/29/15
6			* Time: 2:48 PM.
7			*
8			* For the full copyright and license information, please view the LICENSE
9			* file that was distributed with this source code.
10			*/
11			namespace NilPortugues\Serializer\Transformer;
12
13			class FlatArrayTransformer extends ArrayTransformer
			0 ignored issues – show Coding Style introduced 2015-11-21 16:39 UTC by Report Bug Copy Issue Report Expected 1 space after class name; 2 found Loading history... Coding Style introduced 2015-11-21 16:39 UTC by Report Bug Copy Issue Report Expected 1 space before extends keyword; 2 found Loading history...
14			{
15			/**
16			* @param mixed $value
17			*
18			* @return string
19			*/
20			public function serialize($value)
21			{
22			return $this->flatten(parent::serialize($value));
			0 ignored issues – show Bug Best Practice introduced 2015-11-21 16:39 UTC by Report Bug Copy Issue Report The return type of `return $this->flatten(parent::serialize($value));` (`array`) is incompatible with the return type declared by the interface `NilPortugues\Serializer\...egyInterface::serialize` of type `string`. 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...
23			}
24
25			/**
26			* @param array $array
27			* @param string $prefix
28			*
29			* @return array
30			*/
31			private function flatten(array $array, $prefix = '')
32			{
33			$result = [];
34			foreach ($array as $key => $value) {
35			if (\is_array($value)) {
36			$result = $result + $this->flatten($value, $prefix.$key.'.');
37			} else {
38			$result[$prefix.$key] = $value;
39			}
40			}
41
42			return $result;
43			}
44			}
45

nilportugues / serializer

FlatArrayTransformer::flatten() A last analyzed 2015-12-15 18:10 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

FlatArrayTransformer::flatten() A
last analyzed 2015-12-15 18:10 UTC