ValidatePasswordPolicyEvent
extends Event
in package
This event can be emitted to request a validation of a password.
If a password policy app is installed and the password
is invalid, an \OCP\HintException will be thrown.
Tags
Table of Contents
Properties
- $context : PasswordContext
- $password : string
Methods
- __construct() : mixed
- Compatibility constructor
- getContext() : PasswordContext
- Get the context this password should validated for.
- getPassword() : string
- Get the password that should be validated.
- isPropagationStopped() : bool
- {@inheritDoc}
- stopPropagation() : void
- Stops the propagation of the event to further event listeners
Properties
$context
private
PasswordContext
$context
= PasswordContext::ACCOUNT
$password
private
string
$password
Attributes
- #[SensitiveParameter]
Methods
__construct()
Compatibility constructor
public
__construct(string $password[, PasswordContext $context = PasswordContext::ACCOUNT ]) : mixed
Parameters
- $password : string
- $context : PasswordContext = PasswordContext::ACCOUNT
Tags
getContext()
Get the context this password should validated for.
public
getContext() : PasswordContext
Tags
Return values
PasswordContextgetPassword()
Get the password that should be validated.
public
getPassword() : string
Tags
Return values
stringisPropagationStopped()
{@inheritDoc}
public
isPropagationStopped() : bool
Tags
Attributes
- #[Override]
Return values
boolstopPropagation()
Stops the propagation of the event to further event listeners
public
stopPropagation() : void