Skip to content

Better event description for BeforeTemplateRenderedEvent in files and files_sharing #21853

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
MorrisJobke merged 1 commit into from
Jul 15, 2020
Merged

Better event description for BeforeTemplateRenderedEvent in files and files_sharing #21853

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions apps/files_sharing/lib/Event/BeforeTemplateRenderedEvent.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,25 +29,43 @@
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 */
private $share;
/** @var string|null */
private $scope;

/**
* @since 20.0.0
*/
public function __construct(IShare $share, ?string $scope = null) {
parent::__construct();

$this->share = $share;
$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;
}
Expand Down
4 changes: 2 additions & 2 deletions lib/public/AppFramework/Http/Events/BeforeTemplateRenderedEvent.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,9 @@
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 {
Expand Down