SitemapIndexTemplate::invalidateCache() - Code Metrics - nystudio107/craft-seomatic - Measure and Improve Code Quality continuously with Scrutinizer

SitemapIndexTemplate::invalidateCache() A
last analyzed 2025-10-07 04:23 UTC

↳ Parent: SitemapIndexTemplate

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
cc	1
eloc	5
nc	1
nop	0
dl	0
loc	7
ccs	0
cts	6
cp	0
crap	2
rs	10
c	0
b	0
f	0

<?php
/**
 * SEOmatic plugin for Craft CMS
 *
 * 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\models;

use Craft;
use craft\models\SiteGroup;
use DateTime;
use Exception;
use nystudio107\seomatic\base\FrontendTemplate;
use nystudio107\seomatic\base\SitemapInterface;
use nystudio107\seomatic\events\RegisterSitemapsEvent;
use nystudio107\seomatic\events\RegisterSitemapUrlsEvent;
use nystudio107\seomatic\helpers\MetaValue as MetaValueHelper;
use nystudio107\seomatic\helpers\Sitemap;
use nystudio107\seomatic\Seomatic;
use yii\base\Event;
use yii\caching\TagDependency;
use yii\helpers\Html;
use yii\web\NotFoundHttpException;
use function in_array;

/**
 * @author    nystudio107
 * @package   Seomatic
 * @since     3.0.0
 */
class SitemapIndexTemplate extends FrontendTemplate implements SitemapInterface
{
    // Constants
    // =========================================================================

    /**
     * @event RegisterSitemapsEvent The event that is triggered when registering
     * additional sitemaps for the sitemap index.
     *
     * ---
     * ```php
     * use nystudio107\seomatic\events\RegisterSitemapsEvent;
     * use nystudio107\seomatic\models\SitemapIndexTemplate;
     * use yii\base\Event;
     * Event::on(SitemapIndexTemplate::class, SitemapIndexTemplate::EVENT_REGISTER_SITEMAPS, function(RegisterSitemapsEvent $e) {
     *     $e->sitemaps[] = [
     *         'loc' => $url,
     *         'lastmod' => $lastMod,
     *     ];
     * });
     * ```
     */
    public const EVENT_REGISTER_SITEMAPS = 'registerSitemaps';

    public const TEMPLATE_TYPE = 'SitemapIndexTemplate';

    public const CACHE_KEY = 'seomatic_sitemap_index';

    public const SITEMAP_INDEX_CACHE_TAG = 'seomatic_sitemap_index';

    // Static Methods
    // =========================================================================

    /**
     * @param array $config
     *
     * @return null|SitemapIndexTemplate
     */
    public static function create(array $config = [])
    {
        $defaults = [
            'path' => 'sitemaps-<groupId:\d+>-sitemap.xml',
            'template' => '',
            'controller' => 'sitemap',
            'action' => 'sitemap-index',
        ];
        $config = array_merge($config, $defaults);

        return new SitemapIndexTemplate($config);
    }

    // Public Properties
    // =========================================================================

    // Public Methods
    // =========================================================================

    /**
     * @inheritdoc
     */
    public function rules(): array
    {
        $rules = parent::rules();
        $rules = array_merge($rules, [
        ]);

        return $rules;
    }

    /**
     * @inheritdoc
     */
    public function fields(): array
    {
        return parent::fields();
    }

    /**
     * Get the filename of the sitemap index.
     *
     * @param int $groupId
     * @return string
     */
    public function getFilename(int $groupId): string
    {
        return 'sitemaps-' . $groupId . '-sitemap.xml';
    }

