ObjectStorageInterface.php

<?php

declare(strict_types=1);

namespace TheCodingMachine\TDBM;

/**
 * Object in charge of referencing all beans that have been fetched from the database.
 * If a bean is requested twice from TDBM, the ObjectStorage is used to "cache" the bean.
 *
 * @author David Negrier
 */
interface ObjectStorageInterface
{
    /**
     * Sets an object in the storage.
     *
     * @param string $tableName
     * @param string|int $id
     * @param DbRow $dbRow
     */
    public function set(string $tableName, $id, DbRow $dbRow): void;

    // Notice: the interface has no "has" method because it is meaningless in the case of the Weakref implementation.
    // See https://github.com/thecodingmachine/tdbm/pull/80#issuecomment-385902994

    /**
     * Returns an object from the storage (or null if no object is set).
     *
     * @param string $tableName
     * @param string|int $id
     *
     * @return DbRow|null
     */
    public function get(string $tableName, $id): ?DbRow;

    /**
     * Removes an object from the storage.
     *
     * @param string $tableName
     * @param string|int $id
     */
    public function remove(string $tableName, $id): void;

    /**
     * Removes all objects from the storage.
     */
    public function clear(): void;
}