Merge pull request #15353 from totten/master-api4-header
[civicrm-core.git] / Civi / Api4 / Action / Setting / Set.php
CommitLineData
19b53e5b 1<?php
380f3545
TO
2
3/*
4 +--------------------------------------------------------------------+
5 | CiviCRM version 5 |
6 +--------------------------------------------------------------------+
7 | Copyright CiviCRM LLC (c) 2004-2019 |
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
32 * @copyright CiviCRM LLC (c) 2004-2019
33 * $Id$
34 *
35 */
36
19b53e5b
C
37namespace Civi\Api4\Action\Setting;
38
39use Civi\Api4\Generic\Result;
40
41/**
42 * Set the value of one or more CiviCRM settings.
43 *
44 * @method array getValues
45 * @method $this setValues(array $value)
46 * @method $this addValue(string $name, mixed $value)
47 */
48class Set extends AbstractSettingAction {
49
50 /**
51 * Setting names/values to set.
52 *
53 * @var mixed
54 * @required
55 */
56 protected $values = [];
57
58 /**
59 * @param \Civi\Api4\Generic\Result $result
60 * @param \Civi\Core\SettingsBag $settingsBag
61 * @param array $meta
62 * @param int $domain
63 * @throws \Exception
64 */
65 protected function processSettings(Result $result, $settingsBag, $meta, $domain) {
66 foreach ($this->values as $name => $value) {
67 if (isset($value) && !empty($meta[$name]['serialize'])) {
68 $value = \CRM_Core_DAO::serializeField($value, $meta[$name]['serialize']);
69 }
70 $settingsBag->set($name, $value);
71 $result[] = [
72 'name' => $name,
73 'value' => $this->values[$name],
74 'domain_id' => $domain,
75 ];
76 }
77 }
78
79}