alexdebril/feed-io

<?php

declare(strict_types=1);

namespace FeedIo;

use FeedIo\Reader\Document;
use FeedIo\Rule\DateTimeBuilder;
use FeedIo\Rule\DateTimeBuilderInterface;

abstract class StandardAbstract
{
    /**
     * DateTime default format
     */
    public const DATETIME_FORMAT = \DateTime::RFC2822;

    /**
     * Standard mime type
     */
    public const MIME_TYPE = '';

    /**
     * Supported format
     */
    public const SYNTAX_FORMAT = '';

    protected array $mandatoryFields = [];

    public function __construct(
        protected DateTimeBuilderInterface $dateTimeBuilder
    ) {
    }

    /**
     * Tells if the parser can handle the feed or not
     * @param  Document $document
     * @return boolean
     */
    abstract public function canHandle(Document $document): bool;

    /**
     * @return \FeedIo\FormatterInterface
     */
    abstract public function getFormatter(): FormatterInterface;

    /**
     * @return string
     */
    public function getDefaultDateFormat(): string
    {
        return static::DATETIME_FORMAT;
    }

    /**
     * @return array
     */
    public function getMandatoryFields(): array
    {
        return $this->mandatoryFields;
    }

    /**
     * Returns the Format supported by the standard (XML, JSON, Text...)
     * @return string
     */
    public function getSyntaxFormat(): string
    {
        return static::SYNTAX_FORMAT;
    }

    /**
     * Returns the mime type for the standard
     * @return string
     */
    public function getMimeType(): string
    {
        return static::MIME_TYPE;
    }
}