FeedIo\ParserAbstract

Complexity

Total Complexity

12

Size/Duplication

Total Lines	124
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	3

Test Coverage

Coverage

100%

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
	parseContent()	0	1	?
	checkBodyStructure()	0	1	?
A	__construct()	0	5	1
A	parse()	0	11	2
A	getStandard()	0	4	1
A	addValidItem()	0	8	3
A	isValid()	0	10	3
A	addFilter()	0	6	1
A	resetFilters()	0	6	1

<?php declare(strict_types=1);
/*
 * This file is part of the feed-io package.
 *
 * (c) Alexandre Debril <alex.debril@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace FeedIo;

use FeedIo\Parser\UnsupportedFormatException;
use FeedIo\Reader\Document;
use FeedIo\Feed\ItemInterface;
use FeedIo\Feed\NodeInterface;
use Psr\Log\LoggerInterface;

/**
 * Parses a document if its format matches the parser's standard
 *
 * Depends on :
 *  - FeedIo\StandardAbstract
 *  - Psr\Log\LoggerInterface
 *
 */
abstract class ParserAbstract
{

    /**
     * @var \Psr\Log\LoggerInterface
     */
    protected $logger;

    /**
     * @var array[FilterInterface]
     */
    protected $filters = array();

    /**
     * @var StandardAbstract
     */
    protected $standard;

    /**
     * @param StandardAbstract $standard
     * @param LoggerInterface  $logger
     */
    public function __construct(StandardAbstract $standard, LoggerInterface $logger)
    {
        $this->standard = $standard;
        $this->logger = $logger;
    }

    /**
     * Tries to parse the document
     *
     * @param Document $document
     * @param FeedInterface $feed
     * @return \FeedIo\FeedInterface
     * @throws \FeedIo\Parser\UnsupportedFormatException
     */
    public function parse(Document $document, FeedInterface $feed) : FeedInterface
    {
        if (!$this->standard->canHandle($document)) {
            throw new UnsupportedFormatException('this is not a supported format');
        }

        $this->checkBodyStructure($document, $this->standard->getMandatoryFields());

$this->standard->getMandatoryFields() is of type array, but the function expects a object<FeedIo\iterable>.

        $this->parseContent($document, $feed);

        return $feed;
    }

    /**
     * This method is called by parse() if and only if the checkBodyStructure was successful
     *
     * @param Document $document
     * @param FeedInterface $feed
     * @return \FeedIo\FeedInterface
     */
    abstract public function parseContent(Document $document, FeedInterface $feed) : FeedInterface;

    /**
     * @param Document $document
     * @param iterable $mandatoryFields
     * @throws MissingFieldsException
     * @return bool
     */
    abstract public function checkBodyStructure(Document $document, iterable $mandatoryFields) : bool;

    /**
     * @return StandardAbstract
     */
    public function getStandard() : StandardAbstract
    {
        return $this->standard;
    }

    /**
     * @param  FeedInterface $feed
     * @param  NodeInterface $item
     * @return ParserAbstract
     */
    public function addValidItem(FeedInterface $feed, NodeInterface $item) : ParserAbstract
    {
        if ($item instanceof ItemInterface && $this->isValid($item)) {
            $feed->add($item);
        }

        return $this;
    }

    /**
     * @param  ItemInterface $item
     * @return bool
     */
    public function isValid(ItemInterface $item) : bool
    {
        foreach ($this->filters as $filter) {
            if (!$filter->isValid($item)) {
                return false;
            }
        }

        return true;
    }

    /**
     * @param  FilterInterface $filter
     * @return ParserAbstract
     */
    public function addFilter(FilterInterface $filter) : ParserAbstract
    {
        $this->filters[] = $filter;

        return $this;
    }

    /**
     * Reset filters
     * @return ParserAbstract
     */
    public function resetFilters() : ParserAbstract
    {
        $this->filters = [];

        return $this;
    }
}