CCDNForum\ForumBundle\Model\Component\Gateway\BoardGateway

Complexity

Total Complexity

12

Size/Duplication

Total Lines	120
Duplicated Lines	0 %

Coupling/Cohesion

Components	3
Dependencies	3

7 Methods

Rating	Name	Duplication	Size	Complexity
A	findBoard()	0	10	2
A	findBoards()	0	10	2
A	countBoards()	0	18	4
A	saveBoard()	0	6	1
A	updateBoard()	0	6	1
A	deleteBoard()	0	6	1
A	createBoard()	0	4	1

<?php

/*
 * This file is part of the CCDNForum ForumBundle
 *
 * (c) CCDN (c) CodeConsortium <http://www.codeconsortium.com/>
 *
 * Available on github <http://www.github.com/codeconsortium/>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace CCDNForum\ForumBundle\Model\Component\Gateway;

use Doctrine\ORM\QueryBuilder;
use CCDNForum\ForumBundle\Model\Component\Gateway\GatewayInterface;
use CCDNForum\ForumBundle\Model\Component\Gateway\BaseGateway;
use CCDNForum\ForumBundle\Entity\Board;

/**
 *
 * @category CCDNForum
 * @package  ForumBundle
 *
 * @author   Reece Fowell <reece@codeconsortium.com>
 * @license  http://opensource.org/licenses/MIT MIT
 * @version  Release: 2.0
 * @link     https://github.com/codeconsortium/CCDNForumForumBundle
 *
 */
class BoardGateway extends BaseGateway implements GatewayInterface
{
    /**
     *
     * @access private
     * @var string $queryAlias
     */
    protected $queryAlias = 'b';

    /**
     *
     * @access public
     * @param  \Doctrine\ORM\QueryBuilder                   $qb

Should the type for parameter $qb not be null|QueryBuilder?

     * @param  Array                                        $parameters

Should the type for parameter $parameters not be array|null? Also, consider making the array more specific, something like array<String>, or String[].

     * @return \Doctrine\Common\Collections\ArrayCollection
     */
    public function findBoard(QueryBuilder $qb = null, $parameters = null)
    {
        if (null == $qb) {
            $qb = $this->createSelectQuery();

Consider using a different name than the parameter $qb. This often makes code more readable.

        }

        $qb->addOrderBy('b.listOrderPriority', 'ASC');

        return $this->one($qb, $parameters);

It seems like $parameters defined by parameter $parameters on line 48 can also be of type null; however, CCDNForum\ForumBundle\Model\Component\Gateway\BaseGateway::one() does only seem to accept array, maybe add an additional type check?

    }

    /**
     *
     * @access public
     * @param  \Doctrine\ORM\QueryBuilder                   $qb

Should the type for parameter $qb not be null|QueryBuilder?

     * @param  Array                                        $parameters

Should the type for parameter $parameters not be array|null? Also, consider making the array more specific, something like array<String>, or String[].

     * @return \Doctrine\Common\Collections\ArrayCollection
     */
    public function findBoards(QueryBuilder $qb = null, $parameters = null)
    {
        if (null == $qb) {
            $qb = $this->createSelectQuery();

Consider using a different name than the parameter $qb. This often makes code more readable.

        }

        $qb->addOrderBy('b.listOrderPriority', 'ASC');

        return $this->all($qb, $parameters);

It seems like $parameters defined by parameter $parameters on line 66 can also be of type null; however, CCDNForum\ForumBundle\Model\Component\Gateway\BaseGateway::all() does only seem to accept array, maybe add an additional type check?

    }

    /**
     *
     * @access public
     * @param  \Doctrine\ORM\QueryBuilder $qb

Should the type for parameter $qb not be null|QueryBuilder?

     * @param  Array                      $parameters

Should the type for parameter $parameters not be array|null? Also, consider making the array more specific, something like array<String>, or String[].

     * @return int
     */
    public function countBoards(QueryBuilder $qb = null, $parameters = null)
    {
        if (null == $qb) {
            $qb = $this->createCountQuery();

Consider using a different name than the parameter $qb. This often makes code more readable.

        }

        if (null == $parameters) {
            $parameters = array();

Consider using a different name than the parameter $parameters. This often makes code more readable.

        }

        $qb->setParameters($parameters);

        try {
            return $qb->getQuery()->getSingleScalarResult();
        } catch (\Doctrine\ORM\NoResultException $e) {
            return 0;
        }
    }

    /**
     *
     * @access public
     * @param  \CCDNForum\ForumBundle\Entity\Board                             $board
     * @return \CCDNForum\ForumBundle\Model\Component\Gateway\GatewayInterface

Consider making the return type a bit more specific; maybe use BoardGateway.

     */
    public function saveBoard(Board $board)
    {
        $this->persist($board)->flush();

        return $this;
    }

    /**
     *
     * @access public
     * @param  \CCDNForum\ForumBundle\Entity\Board                             $board
     * @return \CCDNForum\ForumBundle\Model\Component\Gateway\GatewayInterface

Consider making the return type a bit more specific; maybe use BoardGateway.

     */
    public function updateBoard(Board $board)
    {
        $this->persist($board)->flush();

        return $this;
    }

    /**
     *
     * @access public
     * @param  \CCDNForum\ForumBundle\Entity\Board                             $board
     * @return \CCDNForum\ForumBundle\Model\Component\Gateway\GatewayInterface

Consider making the return type a bit more specific; maybe use BoardGateway.

     */
    public function deleteBoard(Board $board)
    {
        $this->remove($board)->flush();

        return $this;
    }

    /**
     *
     * @access public
     * @return \CCDNForum\ForumBundle\Entity\Board
     */
    public function createBoard()
    {
        return new $this->entityClass();
    }
}