mbk-lab
/
nextcloud
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Merge pull request #21853 from nextcloud/enh/noid/better-event-description 

Better event description for BeforeTemplateRenderedEvent in files and files_sharing
This commit is contained in:
Morris Jobke 2020-07-15 21:19:14 +02:00 committed by GitHub
parent 16d0ef9576 c4b53538af
commit 8368d56f8e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 20 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
apps/files_sharing/lib/Event/BeforeTemplateRenderedEvent.php
View File

@ -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;
}

4
lib/public/AppFramework/Http/Events/BeforeTemplateRenderedEvent.php
View File

@ -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 {