rhymix/classes/db/queryparts/Query.class.php

<?php
/* Copyright (C) NAVER <http://www.navercorp.com> */

/**
 * @author NAVER (developers@xpressengine.com)
 * @package /classes/db/queryparts
 * @version 0.1
 */
class Query extends BaseObject
{

	/**
	 * Query id, defined in query xml file
	 * @var string
	 */
	var $queryID;

	/**
	 * DML type, ex) INSERT, DELETE, UPDATE, SELECT
	 * @var string
	 */
	var $action;

	/**
	 * priority level ex)LOW_PRIORITY, HIGHT_PRIORITY
	 * @var string
	 */
	var $priority;

	/**
	 * column list
	 * @var string|array
	 */
	var $columns;

	/**
	 * table list
	 * @var string|array
	 */
	var $tables;

	/**
	 * condition list
	 * @var string|array
	 */
	var $conditions;

	/**
	 * group list
	 * @var string|array
	 */
	var $groups;

	/**
	 * having list
	 * @var string|array
	 */
	var $having;

	/**
	 * order list
	 * @var array
	 */
	var $orderby;

	/**
	 * limit count
	 * @var int
	 */
	var $limit;

	/**
	 * argument list
	 * @var array
	 */
	var $arguments = NULL;

	/**
	 * column list
	 * @var array
	 */
	var $columnList = NULL;

	/**
	 * order by text
	 * @var string
	 */
	var $_orderByString;

	/**
	 * constructor
	 * @param string $queryID
	 * @param string $action
	 * @param string|array $columns
	 * @param string|array $tables
	 * @param string|array $conditions
	 * @param string|array $groups
	 * @param string|array $orderby
	 * @param int $limit
	 * @param string $priority
	 * @return void
	 */
	function __construct($queryID = NULL
	, $action = NULL
	, $columns = NULL
	, $tables = NULL
	, $conditions = NULL
	, $groups = NULL
	, $orderby = NULL
	, $limit = NULL
	, $priority = NULL)
	{
		$this->queryID = $queryID;
		$this->action = $action;
		$this->priority = $priority;

		if(!isset($tables))
		{
			return;
		}

		$this->columns = $this->setColumns($columns);
		$this->tables = $this->setTables($tables);
		$this->conditions = $this->setConditions($conditions);
		$this->groups = $this->setGroups($groups);
		$this->orderby = $this->setOrder($orderby);
		$this->limit = $this->setLimit($limit);
	}

	function show()
	{
		return TRUE;
	}

	function setQueryId($queryID)
	{
		$this->queryID = $queryID;
	}

	function setAction($action)
	{
		$this->action = $action;
	}

	function setPriority($priority)
	{
		$this->priority = $priority;
	}

	function setColumnList($columnList)
	{
		$this->columnList = $columnList;
		if (!is_countable($this->columnList)) return;
		
		if(count($this->columnList) > 0)
		{
			$selectColumns = array();
			$dbParser = DB::getParser();

			foreach($this->columnList as $columnName)
			{
				$columnName = $dbParser->escapeColumnExpression($columnName);
				$selectColumns[] = new SelectExpression($columnName);
			}
			unset($this->columns);
			$this->columns = $selectColumns;
		}
	}

	function setColumns($columns)
	{
		if(!isset($columns) || count($columns) === 0)
		{
			$this->columns = array(new StarExpression());
			return;
		}

		if(!is_array($columns))
		{
			$columns = array($columns);
		}

		$this->columns = $columns;
	}

	function setTables($tables)
	{
		if(!isset($tables) || count($tables) === 0)
		{
			$this->setError(TRUE);
			$this->setMessage("You must provide at least one table for the query.");
			return;
		}

		if(!is_array($tables))
		{
			$tables = array($tables);
		}

		$this->tables = $tables;
	}

	function setSubquery($subquery)
	{
		$this->subquery = $subquery;
	}

	function setConditions($conditions)
	{
		$this->conditions = array();
		if(!isset($conditions) || count($conditions) === 0)
		{
			return;
		}
		if(!is_array($conditions))
		{
			$conditions = array($conditions);
		}

		foreach($conditions as $conditionGroup)
		{
			if($conditionGroup->show())
			{
				$this->conditions[] = $conditionGroup;
			}
		}
	}

	function setGroups($groups)
	{
		if(!isset($groups) || count($groups) === 0)
		{
			return;
		}
		if(!is_array($groups))
		{
			$groups = array($groups);
		}

		$this->groups = $groups;
	}

	function setHaving($conditions)
	{
		$this->having = array();
		if(!isset($conditions) || count($conditions) === 0)
		{
			return;
		}
		if(!is_array($conditions))
		{
			$conditions = array($conditions);
		}

		foreach($conditions as $conditionGroup)
		{
			if($conditionGroup->show())
			{
				$this->having[] = $conditionGroup;
			}
		}
	}

