Civi/Api4/Generic/DAOUpdateAction.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 /**
  23  * Update one or more $ENTITY with new values.
  24  *
  25  * Use the `where` clause (required) to select them.
  26  */
  27 class DAOUpdateAction extends AbstractUpdateAction {
  28   use Traits\DAOActionTrait;
  29
  30   /**
  31    * Criteria for selecting items to update.
  32    *
  33    * Required if no id is supplied in values.
  34    *
  35    * @var array
  36    */
  37   protected $where = [];
  38
  39   /**
  40    * @inheritDoc
  41    */
  42   public function _run(Result $result) {
  43     $this->formatWriteValues($this->values);
  44     // Add ID from values to WHERE clause and check for mismatch
  45     if (!empty($this->values['id'])) {
  46       $wheres = array_column($this->where, NULL, 0);
  47       if (!isset($wheres['id'])) {
  48         $this->addWhere('id', '=', $this->values['id']);
  49       }
  50       elseif (!($wheres['id'][1] === '=' && $wheres['id'][2] == $this->values['id'])) {
  51         throw new \Exception("Cannot update the id of an existing " . $this->getEntityName() . '.');
  52       }
  53     }
  54
  55     // Require WHERE if we didn't get an ID from values
  56     if (!$this->where) {
  57       throw new \API_Exception('Parameter "where" is required unless an id is supplied in values.');
  58     }
  59
  60     // Update a single record by ID unless select requires more than id
  61     if ($this->getSelect() === ['id'] && count($this->where) === 1 && $this->where[0][0] === 'id' && $this->where[0][1] === '=' && !empty($this->where[0][2])) {
  62       $this->values['id'] = $this->where[0][2];
  63       $items = [$this->values];
  64       $result->exchangeArray($this->writeObjects($items));
  65       return;
  66     }
  67
  68     // Batch update 1 or more records based on WHERE clause
  69     $items = $this->getBatchRecords();
  70     foreach ($items as &$item) {
  71       $item = $this->values + $item;
  72     }
  73
  74     $result->exchangeArray($this->writeObjects($items));
  75   }
  76
  77 }