    /**
     * @inheritdoc
     *
     * @throws NotFoundHttpException if the sitemap.xml doesn't exist
     */
    public function render(array $params = []): string
    {
        $cache = Craft::$app->getCache();
        $groupId = $params['groupId'];
        $siteId = $params['siteId'];
        if (Seomatic::$settings->siteGroupsSeparate) {
            /** @var SiteGroup|null $siteGroup */
            $siteGroup = Craft::$app->getSites()->getGroupById($groupId);
            if ($siteGroup === null) {
                throw new NotFoundHttpException(Craft::t('seomatic', 'Sitemap.xml not found for groupId {groupId}', [
                    'groupId' => $groupId,
                ]));
            }
            $groupSiteIds = $siteGroup->getSiteIds();
        } else {
            $groupSiteIds = Craft::$app->getSites()->allSiteIds;
        }

        $dependency = new TagDependency([
            'tags' => [
                self::GLOBAL_SITEMAP_CACHE_TAG,
                self::SITEMAP_INDEX_CACHE_TAG,
            ],
        ]);

        $cacheDuration = Seomatic::$plugin->helper::isPreview() ? 1 : Seomatic::$cacheDuration;

        return $cache->getOrSet(self::CACHE_KEY . $groupId . '.' . $siteId, function() use ($groupSiteIds, $siteId) {
            Craft::info(
                'Sitemap index cache miss',
                __METHOD__
            );
            $lines = [];
            // Sitemap index XML header and opening tag
            $lines[] = '<?xml version="1.0" encoding="UTF-8"?>';
            $lines[] = '<?xml-stylesheet type="text/xsl" href="sitemap.xsl"?>';
            $lines[] = '<sitemapindex xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">';
            // One sitemap entry for each MeteBundle
            $metaBundles = Seomatic::$plugin->metaBundles->getContentMetaBundlesForSiteId($siteId);
            Seomatic::$plugin->metaBundles->pruneVestigialMetaBundles($metaBundles);
            /** @var MetaBundle $metaBundle */
            foreach ($metaBundles as $metaBundle) {
                $sitemapUrls = $metaBundle->metaSitemapVars->sitemapUrls;
                // Check to see if robots is `none` or `no index`
                $robotsEnabled = true;
                if (!empty($metaBundle->metaGlobalVars->robots)) {
                    $robotsEnabled = $metaBundle->metaGlobalVars->robots !== 'none' &&
                        $metaBundle->metaGlobalVars->robots !== 'noindex';
                }
                if (Seomatic::$plugin->sitemaps->anyEntryTypeHasSitemapUrls($metaBundle)) {
                    $robotsEnabled = true;
                    $sitemapUrls = true;
                }
                // Only add in a sitemap entry if it meets our criteria
                if (in_array($metaBundle->sourceSiteId, $groupSiteIds, false)
                    && $sitemapUrls
                    && $robotsEnabled) {
                    // Get all of the elements for this meta bundle type
                    $seoElement = Seomatic::$plugin->seoElements->getSeoElementByMetaBundleType($metaBundle->sourceBundleType);
                    $totalElements = 0;
                    $pageCount = 0;

                    if ($seoElement !== null) {
                        // Ensure `null` so that the resulting element query is correct
                        if (empty($metaBundle->metaSitemapVars->sitemapLimit)) {
                            $metaBundle->metaSitemapVars->sitemapLimit = null;
                        }

                        $totalElements = Sitemap::getTotalElementsInSitemap($seoElement, $metaBundle) ?? 0;

                        $pageSize = $metaBundle->metaSitemapVars->sitemapPageSize;
                        $pageCount = (!empty($pageSize) && $pageSize > 0) ? ceil($totalElements / $pageSize) : 1;
                    }

                    // Only add a sitemap to the sitemap index if there's at least 1 element in the resulting sitemap
                    if ($totalElements > 0 && $pageCount > 0) {
                        for ($page = 1; $page <= $pageCount; $page++) {
                            $sitemapUrl = Seomatic::$plugin->sitemaps->sitemapUrlForBundle(
                                $metaBundle->sourceBundleType,
                                $metaBundle->sourceHandle,
                                $metaBundle->sourceSiteId,
                                $pageCount > 1 ? $page : 0 // No paging, if only one page
                            );

                            $lines[] = '<sitemap>';
                            $lines[] = '<loc>';
                            $lines[] = Html::encode($sitemapUrl);
                            $lines[] = '</loc>';

                            if ($metaBundle->sourceDateUpdated !== null) {
                                $lines[] = '<lastmod>';
                                $lines[] = $metaBundle->sourceDateUpdated->format(DateTime::W3C);
                                $lines[] = '</lastmod>';
                            }

                            $lines[] = '</sitemap>';
                        }
                    }
                }
            }
            // Custom sitemap entries
            $metaBundle = Seomatic::$plugin->metaBundles->getGlobalMetaBundle($siteId, false);
            if ($metaBundle !== null) {
                $this->addAdditionalSitemapUrls($metaBundle, $siteId, $lines);
                $this->addAdditionalSitemaps($metaBundle, $siteId, $lines);
            }
            // Sitemap index closing tag
            $lines[] = '</sitemapindex>';

            return implode('', $lines);
        }, $cacheDuration, $dependency);
    }

