Better event description for BeforeTemplateRenderedEvent in files and files_sharing

Signed-off-by: Morris Jobke <hey@morrisjobke.de>

diff --git a/apps/files_sharing/lib/Event/BeforeTemplateRenderedEvent.php b/apps/files_sharing/lib/Event/BeforeTemplateRenderedEvent.php
index 5f40eaca46dcce20d3c18e689a1923bca6fda0ed..0feec779771a943020ff303729a9dabce426bb82 100644 (file)
--- a/apps/files_sharing/lib/Event/BeforeTemplateRenderedEvent.php
+++ b/apps/files_sharing/lib/Event/BeforeTemplateRenderedEvent.php
@@ -29,7 +29,16 @@ 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';
 
        /** @var IShare */
@@ -37,6 +46,9 @@ class BeforeTemplateRenderedEvent extends Event {
        /** @var string|null */
        private $scope;
 
+       /**
+        * @since 20.0.0
+        */
        public function __construct(IShare $share, ?string $scope = null) {
                parent::__construct();
 
@@ -44,10 +56,16 @@ class BeforeTemplateRenderedEvent extends Event {
                $this->scope = $scope;
        }
 
+       /**
+        * @since 20.0.0
+        */
        public function getShare(): IShare {
                return $this->share;
        }
 
+       /**
+        * @since 20.0.0
+        */
        public function getScope(): ?string {
                return $this->scope;
        }

diff --git a/lib/public/AppFramework/Http/Events/BeforeTemplateRenderedEvent.php b/lib/public/AppFramework/Http/Events/BeforeTemplateRenderedEvent.php
index 1af679f91d47e916e8f180f6720ebc6f2b4c8f34..0cf64e862c5c64d7f2ddeadeee365f6adbf232d9 100644 (file)
--- a/lib/public/AppFramework/Http/Events/BeforeTemplateRenderedEvent.php
+++ b/lib/public/AppFramework/Http/Events/BeforeTemplateRenderedEvent.php
@@ -29,9 +29,9 @@ namespace OCP\AppFramework\Http\Events;
 use OCP\EventDispatcher\Event;
 
 /**
- * The event is triggered before the rendering step of each TemplateResponse.
+ * Emitted before the rendering step of each TemplateResponse. The event holds a
+ * flag that specifies if an user is logged in.
  *
- * @package OCP\AppFramework\Http\Events
  * @since 20.0.0
  */
 class BeforeTemplateRenderedEvent extends Event {