Civi/API/Event/ExceptionEvent.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2020                                |
   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 ExceptionEvent
  32  * @package Civi\API\Event
  33  */
  34 class ExceptionEvent extends Event {
  35
  36   /**
  37    * @var \Exception
  38    */
  39   private $exception;
  40
  41   /**
  42    * @param \Exception $exception
  43    *   The exception which arose while processing the API request.
  44    * @param \Civi\API\Provider\ProviderInterface $apiProvider
  45    *   The API provider responsible for executing the request.
  46    * @param array $apiRequest
  47    *   The full description of the API request.
  48    * @param \Civi\API\Kernel $apiKernel
  49    *   The kernel which fired the event.
  50    */
  51   public function __construct($exception, $apiProvider, $apiRequest, $apiKernel) {
  52     $this->exception = $exception;
  53     parent::__construct($apiProvider, $apiRequest, $apiKernel);
  54   }
  55
  56   /**
  57    * @return \Exception
  58    */
  59   public function getException() {
  60     return $this->exception;
  61   }
  62
  63 }