adumitru68 / QueryBuilder

src/Traits/OrderBy.php

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

namespace Qpdb\QueryBuilder\Traits;


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

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

	/**
	 * @param $column
	 * @param array $allowedColumns
	 * @return $this
	 * @throws QueryException
	 */
	public function orderBy( $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 ORDER BY clause', QueryException::QUERY_ERROR_INVALID_COLUMN_NAME );

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

		return $this;
	}


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

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

		return $this;
	}


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

		return $this;
	}


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

		return '';
	}

}