	function setOrder($order)
	{
		if(!isset($order) || count($order) === 0)
		{
			return;
		}
		if(!is_array($order))
		{
			$order = array($order);
		}

		$this->orderby = $order;
	}

	function getOrder()
	{
		return $this->orderby;
	}

	function setLimit($limit = NULL)
	{
		if(!isset($limit))
		{
			return;
		}
		$this->limit = $limit;
	}

	// START Fluent interface
	/**
	 * seleect set
	 * @param string|array $columns
	 * @return Query return Query instance
	 */
	function select($columns = NULL)
	{
		$this->action = 'select';
		$this->setColumns($columns);
		return $this;
	}

	/**
	 * from set
	 * @param string|array $tables
	 * @return Query return Query instance
	 */
	function from($tables)
	{
		$this->setTables($tables);
		return $this;
	}

	/**
	 * where set
	 * @param string|array $conditions
	 * @return Query return Query instance
	 */
	function where($conditions)
	{
		$this->setConditions($conditions);
		return $this;
	}

	/**
	 * groupBy set
	 * @param string|array $groups
	 * @return Query return Query instance
	 */
	function groupBy($groups)
	{
		$this->setGroups($groups);
		return $this;
	}

	/**
	 * orderBy set
	 * @param string|array $order
	 * @return Query return Query instance
	 */
	function orderBy($order)
	{
		$this->setOrder($order);
		return $this;
	}

	/**
	 * limit set
	 * @param int $limit
	 * @return Query return Query instance
	 */
	function limit($limit)
	{
		$this->setLimit($limit);
		return $this;
	}

	// END Fluent interface

	function getAction()
	{
		return $this->action;
	}

	function getPriority()
	{
		return $this->priority ? 'LOW_PRIORITY' : '';
	}

	/**
	 * Check if current query uses the click count attribute
	 * For CUBRID, this statement uses the click count feature.
	 * For the other databases, using this attribute causes a query
	 * to produce both a select and an update
	 */
	function usesClickCount()
	{
		return count($this->getClickCountColumns()) > 0;
	}

	function getClickCountColumns()
	{
		$click_count_columns = array();
		foreach($this->columns as $column)
		{
			if($column->show() && is_a($column, 'ClickCountExpression'))
			{
				$click_count_columns[] = $column;
			}
		}
		return $click_count_columns;
	}

	/**
	 * Return select sql
	 * @param boolean $with_values
	 * @return string
	 */
	function getSelectString($with_values = TRUE)
	{
		foreach($this->columns as $column)
		{
			if($column->show())
			{
				if($column->isSubquery())
				{
					$select[] = $column->toString($with_values) . ' as ' . $column->getAlias();
				}
				else
				{
					$select[] = $column->getExpression($with_values);
				}
			}
		}
		return trim(implode($select, ', '));
	}

	/**
	 * Return update sql
	 * @param boolean $with_values
	 * @return string
	 */
	function getUpdateString($with_values = TRUE)
	{
		foreach($this->columns as $column)
		{
			if($column->show())
			{
				$update[] = $column->getExpression($with_values);
			}
		}

		if(!$update) return;
		return trim(implode($update, ', '));
	}

	/**
	 * Return insert sql
	 * @param boolean $with_values
	 * @return string
	 */
	function getInsertString($with_values = TRUE)
	{
		$columnsList = '';
		// means we have insert-select
		if($this->subquery)
		{
			foreach($this->columns as $column)
			{
				$columnsList .= $column->getColumnName() . ', ';
			}
			$columnsList = substr($columnsList, 0, -2);
			$selectStatement = $this->subquery->toString($with_values);
			$selectStatement = substr($selectStatement, 1, -1);
			return "($columnsList) \n $selectStatement";
		}

		$valuesList = '';
		foreach($this->columns as $column)
		{
			if($column->show())
			{
				$columnsList .= $column->getColumnName() . ', ';
				$valuesList .= $column->getValue($with_values) . ', ';
			}
		}
		$columnsList = substr($columnsList, 0, -2);
		$valuesList = substr($valuesList, 0, -2);

		return "($columnsList) \n VALUES ($valuesList)";
	}

	function getTables()
	{
		return $this->tables;
	}

	/**
	 * from table_a
	 * from table_a inner join table_b on x=y
	 * from (select * from table a) as x
	 * from (select * from table t) as x inner join table y on y.x
	 * @param boolean $with_values
	 * @return string
	 */
	function getFromString($with_values = TRUE)
	{
		$from = '';
		$simple_table_count = 0;
		foreach($this->tables as $table)
		{
			if($table->isJoinTable() || !$simple_table_count)
			{
				$from .= $table->toString($with_values) . ' ';
			}
			else
			{
				$from .= ', ' . $table->toString($with_values) . ' ';
			}

			if(is_a($table, 'Subquery'))
			{
				$from .= $table->getAlias() ? ' as ' . $table->getAlias() . ' ' : ' ';
			}

			$simple_table_count++;
		}
		if(trim($from) == '')
		{
			return '';
		}
		return $from;
	}

