Commit | Line | Data |
---|---|---|
19b53e5b C |
1 | <?php |
2 | ||
380f3545 TO |
3 | /* |
4 | +--------------------------------------------------------------------+ | |
5 | | CiviCRM version 5 | | |
6 | +--------------------------------------------------------------------+ | |
f299f7db | 7 | | Copyright CiviCRM LLC (c) 2004-2020 | |
380f3545 TO |
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 | |
f299f7db | 32 | * @copyright CiviCRM LLC (c) 2004-2020 |
380f3545 TO |
33 | * $Id$ |
34 | * | |
35 | */ | |
36 | ||
37 | ||
19b53e5b C |
38 | namespace Civi\Api4\Generic; |
39 | ||
40 | /** | |
41 | * Delete one or more items, based on criteria specified in Where param (required). | |
42 | */ | |
43 | class DAODeleteAction extends AbstractBatchAction { | |
44 | use Traits\DAOActionTrait; | |
45 | ||
46 | /** | |
47 | * Batch delete function | |
48 | */ | |
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'); | |
53 | } | |
54 | ||
55 | $items = $this->getObjects(); | |
56 | ||
57 | if (!$items) { | |
58 | throw new \API_Exception('Cannot delete ' . $this->getEntityName() . ', no records found with ' . $this->whereClauseToString()); | |
59 | } | |
60 | ||
61 | $ids = $this->deleteObjects($items); | |
62 | ||
63 | $result->exchangeArray($ids); | |
64 | } | |
65 | ||
66 | /** | |
67 | * @param $items | |
68 | * @return array | |
69 | * @throws \API_Exception | |
70 | */ | |
71 | protected function deleteObjects($items) { | |
72 | $ids = []; | |
73 | $baoName = $this->getBaoName(); | |
74 | ||
75 | if ($this->getCheckPermissions()) { | |
76 | foreach ($items as $item) { | |
77 | $this->checkContactPermissions($baoName, $item); | |
78 | } | |
79 | } | |
80 | ||
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); | |
85 | if ($bao !== FALSE) { | |
86 | $ids[] = ['id' => $item['id']]; | |
87 | } | |
88 | else { | |
89 | throw new \API_Exception("Could not delete {$this->getEntityName()} id {$item['id']}"); | |
90 | } | |
91 | } | |
92 | } | |
93 | else { | |
94 | foreach ($items as $item) { | |
95 | $bao = new $baoName(); | |
96 | $bao->id = $item['id']; | |
97 | // delete it | |
98 | $action_result = $bao->delete(); | |
99 | if ($action_result) { | |
100 | $ids[] = ['id' => $item['id']]; | |
101 | } | |
102 | else { | |
103 | throw new \API_Exception("Could not delete {$this->getEntityName()} id {$item['id']}"); | |
104 | } | |
105 | } | |
106 | } | |
107 | return $ids; | |
108 | } | |
109 | ||
110 | } |