crm.fsf.org/20131203/files/sites/all/modules-new/civicrm/Civi/CCase/Events.php

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