add event for inserting cache entries

this provides a reliable way for apps to listen to new files
without the need to of cache wrappers to hook into inserts themselves
(something which isn't 100% reliable)

Signed-off-by: Robin Appelman <robin@icewind.nl>

1 files changed, 72 insertions, 0 deletions

diff --git a/lib/public/Files/Cache/CacheInsertEvent.php b/lib/public/Files/Cache/CacheInsertEvent.php
new file mode 100644
index 00000000000..071f039d45f
--- /dev/null
+++ b/lib/public/Files/Cache/CacheInsertEvent.php
@@ -0,0 +1,72 @@
+<?php declare(strict_types=1);
+/**
+ * @copyright Copyright (c) 2019 Robin Appelman <robin@icewind.nl>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace OCP\Files\Cache;
+
+use OCP\Files\Storage\IStorage;
+use Symfony\Component\EventDispatcher\Event;
+
+/**
+ * @since 16.0.0
+ */
+class CacheInsertEvent extends Event {
+	private $storage;
+	private $path;
+	private $fileId;
+
+	/**
+	 * CacheInsertEvent constructor.
+	 *
+	 * @param IStorage $storage
+	 * @param string $path
+	 * @param int $fileId
+	 * @since 16.0.0
+	 */
+	public function __construct(IStorage $storage, string $path, int $fileId) {
+		$this->storage = $storage;
+		$this->path = $path;
+		$this->fileId = $fileId;
+	}
+
+	/**
+	 * @return IStorage
+	 * @since 16.0.0
+	 */
+	public function getStorage(): IStorage {
+		return $this->storage;
+	}
+
+	/**
+	 * @return string
+	 * @since 16.0.0
+	 */
+	public function getPath(): string {
+		return $this->path;
+	}
+
+	/**
+	 * @return int
+	 * @since 16.0.0
+	 */
+	public function getFileId(): int {
+		return $this->fileId;
+	}
+}