Civi/Api4/Action/Setting/Revert.php

   1 <?php
   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
  37 namespace Civi\Api4\Action\Setting;
  38
  39 use Civi\Api4\Generic\Result;
  40
  41 /**
  42  * Revert one or more CiviCRM settings to their default value.
  43  *
  44  * @method array getSelect
  45  * @method $this addSelect(string $name)
  46  * @method $this setSelect(array $select)
  47  */
  48 class Revert extends AbstractSettingAction {
  49
  50   /**
  51    * Names of settings to revert
  52    *
  53    * @var array
  54    * @required
  55    */
  56   protected $select = [];
  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->select as $name) {
  67       $settingsBag->revert($name);
  68       $result[] = [
  69         'name' => $name,
  70         'value' => $settingsBag->get($name),
  71         'domain_id' => $domain,
  72       ];
  73     }
  74     foreach ($result as $name => &$setting) {
  75       if (isset($setting['value']) && !empty($meta[$name]['serialize'])) {
  76         $setting['value'] = \CRM_Core_DAO::unSerializeField($setting['value'], $meta[$name]['serialize']);
  77       }
  78     }
  79   }
  80
  81 }