Pour l'analyse du contrôleur Controller dans le framework Yii de PHP

Cet article présente principalement le contrôleur Controller dans le framework Yii de PHP En tant que framework MVC, l'utilisation de la partie contrôleur de Yii est naturellement la priorité absolue. Les amis dans le besoin peuvent se référer au

Control. Le contrôleur fait partie du modèle MVC. C'est un objet qui hérite de la classe yiibaseController et est responsable du traitement des requêtes et de la génération des réponses. Plus précisément, après avoir pris le contrôle du corps de l'application, le contrôleur analyse les données de la demande et les transmet au modèle, transmet les résultats du modèle à la vue et génère enfin des informations de réponse de sortie.

Opération

Un contrôleur est composé d'opérations, qui sont les unités les plus élémentaires pour exécuter les requêtes de l'utilisateur final. Un contrôleur peut avoir une ou plusieurs opérations.

L'exemple suivant montre une publication de contrôleur contenant deux vues d'opérations et créées :

namespace app\controllers;

use Yii;
use app\models\Post;
use yii\web\Controller;
use yii\web\NotFoundHttpException;

class PostController extends Controller
{
 public function actionView($id)
 {
  $model = Post::findOne($id);
  if ($model === null) {
   throw new NotFoundHttpException;
  }

  return $this->render('view', [
   'model' => $model,
  ]);
 }

 public function actionCreate()
 {
  $model = new Post;

  if ($model->load(Yii::$app->request->post()) && $model->save()) {
   return $this->redirect(['view', 'id' => $model->id]);
  } else {
   return $this->render('create', [
    'model' => $model,
   ]);
  }
 }
}

