Yml   A
last analyzed

Complexity

Total Complexity 2

Size/Duplication

Total Lines 20
Duplicated Lines 0 %

Coupling/Cohesion

Components 0
Dependencies 1

Test Coverage

Coverage 100%

Importance

Changes 1
Bugs 0 Features 0
Metric Value
wmc 2
c 1
b 0
f 0
lcom 0
cbo 1
dl 0
loc 20
ccs 5
cts 5
cp 1
rs 10

2 Methods

Rating   Name   Duplication   Size   Complexity  
A load() 0 6 1
A format() 0 4 1
1
<?php
2
/**
3
 * @package    Fuel\Config
4
 * @version    2.0
5
 * @author     Fuel Development Team
6
 * @license    MIT License
7
 * @copyright  2010 - 2015 Fuel Development Team
8
 * @link       http://fuelphp.com
9
 */
10
11
namespace Fuel\Config\Handler;
12
13
use Fuel\Config\Handler;
14
use Symfony\Component\Yaml\Yaml;
15
16
/**
17
 * YAML configuration loading and formatting logic
18
 */
19
class Yml implements Handler
20
{
21
	/**
22
	 * {@inheritdoc}
23
	 */
24 1
    public function load($file)
25
    {
26 1
        $contents = file_get_contents($file);
27
28 1
        return Yaml::parse($contents);
0 ignored issues
show
Bug Best Practice introduced by
The return type of return \Symfony\Componen...Yaml::parse($contents); (array|string|stdClass) is incompatible with the return type declared by the interface Fuel\Config\Handler::load 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...
29
    }
30
31
	/**
32
	 * {@inheritdoc}
33
	 */
34 1
    public function format($data)
35
    {
36 1
        return Yaml::dump($data);
37
    }
38
}
39