Events 3.2+

Most parts during cache warmup allow customization through the use of events. An event dispatcher instance is passed around which allows custom listeners to react on several actions. This page lists all currently available events.

Available events

• Configuration
  • ConfigResolved
• Parser
  • ParserConstructed
  • SitemapAdded
  • SitemapExcluded
  • SitemapParsed
  • SitemapParsingFailed
  • UrlAdded
  • UrlExcluded
• Crawler
  • CrawlerConstructed
  • UrlsPrepared
  • CrawlingStarted
  • UrlCrawlingSucceeded
  • UrlCrawlingFailed
  • CrawlingFinished
• HTTP
  • ClientConstructed

Configuration

ConfigResolved 3.2+

✅ Console command · 🚫 PHP API

Dispatched after final config is resolved.

Parser

ParserConstructed 4.0+

✅ Console command · ✅ PHP API

Dispatched if an XML parser is constructed by the parser factory.

SitemapAdded 3.2+

✅ Console command · ✅ PHP API

Dispatched if an XML sitemap is added for cache warmup.

SitemapExcluded 3.2+

✅ Console command · ✅ PHP API

Dispatched if an XML sitemap was skipped due to a configured exclude pattern.

SitemapParsed 3.2+

✅ Console command · ✅ PHP API

Dispatched once an XML sitemap is successfully parsed.

SitemapParsingFailed 3.2+

✅ Console command · ✅ PHP API

Dispatched if parsing of an XML sitemap failed due to an error.

UrlAdded 3.2+

✅ Console command · ✅ PHP API

Dispatched if a URL is added for cache warmup.

UrlExcluded 3.2+

✅ Console command · ✅ PHP API

Dispatched if a URL was skipped due to a configured exclude pattern.

Crawler

CrawlerConstructed 4.0+

✅ Console command · ✅ PHP API

Dispatched if a crawler is constructed by the crawler factory.

UrlsPrepared 3.2+

✅ Console command · ✅ PHP API

Dispatched if URLs are prepared due to a configured crawling strategy.

CrawlingStarted 3.2+

✅ Console command · ✅ PHP API

Dispatched right before crawling is started.

UrlCrawlingSucceeded 3.2+

✅ Console command · ✅ PHP API

Dispatched when crawling of a single URL was successful.

IMPORTANT

This event is only dispatched if the configured crawler utilizes the ResultCollectorHandler.

UrlCrawlingFailed 3.2+

✅ Console command · ✅ PHP API

Dispatched when crawling of a single URL failed.

IMPORTANT

This event is only dispatched if the configured crawler utilizes the ResultCollectorHandler.

CrawlingFinished 3.2+

✅ Console command · ✅ PHP API

Dispatched once crawling is finished.

HTTP

ClientConstructed 4.0+

✅ Console command · ✅ PHP API

Dispatched if an HTTP client is constructed by the client factory.