Civi/Api4/Generic/BasicBatchAction.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 namespace Civi\Api4\Generic;
  14
  15 use Civi\API\Exception\NotImplementedException;
  16 use Civi\API\Exception\UnauthorizedException;
  17 use Civi\Api4\Utils\CoreUtil;
  18
  19 /**
  20  * $ACTION one or more $ENTITIES.
  21  *
  22  * $ENTITIES are selected based on criteria specified in `where` parameter (required).
  23  *
  24  * @package Civi\Api4\Generic
  25  */
  26 class BasicBatchAction extends AbstractBatchAction {
  27
  28   /**
  29    * @var callable
  30    *   Function(array $item, BasicBatchAction $thisAction): array
  31    */
  32   private $doer;
  33
  34   /**
  35    * BasicBatchAction constructor.
  36    *
  37    * ```php
  38    * $myAction = new BasicBatchAction($entityName, $actionName, function($item) {
  39    *   // Do something with $item
  40    *   $return $item;
  41    * });
  42    * ```
  43    *
  44    * @param string $entityName
  45    * @param string $actionName
  46    * @param callable $doer
  47    */
  48   public function __construct($entityName, $actionName, $doer = NULL) {
  49     parent::__construct($entityName, $actionName);
  50     $this->doer = $doer;
  51     // Accept doer as 4th param for now, but emit deprecated warning
  52     $this->doer = func_get_args()[3] ?? NULL;
  53     if ($this->doer) {
  54       \CRM_Core_Error::deprecatedWarning(__CLASS__ . ' constructor received $doer as 4th param; it should be the 3rd as the $select param has been removed');
  55     }
  56     else {
  57       $this->doer = $doer;
  58     }
  59   }
  60
  61   /**
  62    * We pass the doTask function an array representing one item to update.
  63    * We expect to get the same format back.
  64    *
  65    * @param \Civi\Api4\Generic\Result $result
  66    */
  67   public function _run(Result $result) {
  68     foreach ($this->getBatchRecords() as $item) {
  69       if ($this->checkPermissions && !CoreUtil::checkAccessRecord($this, $item, \CRM_Core_Session::getLoggedInContactID() ?: 0)) {
  70         throw new UnauthorizedException("ACL check failed");
  71       }
  72       $result[] = $this->doTask($item);
  73     }
  74   }
  75
  76   /**
  77    * This Basic Batch class can be used in one of two ways:
  78    *
  79    * 1. Use this class directly by passing a callable ($doer) to the constructor.
  80    * 2. Extend this class and override this function.
  81    *
  82    * Either way, this function should return an array with an output record
  83    * for the item.
  84    *
  85    * @param array $item
  86    * @return array
  87    * @throws \Civi\API\Exception\NotImplementedException
  88    */
  89   protected function doTask($item) {
  90     if (is_callable($this->doer)) {
  91       $this->addCallbackToDebugOutput($this->doer);
  92       return call_user_func($this->doer, $item, $this);
  93     }
  94     throw new NotImplementedException('Doer function not found for api4 ' . $this->getEntityName() . '::' . $this->getActionName());
  95   }
  96
  97 }