PHP Yii Framework_php 기술의 컨트롤러 컨트롤러에 대한 자세한 설명

컨트롤러는 MVC 패턴의 일부이며 yiibaseController 클래스를 상속하고 요청 처리 및 응답 생성을 담당하는 개체입니다. 구체적으로, 컨트롤러는 Application Body로부터 제어권을 넘겨받은 후 요청 데이터를 분석하여 모델에 전달하고, 모델 결과를 뷰에 전달하여 최종적으로 출력 응답 정보를 생성합니다.

작전

컨트롤러는 최종 사용자 요청을 실행하는 가장 기본적인 단위인 작업으로 구성됩니다. 컨트롤러는 하나 이상의 작업을 가질 수 있습니다.

다음 예에서는 두 가지 작업 보기 및 생성이 포함된 컨트롤러 게시물을 보여줍니다.

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: 동일한 애플리케이션(또는 모듈 아래의 컨트롤러인 경우 동일한 모듈)에서 컨트롤러를 고유하게 식별하는 문자열입니다.
작업 ID: 동일한 컨트롤러에서 작업을 고유하게 식별하는 문자열입니다.

경로는 다음 형식을 사용합니다.

컨트롤러ID/액션ID

모듈 아래의 컨트롤러에 속하는 경우 다음 형식을 사용하세요.

모듈 ID/컨트롤러 ID/작업 ID

사용자의 요청 주소가 http://hostname/index.php?r=site/index 이면 사이트 컨트롤러의 인덱스 작업이 실행됩니다.

컨트롤러 생성

yiiwebApplication 웹 애플리케이션에서 컨트롤러는 yiiwebController 또는 해당 하위 클래스를 상속해야 합니다. 마찬가지로 yiiconsoleApplication 콘솔 애플리케이션에서 컨트롤러는 yiiconsoleController 또는 해당 하위 클래스를 상속합니다. 다음 코드는 사이트 컨트롤러를 정의합니다.

namespace app\controllers;

use yii\web\Controller;

class SiteController extends Controller
{
}

컨트롤러 ID

일반적으로 컨트롤러는 요청과 관련된 리소스 유형을 처리하는 데 사용되므로 컨트롤러 ID는 일반적으로 리소스와 관련된 명사입니다. 예를 들어 기사를 처리하기 위한 컨트롤러 ID로 기사를 사용합니다.

컨트롤러 ID에는 영문 소문자, 숫자, 밑줄, 대시, 슬래시만 포함해야 합니다. 예를 들어, 기사와 포스트 댓글은 실제 컨트롤러 ID이고, 기사?, PostComment, adminpost는 컨트롤러 ID가 아닙니다.

컨트롤러 ID에는 하위 디렉터리 접두사가 포함될 수 있습니다. 예를 들어 admin/article은 yiibaseApplication::controllerNamespace 컨트롤러 네임스페이스 아래의 admin 하위 디렉터리에 있는 문서 컨트롤러를 나타냅니다. 하위 디렉터리 접두사는 영어 대문자, 소문자, 숫자, 밑줄, 슬래시를 사용할 수 있습니다. 슬래시는 여러 수준의 하위 디렉터리(예: panel/admin)를 구별하는 데 사용됩니다.

컨트롤러 클래스 명명

컨트롤러 ID는 다음 규칙에 따라 컨트롤러 클래스 이름을 파생합니다.

슬래시로 구분된 각 단어의 첫 글자를 대문자로 변환합니다. 컨트롤러 ID에 슬래시가 포함된 경우 마지막 슬래시 뒤의 첫 문자만 대문자로 변환됩니다.

대시를 제거하고 슬래시를 백슬래시로 바꾸세요.
컨트롤러 접미사 추가
앞에 yiibaseApplication::controllerNamespace 컨트롤러 네임스페이스를 추가하세요.
다음은 yiibaseApplication::controllerNamespace 컨트롤러 네임스페이스가 appcontrollers:
라고 가정하는 몇 가지 예입니다.