    /**
     * Invalidate the sitemap index cache
     */
    public function invalidateCache()
    {
        $cache = Craft::$app->getCache();
        TagDependency::invalidate($cache, self::SITEMAP_INDEX_CACHE_TAG);
        Craft::info(
            'Sitemap index cache cleared',
            __METHOD__
        );
    }

    // Protected Methods
    // =========================================================================

    /**
     * Add an additional sitemap to the sitemap index, coming from the global
     * meta bundle metaSiteVars->additionalSitemaps
     *
     * @param MetaBundle $metaBundle
     * @param int $groupSiteId
     * @param array $lines
     *
     * @throws Exception
     */
    protected function addAdditionalSitemaps(MetaBundle $metaBundle, int $groupSiteId, array &$lines)
    {
        $additionalSitemaps = $metaBundle->metaSiteVars->additionalSitemaps;
        $additionalSitemaps = empty($additionalSitemaps) ? [] : $additionalSitemaps;
        // Allow plugins/modules to add custom URLs
        $event = new RegisterSitemapsEvent([
            'sitemaps' => $additionalSitemaps,
            'siteId' => $groupSiteId,
        ]);
        Event::trigger(SitemapIndexTemplate::class, SitemapIndexTemplate::EVENT_REGISTER_SITEMAPS, $event);
        $additionalSitemaps = array_filter($event->sitemaps);
        // Output the sitemap index
        if (!empty($additionalSitemaps)) {
            foreach ($additionalSitemaps as $additionalSitemap) {
                if (!empty($additionalSitemap['loc'])) {
                    $loc = MetaValueHelper::parseString($additionalSitemap['loc']);
                    $lines[] = '<sitemap>';
                    $lines[] = '<loc>';
                    $lines[] = Html::encode($loc);
                    $lines[] = '</loc>';
                    // Find the most recent date
                    $dateUpdated = !empty($additionalSitemap['lastmod'])
                        ? $additionalSitemap['lastmod']
                        : new DateTime();
                    $lines[] = '<lastmod>';
                    $lines[] = $dateUpdated->format(DateTime::W3C);
                    $lines[] = '</lastmod>';
                    $lines[] = '</sitemap>';
                }
            }
        }
    }

