Civi/API/Event/Event.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
  30 /**
  31  * Class Event
  32  * @package Civi\API\Event
  33  */
  34 class Event extends \Symfony\Component\EventDispatcher\Event {
  35
  36   /**
  37    * @var \Civi\API\Kernel
  38    */
  39   protected $apiKernel;
  40
  41   /**
  42    * @var \Civi\API\Provider\ProviderInterface
  43    *   The API provider responsible for executing the request.
  44    */
  45   protected $apiProvider;
  46
  47   /**
  48    * @var array
  49    *   The full description of the API request.
  50    *
  51    * @see \Civi\API\Request::create
  52    */
  53   protected $apiRequest;
  54
  55   /**
  56    * @param \Civi\API\Provider\ProviderInterface $apiProvider
  57    *   The API responsible for executing the request.
  58    * @param array $apiRequest
  59    *   The full description of the API request.
  60    * @param \Civi\API\Kernel $apiKernel
  61    */
  62   public function __construct($apiProvider, $apiRequest, $apiKernel) {
  63     $this->apiKernel = $apiKernel;
  64     $this->apiProvider = $apiProvider;
  65     $this->apiRequest = $apiRequest;
  66   }
  67
  68   /**
  69    * Get api kernel.
  70    *
  71    * @return \Civi\API\Kernel
  72    */
  73   public function getApiKernel() {
  74     return $this->apiKernel;
  75   }
  76
  77   /**
  78    * @return \Civi\API\Provider\ProviderInterface
  79    */
  80   public function getApiProvider() {
  81     return $this->apiProvider;
  82   }
  83
  84   /**
  85    * @return array
  86    */
  87   public function getApiRequest() {
  88     return $this->apiRequest;
  89   }
  90
  91 }