Civi/Api4/Generic/DAOGetAction.php

   1 <?php
   2
   3 /*
   4  +--------------------------------------------------------------------+
   5  | Copyright CiviCRM LLC. All rights reserved.                        |
   6  |                                                                    |
   7  | This work is published under the GNU AGPLv3 license with some      |
   8  | permitted exceptions and without any warranty. For full license    |
   9  | and copyright information, see https://civicrm.org/licensing       |
  10  +--------------------------------------------------------------------+
  11  */
  12
  13 /**
  14  *
  15  * @package CRM
  16  * @copyright CiviCRM LLC https://civicrm.org/licensing
  17  * $Id$
  18  *
  19  */
  20
  21
  22 namespace Civi\Api4\Generic;
  23
  24 use Civi\Api4\Query\Api4SelectQuery;
  25
  26 /**
  27  * Retrieve $ENTITIES based on criteria specified in the `where` parameter.
  28  *
  29  * Use the `select` param to determine which fields are returned, defaults to `[*]`.
  30  *
  31  * Perform joins on other related entities using a dot notation.
  32  */
  33 class DAOGetAction extends AbstractGetAction {
  34   use Traits\DAOActionTrait;
  35
  36   /**
  37    * Fields to return. Defaults to all non-custom fields `[*]`.
  38    *
  39    * Use the dot notation to perform joins in the select clause, e.g. selecting `['*', 'contact.*']` from `Email::get()`
  40    * will select all fields for the email + all fields for the related contact.
  41    *
  42    * @var array
  43    * @inheritDoc
  44    */
  45   protected $select = [];
  46
  47   /**
  48    * Field(s) by which to group the results.
  49    *
  50    * @var array
  51    */
  52   protected $groupBy = [];
  53
  54   public function _run(Result $result) {
  55     $this->setDefaultWhereClause();
  56     $this->expandSelectClauseWildcards();
  57     $result->exchangeArray($this->getObjects());
  58   }
  59
  60   /**
  61    * @return array|int
  62    */
  63   protected function getObjects() {
  64     $query = new Api4SelectQuery($this);
  65
  66     $result = $query->run();
  67     if (is_array($result)) {
  68       \CRM_Utils_API_HTMLInputCoder::singleton()->decodeRows($result);
  69     }
  70     return $result;
  71   }
  72
  73   /**
  74    * @return array
  75    */
  76   public function getGroupBy(): array {
  77     return $this->groupBy;
  78   }
  79
  80   /**
  81    * @param array $groupBy
  82    * @return $this
  83    */
  84   public function setGroupBy(array $groupBy) {
  85     $this->groupBy = $groupBy;
  86     return $this;
  87   }
  88
  89   /**
  90    * @param string $field
  91    * @return $this
  92    */
  93   public function addGroupBy(string $field) {
  94     $this->groupBy[] = $field;
  95     return $this;
  96   }
  97
  98 }