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 EliasHaeussler\Typo3Warming\Configuration\Configuration

API to access all available extension configuration options.

getCrawler()

Get the configured crawler class.

Return type

class-string<EliasHaeussler\CacheWarmup\Crawler\CrawlerInterface>

getCrawlerOptions()

Get the configured crawler options.

Return type

array

getVerboseCrawler()

Get the configured verbose crawler class.

Return type

class-string<EliasHaeussler\CacheWarmup\Crawler\VerboseCrawlerInterface>

getVerboseCrawlerOptions()

Get the configured verbose crawler options.

Return type

array

getLimit()

Get the configured crawler limit.

Return type

int

getExcludePatterns()

Get the configured exclude patterns.

Return type

list<string>

getStrategy()

Get the configured crawling strategy.

Return type

string|null

isEnabledInPageTree()

Check whether cache warmup from page tree is enabled.

Return type

bool

getSupportedDoktypes()

Get all doktypes that support cache warmup from page tree.

Return type

list<int>

isEnabledInToolbar()

Check whether cache warmup from toolbar is enabled.

Return type

bool

getUserAgent()

Get the calculated user-agent.

Return type

string

See also

View the sources on GitHub: