BaseSpecification::modify() - Code Metrics - Inspection of "Merge pull request #280 from peter-gribanov/BaseSp..." - Happyr/Doctrine-Specification - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 588e78...191551 )

by Peter

created 2021-01-20 15:06 UTC

BaseSpecification::modify() A

↳ Parent: BaseSpecification

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	7
c	0
b	0
f	0
rs	10
cc	2
nc	2
nop	2

<?php

/**
 * This file is part of the Happyr Doctrine Specification package.
 *
 * (c) Tobias Nyholm <[email protected]>
 *     Kacper Gunia <[email protected]>
 *     Peter Gribanov <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Happyr\DoctrineSpecification\Specification;

use Doctrine\ORM\QueryBuilder;
use Happyr\DoctrineSpecification\Filter\Filter;
use Happyr\DoctrineSpecification\Query\QueryModifier;

/**
 * Extend this abstract class if you want to build a new spec with your domain logic.
 */
abstract class BaseSpecification implements Specification
{
    /**
     * @var string|null
     */
    private $dqlAlias;

    /**
     * @param string|null $dqlAlias
     */
    public function __construct($dqlAlias = null)
    {
        $this->dqlAlias = $dqlAlias;
    }

    /**
     * @param QueryBuilder $qb
     * @param string       $dqlAlias
     *
     * @return string
     */
    public function getFilter(QueryBuilder $qb, $dqlAlias)
    {
        $spec = $this->getSpec();
        if ($spec instanceof Filter) {
            return $spec->getFilter($qb, $this->getAlias($dqlAlias));
        }

        return '';
    }

    /**
     * @param QueryBuilder $qb
     * @param string       $dqlAlias
     */
    public function modify(QueryBuilder $qb, $dqlAlias)
    {
        $spec = $this->getSpec();
        if ($spec instanceof QueryModifier) {
            $spec->modify($qb, $this->getAlias($dqlAlias));
        }
    }

    /**
     * Return all the specifications.
     *
     * @return Filter|QueryModifier|null
     */
    protected function getSpec()
    {
        @trigger_error('Using the default implementation of '.__METHOD__.' method is deprecated since version 1.1 and this method will be marked as abstract in 2.0. You must overwrite this implementation.', E_USER_DEPRECATED);
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}

        return null;
    }

    /**
     * @param string $dqlAlias
     *
     * @return string
     */
    private function getAlias($dqlAlias)
    {
        if (null !== $this->dqlAlias) {
            return $this->dqlAlias;
        }

        return $dqlAlias;
    }
}


1			<?php
2
3			/**
4			* This file is part of the Happyr Doctrine Specification package.
5			*
6			* (c) Tobias Nyholm <[email protected]>
7			* Kacper Gunia <[email protected]>
8			* Peter Gribanov <[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 Happyr\DoctrineSpecification\Specification;
15
16			use Doctrine\ORM\QueryBuilder;
17			use Happyr\DoctrineSpecification\Filter\Filter;
18			use Happyr\DoctrineSpecification\Query\QueryModifier;
19
20			/**
21			* Extend this abstract class if you want to build a new spec with your domain logic.
22			*/
23			abstract class BaseSpecification implements Specification
24			{
25			/**
26			* @var string\|null
27			*/
28			private $dqlAlias;
29
30			/**
31			* @param string\|null $dqlAlias
32			*/
33			public function __construct($dqlAlias = null)
34			{
35			$this->dqlAlias = $dqlAlias;
36			}
37
38			/**
39			* @param QueryBuilder $qb
40			* @param string $dqlAlias
41			*
42			* @return string
43			*/
44			public function getFilter(QueryBuilder $qb, $dqlAlias)
45			{
46			$spec = $this->getSpec();
47			if ($spec instanceof Filter) {
48			return $spec->getFilter($qb, $this->getAlias($dqlAlias));
49			}
50
51			return '';
52			}
53
54			/**
55			* @param QueryBuilder $qb
56			* @param string $dqlAlias
57			*/
58			public function modify(QueryBuilder $qb, $dqlAlias)
59			{
60			$spec = $this->getSpec();
61			if ($spec instanceof QueryModifier) {
62			$spec->modify($qb, $this->getAlias($dqlAlias));
63			}
64			}
65
66			/**
67			* Return all the specifications.
68			*
69			* @return Filter\|QueryModifier\|null
70			*/
71			protected function getSpec()
72			{
73			@trigger_error('Using the default implementation of '.__METHOD__.' method is deprecated since version 1.1 and this method will be marked as abstract in 2.0. You must overwrite this implementation.', E_USER_DEPRECATED);
			0 ignored issues – show Security Best Practice introduced 2019-11-19 13:21 UTC by Report Bug Copy Issue Report It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended. If you suppress an error, we recommend checking for the error condition explicitly: // For example instead of @mkdir($dir); // Better use if (@mkdir($dir) === false) { throw new \RuntimeException('The directory '.$dir.' could not be created.'); } Loading history...
74
75			return null;
76			}
77
78			/**
79			* @param string $dqlAlias
80			*
81			* @return string
82			*/
83			private function getAlias($dqlAlias)
84			{
85			if (null !== $this->dqlAlias) {
86			return $this->dqlAlias;
87			}
88
89			return $dqlAlias;
90			}
91			}
92

Happyr / Doctrine-Specification

Push — master ( 588e78...191551 )

BaseSpecification::modify() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like