RoleRepository::findBy() - Code Metrics - WeareJH/JhUser - Measure and Improve Code Quality continuously with Scrutinizer

RoleRepository::findBy() A
last analyzed 2016-12-14 11:36 UTC

↳ Parent: RoleRepository

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	4

<?php

namespace JhUser\Repository;

use Doctrine\ORM\QueryBuilder;
use Doctrine\Common\Persistence\ObjectRepository;
use DoctrineORMModule\Paginator\Adapter\DoctrinePaginator;
use Doctrine\ORM\Tools\Pagination\Paginator as ORMPaginator;
use Zend\Paginator\Paginator;
use JhUser\Entity\Role;

/**
 * Class RoleRepository
 * @package JhUser\Repository
 * @author Aydin Hassan <[email protected]>
 */
class RoleRepository implements RoleRepositoryInterface, ObjectRepository
{

    /**
     * @var \Doctrine\Common\Persistence\ObjectRepository
     */
    protected $roleRepository;

    /**
     * @param ObjectRepository $roleRepository
     */
    public function __construct(ObjectRepository $roleRepository)
    {
        $this->roleRepository = $roleRepository;
    }

    /**
     * Return a paginator object using the query builder object
     *
     * @param \Doctrine\ORM\QueryBuilder $queryBuilder
     * @return \Zend\Paginator\Paginator
     */
    public function paginate(QueryBuilder $queryBuilder)
    {
        return new Paginator(
            new DoctrinePaginator(new ORMPaginator($queryBuilder))
        );
    }

    /**
     * @param string $roleName
     * @return Role|null
     */
    public function findByName($roleName)
    {
        return $this->roleRepository->findOneBy(['name' => $roleName]);
    }

    /**
     * findAll(): defined by ObjectRepository.
     *
     * @param bool $paginate
     * @see    ObjectRepository::findAll()
     * @return Role[]
     */
    public function findAll($paginate = false)
    {
        $qb = $this->roleRepository->createQueryBuilder('u');

        if ($paginate) {
            return $this->paginate($qb);
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());
}
        }
        return $qb->getQuery()->getResult();
    }

    /**
     * find(): defined by ObjectRepository.
     *
     * @see    ObjectRepository::find()
     * @param  int $id
     * @return Role|null
     */
    public function find($id)
    {
        return $this->roleRepository->find($id);
    }

    /**
     * findBy(): defined by ObjectRepository.
     *
     * @see    ObjectRepository::findBy()
     * @param  array      $criteria
     * @param  array|null $orderBy
     * @param  int|null   $limit
     * @param  int|null   $offset
     * @return Role[]
     */
    public function findBy(array $criteria, array $orderBy = null, $limit = null, $offset = null)
    {
        return $this->roleRepository->findBy($criteria, $orderBy, $limit, $offset);
    }

    /**
     * findOneBy(): defined by ObjectRepository.
     *
     * @see    ObjectRepository::findOneBy()
     * @param  array $criteria
     * @return Role|null
     */
    public function findOneBy(array $criteria)
    {
        return $this->roleRepository->findOneBy($criteria);
    }

    /**
     * getClassName(): defined by ObjectRepository.
     *
     * @see    ObjectRepository::getClassName()
     * @return string
     */
    public function getClassName()
    {
        return $this->roleRepository->getClassName();
    }
}


1			<?php
2
3			namespace JhUser\Repository;
4
5			use Doctrine\ORM\QueryBuilder;
6			use Doctrine\Common\Persistence\ObjectRepository;
7			use DoctrineORMModule\Paginator\Adapter\DoctrinePaginator;
8			use Doctrine\ORM\Tools\Pagination\Paginator as ORMPaginator;
9			use Zend\Paginator\Paginator;
10			use JhUser\Entity\Role;
11
12			/**
13			* Class RoleRepository
14			* @package JhUser\Repository
15			* @author Aydin Hassan <[email protected]>
16			*/
17			class RoleRepository implements RoleRepositoryInterface, ObjectRepository
18			{
19
20			/**
21			* @var \Doctrine\Common\Persistence\ObjectRepository
22			*/
23			protected $roleRepository;
24
25			/**
26			* @param ObjectRepository $roleRepository
27			*/
28			public function __construct(ObjectRepository $roleRepository)
29			{
30			$this->roleRepository = $roleRepository;
31			}
32
33			/**
34			* Return a paginator object using the query builder object
35			*
36			* @param \Doctrine\ORM\QueryBuilder $queryBuilder
37			* @return \Zend\Paginator\Paginator
38			*/
39			public function paginate(QueryBuilder $queryBuilder)
40			{
41			return new Paginator(
42			new DoctrinePaginator(new ORMPaginator($queryBuilder))
43			);
44			}
45
46			/**
47			* @param string $roleName
48			* @return Role\|null
49			*/
50			public function findByName($roleName)
51			{
52			return $this->roleRepository->findOneBy(['name' => $roleName]);
53			}
54
55			/**
56			* findAll(): defined by ObjectRepository.
57			*
58			* @param bool $paginate
59			* @see ObjectRepository::findAll()
60			* @return Role[]
61			*/
62			public function findAll($paginate = false)
63			{
64			$qb = $this->roleRepository->createQueryBuilder('u');
65
66			if ($paginate) {
67			return $this->paginate($qb);
			0 ignored issues – show Bug Best Practice introduced 2016-12-14 09:11 UTC by Report Bug Copy Issue Report The return type of `return $this->paginate($qb);` (`Zend\Paginator\Paginator`) is incompatible with the return type declared by the interface `Doctrine\Common\Persiste...jectRepository::findAll` 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...
68			}
69			return $qb->getQuery()->getResult();
70			}
71
72			/**
73			* find(): defined by ObjectRepository.
74			*
75			* @see ObjectRepository::find()
76			* @param int $id
77			* @return Role\|null
78			*/
79			public function find($id)
80			{
81			return $this->roleRepository->find($id);
82			}
83
84			/**
85			* findBy(): defined by ObjectRepository.
86			*
87			* @see ObjectRepository::findBy()
88			* @param array $criteria
89			* @param array\|null $orderBy
90			* @param int\|null $limit
91			* @param int\|null $offset
92			* @return Role[]
93			*/
94			public function findBy(array $criteria, array $orderBy = null, $limit = null, $offset = null)
95			{
96			return $this->roleRepository->findBy($criteria, $orderBy, $limit, $offset);
97			}
98
99			/**
100			* findOneBy(): defined by ObjectRepository.
101			*
102			* @see ObjectRepository::findOneBy()
103			* @param array $criteria
104			* @return Role\|null
105			*/
106			public function findOneBy(array $criteria)
107			{
108			return $this->roleRepository->findOneBy($criteria);
109			}
110
111			/**
112			* getClassName(): defined by ObjectRepository.
113			*
114			* @see ObjectRepository::getClassName()
115			* @return string
116			*/
117			public function getClassName()
118			{
119			return $this->roleRepository->getClassName();
120			}
121			}
122

WeareJH / JhUser

RoleRepository::findBy() A last analyzed 2016-12-14 11:36 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

RoleRepository::findBy() A
last analyzed 2016-12-14 11:36 UTC