使用資料庫

本章節將介紹如何如何建立一個從資料表 country 中獲取國家資料並顯示出來的頁面。為了實現這個目標，你將會組態一個資料庫連線，建立一個活動記錄類，並且建立一個操作及一個檢視。

貫穿整個章節，你將會學到：

組態一個資料庫連線
定義一個活動記錄類
使用活動記錄從資料庫中查詢資料
以分頁方式在檢視中顯示資料

請注意，為了掌握本章你應該具備最基本的資料庫知識和使用經驗。尤其是應該知道如何建立資料庫，如何通過資料庫終端執行 SQL 語句。

準備資料庫

首先建立一個名為 yii2basic 的資料庫，應用將從這個資料庫中獲取資料。你可以建立 SQLite，MySQL，PostregSQL，MSSQL 或 Oracle 資料庫，Yii 內建多種資料庫支援。簡單起見後面的內容將以 MySQL 為例做演示。

然後在資料庫中建立一個名為 country 的表並插入簡單的資料。可以執行下面的語句：

CREATE TABLE `country` (
  `code` CHAR(2) NOT NULL PRIMARY KEY,
  `name` CHAR(52) NOT NULL,
  `population` INT(11) NOT NULL DEFAULT '0'
) ENGINE=InnoDB DEFAULT CHARSET=utf8;

INSERT INTO `Country` VALUES ('AU','Australia',18886000);
INSERT INTO `Country` VALUES ('BR','Brazil',170115000);
INSERT INTO `Country` VALUES ('CA','Canada',1147000);
INSERT INTO `Country` VALUES ('CN','China',1277558000);
INSERT INTO `Country` VALUES ('DE','Germany',82164700);
INSERT INTO `Country` VALUES ('FR','France',59225700);
INSERT INTO `Country` VALUES ('GB','United Kingdom',59623400);
INSERT INTO `Country` VALUES ('IN','India',1013662000);
INSERT INTO `Country` VALUES ('RU','Russia',146934000);
INSERT INTO `Country` VALUES ('US','United States',278357000);

於是便有了一個名為 yii2basic 的資料庫，在這個資料庫中有一個包含三個欄位的資料表 country，表中有十行資料。

組態資料庫連線

開始之前，請確保你已經安裝了 PHP PDO 擴充套件和你所使用的資料庫的 PDO 驅動(例如 MySQL 的 pdo_mysql)。對於使用關係型資料庫來講，這是基本要求。

驅動和擴充套件安裝可用後，開啟 config/db.php 修改裡面的組態引數對應你的資料庫組態。該檔案預設包含這些內容：

<?php

return [
    'class' => 'yiidbConnection',
    'dsn' => 'mysql:host=localhost;dbname=yii2basic',
    'username' => 'root',
    'password' => '',
    'charset' => 'utf8',
];

config/db/php 是一個典型的基於檔案的組態工具。這個檔案組態了資料庫連線 [[yiidbConnection]] 的建立和初始化引數，應用的 SQL 查詢正是基於這個資料庫。

上面組態的資料庫連線可以在應用中通過 Yii::$app->db 存取。

補充：config/db.php 將被包含在應用組態檔案 config/web.php 中，後者指定了整個應用如何初始化。請參考組態章節了解更多資訊。

建立活動記錄

建立一個繼承自活動記錄類的類 Country，把它放在 models/Country.php，去表示和獲取 country 表的資料。

<?php

namespace appmodels;

use yiidbActiveRecord;

class Country extends ActiveRecord
{
}

這個 Country 類繼承自 [[yiidbActiveRecord]]。你不用在裡面寫任何程式碼。只需要像現在這樣，Yii 就能根據類名去猜測對應的資料表名。

補充：如果類名和資料表名不能直接對應，可以重寫 [[yiidbActiveRecord::tableName()|tableName()]] 方法去顯式指定相關表名。

使用 Country 類可以很容易地操作 country 表資料，就像這段程式碼：

use appmodelsCountry;

// 獲取 country 表的所有行並以 name 排序
$countries = Country::find()->orderBy('name')->all();

// 獲取主鍵為 “US” 的行
$country = Country::findOne('US');

// 輸出 “United States”
echo $country->name;

// 修改 name 為 “U.S.A.” 並在資料庫中儲存更改
$country->name = 'U.S.A.';
$country->save();

補充：活動記錄是物件導向、功能強大的存取和運算元據庫資料的方式。你可以在活動記錄章節了解更多資訊。除此之外你還可以使用另一種更原生的稱做資料存取物件的方法運算元據庫資料。

