docs(Storage): update docblock for Cache/StorageGlobal class

Signed-off-by: Josh <josh.t.richards@gmail.com>
This commit is contained in:
Josh 2026-04-25 12:44:28 -04:00 committed by GitHub
parent 358f86753e
commit b9c214f0bc
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -12,15 +12,14 @@ use OCP\DB\QueryBuilder\IQueryBuilder;
use OCP\IDBConnection;
/**
* Handle the mapping between the string and numeric storage ids
* Provides a process-local cache of persisted storage-id mappings.
*
* Each storage has 2 different ids
* a string id which is generated by the storage backend and reflects the configuration of the storage (e.g. 'smb://user@host/share')
* and a numeric storage id which is referenced in the file cache
* Caches lookups in both directions:
* - string storage id to storage record
* - numeric storage id to storage record
*
* A mapping between the two storage ids is stored in the database and accessible through this class
*
* @package OC\Files\Cache
* This class reduces repeated database lookups for storage mapping metadata
* and provides invalidation helpers for callers that update those records.
*/
class StorageGlobal {
/** @var array<string, array{id: string, numeric_id: int, available: bool, last_checked: int}> */