<?php
/**
 * What the import steps read an archive through: the .mmig reader and the .wpress adapter both implement it, so the
 * same steps import either format.
 *
 * Entries are arrays with at least path (relative to wp-content for kind 'file'), size and kind. Only kind 'file' is
 * ever extracted into the site.
 *
 * @package Mench_Migrate
 */

defined( 'ABSPATH' ) || exit;

interface Mench_Migrate_Import_Source {

	/** @return list<array{path:string, size:int, kind:string}> Every entry at once (small archives, tests). */
	public function entries(): array;

	/** Number of entries. */
	public function entry_count(): int;

	/** Entry number $i (0-based, archive order). */
	public function entry_at( int $i ): array;

	/** @return iterable<int, array> Every entry, one at a time. */
	public function each(): iterable;

	/** The entry at $rel, or null. */
	public function find( string $rel ): ?array;

	/** The archive's manifest in the .mmig shape (home, siteurl, prefix, content_abs, …). */
	public function manifest(): array;

	public function is_encrypted(): bool;

	/** A whole small entry, verified. */
	public function read_string( string $rel ): string;

	/** The first $max bytes of an entry, unverified. */
	public function read_head( string $rel, int $max ): string;

	/**
	 * Extracts (part of) an entry to $dest_abs, resumable from the returned cursor (start with []).
	 *
	 * @return array{done:bool, cursor:array}
	 */
	public function extract( string $rel, string $dest_abs, array $cursor, float $deadline ): array;
}