Yii Framework Official Guide Series 7 - Notions de base : contrôleurs

Un contrôleur est une instance de CController ou l'une de ses sous-classes. Il est créé par l'application à la demande de l'utilisateur. Lorsqu'un contrôleur s'exécute, il effectue l'action demandée, qui introduit généralement les modèles nécessaires et restitue les vues correspondantes. La forme d'action la plus simple est une méthode de classe de contrôleur dont le nom commence par action.

Les contrôleurs ont généralement une action par défaut. Lorsque la demande de l'utilisateur ne précise pas une action à effectuer, l'action par défaut sera effectuée. Par défaut, le nom de l'action par défaut est index. Il peut être modifié en définissant CController::defaultAction.

Ce qui suit est le code le plus simple requis pour une classe de contrôleur. Étant donné que ce contrôleur n'a aucune action définie, les demandes qui lui seront adressées lèveront une exception.

class SiteController extends CController
{
}

1. Routage

Les contrôleurs et les actions sont identifiés par ID. L'ID du contrôleur est au format 'path/to/xyz', correspondant au fichier de classe de contrôleur correspondant protected/controllers/path/to/XyzController.php, où l'indicateur xyz doit être remplacé par le nom réel (par exemple, post correspond à protected/controllers/PostController.php). L'ID d'action est le nom de la méthode d'action sans le préfixe d'action. Par exemple, si une classe de contrôleur contient une méthode nommée actionEdit, l'ID d'action correspondant est edit.

Remarque : Avant la version 1.0.3, le format de l'ID du contrôleur était path.to.xyz au lieu de path/to/xyz.

Les utilisateurs demandent des contrôleurs et des actions spécifiques sous forme d'itinéraires. Les routes sont reliées par un ID de contrôleur et un ID d'action, séparés par une barre oblique. Par exemple, la route post/edit représente PostController et son action d'édition. Par défaut, l'URL http://www.php.cn/ demande ce contrôleur et cette action.

Remarque : Par défaut, le routage est sensible à la casse. À partir de la version 1.0.1, vous pouvez définir CUrlManager::caseSensitive sur false dans la configuration de l'application. route insensible à la casse . En mode insensible à la casse, assurez-vous de suivre la convention selon laquelle les noms de répertoires contenant les fichiers de classe de contrôleur sont en minuscules et que les clés utilisées dans les mappes de contrôleur et les mappes d'action sont en minuscules.

À partir de la version 1.0.3, les applications peuvent contenir des Modules. Dans le module, le format de routage des actions du contrôleur est moduleID/controllerID/actionID. Pour plus de détails, veuillez lire les chapitres pertinents du module.

2. Instanciation du contrôleur

L'instance du contrôleur est créée lorsque CWebApplication gère les requêtes entrantes. Lorsqu'un ID de contrôleur est spécifié, l'application utilise les règles suivantes pour déterminer la classe du contrôleur et l'emplacement du fichier de classe.

• Si CWebApplication::catchAllRequest est spécifié, le contrôleur sera créé en fonction de cet attribut et l'ID du contrôleur spécifié par l'utilisateur sera ignoré. Ceci est généralement utilisé pour définir l'application sur l'état de maintenance et afficher une page d'invite statique .

• Si l'ID est trouvé dans CWebApplication::controllerMap, la configuration du contrôleur correspondante sera utilisée pour créer l'instance du contrôleur.

• Si l'ID est au format 'path/to/xyz', le nom de la classe du contrôleur sera jugé comme étant XyzController, et le fichier de classe correspondant sera protégé/ contrôleurs/chemin/vers/XyzController .php. Par exemple, l'ID du contrôleur admin/user sera résolu en classe de contrôleur UserController et le fichier de classe est protected/controllers/admin/UserController.php. Si le fichier de classe n'existe pas, une 404 CHttpException sera déclenchée.

Après avoir utilisé le module (disponible après la version 1.0.3), le processus ci-dessus est légèrement différent. Plus précisément, l'application vérifie si cet ID représente un contrôleur dans un module. Si tel est le cas, l'instance de module sera créée en premier, puis l'instance de contrôleur dans le module sera créée.

3. Action

Comme mentionné ci-dessus, une action peut être définie comme une méthode nommée avec le mot action comme préfixe. Une méthode plus avancée consiste à définir une classe d'action et à demander au contrôleur de l'instancier lorsqu'il reçoit une requête. Cela permet de réutiliser les actions, améliorant ainsi la réutilisabilité.

Pour définir une nouvelle classe d'action, utilisez le code suivant :

class UpdateAction extends CAction
{
    public function run()
    {
        // place the action logic here
    }
}

Pour pour autoriser le contrôle Si le contrôleur remarque cette action, nous devons remplacer la méthode actions() de la classe contrôleur de la manière suivante :

class PostController extends CController
{
    public function actions()
    {
        return array(
            'edit'=>'application.controllers.post.UpdateAction',
        );
    }
}

Comme indiqué ci-dessus, nous avons utilisé l'alias de chemin application.controllers.post.UpdateAction pour spécifier le fichier de classe d'action comme protected/controllers/post/UpdateAction.php.

