adumitru68 / QueryBuilder

src/Traits/GroupBy.php

<?php
/**
 * Created by PhpStorm.
 * Author: Adrian Dumitru
 * Date: 4/30/2017 9:55 PM
 */

namespace Qpdb\QueryBuilder\Traits;


use Qpdb\QueryBuilder\Dependencies\QueryException;
use Qpdb\QueryBuilder\Dependencies\QueryHelper;
use Qpdb\QueryBuilder\Dependencies\QueryStructure;

/**
 * Trait GroupBy
 * @package Qpdb\QueryBuilder\Traits
 * @property QueryStructure $queryStructure
 */
trait GroupBy
{

	/**
	 * @param $column
	 * @param array $allowedColumns
	 * @return $this
	 * @throws QueryException
	 */
	public function groupBy( $column, array $allowedColumns = [] )
	{
		if ( !$this->validateColumn( $column, $allowedColumns ) )

It seems like validateColumn() must be provided by classes using this trait. How about adding it as abstract method to this trait?

			throw new QueryException( 'Invalid column name in GROUP BY clause', QueryException::QUERY_ERROR_INVALID_COLUMN_NAME );

		$column = $this->queryStructure->prepare($column);
		$this->queryStructure->setElement( QueryStructure::ORDER_BY, $column );

		$this->queryStructure->setElement( QueryStructure::GROUP_BY, $column );

		return $this;
	}


	/**
	 * @param int|string $column
	 * @param array $allowedColumns
	 * @return $this
	 * @throws QueryException
	 */
	public function groupByDesc( $column, array $allowedColumns = [] )
	{
		if ( !$this->validateColumn( $column, $allowedColumns ) )
			throw new QueryException( 'Invalid column name in GROUP BY clause', QueryException::QUERY_ERROR_INVALID_COLUMN_NAME );

		$column = $this->queryStructure->prepare($column);
		$this->queryStructure->setElement( QueryStructure::ORDER_BY, $column );

		$this->queryStructure->setElement( QueryStructure::GROUP_BY, $column . ' DESC' );

		return $this;
	}


	/**
	 * @param $expression
	 * @return $this
	 * @throws QueryException
	 */
	public function groupByExpression( $expression )
	{
		$this->queryStructure->setElement( QueryStructure::GROUP_BY, $expression );

		return $this;
	}


	/**
	 * @return string
	 */
	private function getGroupBySyntax()
	{
		if ( count( $this->queryStructure->getElement( QueryStructure::GROUP_BY ) ) )
			return 'GROUP BY ' . QueryHelper::implode( $this->queryStructure->getElement( QueryStructure::GROUP_BY ), ', ' );

		return '';
	}

}