BasicAuth
class BasicAuth (View source)
Provides an interface to HTTP basic authentication.
This utility class can be used to secure any request with basic authentication. To do so, BasicAuth::requireLogin() from your Controller's init() method or action handler method.
It also has a function to protect your entire site. See BasicAuth::protect_entire_site() for more information. You can control this setting on controller-level by using Controller->basicAuthEnabled.
Properties
Methods
Require basic authentication. Will request a username and password if none is given.
Enable protection of the entire site with basic authentication.
Call BasicAuth::requireLogin()} if {@link BasicAuth::protect_entire_site() has been called.
Details
static Member
requireLogin(string $realm, string|array $permissionCode = null, bool $tryUsingSessionLogin = true)
Require basic authentication. Will request a username and password if none is given.
Used by Controller::init().
static
protect_entire_site(bool $protect = true, string $code = 'ADMIN', string $message = null)
Enable protection of the entire site with basic authentication.
This log-in uses the Member database for authentication, but doesn't interfere with the regular log-in form. This can be useful for test sites, where you want to hide the site away from prying eyes, but still be able to test the regular log-in features of the site.
If you are including conf/ConfigureFromEnv.php in your _config.php file, you can also enable this feature by adding this line to your _ss_environment.php:
define('SS_USE_BASIC_AUTH', true);
static
protect_site_if_necessary()
Call BasicAuth::requireLogin()} if {@link BasicAuth::protect_entire_site() has been called.
This is a helper function used by Controller::init().
If you want to enabled protection (rather than enforcing it), please use protect_entire_site().