Civi/Api4/Generic/BasicCreateAction.php

   1 <?php
   2
   3 /*
   4  +--------------------------------------------------------------------+
   5  | CiviCRM version 5                                                  |
   6  +--------------------------------------------------------------------+
   7  | Copyright CiviCRM LLC (c) 2004-2020                                |
   8  +--------------------------------------------------------------------+
   9  | This file is a part of CiviCRM.                                    |
  10  |                                                                    |
  11  | CiviCRM is free software; you can copy, modify, and distribute it  |
  12  | under the terms of the GNU Affero General Public License           |
  13  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  14  |                                                                    |
  15  | CiviCRM is distributed in the hope that it will be useful, but     |
  16  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  17  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  18  | See the GNU Affero General Public License for more details.        |
  19  |                                                                    |
  20  | You should have received a copy of the GNU Affero General Public   |
  21  | License and the CiviCRM Licensing Exception along                  |
  22  | with this program; if not, contact CiviCRM LLC                     |
  23  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  24  | GNU Affero General Public License or the licensing of CiviCRM,     |
  25  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  26  +--------------------------------------------------------------------+
  27  */
  28
  29 /**
  30  *
  31  * @package CRM
  32  * @copyright CiviCRM LLC (c) 2004-2020
  33  * $Id$
  34  *
  35  */
  36
  37
  38 namespace Civi\Api4\Generic;
  39
  40 use Civi\API\Exception\NotImplementedException;
  41
  42 /**
  43  * Create a new object from supplied values.
  44  *
  45  * This function will create 1 new object. It cannot be used to update existing objects. Use the Update or Replace actions for that.
  46  */
  47 class BasicCreateAction extends AbstractCreateAction {
  48
  49   /**
  50    * @var callable
  51    *
  52    * Function(array $item, BasicCreateAction $thisAction) => array
  53    */
  54   private $setter;
  55
  56   /**
  57    * Basic Create constructor.
  58    *
  59    * @param string $entityName
  60    * @param string $actionName
  61    * @param callable $setter
  62    *   Function(array $item, BasicCreateAction $thisAction) => array
  63    */
  64   public function __construct($entityName, $actionName, $setter = NULL) {
  65     parent::__construct($entityName, $actionName);
  66     $this->setter = $setter;
  67   }
  68
  69   /**
  70    * We pass the writeRecord function an array representing one item to write.
  71    * We expect to get the same format back.
  72    *
  73    * @param \Civi\Api4\Generic\Result $result
  74    */
  75   public function _run(Result $result) {
  76     $this->validateValues();
  77     $result->exchangeArray([$this->writeRecord($this->values)]);
  78   }
  79
  80   /**
  81    * This Basic Create class can be used in one of two ways:
  82    *
  83    * 1. Use this class directly by passing a callable ($setter) to the constructor.
  84    * 2. Extend this class and override this function.
  85    *
  86    * Either way, this function should return an array representing the one new object.
  87    *
  88    * @param array $item
  89    * @return array
  90    * @throws \Civi\API\Exception\NotImplementedException
  91    */
  92   protected function writeRecord($item) {
  93     if (is_callable($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 }