-
-
Save Haran/4554671816a9a475cd4c8b1163e76fd2 to your computer and use it in GitHub Desktop.
Yii2 Redirects all users to login (or any) page if not logged in, but allow access to some pages (like signup, password recovery etc.)
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
<?php | |
/* | |
* In configuration file | |
* ... | |
* 'as AccessBehavior' => [ | |
* 'class' => 'app\components\AccessBehavior', | |
* 'allowedRoutes' => [ | |
* '/', | |
* ['/user/registration/register'], | |
* ['/user/registration/resend'], | |
* ['/user/registration/confirm'], | |
* ['/user/recovery/request'], | |
* ['/user/recovery/reset'] | |
* ], | |
* //'redirectUri' => '/' | |
* ], | |
* ... | |
* | |
* (c) Artem Voitko <r3verser@gmail.com> | |
* | |
* For the full copyright and license information, please view the LICENSE | |
* file that was distributed with this source code. | |
*/ | |
namespace app\components; | |
use yii\base\Behavior; | |
use yii\console\Controller; | |
use yii\helpers\Url; | |
/** | |
* Redirects all users to defined page if they are not logged in | |
* | |
* Class AccessBehavior | |
* @package app\components | |
* @author Artem Voitko <r3verser@gmail.com> | |
*/ | |
class AccessBehavior extends Behavior | |
{ | |
/** | |
* @var string Yii route format string | |
*/ | |
protected $redirectUri; | |
/** | |
* @var array Routes which are allowed to access for none logged in users | |
*/ | |
protected $allowedRoutes = []; | |
/** | |
* @var array Urls generated from allowed routes | |
*/ | |
protected $allowedUrls = []; | |
/** | |
* @param $uri string Yii route format string | |
*/ | |
public function setRedirectUri($uri) | |
{ | |
$this->redirectUri = $uri; | |
} | |
/** | |
* Sets allowedRoutes param and generates urls from defined routes | |
* @param array $routes Array of allowed routes | |
*/ | |
public function setAllowedRoutes(array $routes) | |
{ | |
if (count($routes)) { | |
foreach ($routes as $route) { | |
$this->allowedUrls[] = Url::to($route); | |
} | |
} | |
$this->allowedRoutes = $routes; | |
} | |
/** | |
* @inheritdoc | |
*/ | |
public function init() | |
{ | |
if (empty($this->redirectUri)) { | |
$this->redirectUri = \Yii::$app->getUser()->loginUrl; | |
} | |
} | |
/** | |
* Subscribe for event | |
* @return array | |
*/ | |
public function events() | |
{ | |
return [ | |
Controller::EVENT_BEFORE_ACTION => 'beforeAction', | |
]; | |
} | |
/** | |
* On event callback | |
*/ | |
public function beforeAction() | |
{ | |
if (\Yii::$app->getUser()->isGuest && | |
\Yii::$app->getRequest()->url !== Url::to($this->redirectUri) && | |
!in_array(\Yii::$app->getRequest()->url, $this->allowedUrls) | |
) { | |
\Yii::$app->getResponse()->redirect($this->redirectUri)->send(); | |
\Yii::$app->end(); | |
} | |
} | |
} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment