Civi/Api4/Generic/BasicUpdateAction.php

   1 <?php
   2
   3 /*
   4  +--------------------------------------------------------------------+
   5  | CiviCRM version 5                                                  |
   6  +--------------------------------------------------------------------+
   7  | Copyright CiviCRM LLC (c) 2004-2019                                |
   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-2019
  33  * $Id$
  34  *
  35  */
  36
  37
  38 namespace Civi\Api4\Generic;
  39
  40 use Civi\API\Exception\NotImplementedException;
  41
  42 /**
  43  * Update one or more records with new values.
  44  *
  45  * Use the where clause (required) to select them.
  46  */
  47 class BasicUpdateAction extends AbstractUpdateAction {
  48
  49   /**
  50    * @var callable
  51    *
  52    * Function(array $item, BasicUpdateAction $thisAction) => array
  53    */
  54   private $setter;
  55
  56   /**
  57    * BasicUpdateAction constructor.
  58    *
  59    * @param string $entityName
  60    * @param string $actionName
  61    * @param string|array $select
  62    *   One or more fields to select from each matching item.
  63    * @param callable $setter
  64    *   Function(array $item, BasicUpdateAction $thisAction) => array
  65    */
  66   public function __construct($entityName, $actionName, $select = 'id', $setter = NULL) {
  67     parent::__construct($entityName, $actionName, $select);
  68     $this->setter = $setter;
  69   }
  70
  71   /**
  72    * We pass the writeRecord function an array representing one item to update.
  73    * We expect to get the same format back.
  74    *
  75    * @param \Civi\Api4\Generic\Result $result
  76    * @throws \API_Exception
  77    * @throws \Civi\API\Exception\NotImplementedException
  78    */
  79   public function _run(Result $result) {
  80     foreach ($this->getBatchRecords() as $item) {
  81       $result[] = $this->writeRecord($this->values + $item);
  82     }
  83
  84     if (!$result->count()) {
  85       throw new \API_Exception('Cannot ' . $this->getActionName() . ' ' . $this->getEntityName() . ', no records found with ' . $this->whereClauseToString());
  86     }
  87   }
  88
  89   /**
  90    * This Basic Update class can be used in one of two ways:
  91    *
  92    * 1. Use this class directly by passing a callable ($setter) to the constructor.
  93    * 2. Extend this class and override this function.
  94    *
  95    * Either way, this function should return an array representing the one modified object.
  96    *
  97    * @param array $item
  98    * @return array
  99    * @throws \Civi\API\Exception\NotImplementedException
 100    */
 101   protected function writeRecord($item) {
 102     if (is_callable($this->setter)) {
 103       return call_user_func($this->setter, $item, $this);
 104     }
 105     throw new NotImplementedException('Setter function not found for api4 ' . $this->getEntityName() . '::' . $this->getActionName());
 106   }
 107
 108 }