aboutsummaryrefslogtreecommitdiffstats
path: root/apps/files_sharing/lib/Event/BeforeTemplateRenderedEvent.php
diff options
context:
space:
mode:
Diffstat (limited to 'apps/files_sharing/lib/Event/BeforeTemplateRenderedEvent.php')
-rw-r--r--apps/files_sharing/lib/Event/BeforeTemplateRenderedEvent.php49
1 files changed, 49 insertions, 0 deletions
diff --git a/apps/files_sharing/lib/Event/BeforeTemplateRenderedEvent.php b/apps/files_sharing/lib/Event/BeforeTemplateRenderedEvent.php
new file mode 100644
index 00000000000..709d7bacd4a
--- /dev/null
+++ b/apps/files_sharing/lib/Event/BeforeTemplateRenderedEvent.php
@@ -0,0 +1,49 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2020 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+namespace OCA\Files_Sharing\Event;
+
+use OCP\EventDispatcher\Event;
+use OCP\Share\IShare;
+
+/**
+ * Emitted before the rendering step of the public share page happens. The event
+ * holds a flag that specifies if it is the authentication page of a public share.
+ *
+ * @since 20.0.0
+ */
+class BeforeTemplateRenderedEvent extends Event {
+ /**
+ * @since 20.0.0
+ */
+ public const SCOPE_PUBLIC_SHARE_AUTH = 'publicShareAuth';
+
+ /**
+ * @since 20.0.0
+ */
+ public function __construct(
+ private IShare $share,
+ private ?string $scope = null,
+ ) {
+ parent::__construct();
+ }
+
+ /**
+ * @since 20.0.0
+ */
+ public function getShare(): IShare {
+ return $this->share;
+ }
+
+ /**
+ * @since 20.0.0
+ */
+ public function getScope(): ?string {
+ return $this->scope;
+ }
+}