SecurityRoleDao::getRoleById() - Code Metrics - Inspection of "Implementing interfaces for user management ui" - thecodingmachine/security.daos.tdbm - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — 1.0 ( 468aff...8b7abc )

by David

created 2016-08-09 16:37 UTC

SecurityRoleDao::getRoleById() A

↳ Parent: SecurityRoleDao

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	1

<?php

/*
 * This file has been automatically generated by TDBM.
 * DO NOT edit this file, as it might be overwritten.
 * If you need to perform changes, edit the UserDao class instead!
 */

namespace Mouf\Security\DAO;

use Kls\Model\Bean\RolesRightBean;
use Mouf\Database\TDBM\TDBMService;
use Mouf\Database\TDBM\ResultIterator;
use Mouf\Security\Model\Role;
use Mouf\Security\Rights\RightsRegistry;
use Mouf\Security\RightsService\RightInterface;
use Mouf\Security\RightsService\RightsDaoInterface;
use Mouf\Security\UserManagement\Api\RoleDao;
use Mouf\Security\UserManagement\Api\RoleInterface;
use Mouf\Security\UserService\UserDaoInterface;
use Mouf\Security\UserService\UserInterface;

/**
 * This class provides a TDBM implementation of the RoleDao interface.
 */
class SecurityRoleDao implements RoleDao
{
    /**
     * @var TDBMService
     */
    protected $tdbmService;

    /**
     * @param TDBMService    $tdbmService    Sets the TDBM service used by this DAO.
     */
    public function __construct(TDBMService $tdbmService)
    {
        $this->tdbmService = $tdbmService;
    }


    /**
     * Returns the list of all roles known by the application.
     *
     * @return RoleInterface[]
     */
    public function getAllRoles()
    {
        return $this->find();
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());
}
    }

    /**
     * @param UserInterface $user
     * @param RoleInterface[] $roles
     * @return void
     */
    public function setRoles(UserInterface $user, array $roles)
    {
        $user = $this->tdbmService->findObjectByPk('users', [
            'id' => $user->getId()
        ]);
        // FIXME: throw exception is $user is null

        $roleBeans = [];

        foreach ($roles as $role) {
            $roleBeans[] = $this->findRoleById($role->getId());
        }

        $user->setRoles($roleBeans);
        $this->tdbmService->save($user);
    }

    /**
     * @param UserInterface $user
     * @return RoleInterface[]
     */
    public function getRoles(UserInterface $user)
    {
        return $this->find([
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());
}
            'users_roles.user_id' => $user->getId()
        ]);
    }

    /**
     * Get a list of RolesBean specified by its filters.
     *
     * @param mixed $filter                The filter bag (see TDBMService::findObjects for complete description)
     * @param array $parameters            The parameters associated with the filter
     * @param mixed $orderBy               The order string
     * @param array $additionalTablesFetch A list of additional tables to fetch (for performance improvement)
     * @param int   $mode                  Either TDBMService::MODE_ARRAY or TDBMService::MODE_CURSOR (for large datasets). Defaults to TDBMService::MODE_ARRAY.
     *
     * @return RolesRightBean[]|ResultIterator|ResultArray
     */
    private function find($filter = null, array $parameters = [], $orderBy = null, array $additionalTablesFetch = [], $mode = null)
    {
        return $this->tdbmService->findObjects('roles', $filter, $parameters, $orderBy, $additionalTablesFetch, $mode);
    }

    private function findRoleById($roleId) {
        return $this->tdbmService->findObjectByPk('roles', [
            'id' => $roleId
        ]);
    }

    /**
     * Fetches a role by ID.
     *
     * @param $roleId
     * @return RoleInterface
     */
    public function getRoleById($roleId) : RoleInterface
    {
        return self::castToRole($this->findRoleById($roleId));
    }

    public static function castToRole($roleBean) : RoleInterface
    {
        return new Role($roleBean->getId(), $roleBean->getLabel());
    }
}


