AuditReaderInterface.php

<?php

declare(strict_types=1);

/*
 * This file is part of the Sonata Project package.
 *
 * (c) Thomas Rabaix <thomas.rabaix@sonata-project.org>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Sonata\AdminBundle\Model;

/**
 * @author Thomas Rabaix <thomas.rabaix@sonata-project.org>
 *
 * @phpstan-template T of object
 */
interface AuditReaderInterface
{
    /**
     * @param int|string $id
     * @param int|string $revisionId
     *
     * @phpstan-param class-string<T> $className
     * @phpstan-return T|null
     */
    public function find(string $className, $id, $revisionId): ?object;

    /**
     * NEXT_MAJOR: Change the default limit value to `null` and change the native type to `?int`.
     *
     * @return Revision[]
     *
     * @phpstan-param class-string<T> $className
     */
    public function findRevisionHistory(string $className, int $limit = 20, int $offset = 0): array;

    /**
     * @param int|string $revisionId
     *
     * @phpstan-param class-string<T> $className
     */
    public function findRevision(string $className, $revisionId): ?Revision;

    /**
     * @param int|string $id
     *
     * @return Revision[]
     *
     * @phpstan-param class-string<T> $className
     */
    public function findRevisions(string $className, $id): array;

    /**
     * @param int|string $id
     * @param int|string $oldRevisionId
     * @param int|string $newRevisionId
     *
     * @return array<string, array{old: mixed, new: mixed, same: mixed}>
     *
     * @phpstan-param class-string<T> $className
     */
    public function diff(string $className, $id, $oldRevisionId, $newRevisionId): array;
}