Dans la vue des opérations (définie comme actionView( ), le code charge d'abord le modèle en fonction de l'ID de modèle demandé. Si le chargement réussit, la vue nommée view sera rendue et affichée, sinon une exception sera levée.

Dans l'opération create (définie comme méthode actionCreate()), le code est similaire. Remplissez d'abord les données de la demande dans le modèle, puis enregistrez le modèle. Si les deux réussissent, il passera au modèle. modèle nouvellement créé avec l'opération de vue ID, sinon la vue de création qui fournit une entrée utilisateur s'affiche.

Routes

Les utilisateurs finaux trouvent des actions via ce que l'on appelle des routes, qui sont des chaînes contenant les parties suivantes :

• Modèle ID : n'existe que dans les modules où le contrôleur appartient à des non-applications ;

• ID du contrôleur : identifie de manière unique le contrôleur dans la même application (ou le même module s'il s'agit d'un contrôleur sous le module) String;

• ID d'opération : une chaîne qui identifie de manière unique l'opération sous le même contrôleur.

Le routage utilise le format suivant :

ControllerID/ActionID
S'il appartient à un contrôleur sous un module, utilisez le format suivant :

ModuleID/ControllerID /ActionID
Si l'adresse de demande de l'utilisateur est http://hostname/index.php?r=site/index, l'opération d'indexation du contrôleur de site sera exécutée.

Créer un contrôleur

Dans l'application Web yiiwebApplication, le contrôleur doit hériter de yiiwebController ou de sa sous-classe. De même, dans l'application console yiiconsoleApplication, le contrôleur hérite de yiiconsoleController ou de ses sous-classes. Le code suivant définit un contrôleur de site :

namespace app\controllers;

use yii\web\Controller;

class SiteController extends Controller
{
}

ID du contrôleur

Habituellement, le contrôleur utilise Pour traiter le type de ressource lié à la demande, l'ID du contrôleur est généralement un nom lié à la ressource. Par exemple, utilisez article comme ID de contrôleur pour traiter les articles.

L'ID du contrôleur ne doit contenir que des lettres minuscules, des chiffres, des traits de soulignement, des tirets et des barres obliques en anglais. Par exemple, article et post-comment sont de véritables ID de contrôleur, article ?, PostComment, adminpost ne sont pas des ID de contrôleur.

L'ID du contrôleur peut inclure le préfixe du sous-répertoire, par exemple, admin/article représente le contrôleur d'article dans le sous-répertoire admin sous l'espace de noms du contrôleur yiibaseApplication::controllerNamespace. Le préfixe du sous-répertoire peut être composé de lettres majuscules et minuscules anglaises, de chiffres, de traits de soulignement et de barres obliques. Les barres obliques sont utilisées pour distinguer les sous-répertoires à plusieurs niveaux (tels que panels/admin).

Nom de la classe du contrôleur

L'ID du contrôleur suit les règles suivantes pour dériver le nom de la classe du contrôleur :

Séparez chaque mot par une barre oblique Le premier la lettre est convertie en majuscule. Notez que si l'ID du contrôleur contient une barre oblique, seule la première lettre après la dernière barre oblique sera convertie en majuscule ;
supprimez le tiret du milieu et remplacez la barre oblique inverse
augmentez le suffixe du contrôleur ;
Ajoutez l'espace de noms du contrôleur yiibaseApplication::controllerNamespace devant.
Voici quelques exemples, en supposant que l'espace de noms du contrôleur yiibaseApplication::controllerNamespace est appcontrollers:

• l'article correspond à appcontrollersArticleController ;

• post-comment correspond à appcontrollersPostCommentController;

• admin/post-comment correspond à appcontrollersadminPostCommentController;

• adminPanels/post-comment correspond à appcontrollersadminPanelsPostCommentController.

La classe du contrôleur doit être automatiquement chargée, donc dans l'exemple ci-dessus, la classe d'article du contrôleur doit être alias comme @app /controllers/ ArticleController.php, le contrôleur admin/post2-comment doit être dans le fichier @app/controllers/admin/Post2CommentController.php.

Supplément : Le dernier exemple admin/post2-comment indique que vous pouvez placer le contrôleur dans un sous-répertoire sous l'espace de noms du contrôleur yiibaseApplication::controllerNamespace, et classer le contrôleur si vous ne souhaitez pas utiliser de modules, ceci. la méthode est très utile.
Déploiement du contrôleur

Vous pouvez configurer yiibaseApplication::controllerMap pour forcer la correspondance de l'ID du contrôleur et du nom de classe ci-dessus. Il est généralement utilisé lors de l'utilisation d'un contrôleur qu'un tiers ne peut pas contrôler. le nom de la classe supérieure.

Configurez la configuration de l'application dans la configuration de l'application comme suit :

[
 'controllerMap' => [
  // 用类名申明 "account" 控制器
  'account' => 'app\controllers\UserController',

  // 用配置数组申明 "article" 控制器
  'article' => [
   'class' => 'app\controllers\PostController',
   'enableCsrfValidation' => false,
  ],
 ],
]

Contrôleur par défaut

每个应用有一个由yii\base\Application::defaultRoute属性指定的默认控制器； 当请求没有指定 路由，该属性值作为路由使用。 对于yii\web\Application网页应用，它的值为 'site'， 对于 yii\console\Application控制台应用，它的值为 help， 所以URL为http://hostname/index.php 表示由 site 控制器来处理。

可以在 应用配置 中修改默认控制器，如下所示：

[
 'defaultRoute' => 'main',
]

创建操作

创建操作可简单地在控制器类中定义所谓的 操作方法 来完成，操作方法必须是以action开头的公有方法。 操作方法的返回值会作为响应数据发送给终端用户，如下代码定义了两个操作 index 和 hello-world:

namespace app\controllers;

use yii\web\Controller;

class SiteController extends Controller
{
 public function actionIndex()
 {
  return $this->render('index');
 }

 public function actionHelloWorld()
 {
  return 'Hello World';
 }
}

操作ID

操作通常是用来执行资源的特定操作，因此，操作ID通常为动词，如view, update等。

操作ID应仅包含英文小写字母、数字、下划线和中横杠，操作ID中的中横杠用来分隔单词。 例如view, update2, comment-post是真实的操作ID，view?, Update不是操作ID.

可通过两种方式创建操作ID，内联操作和独立操作. An inline action is 内联操作在控制器类中定义为方法；独立操作是继承yii\base\Action或它的子类的类。 内联操作容易创建，在无需重用的情况下优先使用； 独立操作相反，主要用于多个控制器重用，或重构为扩展。

内联操作

内联操作指的是根据我们刚描述的操作方法。

操作方法的名字是根据操作ID遵循如下规则衍生：

• 将每个单词的第一个字母转为大写;

• 去掉中横杠;

• 增加action前缀.

• 例如index 转成 actionIndex, hello-world 转成 actionHelloWorld。

注意: 操作方法的名字大小写敏感，如果方法名称为ActionIndex不会认为是操作方法， 所以请求index操作会返回一个异常，也要注意操作方法必须是公有的，私有或者受保护的方法不能定义成内联操作。
因为容易创建，内联操作是最常用的操作，但是如果你计划在不同地方重用相同的操作， 或者你想重新分配一个操作，需要考虑定义它为独立操作。

独立操作

独立操作通过继承yii\base\Action或它的子类来定义。 例如Yii发布的yii\web\ViewAction和yii\web\ErrorAction都是独立操作。

要使用独立操作，需要通过控制器中覆盖yii\base\Controller::actions()方法在action map中申明，如下例所示：

public function actions()
{
 return [
  // 用类来申明"error" 操作
  'error' => 'yii\web\ErrorAction',

  // 用配置数组申明 "view" 操作
  'view' => [
   'class' => 'yii\web\ViewAction',
   'viewPrefix' => '',
  ],
 ];
}

如上所示， actions() 方法返回键为操作ID、值为对应操作类名或数组configurations 的数组。 和内联操作不同，独立操作ID可包含任意字符，只要在actions() 方法中申明.

为创建一个独立操作类，需要继承yii\base\Action 或它的子类，并实现公有的名称为run()的方法, run() 方法的角色和操作方法类似，例如：

<?php
namespace app\components;

use yii\base\Action;

class HelloWorldAction extends Action
{
 public function run()
 {
  return "Hello World";
 }
}

操作结果

操作方法或独立操作的run()方法的返回值非常重要，它表示对应操作结果。

返回值可为 响应 对象，作为响应发送给终端用户。

对于yii\web\Application网页应用，返回值可为任意数据, 它赋值给yii\web\Response::data， 最终转换为字符串来展示响应内容。
对于yii\console\Application控制台应用，返回值可为整数， 表示命令行下执行的 yii\console\Response::exitStatus 退出状态。
在上面的例子中，操作结果都为字符串，作为响应数据发送给终端用户，下例显示一个操作通过 返回响应对象（因为yii\web\Controller::redirect()方法返回一个响应对象）可将用户浏览器跳转到新的URL。

public function actionForward()

{
 // 用户浏览器跳转到 http://example.com
 return $this->redirect('http://example.com');
}

操作参数

内联操作的操作方法和独立操作的 run() 方法可以带参数，称为操作参数。 参数值从请求中获取，对于yii\web\Application网页应用， 每个操作参数的值从$_GET中获得，参数名作为键； 对于yii\console\Application控制台应用, 操作参数对应命令行参数。

如下例，操作view (内联操作) 申明了两个参数 $id 和 $version。

namespace app\controllers;

use yii\web\Controller;

class PostController extends Controller
{
  public function actionView($id, $version = null)
  {
    // ...
  }
}

操作参数会被不同的参数填入，如下所示：

http://hostname/index.php?r=post/view&id=123: $id 会填入'123'，$version 仍为 null 空因为没有version请求参数;
http://hostname/index.php?r=post/view&id=123&version=2: $id 和 $version 分别填入 '123' 和 '2'`；
http://hostname/index.php?r=post/view: 会抛出yii\web\BadRequestHttpException 异常 因为请求没有提供参数给必须赋值参数$id；
http://hostname/index.php?r=post/view&id[]=123: 会抛出yii\web\BadRequestHttpException 异常 因为$id 参数收到数字值 ['123']而不是字符串.
如果想让操作参数接收数组值，需要指定$id为array，如下所示：

public function actionView(array $id, $version = null)
{
 // ...
}

现在如果请求为 http://hostname/index.php?r=post/view&id[]=123, 参数 $id 会使用数组值['123']， 如果请求为http://hostname/index.php?r=post/view&id=123， 参数 $id 会获取相同数组值，因为无类型的'123'会自动转成数组。

上述例子主要描述网页应用的操作参数，对于控制台应用，更多详情请参阅控制台命令。

默认操作

每个控制器都有一个由 yii\base\Controller::defaultAction 属性指定的默认操作， 当路由 只包含控制器ID，会使用所请求的控制器的默认操作。

默认操作默认为 index，如果想修改默认操作，只需简单地在控制器类中覆盖这个属性，如下所示：

namespace app\controllers;

use yii\web\Controller;

class SiteController extends Controller
{
 public $defaultAction = 'home';

 public function actionHome()
 {
  return $this->render('home');
 }
}

控制器动作参数绑定
从版本 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;

      echo 'Category:'.$category.'/Language:'.$language;
 
      // ... fun code starts here ...
    }
  }

