AuthPublicShareController extends PublicShareController
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.
Tags
Table of Contents
- $appName : string
- app name
- $request : IRequest
- current request
- $session : ISession
- $urlGenerator : IURLGenerator
- $responders : array
- $token : string
- __construct() : mixed
- constructor of the controller
- authenticate() : mixed
- buildResponse() : Response
- Serializes and formats a response
- getAuthenticationRedirect() : RedirectResponse
- getResponderByHTTPHeader() : string
- Parses an HTTP accept header and returns the supported responder type
- getToken() : string
- Get the token for this request
- isAuthenticated() : bool
- Check if a share is authenticated or not
- isValidToken() : bool
- Is the provided token a valid token
- setToken() : mixed
- Middleware set the token for the request
- shareNotFound() : mixed
- Function called if the share is not found.
- showAuthenticate() : TemplateResponse
- showShare() : TemplateResponse
- Default landing page
- authFailed() : mixed
- Function called after failed authentication
- authSucceeded() : mixed
- Function called after successfull authentication
- getPasswordHash() : string
- Get a hash of the password for this share
- isPasswordProtected() : bool
- Is a share with this token password protected
- registerResponder() : mixed
- Registers a formatter for a type
- showAuthFailed() : TemplateResponse
- The template to show when authentication failed
- verifyPassword() : bool
- Verify the password
- getRedirect() : RedirectResponse
- getRoute() : string
Properties
$appName
app name
protected
string
$appName
Tags
$request
current request
protected
IRequest
$request
Tags
$session
protected
ISession
$session
$urlGenerator
protected
IURLGenerator
$urlGenerator
$responders
private
array
$responders
Tags
$token
private
string
$token
Methods
__construct()
constructor of the controller
public
__construct(string $appName, IRequest $request, ISession $session, IURLGenerator $urlGenerator) : mixed
Parameters
- $appName : string
-
the name of the app
- $request : IRequest
-
an instance of the request
- $session : ISession
- $urlGenerator : IURLGenerator
Tags
Return values
mixed —authenticate()
public
final authenticate([string $password = '' ]) : mixed
Parameters
- $password : string = ''
Tags
Return values
mixed —buildResponse()
Serializes and formats a response
public
buildResponse(mixed $response[, string $format = 'json' ]) : Response
Parameters
- $response : mixed
-
the value that was returned from a controller and is not a Response instance
- $format : string = 'json'
-
the format for which a formatter has been registered
Tags
Return values
Response —getAuthenticationRedirect()
public
final getAuthenticationRedirect(string $redirect) : RedirectResponse
Parameters
- $redirect : string
Tags
Return values
RedirectResponse —getResponderByHTTPHeader()
Parses an HTTP accept header and returns the supported responder type
public
getResponderByHTTPHeader(string $acceptHeader[, string $default = 'json' ]) : string
Parameters
- $acceptHeader : string
- $default : string = 'json'
Tags
Return values
string —the responder type
getToken()
Get the token for this request
public
final getToken() : string
Tags
Return values
string —isAuthenticated()
Check if a share is authenticated or not
public
final isAuthenticated() : bool
Tags
Return values
bool —isValidToken()
Is the provided token a valid token
public
abstract isValidToken() : bool
This function is already called from the middleware directly after setting the token.
Tags
Return values
bool —setToken()
Middleware set the token for the request
public
final setToken(string $token) : mixed
Parameters
- $token : string
Tags
Return values
mixed —shareNotFound()
Function called if the share is not found.
public
shareNotFound() : mixed
You can use this to do some logging for example
Tags
Return values
mixed —showAuthenticate()
public
showAuthenticate() : TemplateResponse
Tags
Return values
TemplateResponse —showShare()
Default landing page
public
abstract showShare() : TemplateResponse
Tags
Return values
TemplateResponse —authFailed()
Function called after failed authentication
protected
authFailed() : mixed
You can use this to do some logging for example
Tags
Return values
mixed —authSucceeded()
Function called after successfull authentication
protected
authSucceeded() : mixed
You can use this to do some logging for example
Tags
Return values
mixed —getPasswordHash()
Get a hash of the password for this share
protected
abstract getPasswordHash() : string
To ensure access is blocked when the password to a share is changed we store a hash of the password for this token.
Tags
Return values
string —isPasswordProtected()
Is a share with this token password protected
protected
abstract isPasswordProtected() : bool
Tags
Return values
bool —registerResponder()
Registers a formatter for a type
protected
registerResponder(string $format, Closure $responder) : mixed
Parameters
- $format : string
- $responder : Closure
Tags
Return values
mixed —showAuthFailed()
The template to show when authentication failed
protected
showAuthFailed() : TemplateResponse
Tags
Return values
TemplateResponse —verifyPassword()
Verify the password
protected
abstract verifyPassword(string $password) : bool
Parameters
- $password : string
Tags
Return values
bool —getRedirect()
private
getRedirect() : RedirectResponse
Tags
Return values
RedirectResponse —getRoute()
private
getRoute(string $function) : string
Parameters
- $function : string