<?php

namespace Domain\Repository;

/**
 * Interface for Dokumentation Repository operations.
 */
interface DokumentationRepositoryInterface
{
    /**
     * @return array<string, mixed>|null
     */
    public function findById(int $id): ?array;

    /**
     * @return array<string, mixed>|null
     */
    public function findByPath(string $path): ?array;

    /**
     * @return array<string, mixed>|null
     */
    public function findBySlug(string $slug, ?int $parentId = null): ?array;

    /**
     * @return array<string, mixed>|null
     */
    public function findDocBySlug(string $slug): ?array;

    /**
     * @return array<int, array<string, mixed>>
     */
    public function findChildren(int $parentId): array;

    /**
     * @return array<int, array<string, mixed>>
     */
    public function findRootDocuments(): array;

    /**
     * @return array<int, array<string, mixed>>
     */
    public function getHierarchy(): array;

    /**
     * @return array<int, array<string, mixed>>
     */
    public function getBreadcrumb(int $docId): array;

    /**
     * @return array<int, array<string, mixed>>
     */
    public function getSiblings(int $docId): array;

    /**
     * @return array<string, int>
     */
    public function getStatistics(): array;
}