Commit | Line | Data |
---|---|---|
19b53e5b C |
1 | <?php |
2 | ||
380f3545 TO |
3 | /* |
4 | +--------------------------------------------------------------------+ | |
5 | | CiviCRM version 5 | | |
6 | +--------------------------------------------------------------------+ | |
7 | | Copyright CiviCRM LLC (c) 2004-2019 | | |
8 | +--------------------------------------------------------------------+ | |
9 | | This file is a part of CiviCRM. | | |
10 | | | | |
11 | | CiviCRM is free software; you can copy, modify, and distribute it | | |
12 | | under the terms of the GNU Affero General Public License | | |
13 | | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. | | |
14 | | | | |
15 | | CiviCRM is distributed in the hope that it will be useful, but | | |
16 | | WITHOUT ANY WARRANTY; without even the implied warranty of | | |
17 | | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. | | |
18 | | See the GNU Affero General Public License for more details. | | |
19 | | | | |
20 | | You should have received a copy of the GNU Affero General Public | | |
21 | | License and the CiviCRM Licensing Exception along | | |
22 | | with this program; if not, contact CiviCRM LLC | | |
23 | | at info[AT]civicrm[DOT]org. If you have questions about the | | |
24 | | GNU Affero General Public License or the licensing of CiviCRM, | | |
25 | | see the CiviCRM license FAQ at http://civicrm.org/licensing | | |
26 | +--------------------------------------------------------------------+ | |
27 | */ | |
28 | ||
29 | /** | |
30 | * | |
31 | * @package CRM | |
32 | * @copyright CiviCRM LLC (c) 2004-2019 | |
33 | * $Id$ | |
34 | * | |
35 | */ | |
36 | ||
37 | ||
19b53e5b C |
38 | namespace Civi\Api4\Service\Spec\Provider; |
39 | ||
40 | use Civi\Api4\Service\Spec\RequestSpec; | |
41 | ||
42 | class GetActionDefaultsProvider implements Generic\SpecProviderInterface { | |
43 | ||
44 | /** | |
45 | * @inheritDoc | |
46 | */ | |
47 | public function modifySpec(RequestSpec $spec) { | |
48 | // Exclude deleted records from api Get by default | |
49 | $isDeletedField = $spec->getFieldByName('is_deleted'); | |
50 | if ($isDeletedField) { | |
51 | $isDeletedField->setDefaultValue('0'); | |
52 | } | |
53 | ||
54 | // Exclude test records from api Get by default | |
55 | $isTestField = $spec->getFieldByName('is_test'); | |
56 | if ($isTestField) { | |
57 | $isTestField->setDefaultValue('0'); | |
58 | } | |
57b75c5c | 59 | |
60 | $isTemplateField = $spec->getFieldByName('is_template'); | |
61 | if ($isTemplateField) { | |
62 | $isTemplateField->setDefaultValue('0'); | |
63 | } | |
19b53e5b C |
64 | } |
65 | ||
66 | /** | |
67 | * @inheritDoc | |
68 | */ | |
69 | public function applies($entity, $action) { | |
70 | return $action === 'get'; | |
71 | } | |
72 | ||
73 | } |