From cdcc858d086050758d4647b5064e1c51180f1e13 Mon Sep 17 00:00:00 2001 From: objecttothis Date: Thu, 2 Feb 2023 18:10:54 +0400 Subject: [PATCH] Updated PHPDoc --- app/Config/Validation/OSPOSRules.php | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/app/Config/Validation/OSPOSRules.php b/app/Config/Validation/OSPOSRules.php index 3ba3a9322..903b5b5b2 100644 --- a/app/Config/Validation/OSPOSRules.php +++ b/app/Config/Validation/OSPOSRules.php @@ -11,6 +11,15 @@ use Config\Services; */ class OSPOSRules { + /** + * Validates the username and password sent to the login view. User is logged in on successful validation. + * + * @param string $username Username to check against. + * @param string $fields Comma separated string of the fields for validation. + * @param array $data Data sent to the view. + * @param string|null $error The error sent back to the validation handler on failure. + * @return bool True if validation passes or false if there are errors. + */ public function login_check(string $username, string $fields , array $data, ?string &$error = null): bool { $this->employee = model('Employee');