AuthPublicShareController¶

class OCP\AppFramework\AuthPublicShareController¶

Base controller for interactive public shares

It will verify if the user is properly authenticated to the share. If not the
user will be redirected to an authentication page.

Use this for a controller that is to be called directly by a user. So the
normal public share page for files/calendars etc.

Source:	lib/public/AppFramework/AuthPublicShareController.php#47
Parent:	`OCP\AppFramework\PublicShareController`

Properties¶

protected static property OCP\AppFramework\AuthPublicShareController::$urlGenerator¶

Source:	lib/public/AppFramework/AuthPublicShareController.php#50
Type:	`\OCP\IURLGenerator`

Methods¶

public OCP\AppFramework\AuthPublicShareController::__construct($appName, $request, $session, $urlGenerator)¶

Source:	lib/public/AppFramework/AuthPublicShareController.php#55
Since:	14.0.0

public OCP\AppFramework\AuthPublicShareController::showAuthenticate()¶

Source:	lib/public/AppFramework/AuthPublicShareController.php#73
Since:	14.0.0

protected OCP\AppFramework\AuthPublicShareController::showAuthFailed()¶

The template to show when authentication failed

Source:	lib/public/AppFramework/AuthPublicShareController.php#82
Since:	14.0.0

protected abstract OCP\AppFramework\AuthPublicShareController::verifyPassword($password)¶

Verify the password

Source:	lib/public/AppFramework/AuthPublicShareController.php#91
Since:	14.0.0

protected OCP\AppFramework\AuthPublicShareController::authFailed()¶

Function called after failed authentication

You can use this to do some logging for example

Source:	lib/public/AppFramework/AuthPublicShareController.php#100
Since:	14.0.0

protected OCP\AppFramework\AuthPublicShareController::authSucceeded()¶

Function called after successfull authentication

You can use this to do some logging for example

Source:	lib/public/AppFramework/AuthPublicShareController.php#110
Since:	14.0.0

public final OCP\AppFramework\AuthPublicShareController::authenticate($password="")¶

Source:	lib/public/AppFramework/AuthPublicShareController.php#122
Since:	14.0.0

public abstract OCP\AppFramework\AuthPublicShareController::showShare()¶

Default landing page

Source:	lib/public/AppFramework/AuthPublicShareController.php#151
Since:	14.0.0

public final OCP\AppFramework\AuthPublicShareController::getAuthenticationRedirect($redirect)¶

Source:	lib/public/AppFramework/AuthPublicShareController.php#156
Since:	14.0.0