Civi/API/Subscriber/TransactionSubscriber.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.4                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2013                                |
   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\Subscriber;
  29 use Civi\API\Events;
  30 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  31
  32 /**
  33  * Class TransactionSubscriber
  34  * @package Civi\API\Subscriber
  35  */
  36 class TransactionSubscriber implements EventSubscriberInterface {
  37   /**
  38    * @return array
  39    */
  40   public static function getSubscribedEvents() {
  41     return array(
  42       Events::PREPARE => array('onApiPrepare', Events::W_EARLY),
  43       Events::RESPOND => array('onApiRespond', Events::W_MIDDLE),
  44       Events::EXCEPTION => array('onApiException', Events::W_EARLY),
  45     );
  46   }
  47
  48   /**
  49    * @var array (scalar $apiRequestId => CRM_Core_Transaction $tx)
  50    */
  51   private $transactions = array();
  52
  53   /**
  54    * Determine if an API request should be treated as transactional
  55    *
  56    * @param \Civi\API\Provider\ProviderInterface $apiProvider
  57    * @param array $apiRequest
  58    * @return bool
  59    */
  60   public function isTransactional($apiProvider, $apiRequest) {
  61     if (isset($apiRequest['params']['is_transactional'])) {
  62       return \CRM_Utils_String::strtobool($apiRequest['params']['is_transactional']);
  63     }
  64     return strtolower($apiRequest['action']) == 'create' || strtolower($apiRequest['action']) == 'delete' || strtolower($apiRequest['action']) == 'submit';
  65   }
  66
  67   /**
  68    * Open a new transaction instance (if appropriate in the current policy)
  69    *
  70    * @param \Civi\API\Event\PrepareEvent $event
  71    */
  72   function onApiPrepare(\Civi\API\Event\PrepareEvent $event) {
  73     $apiRequest = $event->getApiRequest();
  74     if ($this->isTransactional($event->getApiProvider(), $apiRequest)) {
  75       $this->transactions[$apiRequest['id']] = new \CRM_Core_Transaction();
  76     }
  77   }
  78
  79   /**
  80    * Close any pending transactions
  81    */
  82   function onApiRespond(\Civi\API\Event\RespondEvent $event) {
  83     $apiRequest = $event->getApiRequest();
  84     if (isset($this->transactions[$apiRequest['id']])) {
  85       if (civicrm_error($event->getResponse())) {
  86         $this->transactions[$apiRequest['id']]->rollback();
  87       }
  88       unset($this->transactions[$apiRequest['id']]);
  89     }
  90   }
  91
  92   /**
  93    * Rollback the pending transaction
  94    *
  95    * @param \Civi\API\Event\ExceptionEvent $event
  96    */
  97   function onApiException(\Civi\API\Event\ExceptionEvent $event) {
  98     $apiRequest = $event->getApiRequest();
  99     if (isset($this->transactions[$apiRequest['id']])) {
 100       $this->transactions[$apiRequest['id']]->rollback();
 101       unset($this->transactions[$apiRequest['id']]);
 102     }
 103   }
 104 }