YamlContent::getArray() - Code Metrics - needle-project/fileio - Measure and Improve Code Quality continuously with Scrutinizer

YamlContent::getArray() A
last analyzed 2017-08-11 10:52 UTC

↳ Parent: YamlContent

Complexity

Conditions	2
Paths	2

Size

Total Lines	13
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	13
ccs	6
cts	6
cp	1
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	8
nc	2
nop	0
crap	2

<?php
/**
 * This file is part of the NeedleProject\FileIo package.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace NeedleProject\FileIo\Content;

use NeedleProject\FileIo\Exception\ContentException;
use Symfony\Component\Yaml\Exception\ParseException;
use Symfony\Component\Yaml\Yaml;

/**
 * Class YamlContent
 *
 * @package NeedleProject\FileIo\Content
 */
class YamlContent extends Content implements ContentInterface
{
    /**
     * Return the content as an array
     *
     * @return array

     * @throws \NeedleProject\FileIo\Exception\ContentException
     */
    public function getArray()
    {
        try {
            return Yaml::parse($this->get(), true);
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());
}
        } catch (ParseException $e) {
            throw new ContentException(
                sprintf(
                    "YAML could not be parsed: %s",
                    $e->getMessage()
                )
            );
        }
    }

    /**
     * {@inheritdoc}
     * @return \stdClass
     */
    public function getObject()
    {
        return (object)$this->getArray();
    }
}


1		<?php
2		/**
3		* This file is part of the NeedleProject\FileIo package.
4		*
5		* For the full copyright and license information, please view the LICENSE
6		* file that was distributed with this source code.
7		*/
8		namespace NeedleProject\FileIo\Content;
9
10		use NeedleProject\FileIo\Exception\ContentException;
11		use Symfony\Component\Yaml\Exception\ParseException;
12		use Symfony\Component\Yaml\Yaml;
13
14		/**
15		* Class YamlContent
16		*
17		* @package NeedleProject\FileIo\Content
18		*/
19		class YamlContent extends Content implements ContentInterface
20		{
21		/**
22		* Return the content as an array
23		*
24		* @return array
		0 ignored issues – show Documentation introduced 2017-06-30 08:56 UTC by Report Bug Copy Issue Report Should the return type not be `null\|\Symfony\Component\...\|string\|array\|\stdClass`? Also, consider making the array more specific, something like `array<String>`, or `String[]`. This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. If the return type contains the type array, this check recommends the use of a more specific type like `String[]` or `array<String>`. Loading history...
25		* @throws \NeedleProject\FileIo\Exception\ContentException
26		*/
27	2	public function getArray()
28		{
29		try {
30	2	return Yaml::parse($this->get(), true);
		0 ignored issues – show Bug Best Practice introduced 2017-06-30 08:56 UTC by Report Bug Copy Issue Report The return type of `return \Symfony\Componen...se($this->get(), true);` (`null\|Symfony\Component\Y...e\|string\|array\|stdClass`) is incompatible with the return type declared by the interface `NeedleProject\FileIo\Con...tentInterface::getArray` 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...
31	1	} catch (ParseException $e) {
32	1	throw new ContentException(
33		sprintf(
34	1	"YAML could not be parsed: %s",
35	1	$e->getMessage()
36		)
37		);
38		}
39		}
40
41		/**
42		* {@inheritdoc}
43		* @return \stdClass
44		*/
45	1	public function getObject()
46		{
47	1	return (object)$this->getArray();
48		}
49		}
50

needle-project / fileio

YamlContent::getArray() A last analyzed 2017-08-11 10:52 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

YamlContent::getArray() A
last analyzed 2017-08-11 10:52 UTC