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
37 namespace Civi\Api4\Action\Setting
;
40 * Get information about CiviCRM settings.
42 * @method int getDomainId
43 * @method $this setDomainId(int $domainId)
45 class GetFields
extends \Civi\Api4\Generic\BasicGetFieldsAction
{
48 * Domain id of settings. Leave NULL for default domain.
54 protected function getRecords() {
55 // TODO: Waiting for filter handling to get fixed in core
56 // $names = $this->_itemsToGet('name');
57 // $filter = $names ? ['name' => $names] : [];
59 return \Civi\Core\SettingsMetadata
::getMetadata($filter, $this->domainId
, $this->loadOptions
);
62 public function fields() {
66 'data_type' => 'String',
70 'data_type' => 'String',
73 'name' => 'description',
74 'data_type' => 'String',
77 'name' => 'help_text',
78 'data_type' => 'String',
82 'data_type' => 'String',
85 'name' => 'pseudoconstant',
86 'data_type' => 'String',
90 'data_type' => 'Array',
93 'name' => 'group_name',
94 'data_type' => 'String',
98 'data_type' => 'String',
101 'name' => 'html_type',
102 'data_type' => 'String',
106 'data_type' => 'String',
109 'name' => 'serialize',
110 'data_type' => 'Integer',
113 'name' => 'data_type',
114 'data_type' => 'Integer',