Configuration API

In order to access the extension configuration, a slim PHP API exists. Each configuration option is accessible by an appropriate class property.

Changed in version 4.2.0

Several class methods were converted to class properties and deprecated in version 4.2.0. Calling those methods will be possible until version 5.0 of the extension, but deprecation notices will be logged on every method call.

class Configuration

Fully qualified name: \EliasHaeussler\Typo3Warming\Configuration\Configuration

API to access all available extension configuration options.

crawlerClass: Get the configured crawler class. To access the instantiated crawler, call the getCrawler method instead.

crawlerOptions: Get the configured crawler options.

verboseCrawlerClass: Get the configured verbose crawler class. To access the instantiated crawler, call the getVerboseCrawler method instead.

verboseCrawlerOptions: Get the configured verbose crawler options.

parserOptions: Get the configured parser options.

clientOptions: Get the configured client options.

limit: Get the configured crawler limit.

excludePatterns: Get the configured exclude patterns.

crawlingStrategy: Get the configured crawling strategy.

enabledInPageTree: Check whether cache warmup from page tree is enabled.

supportedDoktypes: Get all doktypes that support cache warmup from page tree.

enabledInToolbar: Check whether cache warmup from toolbar is enabled.

getCrawler()

Get the configured crawler.

returntype: \EliasHaeussler\CacheWarmup\Crawler\Crawler

getVerboseCrawler()

Get the configured verbose crawler.

returntype: \EliasHaeussler\CacheWarmup\Crawler\VerboseCrawler

getUserAgent()

Get the calculated user-agent.

Deprecated since version 4.2.0

Call \EliasHaeussler\Typo3Warming\Http\Message\Request\RequestOptions::getUserAgent instead. See migration guide for more information.

returntype: string