建立操作

為了向終端使用者顯示國家資料，你需要建立一個操作。相比之前小節掌握的在 site 控制器中建立操作，在這裡為所有和國家有關的資料新建一個控制器更加合理。新控制器名為CountryController，並在其中建立一個 index 操作，如下：

<?php

namespace appcontrollers;

use yiiwebController;
use yiidataPagination;
use appmodelsCountry;

class CountryController extends Controller
{
    public function actionIndex()
    {
        $query = Country::find();

        $pagination = new Pagination([
            'defaultPageSize' => 5,
            'totalCount' => $query->count(),
        ]);

        $countries = $query->orderBy('name')
            ->offset($pagination->offset)
            ->limit($pagination->limit)
            ->all();

        return $this->render('index', [
            'countries' => $countries,
            'pagination' => $pagination,
        ]);
    }
}

把上面的程式碼儲存在 controllers/CountryController.php。

index 操作呼叫了活動記錄 Country::find() 方法，去生成查詢語句並從 country 表中取回所有資料。為了限定每個請求所返回的國家數量，查詢在 [[yiidataPagination]] 物件的幫助下進行分頁。 Pagination 物件的使命主要有兩點：

為 SQL 查詢語句設定 offset 和 limit 從句，確保每個請求只需返回一頁資料(本例中每頁是 5 行)。
在檢視中顯示一個由頁碼列表組成的分頁器，這點將在後面的段落中解釋。

在程式碼末尾，index 操作渲染一個名為 index 的檢視，並傳遞國家資料和分頁資訊進去。

建立檢視

在 views 目錄下先建立一個名為 country 的子目錄。這個目錄儲存所有由 country 控制器渲染的檢視。在 views/country 目錄下建立一個名為 index.php 的檢視檔案，內容如下：

<?php
use yiihelpersHtml;
use yiiwidgetsLinkPager;
?>
<h1>Countries</h1>
<ul>
<?php foreach ($countries as $country): ?>
    <li>
        <?= Html::encode("{$country->name} ({$country->code})") ?>:
        <?= $country->population ?>
    </li>
<?php endforeach; ?>
</ul>

<?= LinkPager::widget(['pagination' => $pagination]) ?>

這個檢視包含兩部分用以顯示國家資料。第一部分遍歷國家資料並以無序 HTML 列表渲染出來。第二部分使用 [[yiiwidgetsLinkPager]] 去渲染從操作中傳來的分頁資訊。小部件LinkPager 顯示一個分頁按鈕的列表。點選任何一個按鈕都會跳轉到對應的分頁。

嘗試下

瀏覽器存取下面的 URL 看看能否工作：

http://hostname/index.php?r=country/index

國家列表

首先你會看到顯示著五個國家的列表頁面。在國家下面，你還會看到一個包含四個按鈕的分頁器。如果你點選按鈕 “2”，將會跳轉到顯示另外五個國家的頁面，也就是第二頁記錄。如果觀察仔細點你還會看到瀏覽器的 URL 變成了：

http://hostname/index.php?r=country/index&page=2

在這個場景裡，[[yiidataPagination|Pagination]] 提供了為資料結果集分頁的所有功能：

首先 [[yiidataPagination|Pagination]] 把 SELECT 的子查詢 LIMIT 5 OFFSET 0 資料表示成第一頁。因此開頭的五條資料會被取出並顯示。
然後小部件 [[yiiwidgetsLinkPager|LinkPager]] 使用 [[yiidataPagination::createUrl()|Pagination::createUrl()]] 方法生成的 URL 去渲染翻頁按鈕。URL 中包含必要的引數 page 才能查詢不同的頁面編號。
如果你點選按鈕 “2”，將會發起一個路由為 country/index 的新請求。[[yiidataPagination|Pagination]] 接收到 URL 中的 page 引數把當前的頁碼設為 2。新的資料庫請求將會以 LIMIT 5 OFFSET 5 查詢並顯示。

總結

本章節中你學到了如何使用資料庫。你還學到了如何取出並使用 [[yiidataPagination]] 和 [[yiiwidgetsLinkPager]] 顯示資料。

下一章中你會學到如何使用 Yii 中強大的程式碼生成器 Gii，去幫助你實現一些常用的功能需求，例如增查改刪(CRUD)資料表中的資料。事實上你之前所寫的程式碼全部都可以由 Gii 自動生成。

Yii2使用資料庫