vistart\Models\components\SSOIdentity

Complexity

Total Complexity

8

Size/Duplication

Total Lines	33
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

94.12%

Importance

Changes	6
Bugs	1	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
B	loginRequired()	0	16	6
A	getMultipleDomainsManager()	0	8	2

<?php

/**
 *  _   __ __ _____ _____ ___  ____  _____
 * | | / // // ___//_  _//   ||  __||_   _|
 * | |/ // /(__  )  / / / /| || |     | |
 * |___//_//____/  /_/ /_/ |_||_|     |_|
 * @link http://vistart.name/
 * @copyright Copyright (c) 2016 vistart
 * @license http://vistart.name/license/
 */

namespace vistart\Models\components;

use Yii;
use yii\web\ForbiddenHttpException;

/**
 * Description of SSOIdentity
 * This component needs MultipleDomainsManager component.
 * Usage:
 * config/web.php (basic template) or config/main.php (advanced template):
 * ```php
 * $config = [
 *     ...
 *     'components' => [
 *         ...
 *         'multipleDomainsManager' => [
 *              'baseDomain' => <Base Domain>,
 *         ],
 *         'user' => [
 *             'class' => 'vistart\Models\components\SSOIdentity',
 *             'enableAutoLogin' => true,
 *             'identityClass' => <User Identity Class>,
 *             'identityCookie' => [
 *                 'name' => '_identity',
 *                 'httpOnly' => true,
 *                 'domain' => '.' . <Base Domain>,    // same as Multiple Domains Manager's `baseDomain` property.
 *             ],
 *         ],
 *         'session' => [
 *             ...
 *             'cookieParams' => [
 *                 'domain' => '.' . <Base Domain>,    // same as Multiple Domains Manager's `baseDomain` property.
 *                 'lifetime' => 0,
 *             ],
 *             ...
 *         ],
 *         ...
 *     ],
 * ];
 * ```
 * @since 2.0
 * @author vistart <i@vistart.name>
 */
class SSOIdentity extends \yii\web\User
{

    public $ssoDomain = 'sso';
    public $loginUrl = ['sso/login'];
    public $multipleDomainsManagerId = 'multipleDomainsManager';

    public function loginRequired($checkAjax = true)
    {
        $request = Yii::$app->getRequest();

        if ($this->enableSession && (!$checkAjax || !$request->getIsAjax())) {
            $this->setReturnUrl($request->getAbsoluteUrl());
        }
        if ($this->loginUrl !== null) {
            $loginUrl = (array) $this->loginUrl;
            if ($loginUrl[0] !== Yii::$app->requestedRoute) {
                $ssoUrlManager = $this->getMultipleDomainsManager()->get($this->ssoDomain);
                return Yii::$app->getResponse()->redirect($ssoUrlManager->createAbsoluteUrl($this->loginUrl));
            }
        }
        throw new ForbiddenHttpException(Yii::t('yii', 'Login Required'));
    }

    protected function getMultipleDomainsManager()
    {
        if (is_string($this->multipleDomainsManagerId)) {
            $mdId = $this->multipleDomainsManagerId;
            return Yii::$app->$mdId;
        }
        return Yii::$app->multipleDomainsManager;
    }
}