Civi/API/Event/Event.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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    * @var \Civi\API\Provider\ProviderInterface
  37    *   The API provider responsible for executing the request.
  38    */
  39   protected $apiProvider;
  40
  41   /**
  42    * @var array
  43    *   The full description of the API request.
  44    *
  45    * @see \Civi\API\Request::create
  46    */
  47   protected $apiRequest;
  48
  49   /**
  50    * @param \Civi\API\Provider\ProviderInterface $apiProvider
  51    *   The API responsible for executing the request.
  52    * @param array $apiRequest
  53    *   The full description of the API request.
  54    */
  55   public function __construct($apiProvider, $apiRequest) {
  56     $this->apiProvider = $apiProvider;
  57     $this->apiRequest = $apiRequest;
  58   }
  59
  60   /**
  61    * @return \Civi\API\Provider\ProviderInterface
  62    */
  63   public function getApiProvider() {
  64     return $this->apiProvider;
  65   }
  66
  67   /**
  68    * @return array
  69    */
  70   public function getApiRequest() {
  71     return $this->apiRequest;
  72   }
  73
  74 }