SymfonyYamlParser   A
last analyzed

Complexity

Total Complexity 2

Size/Duplication

Total Lines 27
Duplicated Lines 0 %

Coupling/Cohesion

Components 0
Dependencies 1

Importance

Changes 1
Bugs 0 Features 0
Metric Value
wmc 2
c 1
b 0
f 0
lcom 0
cbo 1
dl 0
loc 27
rs 10

2 Methods

Rating   Name   Duplication   Size   Complexity  
A parse() 0 4 1
A dump() 0 4 1
1
<?php namespace Cerbero\Workflow\Wrappers;
2
3
use Symfony\Component\Yaml\Yaml;
4
5
/**
6
 * Symfony YAML files parser.
7
 *
8
 * @author	Andrea Marco Sartori
9
 */
10
class SymfonyYamlParser implements YamlParserInterface {
11
12
	/**
13
	 * Parse the given YAML file.
14
	 *
15
	 * @author	Andrea Marco Sartori
16
	 * @param	string	$path
17
	 * @return	array
18
	 */
19
	public function parse($path)
20
	{
21
		return Yaml::parse($path);
0 ignored issues
show
Bug Best Practice introduced by
The return type of return \Symfony\Component\Yaml\Yaml::parse($path); (array|string|stdClass) is incompatible with the return type declared by the interface Cerbero\Workflow\Wrapper...lParserInterface::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...
22
	}
23
24
	/**
25
	 * Dump the given array to YAML string.
26
	 *
27
	 * @author	Andrea Marco Sartori
28
	 * @param	array	$data
29
	 * @return	string
30
	 */
31
	public function dump(array $data)
32
	{
33
		return Yaml::dump($data);
34
	}
35
36
}
37