CakePHP 5：如何在自定义组件中正确调用Authentication插件？

原可运行的控制器代码（简化版） #

class UsersController extends AppController
{
    public function initialize(): void
    {
        parent::initialize();
        $this->loadComponent('Flash');
        $this->loadComponent('Authentication.Authentication');
    }    

    public function beforeFilter(EventInterface $event)
    {
        parent::beforeFilter($event);

        //...

        $protectedMethods = ['login', 'logout', 'edit'];
        if (!empty($this->request->getAttribute('identity')) && 
            in_array($this->request->getAttribute('identity')->get('role'), array_keys(ADMINROLES)) && 
            in_array($this->request->getParam('action'), $protectedMethods)) {
            $this->Flash->error(__('Invalid username or password'));
            $this->Authentication->logout();
            return $this->redirect(['controller' => 'Users', 'action' => 'login']);
        }       
    }
}

重构后的控制器代码（简化版） #

class UsersController extends AppController
{
    public function initialize(): void
    {
        parent::initialize();
        $this->loadComponent('Flash');
        $this->loadComponent('Authentication.Authentication');
        $this->loadComponent('AuthenticationBlocker');
    }    

    public function beforeFilter(EventInterface $event)
    {
        parent::beforeFilter($event);

        ...
        // 拦截管理员访问受保护方法
        $this->AuthenticationBlocker->adminRoles(['login', 'logout', 'edit']);     
    }
}

自定义AuthenticationBlockerComponent组件代码 #

class AuthenticationBlockerComponent extends Component {
    // 依赖的其他组件
    protected array $components = ['Flash', 'Authentication.Authentication'];
    public $controller;

    public function beforeFilter()
    {
        $this->controller = $this->getController();
    }

    public function adminRoles($methods) {
        if (!empty($this->getController()->getRequest()->getAttribute('identity')) 
            && in_array($this->getController()->getRequest()->getAttribute('identity')->get('role'), array_keys(ADMINROLES)) 
            && in_array($this->getController()->getRequest()->getParam('action'), $methods)) {
            $this->Flash->error(__('Invalid username or password'));
            $this->Authentication->logout(); // 此行代码报错
            return $this->controller->redirect(['controller' => 'Users', 'action' => 'login']);
        }
    }
}

问题原因 #

在CakePHP组件中，加载带插件前缀的组件（如Authentication.Authentication）时，无法直接通过$this->Authentication访问实例。CakePHP会将带插件的组件名称转换为驼峰式命名（AuthenticationAuthentication），或者需要通过getComponent方法显式获取组件实例。

修复方案 #

方式一：使用getComponent方法获取组件实例 #

修改组件中调用logout的代码为：

$this->getComponent('Authentication.Authentication')->logout();

方式二：使用驼峰式属性名访问 #

利用CakePHP自动转换的属性名直接调用：

$this->AuthenticationAuthentication->logout();

优化后的完整组件方法 #

可以提前获取组件和请求实例，简化代码：

public function adminRoles($methods) {
    $authComponent = $this->getComponent('Authentication.Authentication');
    $request = $this->getController()->getRequest();
    
    if (!empty($request->getAttribute('identity')) 
        && in_array($request->getAttribute('identity')->get('role'), array_keys(ADMINROLES)) 
        && in_array($request->getParam('action'), $methods)) {
        $this->Flash->error(__('Invalid username or password'));
        $authComponent->logout();
        return $this->controller->redirect(['controller' => 'Users', 'action' => 'login']);
    }
}

内容的提问来源于stack exchange，提问作者user3661042