---
title: "Configuration API"
manual: "Warming"
version: "5.3"
permalink: "https://docs.typo3.org/permalink/eliashaeussler/typo3-warming:configuration-api@5.3"
source: "DeveloperCorner/ConfigurationAPI.rst"
rendered: "2026-11-05T08:37:00+00:00"
---

# Configuration API {#configuration-api}

In order to access the [extension configuration](https://docs.typo3.org/permalink/eliashaeussler/typo3-warming:extension-configuration@5.3),
a slim PHP API exists. Each configuration option is accessible by
an appropriate class property.

<!-- TODO: no Markdown rendering for "versionchanged" -->

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](https://docs.typo3.org/permalink/eliashaeussler/typo3-warming:extconf-crawler@5.3). To access the instantiated
        crawler, call the `getCrawler` method instead.

    -   **crawlerOptions**

        Get the configured [crawler options](https://docs.typo3.org/permalink/eliashaeussler/typo3-warming:extconf-crawleroptions@5.3).

    -   **verboseCrawlerClass**

        Get the configured [verbose crawler class](https://docs.typo3.org/permalink/eliashaeussler/typo3-warming:extconf-verbosecrawler@5.3). To access
        the instantiated crawler, call the `getVerboseCrawler` method instead.

    -   **verboseCrawlerOptions**

        Get the configured [verbose crawler options](https://docs.typo3.org/permalink/eliashaeussler/typo3-warming:extconf-verbosecrawleroptions@5.3).

    -   **parserOptions**

        Get the configured [parser options](https://docs.typo3.org/permalink/eliashaeussler/typo3-warming:extconf-parseroptions@5.3).

    -   **clientOptions**

        Get the configured [client options](https://docs.typo3.org/permalink/eliashaeussler/typo3-warming:extconf-clientoptions@5.3).

    -   **limit**

        Get the configured [crawler limit](https://docs.typo3.org/permalink/eliashaeussler/typo3-warming:extconf-limit@5.3).

    -   **excludePatterns**

        Get the configured [exclude patterns](https://docs.typo3.org/permalink/eliashaeussler/typo3-warming:extconf-exclude@5.3).

    -   **crawlingStrategy**

        Get the configured [crawling strategy](https://docs.typo3.org/permalink/eliashaeussler/typo3-warming:extconf-strategy@5.3).

    -   **enabledInPageTree**

        Check whether cache warmup from [page tree](https://docs.typo3.org/permalink/eliashaeussler/typo3-warming:extconf-enablepagetree@5.3) is enabled.

    -   **supportedDoktypes**

        Get all [doktypes](https://docs.typo3.org/m/typo3/reference-coreapi/main/en-us/ApiOverview/PageTypes/TypesOfPages.html#list-of-page-types) that support cache warmup from
        page tree.

    -   **enabledInToolbar**

        Check whether cache warmup from [toolbar](https://docs.typo3.org/permalink/eliashaeussler/typo3-warming:extconf-enabletoolbar@5.3) is enabled.

    -   **getCrawler()**

        Get the configured [crawler](https://docs.typo3.org/permalink/eliashaeussler/typo3-warming:extconf-crawler@5.3).

        -   *returntype:* `\EliasHaeussler\CacheWarmup\Crawler\Crawler`

    -   **getVerboseCrawler()**

        Get the configured [verbose crawler](https://docs.typo3.org/permalink/eliashaeussler/typo3-warming:extconf-verbosecrawler@5.3).

        -   *returntype:* `\EliasHaeussler\CacheWarmup\Crawler\VerboseCrawler`

    -   **getUserAgent()**

        Get the calculated user-agent.

        <!-- TODO: no Markdown rendering for "deprecated" -->

        Call \EliasHaeussler\Typo3Warming\Http\Message\Request\RequestOptions::getUserAgent
        instead. See migration guide for more information.-   *returntype:* `string`

> [!NOTE]
> **See also**
>
> View the sources on GitHub:
>
> -   [Configuration](https://github.com/eliashaeussler/typo3-warming/blob/main/Classes/Configuration/Configuration.php)