Civi/Api4/Generic/BasicSaveAction.php

   1 <?php
   2
   3 /*
   4  +--------------------------------------------------------------------+
   5  | Copyright CiviCRM LLC. All rights reserved.                        |
   6  |                                                                    |
   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  +--------------------------------------------------------------------+
  11  */
  12
  13 /**
  14  *
  15  * @package CRM
  16  * @copyright CiviCRM LLC https://civicrm.org/licensing
  17  */
  18
  19
  20 namespace Civi\Api4\Generic;
  21
  22 use Civi\API\Exception\NotImplementedException;
  23
  24 /**
  25  * $ACTION one or more $ENTITIES.
  26  *
  27  * If saving more than one new $ENTITY with similar values, use the `defaults` parameter.
  28  *
  29  * Set `reload` if you need the api to return complete $ENTITY records.
  30  */
  31 class BasicSaveAction extends AbstractSaveAction {
  32
  33   /**
  34    * @var callable
  35    *
  36    * Function(array $item, BasicCreateAction $thisAction) => array
  37    */
  38   private $setter;
  39
  40   /**
  41    * Basic Create constructor.
  42    *
  43    * @param string $entityName
  44    * @param string $actionName
  45    * @param string $idField
  46    * @param callable $setter
  47    *   Function(array $item, BasicCreateAction $thisAction) => array
  48    */
  49   public function __construct($entityName, $actionName, $idField = 'id', $setter = NULL) {
  50     parent::__construct($entityName, $actionName, $idField);
  51     $this->setter = $setter;
  52   }
  53
  54   /**
  55    * We pass the writeRecord function an array representing one item to write.
  56    * We expect to get the same format back.
  57    *
  58    * @param \Civi\Api4\Generic\Result $result
  59    */
  60   public function _run(Result $result) {
  61     foreach ($this->records as &$record) {
  62       $record += $this->defaults;
  63       $this->formatWriteValues($record);
  64     }
  65     $this->validateValues();
  66     foreach ($this->records as $item) {
  67       $result[] = $this->writeRecord($item);
  68     }
  69     if ($this->reload) {
  70       /** @var BasicGetAction $get */
  71       $get = \Civi\API\Request::create($this->getEntityName(), 'get', ['version' => 4]);
  72       $get
  73         ->setCheckPermissions($this->getCheckPermissions())
  74         ->addWhere($this->getIdField(), 'IN', (array) $result->column($this->getIdField()));
  75       $result->exchangeArray((array) $get->execute());
  76     }
  77   }
  78
  79   /**
  80    * This Basic Save class can be used in one of two ways:
  81    *
  82    * 1. Use this class directly by passing a callable ($setter) to the constructor.
  83    * 2. Extend this class and override this function.
  84    *
  85    * Either way, this function should return an array representing the one new object.
  86    *
  87    * @param array $item
  88    * @return array
  89    * @throws \Civi\API\Exception\NotImplementedException
  90    */
  91   protected function writeRecord($item) {
  92     if (is_callable($this->setter)) {
  93       $this->addCallbackToDebugOutput($this->setter);
  94       return call_user_func($this->setter, $item, $this);
  95     }
  96     throw new NotImplementedException('Setter function not found for api4 ' . $this->getEntityName() . '::' . $this->getActionName());
  97   }
  98
  99 }