1			<?php
2
3			/*
4			* This file has been automatically generated by TDBM.
5			* DO NOT edit this file, as it might be overwritten.
6			* If you need to perform changes, edit the UserDao class instead!
7			*/
8
9			namespace Mouf\Security\DAO;
10
11			use Kls\Model\Bean\RolesRightBean;
12			use Mouf\Database\TDBM\TDBMService;
13			use Mouf\Database\TDBM\ResultIterator;
14			use Mouf\Security\Model\Role;
15			use Mouf\Security\Rights\RightsRegistry;
16			use Mouf\Security\RightsService\RightInterface;
17			use Mouf\Security\RightsService\RightsDaoInterface;
18			use Mouf\Security\UserManagement\Api\RoleDao;
19			use Mouf\Security\UserManagement\Api\RoleInterface;
20			use Mouf\Security\UserService\UserDaoInterface;
21			use Mouf\Security\UserService\UserInterface;
22
23			/**
24			* This class provides a TDBM implementation of the RoleDao interface.
25			*/
26			class SecurityRoleDao implements RoleDao
27			{
28			/**
29			* @var TDBMService
30			*/
31			protected $tdbmService;
32
33			/**
34			* @param TDBMService $tdbmService Sets the TDBM service used by this DAO.
35			*/
36			public function __construct(TDBMService $tdbmService)
37			{
38			$this->tdbmService = $tdbmService;
39			}
40
41
42			/**
43			* Returns the list of all roles known by the application.
44			*
45			* @return RoleInterface[]
46			*/
47			public function getAllRoles()
48			{
49			return $this->find();
			0 ignored issues – show Bug Best Practice introduced 2016-08-09 16:46 UTC by Report Bug Copy Issue Report The return type of `return $this->find();` (`Kls\Model\Bean\RolesRigh...ecurity\DAO\ResultArray`) is incompatible with the return type declared by the interface `Mouf\Security\UserManage...pi\RoleDao::getAllRoles` of type `Mouf\Security\UserManagement\Api\RoleInterface[]`. 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			}
51
52			/**
53			* @param UserInterface $user
54			* @param RoleInterface[] $roles
55			* @return void
56			*/
57			public function setRoles(UserInterface $user, array $roles)
58			{
59			$user = $this->tdbmService->findObjectByPk('users', [
60			'id' => $user->getId()
61			]);
62			// FIXME: throw exception is $user is null
63
64			$roleBeans = [];
65
66			foreach ($roles as $role) {
67			$roleBeans[] = $this->findRoleById($role->getId());
68			}
69
70			$user->setRoles($roleBeans);
71			$this->tdbmService->save($user);
72			}
73
74			/**
75			* @param UserInterface $user
76			* @return RoleInterface[]
77			*/
78			public function getRoles(UserInterface $user)
79			{
80			return $this->find([
			0 ignored issues – show Bug Best Practice introduced 2016-08-09 16:46 UTC by Report Bug Copy Issue Report The return type of `return $this->find(array...d' => $user->getId()));` (`Kls\Model\Bean\RolesRigh...ecurity\DAO\ResultArray`) is incompatible with the return type declared by the interface `Mouf\Security\UserManagement\Api\RoleDao::getRoles` of type `Mouf\Security\UserManagement\Api\RoleInterface[]`. 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...
81			'users_roles.user_id' => $user->getId()
82			]);
83			}
84
85			/**
86			* Get a list of RolesBean specified by its filters.
87			*
88			* @param mixed $filter The filter bag (see TDBMService::findObjects for complete description)
89			* @param array $parameters The parameters associated with the filter
90			* @param mixed $orderBy The order string
91			* @param array $additionalTablesFetch A list of additional tables to fetch (for performance improvement)
92			* @param int $mode Either TDBMService::MODE_ARRAY or TDBMService::MODE_CURSOR (for large datasets). Defaults to TDBMService::MODE_ARRAY.
93			*
94			* @return RolesRightBean[]\|ResultIterator\|ResultArray
95			*/
96			private function find($filter = null, array $parameters = [], $orderBy = null, array $additionalTablesFetch = [], $mode = null)
97			{
98			return $this->tdbmService->findObjects('roles', $filter, $parameters, $orderBy, $additionalTablesFetch, $mode);
99			}
100
101			private function findRoleById($roleId) {
102			return $this->tdbmService->findObjectByPk('roles', [
103			'id' => $roleId
104			]);
105			}
106
107			/**
108			* Fetches a role by ID.
109			*
110			* @param $roleId
111			* @return RoleInterface
112			*/
113			public function getRoleById($roleId) : RoleInterface
114			{
115			return self::castToRole($this->findRoleById($roleId));
116			}
117
118			public static function castToRole($roleBean) : RoleInterface
119			{
120			return new Role($roleBean->getId(), $roleBean->getLabel());
121			}
122			}
123

thecodingmachine / security.daos.tdbm

Push — 1.0 ( 468aff...8b7abc )

SecurityRoleDao::getRoleById() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like