注意我们在动作方法 actionCreate 中添加了两个参数。这些参数的名字必须和我们想要从 $_GET 中提取的名字一致。当用户没有在请求中指定 $language 参数时，这个参数会使用默认值 en 。由于 $category 没有默认值，如果用户没有在 $_GET 中提供 category 参数，将会自动抛出一个 CHttpException (错误代码 400) 异常。

从版本1.1.5开始，Yii已经支持数组的动作参数。使用方法如下：

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

控制器生命周期

处理一个请求时，应用主体 会根据请求路由创建一个控制器，控制器经过以下生命周期来完成请求：

• 在控制器创建和配置后，yii\base\Controller::init() 方法会被调用。

• 控制器根据请求操作ID创建一个操作对象:

• 如果操作ID没有指定，会使用yii\base\Controller::defaultAction默认操作ID；

• 如果在yii\base\Controller::actions()找到操作ID，会创建一个独立操作；

• 如果操作ID对应操作方法，会创建一个内联操作；

• 否则会抛出yii\base\InvalidRouteException异常。

• 控制器按顺序调用应用主体、模块（如果控制器属于模块）、控制器的 beforeAction() 方法；

• 如果任意一个调用返回false，后面未调用的beforeAction()会跳过并且操作执行会被取消； action execution will be cancelled.

