Configuration API

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

class Configuration
Fully qualified name
\EliasHaeussler\Typo3Warming\Configuration\Configuration

API to access all available extension configuration options.

getCrawler ( )

Get the configured crawler.

returntype

\EliasHaeussler\CacheWarmup\Crawler\Crawler

getCrawlerOptions ( )

Get the configured crawler options.

returntype

array

getVerboseCrawler ( )

Get the configured verbose crawler.

returntype

\EliasHaeussler\CacheWarmup\Crawler\VerboseCrawler

getVerboseCrawlerOptions ( )

Get the configured verbose crawler options.

returntype

array

getParserOptions ( )

Get the configured parser options.

returntype

array

getClientOptions ( )

Get the configured client options.

returntype

array

getLimit ( )

Get the configured crawler limit.

returntype

int

getExcludePatterns ( )

Get the configured exclude patterns.

returntype

list<string>

getStrategy ( )

Get the configured crawling strategy.

returntype

\EliasHaeussler\CacheWarmup\Crawler\Strategy\CrawlingStrategy|null

isEnabledInPageTree ( )

Check whether cache warmup from page tree is enabled.

returntype

bool

getSupportedDoktypes ( )

Get all doktypes that support cache warmup from page tree.

returntype

list<int>

isEnabledInToolbar ( )

Check whether cache warmup from toolbar is enabled.

returntype

bool

getUserAgent ( )

Get the calculated user-agent.

returntype

string