Completed
Push — develop ( 930556...77256d )
by Hassan
9s
created

Yaml::getSupportedExtensions()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 4

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 2
CRAP Score 1

Importance

Changes 0
Metric Value
dl 0
loc 4
ccs 2
cts 2
cp 1
rs 10
c 0
b 0
f 0
cc 1
nc 1
nop 0
crap 1
1
<?php
2
3
namespace Noodlehaus\Parser;
4
5
use Exception;
6
use Symfony\Component\Yaml\Yaml as YamlParser;
7
use Noodlehaus\Exception\ParseException;
8
9
/**
10
 * YAML parser
11
 *
12
 * @package    Config
13
 * @author     Jesus A. Domingo <[email protected]>
14
 * @author     Hassan Khan <[email protected]>
15
 * @author     Filip Š <[email protected]>
16
 * @link       https://github.com/noodlehaus/config
17
 * @license    MIT
18
 */
19
class Yaml implements ParserInterface
20
{
21
    /**
22
     * {@inheritDoc}
23
     * Loads a YAML/YML string as an array
24
     *
25
     * @throws ParseException If If there is an error parsing the YAML string
26
     */
27 9
    public function parse($config, $filename = null)
28
    {
29
        try {
30 9
            $data = YamlParser::parse($config, YamlParser::PARSE_CONSTANT);
31 5
        } catch (Exception $exception) {
32 3
            throw new ParseException(
33
                [
34 3
                    'message'   => 'Error parsing YAML string',
35 3
                    'exception' => $exception,
36
                ]
37 1
            );
38
        }
39
40 6
        return $data;
0 ignored issues
show
Bug Best Practice introduced by
The return type of return $data; (null|Symfony\Component\Y...e|string|array|stdClass) is incompatible with the return type declared by the interface Noodlehaus\Parser\ParserInterface::parse 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...
41
    }
42
43
    /**
44
     * {@inheritDoc}
45
     */
46 3
    public static function getSupportedExtensions()
47
    {
48 3
        return ['yaml', 'yml'];
49
    }
50
}
51