blob: a19049702ca16eacb27c40ad598faa5cb2fce9fe (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
|
<?php
namespace Civi\Api4\Generic;
/**
* Base class for all "Update" api actions
*
* @method $this setValues(array $values) Set all field values from an array of key => value pairs.
* @method $this addValue($field, $value) Set field value.
* @method array getValues() Get field values.
* @method $this setReload(bool $reload) Specify whether complete objects will be returned after saving.
* @method bool getReload()
*
* @package Civi\Api4\Generic
*/
abstract class AbstractUpdateAction extends AbstractBatchAction {
/**
* Field values to update.
*
* @required
* @var array
*/
protected $values = [];
/**
* Reload objects after saving.
*
* Setting to TRUE will load complete records and return them as the api result.
* If FALSE the api usually returns only the fields specified to be updated.
*
* @var bool
*/
protected $reload = FALSE;
/**
* @param string $key
*
* @return mixed|null
*/
public function getValue($key) {
return isset($this->values[$key]) ? $this->values[$key] : NULL;
}
}
|
