Civi/API/Event/PrepareEvent.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2019                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  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.   |
  13  |                                                                    |
  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.        |
  18  |                                                                    |
  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  +--------------------------------------------------------------------+
  26  */
  27
  28 namespace Civi\API\Event;
  29 use Civi\API\Provider\WrappingProvider;
  30
  31 /**
  32  * Class PrepareEvent
  33  * @package Civi\API\Event
  34  */
  35 class PrepareEvent extends Event {
  36
  37   /**
  38    * @param array $apiRequest
  39    *   The full description of the API request.
  40    * @return PrepareEvent
  41    */
  42   public function setApiRequest($apiRequest) {
  43     $this->apiRequest = $apiRequest;
  44     return $this;
  45   }
  46
  47   /**
  48    * Replace the normal implementation of an API call with some wrapper.
  49    *
  50    * The wrapper has discretion to call -- or not call -- or iterate with --
  51    * the original API implementation, with original or substituted arguments.
  52    *
  53    * Ex:
  54    *
  55    * $event->wrapApi(function($apiRequest, $continue){
  56    *   echo "Hello\n";
  57    *   $continue($apiRequest);
  58    *   echo "Goodbye\n";
  59    * });
  60    *
  61    * @param callable $callback
  62    *   The custom API implementation.
  63    *   Function(array $apiRequest, callable $continue).
  64    * @return PrepareEvent
  65    */
  66   public function wrapApi($callback) {
  67     $this->apiProvider = new WrappingProvider($callback, $this->apiProvider);
  68     return $this;
  69   }
  70
  71 }