Civi/CCase/Events.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.5                                                |
   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 namespace Civi\CCase;
  28
  29 class Events {
  30   /**
  31    * @var array (int $caseId => bool $active) list of cases for which we are actively firing case-change event
  32    *
  33    * We do not want to fire case-change events recursively.
  34    */
  35   static $isActive = array();
  36
  37   /**
  38    * Following a change to an activity or case, fire the case-change event.
  39    *
  40    * @param \Civi\Core\Event\PostEvent $event
  41    * @throws \CRM_Core_Exception
  42    */
  43   public static function fireCaseChange(\Civi\Core\Event\PostEvent $event) {
  44     $caseId = NULL;
  45     switch ($event->entity) {
  46       case 'Activity':
  47         if (!empty($event->object->case_id)) {
  48           $caseId = $event->object->case_id;
  49         }
  50         break;
  51       case 'Case':
  52         // by the time we get the post-delete event, the record is gone, so
  53         // there's nothing to analyze
  54         if ($event->action != 'delete') {
  55           $caseId = $event->id;
  56         }
  57         break;
  58       default:
  59         throw new \CRM_Core_Exception("CRM_Case_Listener does not support entity {$event->entity}");
  60     }
  61
  62     if ($caseId) {
  63       if (!isset(self::$isActive[$caseId])) {
  64         \CRM_Core_Transaction::addCallback(
  65           \CRM_Core_Transaction::PHASE_POST_COMMIT,
  66           array(__CLASS__, 'fireCaseChangeForRealz'),
  67           array($caseId),
  68           "Civi_CCase_Events::fire::{$caseId}"
  69         );
  70       }
  71     }
  72   }
  73
  74   public static function fireCaseChangeForRealz($caseId) {
  75     if (!isset(self::$isActive[$caseId])) {
  76       $tx = new \CRM_Core_Transaction();
  77       self::$isActive[$caseId] = 1;
  78       $analyzer = new \Civi\CCase\Analyzer($caseId);
  79       \CRM_Utils_Hook::caseChange($analyzer);
  80       unset(self::$isActive[$caseId]);
  81       unset($tx);
  82     }
  83   }
  84
  85   /**
  86    * Find any extra listeners declared in XML and pass the event along to them
  87    *
  88    * @param Event\CaseChangeEvent $event
  89    */
  90   public static function delegateToXmlListeners(\Civi\CCase\Event\CaseChangeEvent $event) {
  91     $p = new \CRM_Case_XMLProcessor_Process();
  92     $listeners = $p->getListeners($event->analyzer->getCaseType());
  93     foreach ($listeners as $listener) {
  94       /** @var $listener \Civi\CCase\CaseChangeListener */
  95       $listener->onCaseChange($event);
  96     }
  97   }
  98 }