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 /**
  25  * Retrieve items based on criteria specified in the 'where' param.
  26  *
  27  * Use the 'select' param to determine which fields are returned, defaults to *.
  28  *
  29  * Perform joins on other related entities using a dot notation.
  30  */
  31 class DAOGetAction extends AbstractGetAction {
  32   use Traits\DAOActionTrait;
  33
  34   /**
  35    * Fields to return. Defaults to all non-custom fields ["*"].
  36    *
  37    * Use the dot notation to perform joins in the select clause, e.g. selecting ["*", "contact.*"] from Email.get
  38    * will select all fields for the email + all fields for the related contact.
  39    *
  40    * @var array
  41    * @inheritDoc
  42    */
  43   protected $select = [];
  44
  45   public function _run(Result $result) {
  46     $this->setDefaultWhereClause();
  47     $this->expandSelectClauseWildcards();
  48     $result->exchangeArray($this->getObjects());
  49   }
  50
  51 }