From 346d50ec76e72097d27cab3ef421fa01171ea1ef Mon Sep 17 00:00:00 2001
From: Alba2020 <alba2020@gmail.com>
Date: Wed, 29 Jun 2022 18:12:34 +0300
Subject: [PATCH] add SitemapGeneratedEvent

---
 src/console/controllers/SitemapController.php |  3 +
 src/events/SitemapGeneratedEvent.php          | 56 +++++++++++++++++++
 src/helpers/Sitemap.php                       | 29 +++++++++-
 3 files changed, 85 insertions(+), 3 deletions(-)
 create mode 100644 src/events/SitemapGeneratedEvent.php

diff --git a/src/console/controllers/SitemapController.php b/src/console/controllers/SitemapController.php
index 89414f065..4a32416fc 100644
--- a/src/console/controllers/SitemapController.php
+++ b/src/console/controllers/SitemapController.php
@@ -9,6 +9,8 @@
 
 namespace nystudio107\seomatic\console\controllers;
 
+use nystudio107\seomatic\events\SitemapGeneratedEvent;
+use nystudio107\seomatic\helpers\Sitemap;
 use nystudio107\seomatic\models\MetaBundle;
 use nystudio107\seomatic\models\SitemapTemplate;
 use nystudio107\seomatic\Seomatic;
@@ -16,6 +18,7 @@
 use Craft;
 use craft\helpers\App;
 
+use yii\base\Event;
 use yii\console\Controller;
 
 /**
diff --git a/src/events/SitemapGeneratedEvent.php b/src/events/SitemapGeneratedEvent.php
new file mode 100644
index 000000000..880801090
--- /dev/null
+++ b/src/events/SitemapGeneratedEvent.php
@@ -0,0 +1,56 @@
+<?php
+/**
+ * SEOmatic plugin for Craft CMS 3.x
+ *
+ * A turnkey SEO implementation for Craft CMS that is comprehensive, powerful,
+ * and flexible
+ *
+ * @link      https://nystudio107.com
+ * @copyright Copyright (c) 2017 nystudio107
+ */
+
+namespace nystudio107\seomatic\events;
+
+use yii\base\Event;
+use yii\caching\Dependency;
+
+/**
+ * @author    yournextagency
+ * @package   Seomatic
+ * @since     3.1.0
+ */
+class SitemapGeneratedEvent extends Event
+{
+    // Properties
+    // =========================================================================
+
+    /**
+     * @var int The site id
+     */
+    public $siteId;
+
+    /**
+     * @var int Group id
+     */
+    public $groupId;
+
+    /**
+     * @var string $handle
+     */
+    public $handle;
+
+    /**
+     * @var string type
+     */
+    public $type;
+
+    /**
+     * @var string The cache key
+     */
+    public $cacheKey;
+
+    /**
+     * @var Dependency Cache dependency
+     */
+    public $cacheDependency;
+}
diff --git a/src/helpers/Sitemap.php b/src/helpers/Sitemap.php
index 27df777d5..087be3831 100644
--- a/src/helpers/Sitemap.php
+++ b/src/helpers/Sitemap.php
@@ -1,6 +1,9 @@
 <?php
 namespace nystudio107\seomatic\helpers;
 
+use nystudio107\seomatic\events\RegisterSitemapsEvent;
+use nystudio107\seomatic\events\SitemapGeneratedEvent;
+use nystudio107\seomatic\models\SitemapIndexTemplate;
 use nystudio107\seomatic\Seomatic;
 use nystudio107\fastcgicachebust\FastcgiCacheBust;
 use nystudio107\seomatic\base\SeoElementInterface;
@@ -20,6 +23,7 @@
 use craft\fields\Assets as AssetsField;
 use craft\models\SiteGroup;
 
+use yii\base\Event;
 use yii\base\Exception;
 use yii\caching\TagDependency;
 use yii\helpers\Html;
@@ -31,6 +35,14 @@
  */
 class Sitemap
 {
+    // Constants
+    // =========================================================================
+
+    const EVENT_SITEMAP_GENERATED = 'sitemapGenerated';
+
+    // Static Methods
+    // =========================================================================
+
     public static function generateSitemap(array $params)
     {
         /** @var \craft\queue\Queue $queue */
@@ -226,7 +238,7 @@ public static function generateSitemap(array $params)
                                     // Make sure to only include the `hreflang` if the element exists,
                                     // and sitemaps are on for it
                                     if ($altElement && $altElement->url) {
-                                        list($altSourceId, $altSourceBundleType, $altSourceHandle, $altSourceSiteId, $altTypeId)
+                                        [$altSourceId, $altSourceBundleType, $altSourceHandle, $altSourceSiteId, $altTypeId]
                                             = Seomatic::$plugin->metaBundles->getMetaSourceFromElement($altElement);
                                         $altMetaBundle = Seomatic::$plugin->metaBundles->getMetaBundleBySourceId(
                                             $altSourceBundleType,
@@ -355,6 +367,7 @@ public static function generateSitemap(array $params)
             ],
         ]);
         $lines = implode('', $lines);
+
         // Cache sitemap cache; we use this instead of Seomatic::$cacheDuration because for
         // Control Panel requests, we set Seomatic::$cacheDuration = 1 so that they are never
         // cached
@@ -374,8 +387,18 @@ public static function generateSitemap(array $params)
         if ($plugin !== null) {
             FastcgiCacheBust::$plugin->cache->clearAll();
         }
-    }
 
+        // Fire event
+        $event = new SitemapGeneratedEvent([
+          'siteId' => $siteId,
+          'groupId' => $groupId,
+          'handle' => $handle,
+          'type' => $type,
+          'cacheKey' => $cacheKey,
+          'cacheDependency' => $dependency,
+        ]);
+        Event::trigger(Sitemap::class, Sitemap::EVENT_SITEMAP_GENERATED, $event);
+    }
 
     /**
      * Combine any per-entry type field settings from $element with the passed in
@@ -388,7 +411,7 @@ public static function generateSitemap(array $params)
     protected static function combineEntryTypeSettings($seoElement, Element $element, MetaBundle $metaBundle)
     {
         if (!empty($seoElement::typeMenuFromHandle($metaBundle->sourceHandle))) {
-            list($sourceId, $sourceBundleType, $sourceHandle, $sourceSiteId, $typeId)
+            [$sourceId, $sourceBundleType, $sourceHandle, $sourceSiteId, $typeId]
                 = Seomatic::$plugin->metaBundles->getMetaSourceFromElement($element);
             $entryTypeBundle = Seomatic::$plugin->metaBundles->getMetaBundleBySourceId(
                 $sourceBundleType,