Civi/Api4/Generic/DAODeleteAction.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  * Delete one or more $ENTITIES.
  24  *
  25  * $ENTITIES are deleted based on criteria specified in `where` parameter (required).
  26  */
  27 class DAODeleteAction extends AbstractBatchAction {
  28   use Traits\DAOActionTrait;
  29
  30   /**
  31    * Batch delete function
  32    */
  33   public function _run(Result $result) {
  34     $defaults = $this->getParamDefaults();
  35     if ($defaults['where'] && $this->where === $defaults['where']) {
  36       throw new \API_Exception('Cannot delete ' . $this->getEntityName() . ' with no "where" parameter specified');
  37     }
  38
  39     $items = $this->getBatchRecords();
  40     if ($items) {
  41       $result->exchangeArray($this->deleteObjects($items));
  42     }
  43   }
  44
  45   /**
  46    * @param $items
  47    * @return array
  48    * @throws \API_Exception
  49    */
  50   protected function deleteObjects($items) {
  51     $ids = [];
  52     $baoName = $this->getBaoName();
  53
  54     if ($this->getCheckPermissions()) {
  55       foreach (array_keys($items) as $key) {
  56         $items[$key]['check_permissions'] = TRUE;
  57         $this->checkContactPermissions($baoName, $items[$key]);
  58       }
  59     }
  60
  61     if ($this->getEntityName() !== 'EntityTag' && method_exists($baoName, 'del')) {
  62       foreach ($items as $item) {
  63         $args = [$item['id']];
  64         $bao = call_user_func_array([$baoName, 'del'], $args);
  65         if ($bao !== FALSE) {
  66           $ids[] = ['id' => $item['id']];
  67         }
  68         else {
  69           throw new \API_Exception("Could not delete {$this->getEntityName()} id {$item['id']}");
  70         }
  71       }
  72     }
  73     else {
  74       foreach ($items as $item) {
  75         $baoName::deleteRecord($item);
  76         $ids[] = ['id' => $item['id']];
  77       }
  78     }
  79     return $ids;
  80   }
  81
  82 }