4 +--------------------------------------------------------------------+
6 +--------------------------------------------------------------------+
7 | Copyright CiviCRM LLC (c) 2004-2019 |
8 +--------------------------------------------------------------------+
9 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
32 * @copyright CiviCRM LLC (c) 2004-2019
38 namespace Civi\Api4\Generic
;
41 * Base class for all "Update" api actions
43 * @method $this setValues(array $values) Set all field values from an array of key => value pairs.
44 * @method $this addValue($field, $value) Set field value.
45 * @method array getValues() Get field values.
46 * @method $this setReload(bool $reload) Specify whether complete objects will be returned after saving.
47 * @method bool getReload()
49 * @package Civi\Api4\Generic
51 abstract class AbstractUpdateAction
extends AbstractBatchAction
{
54 * Field values to update.
59 protected $values = [];
62 * Reload objects after saving.
64 * Setting to TRUE will load complete records and return them as the api result.
65 * If FALSE the api usually returns only the fields specified to be updated.
69 protected $reload = FALSE;
76 public function getValue($key) {
77 return isset($this->values
[$key]) ?
$this->values
[$key] : NULL;