aboutsummaryrefslogtreecommitdiffstats
path: root/lib/public/Files/Events
diff options
context:
space:
mode:
Diffstat (limited to 'lib/public/Files/Events')
-rw-r--r--lib/public/Files/Events/BeforeFileSystemSetupEvent.php36
-rw-r--r--lib/public/Files/Events/BeforeZipCreatedEvent.php30
-rw-r--r--lib/public/Files/Events/Node/AbstractNodeEvent.php2
-rw-r--r--lib/public/Files/Events/Node/AbstractNodesEvent.php2
4 files changed, 64 insertions, 6 deletions
diff --git a/lib/public/Files/Events/BeforeFileSystemSetupEvent.php b/lib/public/Files/Events/BeforeFileSystemSetupEvent.php
new file mode 100644
index 00000000000..23791aa6ec1
--- /dev/null
+++ b/lib/public/Files/Events/BeforeFileSystemSetupEvent.php
@@ -0,0 +1,36 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-only
+ */
+
+namespace OCP\Files\Events;
+
+use OCP\EventDispatcher\Event;
+use OCP\IUser;
+
+/**
+ * Event triggered before the file system is setup
+ *
+ * @since 31.0.0
+ */
+class BeforeFileSystemSetupEvent extends Event {
+ /**
+ * @since 31.0.0
+ */
+ public function __construct(
+ private IUser $user,
+ ) {
+ parent::__construct();
+ }
+
+ /**
+ * @since 31.0.0
+ */
+ public function getUser(): IUser {
+ return $this->user;
+ }
+}
diff --git a/lib/public/Files/Events/BeforeZipCreatedEvent.php b/lib/public/Files/Events/BeforeZipCreatedEvent.php
index b55b36d3968..0363d385d36 100644
--- a/lib/public/Files/Events/BeforeZipCreatedEvent.php
+++ b/lib/public/Files/Events/BeforeZipCreatedEvent.php
@@ -10,23 +10,45 @@ declare(strict_types=1);
namespace OCP\Files\Events;
use OCP\EventDispatcher\Event;
+use OCP\Files\Folder;
/**
+ * This event is triggered before a archive is created when a user requested
+ * downloading a folder or multiple files.
+ *
+ * By setting `successful` to false the tar creation can be aborted and the download denied.
+ *
* @since 25.0.0
*/
class BeforeZipCreatedEvent extends Event {
private string $directory;
- private array $files;
private bool $successful = true;
private ?string $errorMessage = null;
+ private ?Folder $folder = null;
/**
+ * @param list<string> $files
* @since 25.0.0
+ * @since 31.0.0 support `OCP\Files\Folder` as `$directory` parameter - passing a string is deprecated now
*/
- public function __construct(string $directory, array $files) {
+ public function __construct(
+ string|Folder $directory,
+ private array $files,
+ ) {
parent::__construct();
- $this->directory = $directory;
- $this->files = $files;
+ if ($directory instanceof Folder) {
+ $this->directory = $directory->getPath();
+ $this->folder = $directory;
+ } else {
+ $this->directory = $directory;
+ }
+ }
+
+ /**
+ * @since 31.0.0
+ */
+ public function getFolder(): ?Folder {
+ return $this->folder;
}
/**
diff --git a/lib/public/Files/Events/Node/AbstractNodeEvent.php b/lib/public/Files/Events/Node/AbstractNodeEvent.php
index 64b0e3a3aa5..7afb71277f6 100644
--- a/lib/public/Files/Events/Node/AbstractNodeEvent.php
+++ b/lib/public/Files/Events/Node/AbstractNodeEvent.php
@@ -21,7 +21,7 @@ abstract class AbstractNodeEvent extends Event implements IWebhookCompatibleEven
* @since 20.0.0
*/
public function __construct(
- private Node $node
+ private Node $node,
) {
}
diff --git a/lib/public/Files/Events/Node/AbstractNodesEvent.php b/lib/public/Files/Events/Node/AbstractNodesEvent.php
index 7941a9e596a..8fa8795d1df 100644
--- a/lib/public/Files/Events/Node/AbstractNodesEvent.php
+++ b/lib/public/Files/Events/Node/AbstractNodesEvent.php
@@ -22,7 +22,7 @@ abstract class AbstractNodesEvent extends Event implements IWebhookCompatibleEve
*/
public function __construct(
private Node $source,
- private Node $target
+ private Node $target,
) {
}