File modules/cms/auth/README.md

Last commit: Sun Dec 5 02:03:27 2021 +0100	dankert	Added some documentation.


     1 # Authentication backends
     2 
     3 These authentication backends are used for user identification and authentication.
     4 
     5 Every Authentication must implement [the Auth interface](Auth.class.php) and must provide the 2 methods
     6 
     7 1. `login()` must do an authentification. On successful logins, it should return `Auth::STATUS_SUCCESS`, otherwise this method must return `Auth::STATUS_FAILED`.
     8 1. `username()` may find out the username of the user which want to log in. If this is not possible, this method must return `null`.



Download modules/cms/auth/README.md


History
Sun, 5 Dec 2021 02:03:27 +0100	dankert	Added some documentation.
Sun, 29 Nov 2020 21:46:57 +0100	Jan Dankert	Auth modules should only use the Auth::STATUS_* constants as return value.
Mon, 24 Feb 2020 18:36:11 +0100	Jan Dankert	Documentation added.