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