4 +--------------------------------------------------------------------+
6 +--------------------------------------------------------------------+
7 | Copyright CiviCRM LLC (c) 2004-2020 |
8 +--------------------------------------------------------------------+
9 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
32 * @copyright CiviCRM LLC (c) 2004-2020
38 namespace Civi\Api4\Service\Spec\Provider
;
40 use Civi\Api4\Service\Spec\RequestSpec
;
42 class GetActionDefaultsProvider
implements Generic\SpecProviderInterface
{
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');
54 // Exclude test records from api Get by default
55 $isTestField = $spec->getFieldByName('is_test');
57 $isTestField->setDefaultValue('0');
60 $isTemplateField = $spec->getFieldByName('is_template');
61 if ($isTemplateField) {
62 $isTemplateField->setDefaultValue('0');
69 public function applies($entity, $action) {
70 return $action === 'get';