MadelineProto/src/danog/MadelineProto/Db/DbArray.php

<?php

namespace danog\MadelineProto\Db;

use Amp\Producer;
use Amp\Promise;

/**
 * DB array interface.
 *
 * @template T as mixed
 */
interface DbArray extends DbType, \ArrayAccess, \Countable
{
    /**
     * Get Array copy.
     *
     * @psalm-return Promise<array<string|int, T>>
     *
     * @return Promise
     */
    public function getArrayCopy(): Promise;
    /**
     * Check if element is set.
     *
     * @param string|int $key
     *
     * @psalm-return Promise<bool>
     *
     * @return Promise
     */
    public function isset($key): Promise;
    /**
     * Get element.
     *
     * @param string|int $index
     *
     * @psalm-return Promise<T>
     *
     * @return Promise
     */
    public function offsetGet($index): Promise;
    /**
     * Set element.
     *
     * @param string|int $index
     * @param mixed      $value
     *
     * @psalm-param T $value
     *
     * @return void
     */
    public function offsetSet($index, $value);
    /**
     * Unset element.
     *
     * @param string|int $index Offset
     * @return Promise
     */
    public function offsetUnset($index): Promise;
    /**
     * Count number of elements.
     *
     * @return Promise<integer>
     */
    public function count(): Promise;
    /**
     * Get iterator.
     *
     * @return Producer<array{0: string|int, 1: T}>
     */
    public function getIterator(): Producer;

    /**
     * @deprecated
     * @internal
     * @see DbArray::isset();
     *
     * @param mixed $index
     *
     * @return bool
     */
    public function offsetExists($index);
}