    /**
     * Add an additional "custom" sitemap to the sitemap index, with URLs coming from
     * the global meta bundle metaSiteVars->additionalSitemapUrls
     *
     * @param MetaBundle $metaBundle
     * @param int $groupSiteId
     * @param array $lines
     *
     * @throws Exception
     */
    protected function addAdditionalSitemapUrls(MetaBundle $metaBundle, int $groupSiteId, array &$lines)
    {
        $additionalSitemapUrls = $metaBundle->metaSiteVars->additionalSitemapUrls;
        $additionalSitemapUrls = empty($additionalSitemapUrls) ? [] : $additionalSitemapUrls;
        // Allow plugins/modules to add custom URLs
        $event = new RegisterSitemapUrlsEvent([
            'sitemaps' => $additionalSitemapUrls,
            'siteId' => $groupSiteId,
        ]);
        Event::trigger(SitemapCustomTemplate::class, SitemapCustomTemplate::EVENT_REGISTER_SITEMAP_URLS, $event);
        $additionalSitemapUrls = array_filter($event->sitemaps);
        // Output the sitemap index
        if (!empty($additionalSitemapUrls)) {
            $sitemapUrl = Seomatic::$plugin->sitemaps->sitemapCustomUrlForSiteId(
                $groupSiteId
            );
            $lines[] = '<sitemap>';
            $lines[] = '<loc>';
            $lines[] = Html::encode($sitemapUrl);
            $lines[] = '</loc>';
            // Find the most recent date
            $dateUpdated = $metaBundle->metaSiteVars->additionalSitemapUrlsDateUpdated
                ?? new DateTime();
            foreach ($additionalSitemapUrls as $additionalSitemapUrl) {
                if (!empty($additionalSitemapUrl['lastmod'])) {
                    if ($additionalSitemapUrl['lastmod'] > $dateUpdated) {
                        $dateUpdated = $additionalSitemapUrl['lastmod'];
                    }
                }
            }
            if ($dateUpdated !== null) {
                $lines[] = '<lastmod>';
                $lines[] = $dateUpdated->format(DateTime::W3C);
                $lines[] = '</lastmod>';
            }
            $lines[] = '</sitemap>';
        }
    }
}


