Properties - Code Metrics - Inspection of "Merge pull request #128 from markdegrootnl/propert..." - hassankhan/config - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( 188d2b...06b91e )

by Davide

created 2020-10-13 07:51 UTC

Properties A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	46
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	1

Importance

Changes

Metric	Value
wmc	5
lcom	0
cbo	1
dl	0
loc	46
rs	10
c	0
b	0
f	0

3 Methods

Rating	Name	Size	Complexity
A	toString()	4	1
A	getSupportedExtensions()	4	1
A	toProperties()	20	3

<?php

namespace Noodlehaus\Writer;

/**
 * Properties Writer.
 *
 * @package    Config
 * @author     Jesus A. Domingo <[email protected]>
 * @author     Hassan Khan <[email protected]>
 * @author     Filip Š <[email protected]>
 * @author     Mark de Groot <[email protected]>
 * @link       https://github.com/noodlehaus/config
 * @license    MIT
 */
class Properties extends AbstractWriter
{
    /**
     * {@inheritdoc}
     * Writes an array to a Properties string.
     */
    public function toString($config, $pretty = true)
    {
        return $this->toProperties($config);
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());
}
    }

    /**
     * {@inheritdoc}
     */
    public static function getSupportedExtensions()
    {
        return ['properties'];
    }

    /**
     * Converts array to Properties string.
     * @param array $arr    Array to be converted
     *
     * @return string Converted array as Properties
     */
    protected function toProperties(array $arr)
    {
        $converted = '';

        foreach ($arr as $key => $value) {
            if (is_array($value)) {
                continue;
            }

            // Escape all space, ; and = characters in the key:
            $key = addcslashes($key, ' :=');

            // Escape all backslashes and newlines in the value:
            $value = preg_replace('/([\r\n\t\f\v\\\])/', '\\\$1', $value);

            $converted .= $key.' = '.$value.PHP_EOL;
        }

        return $converted;
    }
}


1			<?php
2
3			namespace Noodlehaus\Writer;
4
5			/**
6			* Properties Writer.
7			*
8			* @package Config
9			* @author Jesus A. Domingo <[email protected]>
10			* @author Hassan Khan <[email protected]>
11			* @author Filip Š <[email protected]>
12			* @author Mark de Groot <[email protected]>
13			* @link https://github.com/noodlehaus/config
14			* @license MIT
15			*/
16			class Properties extends AbstractWriter
17			{
18			/**
19			* {@inheritdoc}
20			* Writes an array to a Properties string.
21			*/
22			public function toString($config, $pretty = true)
23			{
24			return $this->toProperties($config);
			0 ignored issues – show Bug Best Practice introduced 2020-09-25 20:02 UTC by Report Bug Copy Issue Report The return type of `return $this->toProperties($config);` (`string`) is incompatible with the return type declared by the interface `Noodlehaus\Writer\WriterInterface::toString` of type `array`. 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...
25			}
26
27			/**
28			* {@inheritdoc}
29			*/
30			public static function getSupportedExtensions()
31			{
32			return ['properties'];
33			}
34
35			/**
36			* Converts array to Properties string.
37			* @param array $arr Array to be converted
38			*
39			* @return string Converted array as Properties
40			*/
41			protected function toProperties(array $arr)
42			{
43			$converted = '';
44
45			foreach ($arr as $key => $value) {
46			if (is_array($value)) {
47			continue;
48			}
49
50			// Escape all space, ; and = characters in the key:
51			$key = addcslashes($key, ' :=');
52
53			// Escape all backslashes and newlines in the value:
54			$value = preg_replace('/([\r\n\t\f\v\\\])/', '\\\$1', $value);
55
56			$converted .= $key.' = '.$value.PHP_EOL;
57			}
58
59			return $converted;
60			}
61			}
62

hassankhan / config

Push — develop ( 188d2b...06b91e )

Properties A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

3 Methods

Duplication Side-by-Side

Filter issues like