4 +--------------------------------------------------------------------+
5 | Copyright CiviCRM LLC. All rights reserved. |
7 | This work is published under the GNU AGPLv3 license with some |
8 | permitted exceptions and without any warranty. For full license |
9 | and copyright information, see https://civicrm.org/licensing |
10 +--------------------------------------------------------------------+
16 * @copyright CiviCRM LLC https://civicrm.org/licensing
20 namespace Civi\Api4\Generic
;
22 use Civi\API\Exception\NotImplementedException
;
25 * Update one or more $ENTITY with new values.
27 * Use the `where` clause (required) to select them.
29 class BasicUpdateAction
extends AbstractUpdateAction
{
34 * Function(array $item, BasicUpdateAction $thisAction) => array
39 * BasicUpdateAction constructor.
41 * @param string $entityName
42 * @param string $actionName
43 * @param string|array $select
44 * One or more fields to select from each matching item.
45 * @param callable $setter
46 * Function(array $item, BasicUpdateAction $thisAction) => array
48 public function __construct($entityName, $actionName, $select = 'id', $setter = NULL) {
49 parent
::__construct($entityName, $actionName, $select);
50 $this->setter
= $setter;
54 * We pass the writeRecord function an array representing one item to update.
55 * We expect to get the same format back.
57 * @param \Civi\Api4\Generic\Result $result
58 * @throws \API_Exception
59 * @throws \Civi\API\Exception\NotImplementedException
61 public function _run(Result
$result) {
62 $this->formatWriteValues($this->values
);
63 foreach ($this->getBatchRecords() as $item) {
64 $result[] = $this->writeRecord($this->values +
$item);
69 * This Basic Update class can be used in one of two ways:
71 * 1. Use this class directly by passing a callable ($setter) to the constructor.
72 * 2. Extend this class and override this function.
74 * Either way, this function should return an array representing the one modified object.
78 * @throws \Civi\API\Exception\NotImplementedException
80 protected function writeRecord($item) {
81 if (is_callable($this->setter
)) {
82 $this->addCallbackToDebugOutput($this->setter
);
83 return call_user_func($this->setter
, $item, $this);
85 throw new NotImplementedException('Setter function not found for api4 ' . $this->getEntityName() . '::' . $this->getActionName());