webtoolsnz/yii2-require-login

Simple component that enforces a blanket authentication requirement for all controller/actions.

1.0.5 2016-03-21 22:02 UTC

Requires

• yiisoft/yii2: ~2.0.0

Requires (Dev)

• phpunit/phpunit: ~4.0

proprietary

• Webtools Ltd

• component
• yii2
• require-login

README

Simple component that enforces a blanket authentication requirement for all controller/actions.

Provides a configurable list of exceptions.

Installation

The preferred way to install this extension is through composer.

Add the following to your composer.json file.

    "require" : {
        "webtoolsnz/yii2-require-login": "*"
    }, 
    "repositories": [
        {
            "type": "composer",
            "url": "https://packages.webtools.nz"
        }
    ]

Configuration Examples

Basic Configuration

...
'components' => [
    'requireLogin' => [
        'class' => 'webtoolsnz\RequireLogin\Component',
    ]
],
...

Custom Exception List

yii2-require-login will by default provide a list of basic route exceptions including: login logout you can override this list with your own list using the below config.

...
'components' => [
    'requireLogin' => [
        'class' => 'webtoolsnz\RequireLogin\Component',
        'exceptions' => [
            '/login',
            '/logout',
            '/my-controller/foo'
        ]
    ]
],
...

License

The MIT License (MIT). Please see LICENSE for more information.