Configurable Parser 4.0+

Whenever you want to allow a custom behavior of your parser, it should implement Xml\ConfigurableParser:

namespace Vendor\Xml;

use EliasHaeussler\CacheWarmup;

final class MyCustomParser implements CacheWarmup\Xml\Parser
final class MyCustomParser implements CacheWarmup\Xml\ConfigurableParser
{
    // ...
}

Method Reference

The interface describes additional possibilities to pass parser options to your crawler:

setOptions

This method is called when custom parser options are given. They should be persisted inside the parser to change its behavior as desired.

namespace Vendor\Xml;

use EliasHaeussler\CacheWarmup;

final class MyCustomParser implements CacheWarmup\Xml\ConfigurableParser
{
    private array $options = [ 
        'request_options' => [], 
    ]; 
​
    public function __construct(array $options = []) 
    { 
        $this->setOptions($options); 
    } 

    public function parse(CacheWarmup\Sitemap\Sitemap $sitemap): CacheWarmup\Result\ParserResult
    {
        $xml = $this->fetchSitemap($sitemap);
        $sitemaps = $this->extractSitemapsFromXml($xml);
        $urls = $this->extractUrlsFromXml($xml);

        return new CacheWarmup\Result\ParserResult($sitemaps, $urls);
    }

    public function setOptions(array $options): void
    { 
        $this->options = [...$this->options, ...$options]; 
    } 

    private function fetchSitemap(CacheWarmup\Sitemap\Sitemap $sitemap): string
    {
        // ...
    }

    /**
     * @return list<CacheWarmup\Sitemap\Sitemap>
     */
    private function extractSitemapsFromXml(string $xml): array
    {
        // ...
    }

    /**
     * @return list<CacheWarmup\Sitemap\Url>
     */
    private function extractUrlsFromXml(string $xml): array
    {
        // ...
    }
}

Example

namespace Vendor\Xml;

use EliasHaeussler\CacheWarmup;
use GuzzleHttp\ClientInterface;
use Psr\Http\Message;

final class MyCustomParser implements CacheWarmup\Xml\ConfigurableParser
{
    private array $options = [
        'request_options' => [],
    ];

    public function __construct(array $options = [])
    {
        $this->setOptions($options);
    }

    public function parse(CacheWarmup\Sitemap\Sitemap $sitemap): CacheWarmup\Result\ParserResult
    {
        $xml = $this->fetchSitemap($sitemap);
        $sitemaps = $this->extractSitemapsFromXml($xml);
        $urls = $this->extractUrlsFromXml($xml);

        return new CacheWarmup\Result\ParserResult($sitemaps, $urls);
    }

    public function setOptions(array $options): void
    {
        $this->options = [...$this->options, ...$options];
    }

    private function fetchSitemap(CacheWarmup\Sitemap\Sitemap $sitemap): string
    {
        $client = $this->createClient();
        $response = $client->request(
            'GET',
            $sitemap->getUri(),
            $this->options['request_options'],
        );

        return (string) $response->getBody();
    }

    private function createClient(): ClientInterface
    {
        // ...
    }

    /**
     * @return list<CacheWarmup\Sitemap\Sitemap>
     */
    private function extractSitemapsFromXml(string $xml): array
    {
        // ...
    }

    /**
     * @return list<CacheWarmup\Sitemap\Url>
     */
    private function extractUrlsFromXml(string $xml): array
    {
        // ...
    }
}