4 +--------------------------------------------------------------------+
6 +--------------------------------------------------------------------+
7 | Copyright CiviCRM LLC (c) 2004-2019 |
8 +--------------------------------------------------------------------+
9 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
32 * @copyright CiviCRM LLC (c) 2004-2019
38 namespace Civi\Api4\Generic
;
41 * Delete one or more items, based on criteria specified in Where param (required).
43 class DAODeleteAction
extends AbstractBatchAction
{
44 use Traits\DAOActionTrait
;
47 * Batch delete function
49 public function _run(Result
$result) {
50 $defaults = $this->getParamDefaults();
51 if ($defaults['where'] && !array_diff_key($this->where
, $defaults['where'])) {
52 throw new \
API_Exception('Cannot delete ' . $this->getEntityName() . ' with no "where" parameter specified');
55 $items = $this->getObjects();
58 throw new \
API_Exception('Cannot delete ' . $this->getEntityName() . ', no records found with ' . $this->whereClauseToString());
61 $ids = $this->deleteObjects($items);
63 $result->exchangeArray($ids);
69 * @throws \API_Exception
71 protected function deleteObjects($items) {
73 $baoName = $this->getBaoName();
75 if ($this->getCheckPermissions()) {
76 foreach ($items as $item) {
77 $this->checkContactPermissions($baoName, $item);
81 if ($this->getEntityName() !== 'EntityTag' && method_exists($baoName, 'del')) {
82 foreach ($items as $item) {
83 $args = [$item['id']];
84 $bao = call_user_func_array([$baoName, 'del'], $args);
86 $ids[] = ['id' => $item['id']];
89 throw new \
API_Exception("Could not delete {$this->getEntityName()} id {$item['id']}");
94 foreach ($items as $item) {
95 $bao = new $baoName();
96 $bao->id
= $item['id'];
98 $action_result = $bao->delete();
100 $ids[] = ['id' => $item['id']];
103 throw new \
API_Exception("Could not delete {$this->getEntityName()} id {$item['id']}");