Merge pull request #15699 from mattwire/participant_cleanup_completeOrderPBRef
[civicrm-core.git] / Civi / Api4 / Action / Setting / Get.php
CommitLineData
19b53e5b 1<?php
380f3545
TO
2
3/*
4 +--------------------------------------------------------------------+
5 | CiviCRM version 5 |
6 +--------------------------------------------------------------------+
f299f7db 7 | Copyright CiviCRM LLC (c) 2004-2020 |
380f3545
TO
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
f299f7db 32 * @copyright CiviCRM LLC (c) 2004-2020
380f3545
TO
33 * $Id$
34 *
35 */
36
19b53e5b
C
37namespace Civi\Api4\Action\Setting;
38
39use Civi\Api4\Generic\Result;
40
41/**
42 * Get the value of one or more CiviCRM settings.
43 *
44 * @method array getSelect
45 * @method $this addSelect(string $name)
46 * @method $this setSelect(array $select)
47 */
48class Get extends AbstractSettingAction {
49
50 /**
51 * Names of settings to retrieve
52 *
53 * @var array
54 */
55 protected $select = [];
56
57 /**
58 * @param \Civi\Api4\Generic\Result $result
59 * @param \Civi\Core\SettingsBag $settingsBag
60 * @param array $meta
61 * @param int $domain
62 * @throws \Exception
63 */
64 protected function processSettings(Result $result, $settingsBag, $meta, $domain) {
65 if ($this->select) {
66 foreach ($this->select as $name) {
67 $result[] = [
68 'name' => $name,
69 'value' => $settingsBag->get($name),
70 'domain_id' => $domain,
71 ];
72 }
73 }
74 else {
75 foreach ($settingsBag->all() as $name => $value) {
76 $result[] = [
77 'name' => $name,
78 'value' => $value,
79 'domain_id' => $domain,
80 ];
81 }
82 }
83 foreach ($result as $name => &$setting) {
84 if (isset($setting['value']) && !empty($meta[$name]['serialize'])) {
85 $setting['value'] = \CRM_Core_DAO::unSerializeField($setting['value'], $meta[$name]['serialize']);
86 }
87 }
88 }
89
90}