UserRepository::setUserModel() - Code Metrics - Inspection of "Feat 133 login page" - literat/srazvs - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — devel (#146)

by Litera

created 2018-03-23 10:00 UTC

UserRepository::setUserModel() A

↳ Parent: UserRepository

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	3
nc	1
nop	1
dl	0
loc	6
rs	9.4285
c	0
b	0
f	0

<?php

namespace App\Repositories;

use App\Entities\UserEntity;
use App\Models\UserModel;

class UserRepository
{

	/**
	 * @var UserModel
	 */
	protected $userModel;

	/**
	 * @param UserModel $userModel
	 */
	public function __construct(UserModel $userModel)
	{
		$this->setUserModel($userModel);
	}

	/**
	 * @return array
	 */
	public function all(): array
	{
		return $this->getUserModel()->all();
	}

	/**
	 * @param  int $id
	 * @return UserEntity
	 */
	public function find(int $id): UserEntity
	{
		return $this->getUserModel()->find($id);
	}

	/**
	 * @param  $user
	 * @return \Nette\Database\Table\ActiveRow
	 */
	public function create($user)
	{
		unset($user->id);

		return $this->getUserModel()
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());
}
			->save(
				$this->populate($user)
			);
	}

	/**
	 * @param  $id
	 * @param  $user
	 * @return \Nette\Database\Table\ActiveRow
	 */
	public function update($id, $user)

	{
		return $this->getUserModel()
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());
}
			->save(
				$this->populate($user)
			);
	}

	/**
	 * @param  $id
	 * @param  $user
	 * @return \Nette\Database\Table\ActiveRow
	 */
	public function save($user)
	{
		return $this->getUserModel()
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());
}
			->save(
				$this->populate($user)
			);
	}

	/**
	 * @param  $id
	 * @return bool
	 */
	public function delete($id): bool
	{
		return $this->getUserModel()->delete($id);
	}

	/**
	 * @param  array $values
	 * @return UserEntity
	 */
	protected function populate($values): UserEntity
	{
		$model = $this->getUserModel();
		$user = $model->hydrate($values);

		return $user;
	}

	/**
	 * @return UserModel
	 */
	protected function getUserModel(): UserModel
	{
		return $this->userModel;
	}

	/**
	 * @param  UserModel $model
	 * @return $this
	 */
	protected function setUserModel(UserModel $model): self
	{
		$this->userModel = $model;

		return $this;
	}

}


1			<?php
2
3			namespace App\Repositories;
4
5			use App\Entities\UserEntity;
6			use App\Models\UserModel;
7
8			class UserRepository
9			{
10
11			/**
12			* @var UserModel
13			*/
14			protected $userModel;
15
16			/**
17			* @param UserModel $userModel
18			*/
19			public function __construct(UserModel $userModel)
20			{
21			$this->setUserModel($userModel);
22			}
23
24			/**
25			* @return array
26			*/
27			public function all(): array
28			{
29			return $this->getUserModel()->all();
30			}
31
32			/**
33			* @param int $id
34			* @return UserEntity
35			*/
36			public function find(int $id): UserEntity
37			{
38			return $this->getUserModel()->find($id);
39			}
40
41			/**
42			* @param $user
43			* @return \Nette\Database\Table\ActiveRow
44			*/
45			public function create($user)
46			{
47			unset($user->id);
48
49			return $this->getUserModel()
			0 ignored issues – show Bug Best Practice introduced 2018-03-23 10:18 UTC by Report Bug Copy Issue Report The return type of `return $this->getUserMod...this->populate($user));` (`Nette\Database\Table\IRow\|integer\|boolean\|null`) is incompatible with the return type documented by `App\Repositories\UserRepository::create` of type `Nette\Database\Table\ActiveRow\|null`. 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...
50			->save(
51			$this->populate($user)
52			);
53			}
54
55			/**
56			* @param $id
57			* @param $user
58			* @return \Nette\Database\Table\ActiveRow
59			*/
60			public function update($id, $user)
			0 ignored issues – show Unused Code introduced 2018-03-23 10:18 UTC by Report Bug Copy Issue Report The parameter `$id` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
61			{
62			return $this->getUserModel()
			0 ignored issues – show Bug Best Practice introduced 2018-03-23 10:18 UTC by Report Bug Copy Issue Report The return type of `return $this->getUserMod...this->populate($user));` (`Nette\Database\Table\IRow\|integer\|boolean\|null`) is incompatible with the return type documented by `App\Repositories\UserRepository::update` of type `Nette\Database\Table\ActiveRow\|null`. 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...
63			->save(
64			$this->populate($user)
65			);
66			}
67
68			/**
69			* @param $id
70			* @param $user
71			* @return \Nette\Database\Table\ActiveRow
72			*/
73			public function save($user)
74			{
75			return $this->getUserModel()
			0 ignored issues – show Bug Best Practice introduced 2018-03-23 10:18 UTC by Report Bug Copy Issue Report The return type of `return $this->getUserMod...this->populate($user));` (`Nette\Database\Table\IRow\|integer\|boolean\|null`) is incompatible with the return type documented by `App\Repositories\UserRepository::save` of type `Nette\Database\Table\ActiveRow\|null`. 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...
76			->save(
77			$this->populate($user)
78			);
79			}
80
81			/**
82			* @param $id
83			* @return bool
84			*/
85			public function delete($id): bool
86			{
87			return $this->getUserModel()->delete($id);
88			}
89
90			/**
91			* @param array $values
92			* @return UserEntity
93			*/
94			protected function populate($values): UserEntity
95			{
96			$model = $this->getUserModel();
97			$user = $model->hydrate($values);
98
99			return $user;
100			}
101
102			/**
103			* @return UserModel
104			*/
105			protected function getUserModel(): UserModel
106			{
107			return $this->userModel;
108			}
109
110			/**
111			* @param UserModel $model
112			* @return $this
113			*/
114			protected function setUserModel(UserModel $model): self
115			{
116			$this->userModel = $model;
117
118			return $this;
119			}
120
121			}
122

literat / srazvs

Pull Request — devel (#146)

UserRepository::setUserModel() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like