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 | use Civi\API\Exception\NotImplementedException; | |
41 | ||
42 | /** | |
43 | * Basic action for deleting or performing some other task with a set of records. Ex: | |
44 | * | |
45 | * $myAction = new BasicBatchAction('Entity', 'action', function($item) { | |
46 | * // Do something with $item | |
47 | * $return $item; | |
48 | * }); | |
49 | * | |
50 | * @package Civi\Api4\Generic | |
51 | */ | |
52 | class BasicBatchAction extends AbstractBatchAction { | |
53 | ||
54 | /** | |
55 | * @var callable | |
56 | * | |
57 | * Function(array $item, BasicBatchAction $thisAction) => array | |
58 | */ | |
59 | private $doer; | |
60 | ||
61 | /** | |
62 | * BasicBatchAction constructor. | |
63 | * | |
64 | * @param string $entityName | |
65 | * @param string $actionName | |
66 | * @param string|array $select | |
67 | * One or more fields to select from each matching item. | |
68 | * @param callable $doer | |
69 | * Function(array $item, BasicBatchAction $thisAction) => array | |
70 | */ | |
71 | public function __construct($entityName, $actionName, $select = 'id', $doer = NULL) { | |
72 | parent::__construct($entityName, $actionName, $select); | |
73 | $this->doer = $doer; | |
74 | } | |
75 | ||
76 | /** | |
77 | * We pass the doTask function an array representing one item to update. | |
78 | * We expect to get the same format back. | |
79 | * | |
80 | * @param \Civi\Api4\Generic\Result $result | |
81 | */ | |
82 | public function _run(Result $result) { | |
83 | foreach ($this->getBatchRecords() as $item) { | |
84 | $result[] = $this->doTask($item); | |
85 | } | |
86 | } | |
87 | ||
88 | /** | |
89 | * This Basic Batch class can be used in one of two ways: | |
90 | * | |
91 | * 1. Use this class directly by passing a callable ($doer) to the constructor. | |
92 | * 2. Extend this class and override this function. | |
93 | * | |
94 | * Either way, this function should return an array with an output record | |
95 | * for the item. | |
96 | * | |
97 | * @param array $item | |
98 | * @return array | |
99 | * @throws \Civi\API\Exception\NotImplementedException | |
100 | */ | |
101 | protected function doTask($item) { | |
102 | if (is_callable($this->doer)) { | |
103 | return call_user_func($this->doer, $item, $this); | |
104 | } | |
105 | throw new NotImplementedException('Doer function not found for api4 ' . $this->getEntityName() . '::' . $this->getActionName()); | |
106 | } | |
107 | ||
108 | } |