1			<?php
2			/**
3			* SEOmatic plugin for Craft CMS
4			*
5			* A turnkey SEO implementation for Craft CMS that is comprehensive, powerful,
6			* and flexible
7			*
8			* @link https://nystudio107.com
9			* @copyright Copyright (c) 2017 nystudio107
10			*/
11
12			namespace nystudio107\seomatic\models;
13
14			use Craft;
15			use craft\models\SiteGroup;
16			use DateTime;
17			use Exception;
18			use nystudio107\seomatic\base\FrontendTemplate;
19			use nystudio107\seomatic\base\SitemapInterface;
20			use nystudio107\seomatic\events\RegisterSitemapsEvent;
21			use nystudio107\seomatic\events\RegisterSitemapUrlsEvent;
22			use nystudio107\seomatic\helpers\MetaValue as MetaValueHelper;
23			use nystudio107\seomatic\helpers\Sitemap;
24			use nystudio107\seomatic\Seomatic;
25			use yii\base\Event;
26			use yii\caching\TagDependency;
27			use yii\helpers\Html;
28			use yii\web\NotFoundHttpException;
29			use function in_array;
30
31			/**
32			* @author nystudio107
33			* @package Seomatic
34			* @since 3.0.0
35			*/
36			class SitemapIndexTemplate extends FrontendTemplate implements SitemapInterface
37			{
38			// Constants
39			// =========================================================================
40
41			/**
42			* @event RegisterSitemapsEvent The event that is triggered when registering
43			* additional sitemaps for the sitemap index.
44			*
45			* ---
46			* ```php
47			* use nystudio107\seomatic\events\RegisterSitemapsEvent;
48			* use nystudio107\seomatic\models\SitemapIndexTemplate;
49			* use yii\base\Event;
50			* Event::on(SitemapIndexTemplate::class, SitemapIndexTemplate::EVENT_REGISTER_SITEMAPS, function(RegisterSitemapsEvent $e) {
51			* $e->sitemaps[] = [
52			* 'loc' => $url,
53			* 'lastmod' => $lastMod,
54			* ];
55			* });
56			* ```
57			*/
58			public const EVENT_REGISTER_SITEMAPS = 'registerSitemaps';
59
60			public const TEMPLATE_TYPE = 'SitemapIndexTemplate';
61
62			public const CACHE_KEY = 'seomatic_sitemap_index';
63
64			public const SITEMAP_INDEX_CACHE_TAG = 'seomatic_sitemap_index';
65
66			// Static Methods
67			// =========================================================================
68
69			/**
70			* @param array $config
71			*
72			* @return null\|SitemapIndexTemplate
73			*/
74			public static function create(array $config = [])
75			{
76			$defaults = [
77			'path' => 'sitemaps-<groupId:\d+>-sitemap.xml',
78			'template' => '',
79			'controller' => 'sitemap',
80			'action' => 'sitemap-index',
81			];
82			$config = array_merge($config, $defaults);
83
84			return new SitemapIndexTemplate($config);
85			}
86
87			// Public Properties
88			// =========================================================================
89
90			// Public Methods
91			// =========================================================================
92
93			/**
94			* @inheritdoc
95			*/
96			public function rules(): array
97			{
98			$rules = parent::rules();
99			$rules = array_merge($rules, [
100			]);
101
102			return $rules;
103			}
104
105			/**
106			* @inheritdoc
107			*/
108			public function fields(): array
109			{
110			return parent::fields();
111			}
112
113			/**
114			* Get the filename of the sitemap index.
115			*
116			* @param int $groupId
117			* @return string
118			*/
119			public function getFilename(int $groupId): string
120			{
121			return 'sitemaps-' . $groupId . '-sitemap.xml';
122			}
123
124			/**
125			* @inheritdoc
126			*
127			* @throws NotFoundHttpException if the sitemap.xml doesn't exist
128			*/
129			public function render(array $params = []): string
130			{
131			$cache = Craft::$app->getCache();
132			$groupId = $params['groupId'];
133			$siteId = $params['siteId'];
134			if (Seomatic::$settings->siteGroupsSeparate) {
135			/** @var SiteGroup\|null $siteGroup */
136			$siteGroup = Craft::$app->getSites()->getGroupById($groupId);
137			if ($siteGroup === null) {
138			throw new NotFoundHttpException(Craft::t('seomatic', 'Sitemap.xml not found for groupId {groupId}', [
139			'groupId' => $groupId,
140			]));
141			}
142			$groupSiteIds = $siteGroup->getSiteIds();
143			} else {
144			$groupSiteIds = Craft::$app->getSites()->allSiteIds;
145			}
146
147			$dependency = new TagDependency([
148			'tags' => [
149			self::GLOBAL_SITEMAP_CACHE_TAG,
150			self::SITEMAP_INDEX_CACHE_TAG,
151			],
152			]);
153
154			$cacheDuration = Seomatic::$plugin->helper::isPreview() ? 1 : Seomatic::$cacheDuration;
155
156			return $cache->getOrSet(self::CACHE_KEY . $groupId . '.' . $siteId, function() use ($groupSiteIds, $siteId) {
157			Craft::info(
158			'Sitemap index cache miss',
159			__METHOD__
160			);
161			$lines = [];
162			// Sitemap index XML header and opening tag
163			$lines[] = '<?xml version="1.0" encoding="UTF-8"?>';
164			$lines[] = '<?xml-stylesheet type="text/xsl" href="sitemap.xsl"?>';
165			$lines[] = '<sitemapindex xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">';
166			// One sitemap entry for each MeteBundle
167			$metaBundles = Seomatic::$plugin->metaBundles->getContentMetaBundlesForSiteId($siteId);
168			Seomatic::$plugin->metaBundles->pruneVestigialMetaBundles($metaBundles);
169			/** @var MetaBundle $metaBundle */
170			foreach ($metaBundles as $metaBundle) {
171			$sitemapUrls = $metaBundle->metaSitemapVars->sitemapUrls;
172			// Check to see if robots is `none` or `no index`
173			$robotsEnabled = true;
174			if (!empty($metaBundle->metaGlobalVars->robots)) {
175			$robotsEnabled = $metaBundle->metaGlobalVars->robots !== 'none' &&
176			$metaBundle->metaGlobalVars->robots !== 'noindex';
177			}
178			if (Seomatic::$plugin->sitemaps->anyEntryTypeHasSitemapUrls($metaBundle)) {
179			$robotsEnabled = true;
180			$sitemapUrls = true;
181			}
182			// Only add in a sitemap entry if it meets our criteria
183			if (in_array($metaBundle->sourceSiteId, $groupSiteIds, false)
184			&& $sitemapUrls
185			&& $robotsEnabled) {
186			// Get all of the elements for this meta bundle type
187			$seoElement = Seomatic::$plugin->seoElements->getSeoElementByMetaBundleType($metaBundle->sourceBundleType);
188			$totalElements = 0;
189			$pageCount = 0;
190
191			if ($seoElement !== null) {
192			// Ensure `null` so that the resulting element query is correct
193			if (empty($metaBundle->metaSitemapVars->sitemapLimit)) {
194			$metaBundle->metaSitemapVars->sitemapLimit = null;
195			}
196
197			$totalElements = Sitemap::getTotalElementsInSitemap($seoElement, $metaBundle) ?? 0;
198
199			$pageSize = $metaBundle->metaSitemapVars->sitemapPageSize;
200			$pageCount = (!empty($pageSize) && $pageSize > 0) ? ceil($totalElements / $pageSize) : 1;
201			}
202
203			// Only add a sitemap to the sitemap index if there's at least 1 element in the resulting sitemap
204			if ($totalElements > 0 && $pageCount > 0) {
205			for ($page = 1; $page <= $pageCount; $page++) {
206			$sitemapUrl = Seomatic::$plugin->sitemaps->sitemapUrlForBundle(
207			$metaBundle->sourceBundleType,
208			$metaBundle->sourceHandle,
209			$metaBundle->sourceSiteId,
210			$pageCount > 1 ? $page : 0 // No paging, if only one page
211			);
212
213			$lines[] = '<sitemap>';
214			$lines[] = '<loc>';
215			$lines[] = Html::encode($sitemapUrl);
216			$lines[] = '</loc>';
217
218			if ($metaBundle->sourceDateUpdated !== null) {
219			$lines[] = '<lastmod>';
220			$lines[] = $metaBundle->sourceDateUpdated->format(DateTime::W3C);
221			$lines[] = '</lastmod>';
222			}
223
224			$lines[] = '</sitemap>';
225			}
226			}
227			}
228			}
229			// Custom sitemap entries
230			$metaBundle = Seomatic::$plugin->metaBundles->getGlobalMetaBundle($siteId, false);
231			if ($metaBundle !== null) {
232			$this->addAdditionalSitemapUrls($metaBundle, $siteId, $lines);
233			$this->addAdditionalSitemaps($metaBundle, $siteId, $lines);
234			}
235			// Sitemap index closing tag
236			$lines[] = '</sitemapindex>';
237
238			return implode('', $lines);
239			}, $cacheDuration, $dependency);
240			}
241
242			/**
243			* Invalidate the sitemap index cache
244			*/
245			public function invalidateCache()
246			{
247			$cache = Craft::$app->getCache();
248			TagDependency::invalidate($cache, self::SITEMAP_INDEX_CACHE_TAG);
249			Craft::info(
250			'Sitemap index cache cleared',
251			__METHOD__
252			);
253			}
254
255			// Protected Methods
256			// =========================================================================
257
258			/**
259			* Add an additional sitemap to the sitemap index, coming from the global
260			* meta bundle metaSiteVars->additionalSitemaps
261			*
262			* @param MetaBundle $metaBundle
263			* @param int $groupSiteId
264			* @param array $lines
265			*
266			* @throws Exception
267			*/
268			protected function addAdditionalSitemaps(MetaBundle $metaBundle, int $groupSiteId, array &$lines)
269			{
270			$additionalSitemaps = $metaBundle->metaSiteVars->additionalSitemaps;
271			$additionalSitemaps = empty($additionalSitemaps) ? [] : $additionalSitemaps;
272			// Allow plugins/modules to add custom URLs
273			$event = new RegisterSitemapsEvent([
274			'sitemaps' => $additionalSitemaps,
275			'siteId' => $groupSiteId,
276			]);
277			Event::trigger(SitemapIndexTemplate::class, SitemapIndexTemplate::EVENT_REGISTER_SITEMAPS, $event);
278			$additionalSitemaps = array_filter($event->sitemaps);
279			// Output the sitemap index
280			if (!empty($additionalSitemaps)) {
281			foreach ($additionalSitemaps as $additionalSitemap) {
282			if (!empty($additionalSitemap['loc'])) {
283			$loc = MetaValueHelper::parseString($additionalSitemap['loc']);
284			$lines[] = '<sitemap>';
285			$lines[] = '<loc>';
286			$lines[] = Html::encode($loc);
287			$lines[] = '</loc>';
288			// Find the most recent date
289			$dateUpdated = !empty($additionalSitemap['lastmod'])
290			? $additionalSitemap['lastmod']
291			: new DateTime();
292			$lines[] = '<lastmod>';
293			$lines[] = $dateUpdated->format(DateTime::W3C);
294			$lines[] = '</lastmod>';
295			$lines[] = '</sitemap>';
296			}
297			}
298			}
299			}
300
301			/**
302			* Add an additional "custom" sitemap to the sitemap index, with URLs coming from
303			* the global meta bundle metaSiteVars->additionalSitemapUrls
304			*
305			* @param MetaBundle $metaBundle
306			* @param int $groupSiteId
307			* @param array $lines
308			*
309			* @throws Exception
310			*/
311			protected function addAdditionalSitemapUrls(MetaBundle $metaBundle, int $groupSiteId, array &$lines)
312			{
313			$additionalSitemapUrls = $metaBundle->metaSiteVars->additionalSitemapUrls;
314			$additionalSitemapUrls = empty($additionalSitemapUrls) ? [] : $additionalSitemapUrls;
315			// Allow plugins/modules to add custom URLs
316			$event = new RegisterSitemapUrlsEvent([
317			'sitemaps' => $additionalSitemapUrls,
318			'siteId' => $groupSiteId,
319			]);
320			Event::trigger(SitemapCustomTemplate::class, SitemapCustomTemplate::EVENT_REGISTER_SITEMAP_URLS, $event);
321			$additionalSitemapUrls = array_filter($event->sitemaps);
322			// Output the sitemap index
323			if (!empty($additionalSitemapUrls)) {
324			$sitemapUrl = Seomatic::$plugin->sitemaps->sitemapCustomUrlForSiteId(
325			$groupSiteId
326			);
327			$lines[] = '<sitemap>';
328			$lines[] = '<loc>';
329			$lines[] = Html::encode($sitemapUrl);
330			$lines[] = '</loc>';
331			// Find the most recent date
332			$dateUpdated = $metaBundle->metaSiteVars->additionalSitemapUrlsDateUpdated
333			?? new DateTime();
334			foreach ($additionalSitemapUrls as $additionalSitemapUrl) {
335			if (!empty($additionalSitemapUrl['lastmod'])) {
336			if ($additionalSitemapUrl['lastmod'] > $dateUpdated) {
337			$dateUpdated = $additionalSitemapUrl['lastmod'];
338			}
339			}
340			}
341			if ($dateUpdated !== null) {
342			$lines[] = '<lastmod>';
343			$lines[] = $dateUpdated->format(DateTime::W3C);
344			$lines[] = '</lastmod>';
345			}
346			$lines[] = '</sitemap>';
347			}
348			}
349			}
350

nystudio107 / craft-seomatic

SitemapIndexTemplate::invalidateCache() A last analyzed 2025-10-07 04:23 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

SitemapIndexTemplate::invalidateCache() A
last analyzed 2025-10-07 04:23 UTC