	/**
	 * Return where sql
	 * @param boolean $with_values
	 * @param boolean $with_optimization
	 * @return string
	 */
	function getWhereString($with_values = TRUE, $with_optimization = TRUE)
	{
		$where = '';
		$condition_count = 0;

		foreach($this->conditions as $conditionGroup)
		{
			if($condition_count === 0)
			{
				$conditionGroup->setPipe("");
			}
			$condition_string = $conditionGroup->toString($with_values);
			$where .= $condition_string;
			$condition_count++;
		}

		if($with_optimization &&
				(strstr($this->getOrderByString(), 'list_order') || strstr($this->getOrderByString(), 'update_order')))
		{

			if($condition_count !== 0)
			{
				$where = '(' . $where . ') ';
			}

			foreach($this->orderby as $order)
			{
				$colName = $order->getColumnName();
				if(strstr($colName, 'list_order') || strstr($colName, 'update_order'))
				{
					$opt_condition = new ConditionWithoutArgument($colName, 2100000000, 'less', 'and');
					if($condition_count === 0)
					{
						$opt_condition->setPipe("");
					}
					$where .= $opt_condition->toString($with_values) . ' ';
					$condition_count++;
				}
			}
		}

		return trim($where);
	}

	/**
	 * Return groupby sql
	 * @return string
	 */
	function getGroupByString()
	{
		$groupBy = '';
		if($this->groups)
		{
			if($this->groups[0] !== "")
			{
				$groupBy = implode(', ', $this->groups);
			}
		}
		return $groupBy;
	}

	/**
	 * Return having sql
	 * @param boolean $with_values
	 * @return string
	 */
	function getHavingString($with_values = TRUE)
	{
		if(!is_array($this->having))
		{
			return '';
		}
		
		$having = '';
		$condition_count = 0;

		foreach($this->having as $conditionGroup)
		{
			if($condition_count === 0)
			{
				$conditionGroup->setPipe("");
			}
			$condition_string = $conditionGroup->toString($with_values);
			$having .= $condition_string;
			$condition_count++;
		}

		return trim($having);
	}

	/**
	 * Return orderby sql
	 * @return string
	 */
	function getOrderByString()
	{
		if(!$this->_orderByString)
		{
			if(countobj($this->orderby) === 0)
			{
				return '';
			}
			$orderBy = '';
			foreach($this->orderby as $order)
			{
				$orderBy .= $order->toString() . ', ';
			}
			$orderBy = substr($orderBy, 0, -2);
			$this->_orderByString = $orderBy;
		}
		return $this->_orderByString;
	}

	function getLimit()
	{
		return $this->limit;
	}

	/**
	 * Return limit sql
	 * @return string
	 */
	function getLimitString()
	{
		$limit = '';
		if(countobj($this->limit) > 0)
		{
			$limit = '';
			$limit .= $this->limit->toString();
		}
		return $limit;
	}

	function getFirstTableName()
	{
		return $this->tables[0]->getName();
	}

	/**
	 * Return argument list
	 * @return array
	 */
	function getArguments()
	{
		if(!isset($this->arguments))
		{
			$this->arguments = array();

			// Join table arguments
			if(countobj($this->tables) > 0)
			{
				foreach($this->tables as $table)
				{
					if($table->isJoinTable() || is_a($table, 'Subquery'))
					{
						$args = $table->getArguments();
						if($args)
						{
							$this->arguments = array_merge($this->arguments, $args);
						}
					}
				}
			}

			// Column arguments
			// The if is for delete statements, all others must have columns
			if(countobj($this->columns) > 0)
			{
				foreach($this->columns as $column)
				{
					if($column->show())
					{
						$args = $column->getArguments();
						if($args)
						{
							$this->arguments = array_merge($this->arguments, $args);
						}
					}
				}
			}

			// Condition arguments
			if(countobj($this->conditions) > 0)
			{
				foreach($this->conditions as $conditionGroup)
				{
					$args = $conditionGroup->getArguments();
					if(countobj($args) > 0)
					{
						$this->arguments = array_merge($this->arguments, $args);
					}
				}
			}

			// Having arguments
			if(countobj($this->having) > 0)
			{
				foreach($this->having as $conditionGroup)
				{
					$args = $conditionGroup->getArguments();
					if(countobj($args) > 0)
					{
						$this->arguments = array_merge($this->arguments, $args);
					}
				}
			}

			// Navigation arguments
			if(countobj($this->orderby) > 0)
			{
				foreach($this->orderby as $order)
				{
					$args = $order->getArguments();
					if(countobj($args) > 0)
					{
						$this->arguments = array_merge($this->arguments, $args);
					}
				}
			}
		}
		
		return $this->arguments;
	}

}
/* End of file Query.class.php */
/* Location: ./classes/db/queryparts/Query.class.php */