Merge pull request #17871 from seamuslee001/deprecated_jquery
[civicrm-core.git] / Civi / ActionSchedule / Event / MappingRegisterEvent.php
index 7bd0d2899b7e0a459b9588a7b1bac3483217af28..ef8c7f3750366f0e973011c62c8b4e402d6cb318 100644 (file)
@@ -9,6 +9,8 @@ use Symfony\Component\EventDispatcher\Event;
  * @package Civi\ActionSchedule\Event
  *
  * Register any available mappings.
+ *
+ * Event name: 'civi.actionSchedule.getMappings'
  */
 class MappingRegisterEvent extends Event {
 
@@ -16,14 +18,14 @@ class MappingRegisterEvent extends Event {
    * @var array
    *   Array(scalar $id => Mapping $mapping).
    */
-  protected $mappings = array();
+  protected $mappings = [];
 
   /**
    * Register a new mapping.
    *
-   * @param MappingInterface $mapping
+   * @param \Civi\ActionSchedule\MappingInterface $mapping
    *   The new mapping.
-   * @return $this
+   * @return MappingRegisterEvent
    */
   public function register(MappingInterface $mapping) {
     $this->mappings[$mapping->getId()] = $mapping;