기사는 appcontrollersArticleController에 해당합니다.
post-comment는 appcontrollersPostCommentController에 해당합니다.
admin/post-comment는 appcontrollersadminPostCommentController에 해당합니다.
adminPanels/post-comment는 appcontrollersadminPanelsPostCommentController에 해당합니다.

컨트롤러 클래스는 자동으로 로드되어야 하므로 위 예에서 컨트롤러 기사 클래스는 @app/controllers/ArticleController.php라는 별칭을 사용하여 파일에 정의되어야 하며 컨트롤러 admin/post2-comment는 다음에서 정의되어야 합니다. @ app/controllers/admin/Post2CommentController.php 파일에 있습니다.

보충: 마지막 예제 admin/post2-comment는 컨트롤러를 yiibaseApplication::controllerNamespace 컨트롤러 네임스페이스 아래의 하위 디렉터리에 배치하고 모듈을 사용하지 않을 때 컨트롤러를 분류할 수 있음을 의미합니다. 매우 유용합니다.

컨트롤러 배포

위의 컨트롤러 ID와 클래스 이름이 일치하도록 yiibaseApplication::controllerMap을 구성할 수 있습니다. 이는 일반적으로 타사를 사용할 때 클래스 이름을 제어할 수 없는 컨트롤러에 사용됩니다.

아래와 같이 애플리케이션 구성에서 애플리케이션 구성을 구성합니다.

[
 '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() 方法的角色和操作方法类似，例如：

<&#63;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
    }
  }

컨트롤러 수명주기

요청을 처리할 때 애플리케이션 본문은 요청 경로를 기반으로 컨트롤러를 생성합니다. 컨트롤러는 요청을 완료하기 위해 다음 수명 주기를 거칩니다.

• 컨트롤러가 생성 및 구성된 후 yiibaseController::init() 메서드가 호출됩니다.
• 컨트롤러는 요청 작업 ID를 기반으로 작업 개체를 생성합니다.
• 작업 ID를 지정하지 않으면 yiibaseController::defaultAction의 기본 작업 ID가 사용됩니다.
• 작업 ID가 yiibaseController::actions()에서 발견되면 독립적인 작업이 생성됩니다.
• 작업 ID가 작업 방법과 일치하면 인라인 작업이 생성됩니다.
• 그렇지 않으면 yiibaseInvalidRouteException이 발생합니다.
• 컨트롤러는 애플리케이션 본문, 모듈(컨트롤러가 모듈에 속하는 경우) 및 컨트롤러의 beforeAction() 메서드를 순서대로 호출합니다.
• 어떤 호출이라도 false를 반환하면 호출되지 않은 후속 beforeAction()을 건너뛰고 작업 실행이 취소됩니다.
• 기본적으로 각 beforeAction() 메서드는 이벤트 처리 작업을 추가할 수 있는 beforeAction 이벤트를 트리거합니다.
• 컨트롤러가 작업을 수행합니다:
• 데이터 분석 및 작업 매개변수 입력 요청
• 컨트롤러는 컨트롤러의 afterAction() 메서드, 모듈(컨트롤러가 모듈에 속하는 경우), 애플리케이션 본문을 순서대로 호출합니다.
• 기본적으로 각 afterAction() 메서드는 이벤트 처리 작업을 추가할 수 있는 afterAction 이벤트를 트리거합니다.
• 애플리케이션 본문은 연산 결과를 얻어 응답에 할당합니다.

모범 사례

잘 설계된 애플리케이션에서 컨트롤러는 간결하고 짧은 작업 코드를 포함합니다. 컨트롤러가 복잡하다면 일반적으로 일부 코드를 리팩터링하고 다른 클래스로 전송해야 함을 의미합니다.

요약하자면 컨트롤러:

• 접근 가능한 요청 데이터
• 요청 데이터를 기반으로 모델 메소드 및 기타 서비스 구성요소를 호출할 수 있습니다.
• 뷰를 사용하여 응답을 구성할 수 있습니다.
• 모델에서 처리해야 하는 요청 데이터는 처리하면 안 됩니다.
• 임베디드 HTML이나 기타 프리젠테이션 코드는 피해야 하며 뷰 내에서 처리하는 것이 가장 좋습니다.