*/ interface FlexIndexInterface extends FlexCollectionInterface { /** * Helper method to create Flex Index. * * @used-by FlexDirectory::getIndex() Official method to get Index from a Flex Directory. * * @param FlexDirectory $directory Flex directory. * @return static Returns a new Flex Index. */ public static function createFromStorage(FlexDirectory $directory); /** * Method to load index from the object storage, usually filesystem. * * @used-by FlexDirectory::getIndex() Official method to get Index from a Flex Directory. * * @param FlexStorageInterface $storage Flex Storage associated to the directory. * @return array Returns a list of existing objects [storage_key => [storage_key => xxx, storage_timestamp => 123456, ...]] */ public static function loadEntriesFromStorage(FlexStorageInterface $storage): array; /** * Return new collection with a different key. * * @param string|null $keyField Switch key field of the collection. * @return static Returns a new Flex Collection with new key field. * @phpstan-return static * @api */ public function withKeyField(?string $keyField = null); /** * @param string|null $indexKey * @return array */ public function getIndexMap(?string $indexKey = null); }