aboutsummaryrefslogtreecommitdiffstats
path: root/lib/public/AppFramework/Http/Events/BeforeTemplateRenderedEvent.php
diff options
context:
space:
mode:
Diffstat (limited to 'lib/public/AppFramework/Http/Events/BeforeTemplateRenderedEvent.php')
-rw-r--r--lib/public/AppFramework/Http/Events/BeforeTemplateRenderedEvent.php49
1 files changed, 49 insertions, 0 deletions
diff --git a/lib/public/AppFramework/Http/Events/BeforeTemplateRenderedEvent.php b/lib/public/AppFramework/Http/Events/BeforeTemplateRenderedEvent.php
new file mode 100644
index 00000000000..7219ca5bfb6
--- /dev/null
+++ b/lib/public/AppFramework/Http/Events/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 OCP\AppFramework\Http\Events;
+
+use OCP\AppFramework\Http\TemplateResponse;
+use OCP\EventDispatcher\Event;
+
+/**
+ * Emitted before the rendering step of each TemplateResponse. The event holds a
+ * flag that specifies if an user is logged in.
+ *
+ * @since 20.0.0
+ */
+class BeforeTemplateRenderedEvent extends Event {
+ /** @var bool */
+ private $loggedIn;
+ /** @var TemplateResponse */
+ private $response;
+
+ /**
+ * @since 20.0.0
+ */
+ public function __construct(bool $loggedIn, TemplateResponse $response) {
+ parent::__construct();
+
+ $this->loggedIn = $loggedIn;
+ $this->response = $response;
+ }
+
+ /**
+ * @since 20.0.0
+ */
+ public function isLoggedIn(): bool {
+ return $this->loggedIn;
+ }
+
+ /**
+ * @since 20.0.0
+ */
+ public function getResponse(): TemplateResponse {
+ return $this->response;
+ }
+}