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 * Create a new object from supplied values.
29 * This function will create 1 new object. It cannot be used to update existing objects. Use the Update or Replace actions for that.
31 class BasicCreateAction
extends AbstractCreateAction
{
36 * Function(array $item, BasicCreateAction $thisAction) => array
41 * Basic Create constructor.
43 * @param string $entityName
44 * @param string $actionName
45 * @param callable $setter
46 * Function(array $item, BasicCreateAction $thisAction) => array
48 public function __construct($entityName, $actionName, $setter = NULL) {
49 parent
::__construct($entityName, $actionName);
50 $this->setter
= $setter;
54 * We pass the writeRecord function an array representing one item to write.
55 * We expect to get the same format back.
57 * @param \Civi\Api4\Generic\Result $result
59 public function _run(Result
$result) {
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 return call_user_func($this->setter
, $item, $this);
80 throw new NotImplementedException('Setter function not found for api4 ' . $this->getEntityName() . '::' . $this->getActionName());