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 +--------------------------------------------------------------------+
13 namespace Civi\Api4\Action\Setting
;
16 * Get information about CiviCRM settings.
18 * @method int getDomainId
19 * @method $this setDomainId(int $domainId)
21 class GetFields
extends \Civi\Api4\Generic\BasicGetFieldsAction
{
24 * Domain id of settings. Leave NULL for default domain.
30 protected function getRecords() {
31 // TODO: Waiting for filter handling to get fixed in core
32 // $names = $this->_itemsToGet('name');
33 // $filter = $names ? ['name' => $names] : [];
35 return \Civi\Core\SettingsMetadata
::getMetadata($filter, $this->domainId
, $this->loadOptions
);
38 public function fields() {
42 'data_type' => 'String',
46 'data_type' => 'String',
49 'name' => 'description',
50 'data_type' => 'String',
53 'name' => 'help_text',
54 'data_type' => 'String',
58 'data_type' => 'String',
61 'name' => 'pseudoconstant',
62 'data_type' => 'String',
66 'data_type' => 'Array',
69 'name' => 'group_name',
70 'data_type' => 'String',
74 'data_type' => 'String',
77 'name' => 'html_type',
78 'data_type' => 'String',
82 'data_type' => 'String',
85 'name' => 'serialize',
86 'data_type' => 'Integer',
89 'name' => 'data_type',
90 'data_type' => 'Integer',