• 默认情况下每个 beforeAction() 方法会触发一个 beforeAction 事件，在事件中你可以追加事件处理操作；

• 控制器执行操作:

• 请求数据解析和填入到操作参数；

• 控制器按顺序调用控制器、模块（如果控制器属于模块）、应用主体的 afterAction() 方法；

• 默认情况下每个 afterAction() 方法会触发一个 afterAction 事件，在事件中你可以追加事件处理操作；

• 应用主体获取操作结果并赋值给响应.

最佳实践

在设计良好的应用中，控制器很精练，包含的操作代码简短； 如果你的控制器很复杂，通常意味着需要重构，转移一些代码到其他类中。

Pour résumer, le contrôleur :

• peut accéder aux données de la demande

• peut appeler les méthodes du modèle et d'autres composants de service en fonction ; sur les données de la demande. ;

• Les vues peuvent être utilisées pour construire des réponses;

• ne doit pas traiter les données de la demande qui doivent être traitées par le modèle. ;

• Le HTML intégré ou tout autre code d'affichage doit être évité. Ces codes sont mieux gérés dans la vue.

Ce qui précède représente l'intégralité du contenu. de cet article. J'espère qu'il sera utile à l'apprentissage de tout le monde. Pour plus de contenu connexe, veuillez faire attention au site Web PHP chinois !

Recommandations associées :

À propos de l'utilisation des conditions de requête CDbCriteria de Yii

À propos de l'interface de sérialisation personnalisée PHP Analyse de l'utilisation sérialisable

À propos de l'utilisation du contrôleur d'action Zend Framework

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!