4 +--------------------------------------------------------------------+
5 | Copyright CiviCRM LLC. All rights reserved. |
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 +--------------------------------------------------------------------+
16 * @copyright CiviCRM LLC https://civicrm.org/licensing
21 namespace Civi\Api4\Action\Setting
;
24 * Get information about CiviCRM settings.
26 * @method int getDomainId
27 * @method $this setDomainId(int $domainId)
29 class GetFields
extends \Civi\Api4\Generic\BasicGetFieldsAction
{
32 * Domain id of settings. Leave NULL for default domain.
38 protected function getRecords() {
39 // TODO: Waiting for filter handling to get fixed in core
40 // $names = $this->_itemsToGet('name');
41 // $filter = $names ? ['name' => $names] : [];
43 return \Civi\Core\SettingsMetadata
::getMetadata($filter, $this->domainId
, $this->loadOptions
);
46 public function fields() {
50 'data_type' => 'String',
54 'data_type' => 'String',
57 'name' => 'description',
58 'data_type' => 'String',
61 'name' => 'help_text',
62 'data_type' => 'String',
66 'data_type' => 'String',
69 'name' => 'pseudoconstant',
70 'data_type' => 'String',
74 'data_type' => 'Array',
77 'name' => 'group_name',
78 'data_type' => 'String',
82 'data_type' => 'String',
85 'name' => 'html_type',
86 'data_type' => 'String',
90 'data_type' => 'String',
93 'name' => 'serialize',
94 'data_type' => 'Integer',
97 'name' => 'data_type',
98 'data_type' => 'Integer',