En écrivant la classe -actions basées sur, nous pouvons organiser l'application pour le style de module. Par exemple, la structure de répertoires suivante peut être utilisée pour organiser le code lié au contrôleur :

protected/
    controllers/
        PostController.php
        UserController.php
        post/
            CreateAction.php
            ReadAction.php
            UpdateAction.php
        user/
            CreateAction.php
            ListAction.php
            ProfileAction.php
            UpdateAction.php

Liaison des paramètres d'action

从版本 1.1.4 开始，Yii 提供了对自动动作参数绑定的支持。 就是说，控制器动作可以定义命名的参数，参数的值将由 Yii 自动从 $_GET 填充。

为了详细说明此功能，假设我们需要为 PostController 写一个 create 动作。此动作需要两个参数：

• category: 一个整数，代表帖子（post）要发表在的那个分类的ID。

• language: 一个字符串，代表帖子所使用的语言代码。

从 $_GET 中提取参数时，我们可以不再下面这种无聊的代码了：

class PostController extends CController
{
    public function actionCreate()
    {
        if(isset($_GET['category']))
            $category=(int)$_GET['category'];
        else
            throw new CHttpException(404,'invalid request');

        if(isset($_GET['language']))
            $language=$_GET['language'];
        else
            $language='en';

        // ... fun code starts here ...
    }
}

现在使用动作参数功能，我们可以更轻松的完成任务：

class PostController extends CController
{
    public function actionCreate($category, $language='en')
    {
        $category=(int)$category;

        // ... fun code starts here ...
    }
}

注意我们在动作方法 actionCreate 中添加了两个参数。 这些参数的名字必须和我们想要从 $_GET 中提取的名字一致。 当用户没有在请求中指定 $language 参数时，这个参数会使用默认值 en 。 由于 $category 没有默认值，如果用户没有在 $_GET 中提供 category 参数， 将会自动抛出一个 CHttpException (错误代码 400) 异常。从版本1.1.5开始, Yii还支持数组类型的动作参数绑定。 这是通过PHP的类型约束来实现的，语法如下：

class PostController extends CController
{
    public function actionCreate(array $categories)
    {
        // Yii will make sure $categories be an array
    }
}

也就是说我们在方法参数声明里的$categories之前添加了array关键字。这样的话，如果$_GET['categories']只是一个简单的字符串，它将会被转化为一个包含该字符串的数组。

注意: 如果参数声明没有加上 array 类型约束, 意味着参数必须是标量 (i.e., not an array)。这种情况下，通过 $_GET 传入一个数组参数将会引发HTTP异常。

4. 过滤器

过滤器是一段代码，可被配置在控制器动作执行之前或之后执行。例如， 访问控制过滤器将被执行以确保在执行请求的动作之前用户已通过身份验证；性能过滤器可用于测量控制器执行所用的时间。

一个动作可以有多个过滤器。过滤器执行顺序为它们出现在过滤器列表中的顺序。过滤器可以阻止动作及后面其他过滤器的执行

过滤器可以定义为一个控制器类的方法。方法名必须以 filter 开头。例如，现有的 filterAccessControl 方法定义了一个名为 accessControl 的过滤器。 过滤器方法必须为如下结构：

public function filterAccessControl($filterChain)
{
    // 调用 $filterChain->run() 以继续后续过滤器与动作的执行。
}

其中的 $filterChain (过滤器链)是一个 CFilterChain 的实例，代表与所请求动作相关的过滤器列表。在过滤器方法中， 我们可以调用 $filterChain->run() 以继续执行后续过滤器和动作。

过滤器也可以是一个 CFilter 或其子类的实例。如下代码定义了一个新的过滤器类：

class PerformanceFilter extends CFilter
{
    protected function preFilter($filterChain)
    {
        // 动作被执行之前应用的逻辑
        return true; // 如果动作不应被执行，此处返回 false
    }

    protected function postFilter($filterChain)
    {
        // 动作执行之后应用的逻辑
    }
}

要对动作应用过滤器，我们需要覆盖 CController::filters() 方法。此方法应返回一个过滤器配置数组。例如：

class PostController extends CController
{
    ......
    public function filters()
    {
        return array(
            'postOnly + edit, create',
            array(
                'application.filters.PerformanceFilter - edit, create',
                'unit'=>'second',
            ),
        );
    }
}

上述代码指定了两个过滤器： postOnly 和 PerformanceFilter。 postOnly 过滤器是基于方法的（相应的过滤器方法已在 CController 中定义）； 而 performanceFilter 过滤器是基于对象的。路径别名application.filters.PerformanceFilter 指定过滤器类文件是protected/filters/PerformanceFilter。我们使用一个数组配置 PerformanceFilter ，这样它就可被用于初始化过滤器对象的属性值。此处 PerformanceFilter 的 unit 属性值将被初始为 second。

使用加减号，我们可指定哪些动作应该或不应该应用过滤器。上述代码中， postOnly 应只被应用于 edit 和 create动作，而 PerformanceFilter 应被应用于 除了 edit 和 create 之外的动作。 如果过滤器配置中没有使用加减号，则此过滤器将被应用于所有动作。

附图：控制器的run方法执行过程

以上就是Yii框架官方指南系列7——基础知识：控制器的内容，更多相关内容请关注PHP中文网（www.php.cn）！