GroupBy::groupByDesc()   A
last analyzed

Complexity

Conditions 2
Paths 2

Size

Total Lines 11
Code Lines 6

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
eloc 6
dl 0
loc 11
rs 10
c 0
b 0
f 0
cc 2
nc 2
nop 2
1
<?php
2
/**
3
 * Created by PhpStorm.
4
 * Author: Adrian Dumitru
5
 * Date: 4/30/2017 9:55 PM
6
 */
7
8
namespace Qpdb\QueryBuilder\Traits;
9
10
11
use Qpdb\QueryBuilder\Dependencies\QueryException;
12
use Qpdb\QueryBuilder\Dependencies\QueryHelper;
13
use Qpdb\QueryBuilder\Dependencies\QueryStructure;
14
15
/**
16
 * Trait GroupBy
17
 * @package Qpdb\QueryBuilder\Traits
18
 * @property QueryStructure $queryStructure
19
 */
20
trait GroupBy
21
{
22
23
	/**
24
	 * @param $column
25
	 * @param array $allowedColumns
26
	 * @return $this
27
	 * @throws QueryException
28
	 */
29
	public function groupBy( $column, array $allowedColumns = [] )
30
	{
31
		if ( !$this->validateColumn( $column, $allowedColumns ) )
0 ignored issues
show
Bug introduced by
It seems like validateColumn() must be provided by classes using this trait. How about adding it as abstract method to this trait? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-call  annotation

31
		if ( !$this->/** @scrutinizer ignore-call */ validateColumn( $column, $allowedColumns ) )
Loading history...
32
			throw new QueryException( 'Invalid column name in GROUP BY clause', QueryException::QUERY_ERROR_INVALID_COLUMN_NAME );
33
34
		$column = $this->queryStructure->prepare($column);
35
		$this->queryStructure->setElement( QueryStructure::ORDER_BY, $column );
36
37
		$this->queryStructure->setElement( QueryStructure::GROUP_BY, $column );
38
39
		return $this;
40
	}
41
42
43
	/**
44
	 * @param int|string $column
45
	 * @param array $allowedColumns
46
	 * @return $this
47
	 * @throws QueryException
48
	 */
49
	public function groupByDesc( $column, array $allowedColumns = [] )
50
	{
51
		if ( !$this->validateColumn( $column, $allowedColumns ) )
52
			throw new QueryException( 'Invalid column name in GROUP BY clause', QueryException::QUERY_ERROR_INVALID_COLUMN_NAME );
53
54
		$column = $this->queryStructure->prepare($column);
55
		$this->queryStructure->setElement( QueryStructure::ORDER_BY, $column );
56
57
		$this->queryStructure->setElement( QueryStructure::GROUP_BY, $column . ' DESC' );
58
59
		return $this;
60
	}
61
62
63
	/**
64
	 * @param $expression
65
	 * @return $this
66
	 * @throws QueryException
67
	 */
68
	public function groupByExpression( $expression )
69
	{
70
		$this->queryStructure->setElement( QueryStructure::GROUP_BY, $expression );
71
72
		return $this;
73
	}
74
75
76
	/**
77
	 * @return string
78
	 */
79
	private function getGroupBySyntax()
80
	{
81
		if ( count( $this->queryStructure->getElement( QueryStructure::GROUP_BY ) ) )
82
			return 'GROUP BY ' . QueryHelper::implode( $this->queryStructure->getElement( QueryStructure::GROUP_BY ), ', ' );
83
84
		return '';
85
	}
86
87
}