3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2020 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
28 namespace Civi\API\Event
;
30 use Civi\API\Provider\WrappingProvider
;
34 * @package Civi\API\Event
36 class PrepareEvent
extends Event
{
39 * @param array $apiRequest
40 * The full description of the API request.
41 * @return PrepareEvent
43 public function setApiRequest($apiRequest) {
44 $this->apiRequest
= $apiRequest;
49 * Replace the normal implementation of an API call with some wrapper.
51 * The wrapper has discretion to call -- or not call -- or iterate with --
52 * the original API implementation, with original or substituted arguments.
56 * $event->wrapApi(function($apiRequest, $continue){
58 * $continue($apiRequest);
62 * @param callable $callback
63 * The custom API implementation.
64 * Function(array $apiRequest, callable $continue).
65 * @return PrepareEvent
67 public function wrapApi($callback) {
68 $this->apiProvider
= new WrappingProvider($callback, $this->apiProvider
);