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
22 namespace Civi\Api4\Generic
;
24 use Civi\API\Exception\NotImplementedException
;
27 * $ACTION one or more $ENTITIES.
29 * If saving more than one new $ENTITY with similar values, use the `defaults` parameter.
31 * Set `reload` if you need the api to return complete $ENTITY records.
33 class BasicSaveAction
extends AbstractSaveAction
{
38 * Function(array $item, BasicCreateAction $thisAction) => array
43 * Basic Create constructor.
45 * @param string $entityName
46 * @param string $actionName
47 * @param string $idField
48 * @param callable $setter
49 * Function(array $item, BasicCreateAction $thisAction) => array
51 public function __construct($entityName, $actionName, $idField = 'id', $setter = NULL) {
52 parent
::__construct($entityName, $actionName, $idField);
53 $this->setter
= $setter;
57 * We pass the writeRecord function an array representing one item to write.
58 * We expect to get the same format back.
60 * @param \Civi\Api4\Generic\Result $result
62 public function _run(Result
$result) {
63 foreach ($this->records
as &$record) {
64 $record +
= $this->defaults
;
65 $this->formatWriteValues($record);
67 $this->validateValues();
68 foreach ($this->records
as $item) {
69 $result[] = $this->writeRecord($item);
72 /** @var BasicGetAction $get */
73 $get = \Civi\API\Request
::create($this->getEntityName(), 'get', ['version' => 4]);
75 ->setCheckPermissions($this->getCheckPermissions())
76 ->addWhere($this->getIdField(), 'IN', (array) $result->column($this->getIdField()));
77 $result->exchangeArray((array) $get->execute());
82 * This Basic Save class can be used in one of two ways:
84 * 1. Use this class directly by passing a callable ($setter) to the constructor.
85 * 2. Extend this class and override this function.
87 * Either way, this function should return an array representing the one new object.
91 * @throws \Civi\API\Exception\NotImplementedException
93 protected function writeRecord($item) {
94 if (is_callable($this->setter
)) {
95 $this->addCallbackToDebugOutput($this->setter
);
96 return call_user_func($this->setter
, $item, $this);
98 throw new NotImplementedException('Setter function not found for api4 ' . $this->getEntityName() . '::' . $this->getActionName());