CommentManager::updateCommentsCount() - Code Metrics - sonata-project/SonataNewsBundle - Measure and Improve Code Quality continuously with Scrutinizer

CommentManager::updateCommentsCount() A
last analyzed 2020-08-28 02:03 UTC

↳ Parent: CommentManager

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	6
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	1

<?php

declare(strict_types=1);

/*
 * This file is part of the Sonata Project package.
 *
 * (c) Thomas Rabaix <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Sonata\NewsBundle\Document;

use Sonata\Doctrine\Document\BaseDocumentManager;
use Sonata\DoctrineMongoDBAdminBundle\Datagrid\Pager;
use Sonata\DoctrineMongoDBAdminBundle\Datagrid\ProxyQuery;
use Sonata\NewsBundle\Model\CommentInterface;
use Sonata\NewsBundle\Model\CommentManagerInterface;
use Sonata\NewsBundle\Model\PostInterface;

class CommentManager extends BaseDocumentManager implements CommentManagerInterface
{
    /**
     * @param int $page
     * @param int $limit
     *
     * @return Pager
     */
    public function getPager(array $criteria, $page, $limit = 10, array $sort = [])
    {
        $qb = $this->getDocumentManager()->getRepository($this->class)
            ->createQueryBuilder()
            ->sort('createdAt', 'desc');

        $criteria['status'] = $criteria['status'] ?? CommentInterface::STATUS_VALID;
        $qb->field('status')->equals($criteria['status']);

        if (isset($criteria['postId'])) {
            $qb->field('post')->equals($criteria['postId']);
        }

        $pager = new Pager(500); // no limit
        $pager->setQuery(new ProxyQuery($qb));
        $pager->setPage($page);
        $pager->init();

        return $pager;
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());
}
    }

    /**
     * Update the comments count.
     *
     * @param PostInterface $post
     */
    public function updateCommentsCount(?PostInterface $post = null): void
    {
        $post->setCommentsCount($post->getCommentsCount() + 1);
function someFunction(A $objectMaybe = null)
{
    if ($objectMaybe instanceof A) {
        $objectMaybe->doSomething();
    }
}
        $this->getDocumentManager()->persist($post);
        $this->getDocumentManager()->flush();
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			/*
6			* This file is part of the Sonata Project package.
7			*
8			* (c) Thomas Rabaix <[email protected]>
9			*
10			* For the full copyright and license information, please view the LICENSE
11			* file that was distributed with this source code.
12			*/
13
14			namespace Sonata\NewsBundle\Document;
15
16			use Sonata\Doctrine\Document\BaseDocumentManager;
17			use Sonata\DoctrineMongoDBAdminBundle\Datagrid\Pager;
18			use Sonata\DoctrineMongoDBAdminBundle\Datagrid\ProxyQuery;
19			use Sonata\NewsBundle\Model\CommentInterface;
20			use Sonata\NewsBundle\Model\CommentManagerInterface;
21			use Sonata\NewsBundle\Model\PostInterface;
22
23			class CommentManager extends BaseDocumentManager implements CommentManagerInterface
24			{
25			/**
26			* @param int $page
27			* @param int $limit
28			*
29			* @return Pager
30			*/
31			public function getPager(array $criteria, $page, $limit = 10, array $sort = [])
32			{
33			$qb = $this->getDocumentManager()->getRepository($this->class)
34			->createQueryBuilder()
35			->sort('createdAt', 'desc');
36
37			$criteria['status'] = $criteria['status'] ?? CommentInterface::STATUS_VALID;
38			$qb->field('status')->equals($criteria['status']);
39
40			if (isset($criteria['postId'])) {
41			$qb->field('post')->equals($criteria['postId']);
42			}
43
44			$pager = new Pager(500); // no limit
45			$pager->setQuery(new ProxyQuery($qb));
46			$pager->setPage($page);
47			$pager->init();
48
49			return $pager;
			0 ignored issues – show Bug Best Practice introduced 2019-10-30 21:15 UTC by Report Bug Copy Issue Report The return type of `return $pager;` (`Sonata\DoctrineMongoDBAdminBundle\Datagrid\Pager`) is incompatible with the return type declared by the interface `Sonata\DatagridBundle\Pa...ableInterface::getPager` of type `Sonata\DatagridBundle\Pager\PagerInterface`. 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			* Update the comments count.
54			*
55			* @param PostInterface $post
56			*/
57			public function updateCommentsCount(?PostInterface $post = null): void
58			{
59			$post->setCommentsCount($post->getCommentsCount() + 1);
			0 ignored issues – show Bug introduced 2015-11-23 07:52 UTC by Report Bug Copy Issue Report It seems like `$post` is not always an object, but can also be of type `null`. Maybe add an additional type check? If a variable is not always an object, we recommend to add an additional type check to ensure your method call is safe: function someFunction(A $objectMaybe = null) { if ($objectMaybe instanceof A) { $objectMaybe->doSomething(); } } Loading history...
60			$this->getDocumentManager()->persist($post);
61			$this->getDocumentManager()->flush();
62			}
63			}
64

sonata-project / SonataNewsBundle

CommentManager::updateCommentsCount() A last analyzed 2020-08-28 02:03 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

CommentManager::updateCommentsCount() A
last analyzed 2020-08-28 02:03 UTC