InConditionBuilder.php 7.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241
  1. <?php
  2. /**
  3. * @link http://www.yiiframework.com/
  4. * @copyright Copyright (c) 2008 Yii Software LLC
  5. * @license http://www.yiiframework.com/license/
  6. */
  7. namespace yii\db\conditions;
  8. use yii\db\ExpressionBuilderInterface;
  9. use yii\db\ExpressionBuilderTrait;
  10. use yii\db\ExpressionInterface;
  11. use yii\db\Query;
  12. /**
  13. * Class InConditionBuilder builds objects of [[InCondition]]
  14. *
  15. * @author Dmytro Naumenko <d.naumenko.a@gmail.com>
  16. * @since 2.0.14
  17. */
  18. class InConditionBuilder implements ExpressionBuilderInterface
  19. {
  20. use ExpressionBuilderTrait;
  21. /**
  22. * Method builds the raw SQL from the $expression that will not be additionally
  23. * escaped or quoted.
  24. *
  25. * @param ExpressionInterface|InCondition $expression the expression to be built.
  26. * @param array $params the binding parameters.
  27. * @return string the raw SQL that will not be additionally escaped or quoted.
  28. */
  29. public function build(ExpressionInterface $expression, array &$params = [])
  30. {
  31. $operator = $expression->getOperator();
  32. $column = $expression->getColumn();
  33. $values = $expression->getValues();
  34. if ($column === []) {
  35. // no columns to test against
  36. return $operator === 'IN' ? '0=1' : '';
  37. }
  38. if ($values instanceof Query) {
  39. return $this->buildSubqueryInCondition($operator, $column, $values, $params);
  40. }
  41. if (!is_array($values) && !$values instanceof \Traversable) {
  42. // ensure values is an array
  43. $values = (array) $values;
  44. }
  45. if (is_array($column)) {
  46. if (count($column) > 1) {
  47. return $this->buildCompositeInCondition($operator, $column, $values, $params);
  48. } else {
  49. $column = reset($column);
  50. }
  51. }
  52. if ($column instanceof \Traversable) {
  53. if (iterator_count($column) > 1) {
  54. return $this->buildCompositeInCondition($operator, $column, $values, $params);
  55. } else {
  56. $column->rewind();
  57. $column = $column->current();
  58. }
  59. }
  60. if (is_array($values)) {
  61. $rawValues = $values;
  62. } elseif ($values instanceof \Traversable) {
  63. $rawValues = $this->getRawValuesFromTraversableObject($values);
  64. }
  65. if (isset($rawValues) && in_array(null, $rawValues, true)) {
  66. $nullCondition = $this->getNullCondition($operator, $column);
  67. $nullConditionOperator = $operator === 'IN' ? 'OR' : 'AND';
  68. }
  69. $sqlValues = $this->buildValues($expression, $values, $params);
  70. if (empty($sqlValues)) {
  71. if (!isset($nullCondition)) {
  72. return $operator === 'IN' ? '0=1' : '';
  73. }
  74. return $nullCondition;
  75. }
  76. if (strpos($column, '(') === false) {
  77. $column = $this->queryBuilder->db->quoteColumnName($column);
  78. }
  79. if (count($sqlValues) > 1) {
  80. $sql = "$column $operator (" . implode(', ', $sqlValues) . ')';
  81. } else {
  82. $operator = $operator === 'IN' ? '=' : '<>';
  83. $sql = $column . $operator . reset($sqlValues);
  84. }
  85. return isset($nullCondition) ? sprintf('%s %s %s', $sql, $nullConditionOperator, $nullCondition) : $sql;
  86. }
  87. /**
  88. * Builds $values to be used in [[InCondition]]
  89. *
  90. * @param ConditionInterface|InCondition $condition
  91. * @param array $values
  92. * @param array $params the binding parameters
  93. * @return array of prepared for SQL placeholders
  94. */
  95. protected function buildValues(ConditionInterface $condition, $values, &$params)
  96. {
  97. $sqlValues = [];
  98. $column = $condition->getColumn();
  99. if (is_array($column)) {
  100. $column = reset($column);
  101. }
  102. if ($column instanceof \Traversable) {
  103. $column->rewind();
  104. $column = $column->current();
  105. }
  106. foreach ($values as $i => $value) {
  107. if (is_array($value) || $value instanceof \ArrayAccess) {
  108. $value = isset($value[$column]) ? $value[$column] : null;
  109. }
  110. if ($value === null) {
  111. continue;
  112. } elseif ($value instanceof ExpressionInterface) {
  113. $sqlValues[$i] = $this->queryBuilder->buildExpression($value, $params);
  114. } else {
  115. $sqlValues[$i] = $this->queryBuilder->bindParam($value, $params);
  116. }
  117. }
  118. return $sqlValues;
  119. }
  120. /**
  121. * Builds SQL for IN condition.
  122. *
  123. * @param string $operator
  124. * @param array|string $columns
  125. * @param Query $values
  126. * @param array $params
  127. * @return string SQL
  128. */
  129. protected function buildSubqueryInCondition($operator, $columns, $values, &$params)
  130. {
  131. $sql = $this->queryBuilder->buildExpression($values, $params);
  132. if (is_array($columns)) {
  133. foreach ($columns as $i => $col) {
  134. if (strpos($col, '(') === false) {
  135. $columns[$i] = $this->queryBuilder->db->quoteColumnName($col);
  136. }
  137. }
  138. return '(' . implode(', ', $columns) . ") $operator $sql";
  139. }
  140. if (strpos($columns, '(') === false) {
  141. $columns = $this->queryBuilder->db->quoteColumnName($columns);
  142. }
  143. return "$columns $operator $sql";
  144. }
  145. /**
  146. * Builds SQL for IN condition.
  147. *
  148. * @param string $operator
  149. * @param array|\Traversable $columns
  150. * @param array $values
  151. * @param array $params
  152. * @return string SQL
  153. */
  154. protected function buildCompositeInCondition($operator, $columns, $values, &$params)
  155. {
  156. $vss = [];
  157. foreach ($values as $value) {
  158. $vs = [];
  159. foreach ($columns as $column) {
  160. if (isset($value[$column])) {
  161. $vs[] = $this->queryBuilder->bindParam($value[$column], $params);
  162. } else {
  163. $vs[] = 'NULL';
  164. }
  165. }
  166. $vss[] = '(' . implode(', ', $vs) . ')';
  167. }
  168. if (empty($vss)) {
  169. return $operator === 'IN' ? '0=1' : '';
  170. }
  171. $sqlColumns = [];
  172. foreach ($columns as $i => $column) {
  173. $sqlColumns[] = strpos($column, '(') === false ? $this->queryBuilder->db->quoteColumnName($column) : $column;
  174. }
  175. return '(' . implode(', ', $sqlColumns) . ") $operator (" . implode(', ', $vss) . ')';
  176. }
  177. /**
  178. * Builds is null/is not null condition for column based on operator
  179. *
  180. * @param string $operator
  181. * @param string $column
  182. * @return string is null or is not null condition
  183. * @since 2.0.31
  184. */
  185. protected function getNullCondition($operator, $column) {
  186. $column = $this->queryBuilder->db->quoteColumnName($column);
  187. if ($operator === 'IN') {
  188. return sprintf('%s IS NULL', $column);
  189. }
  190. return sprintf('%s IS NOT NULL', $column);
  191. }
  192. /**
  193. * @param \Traversable $traversableObject
  194. * @return array raw values
  195. * @since 2.0.31
  196. */
  197. protected function getRawValuesFromTraversableObject(\Traversable $traversableObject)
  198. {
  199. $rawValues = [];
  200. foreach ($traversableObject as $value) {
  201. if (is_array($value)) {
  202. $values = array_values($value);
  203. $rawValues = array_merge($rawValues, $values);
  204. } else {
  205. $rawValues[] = $value;
  206. }
  207. }
  208. return $rawValues;
  209. }
  210. }