Sobak/scrawler

<?php

declare(strict_types=1);

namespace Sobak\Scrawler\Block\ResultWriter;

use Psr\Log\LoggerInterface;

interface ResultWriterInterface
{
    /**
     * ResultWriterInterface constructor.
     *
     * @param array $configuration
     */
    public function __construct(array $configuration = []);

    /**
     * Returns implementation-specific configuration provided by the user.
     *
     * @return array
     */
    public function getConfiguration(): array;

    /**
     * Gets entity context for the result writer.
     *
     * @return string Fully qualified name of entity class
     */
    public function getEntity(): string;

    /**
     * Sets the entity context for the result writer.
     *
     * @param string $entityName Fully qualified name of entity class being
     *                           written by this ResultWriter instance.
     * @return ResultWriterInterface
     */
    public function setEntity(string $entityName): ResultWriterInterface;

    /**
     * Gets log writer for the result writer.
     *
     * @return LoggerInterface Log writer implementation
     */
    public function getLogWriter(): LoggerInterface;

    /**
     * Sets the log writer for the result writer.
     *
     * @param LoggerInterface $logWriter Log writer implementation
     * @return ResultWriterInterface
     */
    public function setLogWriter(LoggerInterface $logWriter): ResultWriterInterface;

    /**
     * Fires once before calling write() on any of the entities found for single result writer.
     *
     * Might be useul to prepare result storage in any way, like create a directory,
     * perform initial checks, caching something to improve performance and so on...
     */
    public function initializeResultWrites(): void;

    /**
     * Writes single entitty and returns the operation status.
     *
     * @param  object $entity
     * @return bool
     */
    public function write(object $entity): bool;
}