nextcloud/lib/public/Files/Cache/IUpdater.php

<?php

/**
 * SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors
 * SPDX-FileCopyrightText: 2016 ownCloud, Inc.
 * SPDX-License-Identifier: AGPL-3.0-only
 */
namespace OCP\Files\Cache;

use OCP\Files\Storage\IStorage;

/**
 * Update the cache and propagate changes
 *
 * @since 9.0.0
 */
interface IUpdater {
	/**
	 * Get the propagator for etags and mtime for the view the updater works on
	 *
	 * @since 9.0.0
	 */
	public function getPropagator(): IPropagator;

	/**
	 * Propagate etag and mtime changes for the parent folders of $path up to the root of the filesystem
	 *
	 * @param string $path the path of the file to propagate the changes for
	 * @param int|null $time the timestamp to set as mtime for the parent folders, if left out the current time is used
	 * @since 9.0.0
	 */
	public function propagate(string $path, ?int $time = null): void;

	/**
	 * Update the cache for $path and update the size, etag and mtime of the parent folders
	 * @since 9.0.0
	 */
	public function update(string $path, ?int $time = null, ?int $sizeDifference = null): void;

	/**
	 * Remove $path from the cache and update the size, etag and mtime of the parent folders
	 *
	 * @since 9.0.0
	 */
	public function remove(string $path): void;

	/**
	 * Rename a file or folder in the cache and update the size, etag and mtime of the parent folders
	 *
	 * @since 9.0.0
	 */
	public function renameFromStorage(IStorage $sourceStorage, string $source, string $target): void;

	/**
	 * Copy a file or folder in the cache and update the size, etag and mtime of the parent folders
	 *
	 * @since 31.0.0
	 */
	public function copyFromStorage(IStorage $sourceStorage, string $source, string $target): void;
}