dotkernel/dot-controller-plugin-authentication

DotKernel authentication controller plugin

2.9.2 2024-03-22 15:17 UTC

Requires

• php: ~8.1.0 || ~8.2.0 || ~8.3.0
• dotkernel/dot-authentication: ^2.3.0
• dotkernel/dot-controller: ^3.4.0
• laminas/laminas-servicemanager: ^3.21.0

Requires (Dev)

• phpunit/phpunit: ^10.3.2
• squizlabs/php_codesniffer: ^3.7

MIT

• DotKernel Team

README

Authentication controller plugin.

Caution

Security-Only Maintenance Mode

This package is considered feature-complete, and is now in security-only maintenance mode.

Installation

Run the following command

$ composer require dotkernel/dot-controller-plugin-authentication

This will also install package dotkernel/dot-controller and dotkernel/dot-authentication as dependencies Enable the module by merging the ConfiProvider output to your application's configuration, to register the services defined by this module.

Usage

In any controller, you can access this plugin by calling

$this->authentication()->...

This plugin defines 2 methods you can use in your controllers to check for the currently authenticated identity.

$this->authentication()->hasIdentity()

Returns a boolean value indicating if there is an authenticated identity or a guest identity

$this->authentication()->getIdentity()

Returns the current identity as an hydrated object, as defined in the authentication module