PHPのYiiフレームワークにおけるControllerコントローラーの解析用

この記事では主に PHP の Yii フレームワークにおけるコントローラーを紹介します。MVC フレームワークとして、Yii のコントローラー部分の使用が最優先です。必要な方は

Control を参照してください。コントローラーは MVC パターンの一部であり、yii\base\Controller クラスを継承し、リクエストの処理と応答の生成を担当します。具体的には、コントローラーはアプリケーション本体から制御を引き継いだ後、リクエストデータを解析してモデルに送信し、モデルの結果をビューに送信し、最後に出力応答情報を生成します。

オペレーション

コントローラーは、エンドユーザー要求を実行するための最も基本的な単位であるオペレーションで構成されます。コントローラーは 1 つ以上のオペレーションを持つことができます。

次の例は、2 つの操作ビューと作成を含むコントローラー ポストを示しています。

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,
   ]);
  }
 }
}

操作ビュー内 (actionView() として定義)メソッド)、コードはまず、要求されたモデル ID に基づいてモデルを読み込みます。読み込みが成功すると、view という名前のビューがレンダリングされて表示されます。そうでない場合は、例外がスローされます。

操作 create (actionCreate() メソッドとして定義) のコードは同様です。最初にリクエスト データをモデルに入力し、両方が成功すると、モデルを保存します。 ID ビュー操作を使用して新しく作成されたモデル。それ以外の場合は、ユーザー入力を提供する作成ビューが表示されます。

ルーティング

エンド ユーザーは、いわゆるルートを通じて操作を見つけます。ルートとは、次の部分を含む文字列です。

• モデルID: コントローラーが非アプリケーション モジュールに属している場合にのみ存在します。

• コントローラー ID: 同じアプリケーション (または、それがアプリケーション モジュールの下にあるコントローラーの場合は同じモジュール) 内のコントローラーを一意に識別します。 module) String;

• Operation ID: 同じコントローラの下でオペレーションを一意に識別する文字列。

#ルーティングでは次の形式を使用します:

ControllerID/ActionID

モジュール内のコントローラーに属する場合は、次の形式を使用します:

ModuleID/ControllerID /ActionID

ユーザーのリクエストアドレスが http://hostname/index.php?r=site/index の場合、サイトコントローラーのインデックス操作が実行されます。

コントローラーの作成

yii\web\Application Web アプリケーションでは、コントローラーは yii\web\Controller またはそのサブクラスを継承する必要があります。同様に、 yii\console\Application コンソール アプリケーションでは、コントローラーは yii\console\Controller またはそのサブクラスを継承します。次のコードは、サイト コントローラーを定義します。

namespace app\controllers;

use yii\web\Controller;

class SiteController extends Controller
{
}

コントローラー ID

通常、コントローラーは、リクエストに関連するリソース タイプであるため、コントローラ ID は通常、リソースに関連する名詞になります。たとえば、アーティクルを処理するためのコントローラー ID としてアーティクルを使用します。

コントローラー ID には、英語の小文字、数字、アンダースコア、ダッシュ、スラッシュのみを含める必要があります。たとえば、article と postcomment は実際のコントローラー ID ですが、article?、PostComment、admin\post はコントロールではありません。デバイスID。

コントローラー ID にはサブディレクトリ プレフィックスを含めることができます。たとえば、admin/article は、yii\base\Application::controllerNamespace コントローラー名前空間の下の admin サブディレクトリ内のアーティクル コントローラーを表します。サブディレクトリの接頭辞には、英語の大文字と小文字、数字、アンダースコア、およびスラッシュを使用できます。スラッシュは、複数レベルのサブディレクトリ (panels/admin など) を区別するために使用されます。

コントローラー クラスの名前付け

コントローラー ID は、次の規則に従ってコントローラー クラス名を取得します。

各単語はスラッシュで区切ります。文字は大文字に変換されます。コントローラ ID にスラッシュが含まれている場合、最後のスラッシュの後の最初の文字のみが大文字に変換されることに注意してください。

中央の水平スラッシュを削除し、スラッシュをバックスラッシュに置き換えます。
コントローラのサフィックスを追加します。
yii\base\Application::controllerNamespace コントローラーの名前空間を前に追加します。
以下は、yii\base\Application::controllerNamespace コントローラーの名前空間が app\controllers:
## であると仮定した場合のいくつかの例です。

#記事は app\controllers\ArticleController に対応します;
投稿コメントは app\controllers\PostCommentController に対応します;

• #admin/post-comment は app\controllers\admin\PostCommentController に対応します。

• adminPanels/post-comment は app\controllers\adminPanels\PostCommentController に対応します。

• コントローラー クラスは自動的にロードされる必要があるため、上記の例では、コントローラー アーティクル クラスはエイリアス @app/controllers/ArticleController.php でファイル内に定義する必要があり、コントローラー admin/post2-comment は@app/controllers/admin/Post2CommentController.php ファイル内にあります。

補足: 最後の例 admin/post2-comment は、モジュールこのメソッドを使用したくない場合、コントローラーを yii\base\Application::controllerNamespace コントローラー名前空間の下のサブディレクトリに配置できることを意味します。コントローラーを分類するのに役立ちます。

コントローラーのデプロイメント

yii\base\Application::controllerMap を設定して、上記のコントローラー ID とクラス名を強制的に対応させることができます。これは通常、サードパーティが制御できない場合に使用されます。名前付きコントローラーのクラス。

構成 [アプリケーション構成] のアプリケーション構成は次のとおりです:

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

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

デフォルト コントローラー

每个应用有一个由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 事件，在事件中你可以追加事件处理操作；

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

最佳实践

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

要約すると、コントローラーは:

• はリクエスト データにアクセスでき、

• はモデルのメソッドと他のサービス コンポーネント ベースを呼び出すことができます。 ;

• レスポンスはビューを使用して構築できます;

• モデルによって処理されるべきリクエスト データは処理されるべきではありません。 ;

• HTML またはその他の表示コードの埋め込みは避けてください。これらのコードはビューで処理するのが最適です。

上記はコンテンツ全体です。この記事が皆さんの学習に役立つことを願っています。その他の関連コンテンツについては、PHP 中国語 Web サイトに注目してください。

関連する推奨事項:

Yii の CDbCriteria クエリ条件の使用法について

PHP カスタム シリアル化インターフェイスについてシリアル化可能な使用状況の分析

Zend Framework アクション コントローラーの使用方法について

##

以上がPHPのYiiフレームワークにおけるControllerコントローラーの解析用の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。