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
;
25 use Civi\Api4\Utils\ActionUtil
;
28 * Create or update one or more records.
30 * If creating more than one record with similar values, use the "defaults" param.
32 * Set "reload" if you need the api to return complete records.
34 class BasicSaveAction
extends AbstractSaveAction
{
39 * Function(array $item, BasicCreateAction $thisAction) => array
44 * Basic Create constructor.
46 * @param string $entityName
47 * @param string $actionName
48 * @param string $idField
49 * @param callable $setter
50 * Function(array $item, BasicCreateAction $thisAction) => array
52 public function __construct($entityName, $actionName, $idField = 'id', $setter = NULL) {
53 parent
::__construct($entityName, $actionName, $idField);
54 $this->setter
= $setter;
58 * We pass the writeRecord function an array representing one item to write.
59 * We expect to get the same format back.
61 * @param \Civi\Api4\Generic\Result $result
63 public function _run(Result
$result) {
64 $this->validateValues();
65 foreach ($this->records
as $record) {
66 $record +
= $this->defaults
;
67 $result[] = $this->writeRecord($record);
70 /** @var BasicGetAction $get */
71 $get = ActionUtil
::getAction($this->getEntityName(), 'get');
73 ->setCheckPermissions($this->getCheckPermissions())
74 ->addWhere($this->getIdField(), 'IN', (array) $result->column($this->getIdField()));
75 $result->exchangeArray((array) $get->execute());
80 * This Basic Save class can be used in one of two ways:
82 * 1. Use this class directly by passing a callable ($setter) to the constructor.
83 * 2. Extend this class and override this function.
85 * Either way, this function should return an array representing the one new object.
89 * @throws \Civi\API\Exception\NotImplementedException
91 protected function writeRecord($item) {
92 if (is_callable($this->setter
)) {
93 return call_user_func($this->setter
, $item, $this);
95 throw new NotImplementedException('Setter function not found for api4 ' . $this->getEntityName() . '::' . $this->getActionName());