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 * Create a new $ENTITY from supplied values.
27 * This action will create 1 new $ENTITY.
28 * It cannot be used to update existing $ENTITIES; use the `Update` or `Replace` actions for that.
30 class BasicCreateAction
extends AbstractCreateAction
{
35 * Function(array $item, BasicCreateAction $thisAction) => array
40 * Basic Create constructor.
42 * @param string $entityName
43 * @param string $actionName
44 * @param callable $setter
45 * Function(array $item, BasicCreateAction $thisAction) => array
47 public function __construct($entityName, $actionName, $setter = NULL) {
48 parent
::__construct($entityName, $actionName);
49 $this->setter
= $setter;
53 * We pass the writeRecord function an array representing one item to write.
54 * We expect to get the same format back.
56 * @param \Civi\Api4\Generic\Result $result
58 public function _run(Result
$result) {
59 $this->formatWriteValues($this->values
);
60 $this->validateValues();
61 $result->exchangeArray([$this->writeRecord($this->values
)]);
65 * This Basic Create class can be used in one of two ways:
67 * 1. Use this class directly by passing a callable ($setter) to the constructor.
68 * 2. Extend this class and override this function.
70 * Either way, this function should return an array representing the one new object.
74 * @throws \Civi\API\Exception\NotImplementedException
76 protected function writeRecord($item) {
77 if (is_callable($this->setter
)) {
78 $this->addCallbackToDebugOutput($this->setter
);
79 return call_user_func($this->setter
, $item, $this);
81 throw new NotImplementedException('Setter function not found for api4 ' . $this->getEntityName() . '::' . $this->getActionName());