Civi/Core/Event/PostEvent.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2019                                |
   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\Core\Event;
  29
  30 /**
  31  * Class AuthorizeEvent
  32  * @package Civi\API\Event
  33  */
  34 class PostEvent extends GenericHookEvent {
  35
  36   /**
  37    * This adapter automatically emits a narrower event.
  38    *
  39    * For example, `hook_civicrm_pre(Contact, ...)` will also dispatch `hook_civicrm_pre::Contact`.
  40    *
  41    * @param \Civi\Core\Event\PostEvent $event
  42    */
  43   public static function dispatchSubevent(PostEvent $event) {
  44     \Civi::service('dispatcher')->dispatch("hook_civicrm_post::" . $event->entity, $event);
  45   }
  46
  47   /**
  48    * @var string 'create'|'edit'|'delete' etc
  49    */
  50   public $action;
  51
  52   /**
  53    * @var string
  54    */
  55   public $entity;
  56
  57   /**
  58    * @var int|NULL
  59    */
  60   public $id;
  61
  62   /**
  63    * @var Object
  64    */
  65   public $object;
  66
  67   /**
  68    * @param $action
  69    * @param $entity
  70    * @param $id
  71    * @param $object
  72    */
  73   public function __construct($action, $entity, $id, &$object) {
  74     $this->action = $action;
  75     $this->entity = $entity;
  76     $this->id = $id;
  77     $this->object = &$object;
  78   }
  79
  80   /**
  81    * @inheritDoc
  82    */
  83   public function getHookValues() {
  84     return array($this->action, $this->entity, $this->id, &$this->object);
  85   }
  86
  87 }