HashHydrator   A
last analyzed

Complexity

Total Complexity 2

Size/Duplication

Total Lines 29
Duplicated Lines 0 %

Coupling/Cohesion

Components 0
Dependencies 2

Importance

Changes 0
Metric Value
wmc 2
lcom 0
cbo 2
dl 0
loc 29
rs 10
c 0
b 0
f 0

2 Methods

Rating   Name   Duplication   Size   Complexity  
A hydrateAll() 0 4 1
A hydrateRow() 0 4 1
1
<?php
2
3
/**
4
 * This file is part of the Kdyby (http://www.kdyby.org)
5
 *
6
 * Copyright (c) 2008 Filip Procházka ([email protected])
7
 *
8
 * For the full copyright and license information, please view the file license.txt that was distributed with this source code.
9
 */
10
11
namespace Kdyby\Doctrine\Hydration;
12
13
use Doctrine\ORM\Internal\Hydration\ArrayHydrator;
14
use Kdyby;
15
use Nette;
16
use Nette\Utils\ArrayHash;
17
18
19
20
/**
21
 * @author Filip Procházka <[email protected]>
22
 */
23
class HashHydrator extends ArrayHydrator
24
{
25
26
	const NAME = 'hash';
27
28
29
30
	/**
31
	 * @param object $stmt
32
	 * @param object $resultSetMapping
33
	 * @param array $hints
34
	 * @return array
35
	 */
36
	public function hydrateAll($stmt, $resultSetMapping, array $hints = [])
37
	{
38
		return array_map(Nette\Utils\ArrayHash::class . '::from', parent::hydrateAll($stmt,$resultSetMapping,$hints));
39
	}
40
41
42
43
	/**
44
	 * @return ArrayHash
45
	 */
46
	public function hydrateRow()
47
	{
48
		return ArrayHash::from(parent::hydrateRow());
0 ignored issues
show
Bug Best Practice introduced by
The return type of return \Nette\Utils\Arra...(parent::hydrateRow()); (Nette\Utils\ArrayHash) is incompatible with the return type of the parent method Doctrine\ORM\Internal\Hy...actHydrator::hydrateRow of type false|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...
Security Bug introduced by
It seems like parent::hydrateRow() targeting Doctrine\ORM\Internal\Hy...tHydrator::hydrateRow() can also be of type false; however, Nette\Utils\ArrayHash::from() does only seem to accept array, did you maybe forget to handle an error condition?
Loading history...
49
	}
50
51
}
52