Yii創建事件


在本章中,我們將學習在Yii中創建事件。要顯示操作事件,需要準備一些原始數據。

準備數據庫

第1步 - 創建一個新的數據庫。數據庫可以通過以下兩種方式進行。
  • 在終端運行 mysql -u root –p

  • 登錄數據後,通過執行 CREATE DATABASE mystudy CHARACTER SET utf8 COLLATE utf8_general_ci; 創建一個新的數據庫;

第2步 - 在 config/db.php 文件中配置數據庫連接。下面的配置可根據自己的實際情況配置。
<?php
   return [
      'class' => 'yii\db\Connection',
      'dsn' => 'mysql:host = localhost;dbname = mystudy',
      'username' => 'root',
      'password' => '',
      'charset' => 'utf8',
   ];
?>

第3步 - 在項目根文件夾執行:yii migrate/create test_table 。此命令將用於創建管理數據庫數據庫遷移。 migrations文件會出現在項目的根的 migrations 文件夾中。
Yii數據Widgets

第4步 - 修改遷移文件(在本示例中生成的是:m160529_014611_test_table.php),並使用以下這些代碼。
<?php
   use yii\db\Schema;
   use yii\db\Migration;
   class m160529_014611_test_table extends Migration {
      public function up() {
         $this->createTable("user", [
            "id" => Schema::TYPE_PK,
            "name" => Schema::TYPE_STRING,
            "email" => Schema::TYPE_STRING,
         ]);
         $this->batchInsert("user", ["name", "email"], [
            ["User1", "[email protected]"],
            ["User2", "[email protected]"],
            ["User3", "[email protected]"],
            ["User4", "[email protected]"],
            ["User5", "[email protected]"],
            ["User6", "[email protected]"],
            ["User7", "[email protected]"],
            ["User8", "[email protected]"],
            ["User9", "[email protected]"],
            ["User10", "[email protected]"],
            ["User11", "[email protected]"],
         ]);
      }
      public function down() {
         //$this->dropTable('user');
      }
   }
?>
上述遷移創建用戶表,它包含了以下這些字段:id, name, 和 email。它還增加了一些演示用戶帳號。
第5步 - 在項目的根目錄內運行: yii migrate  來遷移應用到數據庫。執行結果如下圖所示:
Yii創建事件

第6步-現在,我們需要爲user表創建模型。爲了簡便起見,我們將使用GII代碼生成工具。在瀏覽器中打開 url: http://localhost:8080/index.php?r=gii 。
然後,點擊 「Model generator」 下的 「Start」按鈕。 填寫表名(「user」)和模型類(「MyUser」),單擊「Preview」按鈕,最後點擊 「Generate」 按鈕。

Yii創建事件
Yii創建事件
MyUser 文件憶經生成在 models 目錄。

創建一個事件

假設每當一個新用戶在網站註冊後,要發送一封電子郵件通知管理員。
第1步 - 修改 models/MyUser.php 文件如下代碼所示:
<?php
   namespace app\models;
   use Yii;
   /**
   * This is the model class for table "user".
   *
   * @property integer $id
   * @property string $name
   * @property string $email
   */
   class MyUser extends \yii\db\ActiveRecord {
      const EVENT_NEW_USER = 'new-user';
      public function init() {
         // first parameter is the name of the event and second is the handler.
         $this->on(self::EVENT_NEW_USER, [$this, 'sendMailToAdmin']);
      }
      /**
      * @inheritdoc
      */
      public static function tableName() {
         return 'user';
      }
      /**
      * @inheritdoc
      */
      public function rules() {
         return [
            [['name', 'email'], 'string', 'max' => 255]
         ];
      }
      /**
      * @inheritdoc
      */
      public function attributeLabels() {
         return [
            'id' => 'ID',
            'name' => 'Name',
            'email' => 'Email',
         ];
      }
      public function sendMailToAdmin($event) {
         echo 'mail sent to admin using the event';
      }
   }
?>
在上面的代碼中,我們定義一個「new-user」事件。然後在 init()方法附加 sendMailToAdmin() 函數到 「new-user」 事件。現在就可以觸發此事件。
第2步 - 在SiteController控制器中創建一個 actionTestEvent() 方法。
public function actionTestEvent() {
   $model = new MyUser();
   $model->name = "John";
   $model->email = "[email protected]";
   if($model->save()) {
      $model->trigger(MyUser::EVENT_NEW_USER);
   }
}
第3步 - 現在訪問: http://localhost:8080/index.php?r=site/test-event ,會看到以下輸出結果:
Yii創建事件