Commit | Line | Data |
---|---|---|
19b53e5b C |
1 | <?php |
2 | ||
380f3545 TO |
3 | /* |
4 | +--------------------------------------------------------------------+ | |
41498ac5 | 5 | | Copyright CiviCRM LLC. All rights reserved. | |
380f3545 | 6 | | | |
41498ac5 TO |
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 | | |
380f3545 TO |
10 | +--------------------------------------------------------------------+ |
11 | */ | |
12 | ||
13 | /** | |
14 | * | |
15 | * @package CRM | |
ca5cec67 | 16 | * @copyright CiviCRM LLC https://civicrm.org/licensing |
380f3545 TO |
17 | * $Id$ |
18 | * | |
19 | */ | |
20 | ||
21 | ||
19b53e5b C |
22 | namespace Civi\Api4\Generic; |
23 | ||
24 | /** | |
e3c6d5ff | 25 | * Retrieve $ENTITIES based on criteria specified in the `where` parameter. |
19b53e5b | 26 | * |
fc95d9a5 | 27 | * Use the `select` param to determine which fields are returned, defaults to `[*]`. |
19b53e5b C |
28 | * |
29 | * Perform joins on other related entities using a dot notation. | |
30 | */ | |
31 | class DAOGetAction extends AbstractGetAction { | |
32 | use Traits\DAOActionTrait; | |
33 | ||
39e0f675 | 34 | /** |
fc95d9a5 | 35 | * Fields to return. Defaults to all non-custom fields `[*]`. |
39e0f675 | 36 | * |
fc95d9a5 | 37 | * Use the dot notation to perform joins in the select clause, e.g. selecting `['*', 'contact.*']` from `Email::get()` |
39e0f675 CW |
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 | ||
19b53e5b C |
45 | public function _run(Result $result) { |
46 | $this->setDefaultWhereClause(); | |
39e0f675 | 47 | $this->expandSelectClauseWildcards(); |
19b53e5b C |
48 | $result->exchangeArray($this->getObjects()); |
49 | } | |
50 | ||
51 | } |