3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
6 | This work is published under the GNU AGPLv3 license with some |
7 | permitted exceptions and without any warranty. For full license |
8 | and copyright information, see https://civicrm.org/licensing |
9 +--------------------------------------------------------------------+
12 namespace Civi\Api4\Query
;
14 use Civi\Api4\Service\Schema\Joinable\CustomGroupJoinable
;
15 use Civi\Api4\Utils\FormattingUtil
;
16 use Civi\Api4\Utils\CoreUtil
;
17 use Civi\Api4\Utils\SelectUtil
;
20 * A query `node` may be in one of three formats:
22 * * leaf: [$fieldName, $operator, $criteria]
23 * * negated: ['NOT', $node]
24 * * branch: ['OR|NOT', [$node, $node, ...]]
26 * Leaf operators are one of:
28 * * '=', '<=', '>=', '>', '<', 'LIKE', "<>", "!=",
29 * * "NOT LIKE", 'IN', 'NOT IN', 'BETWEEN', 'NOT BETWEEN',
30 * * 'IS NOT NULL', or 'IS NULL'.
32 class Api4SelectQuery
{
35 MAIN_TABLE_ALIAS
= 'a',
36 UNLIMITED
= '18446744073709551615';
39 * @var \CRM_Utils_SQL_Select
46 protected $joins = [];
51 protected $apiFieldSpec;
56 protected $entityFieldNames = [];
61 protected $aclFields = [];
64 * @var \Civi\Api4\Generic\DAOGetAction
72 protected $selectAliases = [];
77 public $forceSelectId = TRUE;
80 * @param \Civi\Api4\Generic\DAOGetAction $apiGet
82 public function __construct($apiGet) {
85 // Always select ID of main table unless grouping by something else
86 $this->forceSelectId
= !$this->getGroupBy() ||
$this->getGroupBy() === ['id'];
89 foreach ($this->api
->entityFields() as $field) {
90 $this->entityFieldNames
[] = $field['name'];
91 $field['sql_name'] = '`' . self
::MAIN_TABLE_ALIAS
. '`.`' . $field['column_name'] . '`';
92 $this->addSpecField($field['name'], $field);
95 $tableName = CoreUtil
::getTableName($this->getEntity());
96 $this->query
= \CRM_Utils_SQL_Select
::from($tableName . ' ' . self
::MAIN_TABLE_ALIAS
);
98 // Add ACLs first to avoid redundant subclauses
99 $baoName = CoreUtil
::getBAOFromApiName($this->getEntity());
100 $this->query
->where($this->getAclClause(self
::MAIN_TABLE_ALIAS
, $baoName));
104 * Builds main final sql statement after initialization.
107 * @throws \API_Exception
108 * @throws \CRM_Core_Exception
110 public function getSql() {
111 // Add explicit joins. Other joins implied by dot notation may be added later
112 $this->addExplicitJoins();
113 $this->buildSelectClause();
114 $this->buildWhereClause();
115 $this->buildOrderBy();
117 $this->buildGroupBy();
118 $this->buildHavingClause();
119 return $this->query
->toSQL();
123 * Why walk when you can
127 public function run() {
129 $sql = $this->getSql();
130 $this->debug('sql', $sql);
131 $query = \CRM_Core_DAO
::executeQuery($sql);
132 while ($query->fetch()) {
134 foreach ($this->selectAliases
as $alias => $expr) {
135 $returnName = $alias;
136 $alias = str_replace('.', '_', $alias);
137 $result[$returnName] = property_exists($query, $alias) ?
$query->$alias : NULL;
139 $results[] = $result;
141 FormattingUtil
::formatOutputValues($results, $this->apiFieldSpec
, $this->getEntity());
147 * @throws \API_Exception
149 public function getCount() {
150 $this->addExplicitJoins();
151 $this->buildWhereClause();
152 // If no having or groupBy, we only need to select count
153 if (!$this->getHaving() && !$this->getGroupBy()) {
154 $this->query
->select('COUNT(*) AS `c`');
155 $sql = $this->query
->toSQL();
157 // Use a subquery to count groups from GROUP BY or results filtered by HAVING
159 // With no HAVING, just select the last field grouped by
160 if (!$this->getHaving()) {
161 $select = array_slice($this->getGroupBy(), -1);
163 $this->buildSelectClause($select ??
NULL);
164 $this->buildHavingClause();
165 $this->buildGroupBy();
166 $subquery = $this->query
->toSQL();
167 $sql = "SELECT count(*) AS `c` FROM ( $subquery ) AS rows";
169 $this->debug('sql', $sql);
170 return (int) \CRM_Core_DAO
::singleValueQuery($sql);
174 * @param array $select
175 * Array of select expressions; defaults to $this->getSelect
176 * @throws \API_Exception
178 protected function buildSelectClause($select = NULL) {
179 // Use default if select not provided, exclude row_count which is handled elsewhere
180 $select = array_diff($select ??
$this->getSelect(), ['row_count']);
181 // An empty select is the same as *
182 if (empty($select)) {
183 $select = $this->entityFieldNames
;
186 if ($this->forceSelectId
) {
187 $select = array_merge(['id'], $select);
190 // Expand wildcards in joins (the api wrapper already expanded non-joined wildcards)
191 $wildFields = array_filter($select, function($item) {
192 return strpos($item, '*') !== FALSE && strpos($item, '.') !== FALSE && strpos($item, '(') === FALSE && strpos($item, ' ') === FALSE;
194 foreach ($wildFields as $item) {
195 $pos = array_search($item, array_values($select));
196 $this->autoJoinFK($item);
197 $matches = SelectUtil
::getMatchingFields($item, array_keys($this->apiFieldSpec
));
198 array_splice($select, $pos, 1, $matches);
200 $select = array_unique($select);
202 foreach ($select as $item) {
203 $expr = SqlExpression
::convert($item, TRUE);
205 foreach ($expr->getFields() as $fieldName) {
206 $field = $this->getField($fieldName);
207 // Remove expressions with unknown fields without raising an error
209 $select = array_diff($select, [$item]);
210 $this->debug('undefined_fields', $fieldName);
215 $alias = $expr->getAlias();
216 if ($alias != $expr->getExpr() && isset($this->apiFieldSpec
[$alias])) {
217 throw new \
API_Exception('Cannot use existing field name as alias');
219 $this->selectAliases
[$alias] = $expr->getExpr();
220 $this->query
->select($expr->render($this->apiFieldSpec
) . " AS `$alias`");
226 * Add WHERE clause to query
228 protected function buildWhereClause() {
229 foreach ($this->getWhere() as $clause) {
230 $sql = $this->treeWalkClauses($clause, 'WHERE');
232 $this->query
->where($sql);
238 * Add HAVING clause to query
240 * Every expression referenced must also be in the SELECT clause.
242 protected function buildHavingClause() {
243 foreach ($this->getHaving() as $clause) {
244 $this->query
->having($this->treeWalkClauses($clause, 'HAVING'));
249 * Add ORDER BY to query
251 protected function buildOrderBy() {
252 foreach ($this->getOrderBy() as $item => $dir) {
253 if ($dir !== 'ASC' && $dir !== 'DESC') {
254 throw new \
API_Exception("Invalid sort direction. Cannot order by $item $dir");
256 $expr = $this->getExpression($item);
257 $column = $expr->render($this->apiFieldSpec
);
259 // Use FIELD() function to sort on pseudoconstant values
260 $suffix = strstr($item, ':');
261 if ($suffix && $expr->getType() === 'SqlField') {
262 $field = $this->getField($item);
263 $options = FormattingUtil
::getPseudoconstantList($field['entity'], $field['name'], substr($suffix, 1));
266 $column = "FIELD($column,'" . implode("','", array_keys($options)) . "')";
269 $this->query
->orderBy("$column $dir");
276 * @throws \CRM_Core_Exception
278 protected function buildLimit() {
279 if ($this->getLimit() ||
$this->getOffset()) {
280 // If limit is 0, mysql will actually return 0 results. Instead set to maximum possible.
281 $this->query
->limit($this->getLimit() ?
: self
::UNLIMITED
, $this->getOffset());
286 * Add GROUP BY clause to query
288 protected function buildGroupBy() {
289 foreach ($this->getGroupBy() as $item) {
290 $this->query
->groupBy($this->getExpression($item)->render($this->apiFieldSpec
));
295 * Recursively validate and transform a branch or leaf clause array to SQL.
297 * @param array $clause
298 * @param string $type
300 * @return string SQL where clause
302 * @throws \API_Exception
303 * @uses composeClause() to generate the SQL etc.
305 protected function treeWalkClauses($clause, $type) {
307 if (in_array($clause[0], ['AND', 'OR', 'NOT']) && empty($clause[1])) {
310 switch ($clause[0]) {
314 if (count($clause[1]) === 1) {
315 // a single set so AND|OR is immaterial
316 return $this->treeWalkClauses($clause[1][0], $type);
319 $sql_subclauses = [];
320 foreach ($clause[1] as $subclause) {
321 $sql_subclauses[] = $this->treeWalkClauses($subclause, $type);
323 return '(' . implode("\n" . $clause[0], $sql_subclauses) . ')';
327 // If we get a group of clauses with no operator, assume AND
328 if (!is_string($clause[1][0])) {
329 $clause[1] = ['AND', $clause[1]];
331 return 'NOT (' . $this->treeWalkClauses($clause[1], $type) . ')';
334 return $this->composeClause($clause, $type);
339 * Validate and transform a leaf clause array to SQL.
340 * @param array $clause [$fieldName, $operator, $criteria]
341 * @param string $type
344 * @throws \API_Exception
347 protected function composeClause(array $clause, string $type) {
348 // Pad array for unary operators
349 list($expr, $operator, $value) = array_pad($clause, 3, NULL);
350 if (!in_array($operator, \CRM_Core_DAO
::acceptedSQLOperators(), TRUE)) {
351 throw new \
API_Exception('Illegal operator');
354 // For WHERE clause, expr must be the name of a field.
355 if ($type === 'WHERE') {
356 $field = $this->getField($expr, TRUE);
357 FormattingUtil
::formatInputValue($value, $expr, $field);
358 $fieldAlias = $field['sql_name'];
360 // For HAVING, expr must be an item in the SELECT clause
361 elseif ($type === 'HAVING') {
362 // Expr references a fieldName or alias
363 if (isset($this->selectAliases
[$expr])) {
365 // Attempt to format if this is a real field
366 if (isset($this->apiFieldSpec
[$expr])) {
367 FormattingUtil
::formatInputValue($value, $expr, $this->apiFieldSpec
[$expr]);
370 // Expr references a non-field expression like a function; convert to alias
371 elseif (in_array($expr, $this->selectAliases
)) {
372 $fieldAlias = array_search($expr, $this->selectAliases
);
374 // If either the having or select field contains a pseudoconstant suffix, match and perform substitution
376 list($fieldName) = explode(':', $expr);
377 foreach ($this->selectAliases
as $selectAlias => $selectExpr) {
378 list($selectField) = explode(':', $selectAlias);
379 if ($selectAlias === $selectExpr && $fieldName === $selectField && isset($this->apiFieldSpec
[$fieldName])) {
380 FormattingUtil
::formatInputValue($value, $expr, $this->apiFieldSpec
[$fieldName]);
381 $fieldAlias = $selectAlias;
386 if (!isset($fieldAlias)) {
387 throw new \
API_Exception("Invalid expression in HAVING clause: '$expr'. Must use a value from SELECT clause.");
389 $fieldAlias = '`' . $fieldAlias . '`';
391 elseif ($type === 'ON') {
392 $expr = $this->getExpression($expr);
393 $fieldName = count($expr->getFields()) === 1 ?
$expr->getFields()[0] : NULL;
394 $fieldAlias = $expr->render($this->apiFieldSpec
);
395 if (is_string($value)) {
396 $valExpr = $this->getExpression($value);
397 if ($fieldName && $valExpr->getType() === 'SqlString') {
398 FormattingUtil
::formatInputValue($valExpr->expr
, $fieldName, $this->apiFieldSpec
[$fieldName]);
400 return sprintf('%s %s %s', $fieldAlias, $operator, $valExpr->render($this->apiFieldSpec
));
402 elseif ($fieldName) {
403 FormattingUtil
::formatInputValue($value, $fieldName, $this->apiFieldSpec
[$fieldName]);
407 $sql_clause = \CRM_Core_DAO
::createSQLFilter($fieldAlias, [$operator => $value]);
408 if ($sql_clause === NULL) {
409 throw new \
API_Exception("Invalid value in $type clause for '$expr'");
415 * @param string $expr
416 * @return SqlExpression
417 * @throws \API_Exception
419 protected function getExpression(string $expr) {
420 $sqlExpr = SqlExpression
::convert($expr);
421 foreach ($sqlExpr->getFields() as $fieldName) {
422 $this->getField($fieldName, TRUE);
428 * Get acl clause for an entity
430 * @param string $tableAlias
431 * @param \CRM_Core_DAO|string $baoName
432 * @param array $stack
435 public function getAclClause($tableAlias, $baoName, $stack = []) {
436 if (!$this->getCheckPermissions()) {
439 // Prevent (most) redundant acl sub clauses if they have already been applied to the main entity.
440 // FIXME: Currently this only works 1 level deep, but tracking through multiple joins would increase complexity
441 // and just doing it for the first join takes care of most acl clause deduping.
442 if (count($stack) === 1 && in_array($stack[0], $this->aclFields
, TRUE)) {
445 $clauses = $baoName::getSelectWhereClause($tableAlias);
447 // Track field clauses added to the main entity
448 $this->aclFields
= array_keys($clauses);
450 return array_filter($clauses);
454 * Fetch a field from the getFields list
456 * @param string $expr
457 * @param bool $strict
458 * In strict mode, this will throw an exception if the field doesn't exist
461 * @throws \API_Exception
463 public function getField($expr, $strict = FALSE) {
464 // If the expression contains a pseudoconstant filter like activity_type_id:label,
465 // strip it to look up the base field name, then add the field:filter key to apiFieldSpec
466 $col = strpos($expr, ':');
467 $fieldName = $col ?
substr($expr, 0, $col) : $expr;
468 // Perform join if field not yet available - this will add it to apiFieldSpec
469 if (!isset($this->apiFieldSpec
[$fieldName]) && strpos($fieldName, '.')) {
470 $this->autoJoinFK($fieldName);
472 $field = $this->apiFieldSpec
[$fieldName] ??
NULL;
473 if ($strict && !$field) {
474 throw new \
API_Exception("Invalid field '$fieldName'");
476 $this->apiFieldSpec
[$expr] = $field;
481 * Join onto other entities as specified by the api call.
483 * @throws \API_Exception
484 * @throws \Civi\API\Exception\NotImplementedException
486 private function addExplicitJoins() {
487 foreach ($this->getJoin() as $join) {
488 // First item in the array is the entity name
489 $entity = array_shift($join);
490 // Which might contain an alias. Split on the keyword "AS"
491 list($entity, $alias) = array_pad(explode(' AS ', $entity), 2, NULL);
492 // Ensure alias is a safe string, and supply default if not given
493 $alias = $alias ? \CRM_Utils_String
::munge($alias) : strtolower($entity);
494 // First item in the array is a boolean indicating if the join is required (aka INNER or LEFT).
495 // The rest are join conditions.
496 $side = array_shift($join) ?
'INNER' : 'LEFT';
497 // Add all fields from joined entity to spec
498 $joinEntityGet = \Civi\API\Request
::create($entity, 'get', ['version' => 4, 'checkPermissions' => $this->getCheckPermissions()]);
499 foreach ($joinEntityGet->entityFields() as $field) {
500 $field['sql_name'] = '`' . $alias . '`.`' . $field['column_name'] . '`';
501 $this->addSpecField($alias . '.' . $field['name'], $field);
503 if (!empty($join[0]) && is_string($join[0]) && \CRM_Utils_Rule
::alphanumeric($join[0])) {
504 $conditions = $this->getBridgeJoin($join, $entity, $alias);
507 $conditions = $this->getJoinConditions($join, $entity, $alias);
509 foreach (array_filter($join) as $clause) {
510 $conditions[] = $this->treeWalkClauses($clause, 'ON');
512 $tableName = CoreUtil
::getTableName($entity);
513 $this->join($side, $tableName, $alias, $conditions);
518 * Supply conditions for an explicit join.
520 * @param array $joinTree
521 * @param string $joinEntity
522 * @param string $alias
525 private function getJoinConditions($joinTree, $joinEntity, $alias) {
527 // getAclClause() expects a stack of 1-to-1 join fields to help it dedupe, but this is more flexible,
528 // so unless this is a direct 1-to-1 join with the main entity, we'll just hack it
529 // with a padded empty stack to bypass its deduping.
530 $stack = [NULL, NULL];
531 // If we're not explicitly referencing the joinEntity ID in the ON clause, search for a default
532 $explicitId = array_filter($joinTree, function($clause) use ($alias) {
533 list($sideA, $op, $sideB) = array_pad((array) $clause, 3, NULL);
534 return $op === '=' && ($sideA === "$alias.id" ||
$sideB === "$alias.id");
537 foreach ($this->apiFieldSpec
as $name => $field) {
538 if ($field['entity'] !== $joinEntity && $field['fk_entity'] === $joinEntity) {
539 $conditions[] = $this->treeWalkClauses([$name, '=', "$alias.id"], 'ON');
541 elseif (strpos($name, "$alias.") === 0 && substr_count($name, '.') === 1 && $field['fk_entity'] === $this->getEntity()) {
542 $conditions[] = $this->treeWalkClauses([$name, '=', 'id'], 'ON');
546 // Hmm, if we came up with > 1 condition, then it's ambiguous how it should be joined so we won't return anything but the generic ACLs
547 if (count($conditions) > 1) {
548 $stack = [NULL, NULL];
552 $baoName = CoreUtil
::getBAOFromApiName($joinEntity);
553 $acls = array_values($this->getAclClause($alias, $baoName, $stack));
554 return array_merge($acls, $conditions);
558 * Join onto a BridgeEntity table
560 * @param array $joinTree
561 * @param string $joinEntity
562 * @param string $alias
564 * @throws \API_Exception
566 protected function getBridgeJoin(&$joinTree, $joinEntity, $alias) {
567 $bridgeEntity = array_shift($joinTree);
568 if (!is_a('\Civi\Api4\\' . $bridgeEntity, '\Civi\Api4\Generic\BridgeEntity', TRUE)) {
569 throw new \
API_Exception("Illegal bridge entity specified: " . $bridgeEntity);
571 $bridgeAlias = $alias . '_via_' . strtolower($bridgeEntity);
572 $bridgeTable = CoreUtil
::getTableName($bridgeEntity);
573 $joinTable = CoreUtil
::getTableName($joinEntity);
574 $bridgeEntityGet = \Civi\API\Request
::create($bridgeEntity, 'get', ['version' => 4, 'checkPermissions' => $this->getCheckPermissions()]);
575 $fkToJoinField = $fkToBaseField = NULL;
576 // Find the bridge field that links to the joinEntity (either an explicit FK or an entity_id/entity_table combo)
577 foreach ($bridgeEntityGet->entityFields() as $name => $field) {
578 if ($field['fk_entity'] === $joinEntity ||
(!$fkToJoinField && $name === 'entity_id')) {
579 $fkToJoinField = $name;
582 // Get list of entities allowed for entity_table
583 if (array_key_exists('entity_id', $bridgeEntityGet->entityFields())) {
584 $entityTables = (array) civicrm_api4($bridgeEntity, 'getFields', [
585 'checkPermissions' => FALSE,
586 'where' => [['name', '=', 'entity_table']],
587 'loadOptions' => TRUE,
588 ], ['options'])->first();
590 // If bridge field to joinEntity is entity_id, validate entity_table is allowed
591 if (!$fkToJoinField ||
($fkToJoinField === 'entity_id' && !array_key_exists($joinTable, $entityTables))) {
592 throw new \
API_Exception("Unable to join $bridgeEntity to $joinEntity");
594 // Create link between bridge entity and join entity
596 "`$bridgeAlias`.`$fkToJoinField` = `$alias`.`id`",
598 if ($fkToJoinField === 'entity_id') {
599 $joinConditions[] = "`$bridgeAlias`.`entity_table` = '$joinTable'";
601 // Register fields from the bridge entity as if they belong to the join entity
602 foreach ($bridgeEntityGet->entityFields() as $name => $field) {
603 if ($name == 'id' ||
$name == $fkToJoinField ||
($name == 'entity_table' && $fkToJoinField == 'entity_id')) {
606 if ($field['fk_entity'] ||
(!$fkToBaseField && $name == 'entity_id')) {
607 $fkToBaseField = $name;
609 // Note these fields get a sql alias pointing to the bridge entity, but an api alias pretending they belong to the join entity
610 $field['sql_name'] = '`' . $bridgeAlias . '`.`' . $field['column_name'] . '`';
611 $this->addSpecField($alias . '.' . $field['name'], $field);
613 // Move conditions for the bridge join out of the joinTree
614 $bridgeConditions = [];
615 $joinTree = array_filter($joinTree, function($clause) use ($fkToBaseField, $alias, $bridgeAlias, &$bridgeConditions) {
616 list($sideA, $op, $sideB) = array_pad((array) $clause, 3, NULL);
617 if ($op === '=' && $sideB && ($sideA === "$alias.$fkToBaseField" ||
$sideB === "$alias.$fkToBaseField")) {
618 $expr = $sideA === "$alias.$fkToBaseField" ?
$sideB : $sideA;
619 $bridgeConditions[] = "`$bridgeAlias`.`$fkToBaseField` = " . $this->getExpression($expr)->render($this->apiFieldSpec
);
622 elseif ($op === '=' && $fkToBaseField == 'entity_id' && ($sideA === "$alias.entity_table" ||
$sideB === "$alias.entity_table")) {
623 $expr = $sideA === "$alias.entity_table" ?
$sideB : $sideA;
624 $bridgeConditions[] = "`$bridgeAlias`.`entity_table` = " . $this->getExpression($expr)->render($this->apiFieldSpec
);
629 // If no bridge conditions were specified, link it to the base entity
630 if (!$bridgeConditions) {
631 $bridgeConditions[] = "`$bridgeAlias`.`$fkToBaseField` = a.id";
632 if ($fkToBaseField == 'entity_id') {
633 if (!array_key_exists($this->getFrom(), $entityTables)) {
634 throw new \
API_Exception("Unable to join $bridgeEntity to " . $this->getEntity());
636 $bridgeConditions[] = "`$bridgeAlias`.`entity_table` = '" . $this->getFrom() . "'";
640 $this->join('LEFT', $bridgeTable, $bridgeAlias, $bridgeConditions);
642 $baoName = CoreUtil
::getBAOFromApiName($joinEntity);
643 $acls = array_values($this->getAclClause($alias, $baoName, [NULL, NULL]));
644 return array_merge($acls, $joinConditions);
648 * Joins a path and adds all fields in the joined entity to apiFieldSpec
651 * @throws \API_Exception
654 protected function autoJoinFK($key) {
655 if (isset($this->apiFieldSpec
[$key])) {
659 $pathArray = explode('.', $key);
661 /** @var \Civi\Api4\Service\Schema\Joiner $joiner */
662 $joiner = \Civi
::container()->get('joiner');
663 // The last item in the path is the field name. We don't care about that; we'll add all fields from the joined entity.
664 array_pop($pathArray);
665 $pathString = implode('.', $pathArray);
667 if (!$joiner->canAutoJoin($this->getFrom(), $pathString)) {
671 $joinPath = $joiner->join($this, $pathString);
673 $lastLink = array_pop($joinPath);
675 // Custom field names are already prefixed
676 $isCustom = $lastLink instanceof CustomGroupJoinable
;
678 array_pop($pathArray);
680 $prefix = $pathArray ?
implode('.', $pathArray) . '.' : '';
681 // Cache field info for retrieval by $this->getField()
682 foreach ($lastLink->getEntityFields() as $fieldObject) {
683 $fieldArray = $fieldObject->toArray();
684 $fieldArray['sql_name'] = '`' . $lastLink->getAlias() . '`.`' . $fieldArray['column_name'] . '`';
685 $this->addSpecField($prefix . $fieldArray['name'], $fieldArray);
690 * @param string $side
691 * @param string $tableName
692 * @param string $tableAlias
693 * @param array $conditions
695 public function join($side, $tableName, $tableAlias, $conditions) {
696 // INNER JOINs take precedence over LEFT JOINs
697 if ($side != 'LEFT' ||
!isset($this->joins
[$tableAlias])) {
698 $this->joins
[$tableAlias] = $side;
699 $this->query
->join($tableAlias, "$side JOIN `$tableName` `$tableAlias` ON " . implode(' AND ', $conditions));
704 * @return FALSE|string
706 public function getFrom() {
707 return CoreUtil
::getTableName($this->getEntity());
713 public function getEntity() {
714 return $this->api
->getEntityName();
720 public function getSelect() {
721 return $this->api
->getSelect();
727 public function getWhere() {
728 return $this->api
->getWhere();
734 public function getHaving() {
735 return $this->api
->getHaving();
741 public function getJoin() {
742 return $this->api
->getJoin();
748 public function getGroupBy() {
749 return $this->api
->getGroupBy();
755 public function getOrderBy() {
756 return $this->api
->getOrderBy();
762 public function getLimit() {
763 return $this->api
->getLimit();
769 public function getOffset() {
770 return $this->api
->getOffset();
774 * @return \CRM_Utils_SQL_Select
776 public function getQuery() {
781 * @return bool|string
783 public function getCheckPermissions() {
784 return $this->api
->getCheckPermissions();
788 * @param string $path
789 * @param array $field
791 private function addSpecField($path, $field) {
792 // Only add field to spec if we have permission
793 if ($this->getCheckPermissions() && !empty($field['permission']) && !\CRM_Core_Permission
::check($field['permission'])) {
794 $this->apiFieldSpec
[$path] = FALSE;
797 $this->apiFieldSpec
[$path] = $field;
801 * Add something to the api's debug output if debugging is enabled
806 public function debug($key, $item) {
807 if ($this->api
->getDebug()) {
808 $this->api
->_debugOutput
[$key][] = $item;