寫(xiě)在前面

本文為學(xué)習(xí)Propel框架使用的筆記经柴，默認(rèn)已經(jīng)安裝好Propel環(huán)境，若有讀者不知如何安裝Propel钟些，可參考《聽(tīng)說(shuō)你PHP配置Composer遇到了一些困境》一文烟号。

Propel初始化

執(zhí)行propel init指令，進(jìn)行Propel初始化政恍，若讀者執(zhí)行該指令遇到問(wèn)題可以參考《【PHP】使用Propel踩過(guò)的坑》一文汪拥。執(zhí)行完propel init，需設(shè)置數(shù)據(jù)庫(kù)類(lèi)型篙耗、IP地址迫筑、端口號(hào)、數(shù)據(jù)庫(kù)名宗弯、用戶(hù)名脯燃、密碼、編碼方式蒙保，然后設(shè)置相應(yīng)配置文件的存放位置和命名空間辕棚，如下圖所示：

CRUD（增刪改查）操作

• Creating Rows
  以名為author的表為例，進(jìn)行插入操作邓厕，語(yǔ)句如下：

<?php
$author = new Author();
$author->setFirstName('Jane');
$author->setLastName('Austen');
$author->save();

上述語(yǔ)句等效于：

INSERT INTO author (first_name, last_name) VALUES ('Jane', 'Austen');

通過(guò)setXXX()方法插入對(duì)應(yīng)的列逝嚎，括號(hào)中的參數(shù)表示插入的值；通過(guò)save()方法執(zhí)行插入語(yǔ)句邑狸，這里表和列名都用小寫(xiě)字母+下劃線的命名方式懈糯。

• Reading Object Properties
  Propel支持讀取某一條記錄的相關(guān)信息，并將其語(yǔ)句如下：

<?php
echo $author->getId();        // 1
echo $author->getFirstName(); // 'Jane'
echo $author->getLastName();  // 'Austen'

如果原來(lái)數(shù)據(jù)庫(kù)表未定義id单雾，則Propel會(huì)默認(rèn)定義一個(gè)整型自增的id赚哗；通過(guò)getXXX()方法得到相應(yīng)屬性（列）的值。除了將屬性一個(gè)一個(gè)顯示出來(lái)硅堆，還提供了便捷的方法將對(duì)象以json屿储、yaml、數(shù)組渐逃、XML够掠、CVS和純字符串的格式顯示出來(lái)：

<?php
echo $author->toJSON();
echo $author->toArray();
echo $author->toXML();
echo $author->toYAML();
echo $author->toJSON();
echo $author->toCSV();
echo $author->__toString();

如果想把json數(shù)據(jù)轉(zhuǎn)為一個(gè)對(duì)象，可以調(diào)用fromJSON()茄菊，對(duì)應(yīng)的還有fromArray()疯潭、fromXML()赊堪、fromYAML()、fromCSV()竖哩。

• Retrieving Rows
  除了讀取對(duì)象外哭廉，Propel還支持條件查詢(xún)來(lái)讀取記錄。
  • Retrieving by Primary Key
    最簡(jiǎn)單的使用就是通過(guò)主鍵來(lái)讀取記錄相叁，代碼如下：

<?php
$q = new AuthorQuery();
$firstAuthor = $q->findPK(1);

上述代碼中AuthorQuery類(lèi)是在命名空間文件夾里自動(dòng)生成的遵绰。如筆者的命名空間為kq，所以在這個(gè)文件夾下會(huì)在執(zhí)行propel init指令時(shí)自動(dòng)生成各種XXXQuery類(lèi)增淹，如下圖所示：

use kq\kq; // use 文件夾\文件夾...；

而變量firstAuthor虑润，如果有找到記錄成玫，則它是一個(gè)Author對(duì)象，如果沒(méi)有找到端辱，則它為NULL梁剔。上述代碼實(shí)現(xiàn)的效果相當(dāng)于：

SELECT author.id, author.first_name, author.last_name
FROM `author`
WHERE author.id = 1
LIMIT 1;

和Java語(yǔ)言類(lèi)似，Propel也提供了工廠模式舞蔽，上述語(yǔ)句也可以寫(xiě)成工廠模式的形式：

<?php
$firstAuthor = AuthorQuery::create()->findPK(1);

如果想要通過(guò)主鍵查找多條記錄荣病，則可以調(diào)用findPKs()方法，如下：

<?php
$selectedAuthors = AuthorQuery::create()->findPKs(array(1,2,3,4,5,6,7));

這時(shí)候selectedAuthors就是一個(gè)Author對(duì)象的集合渗柿。

• Querying the Database
  除了findPK()方法个盆，讀者們還可以通過(guò)find()方法來(lái)查詢(xún)記錄，如下：

<?php
$authors = AuthorQuery::create()->find();

上述查詢(xún)得到的結(jié)果是author表的所有記錄朵栖，如果想要通過(guò)類(lèi)似于WHERE的Sql語(yǔ)法篩選記錄颊亮，可以用filterByXXX()方法實(shí)現(xiàn)，其代碼實(shí)現(xiàn)如下：

<?php
$authors = AuthorQuery::create()
      ->filterByFirstName('Jane')
      ->find();

上述代碼得到的authors對(duì)象可用foreach來(lái)遍歷：

foreach($authors as $author) {
        echo $author->getFirstName();
}

Sql語(yǔ)句中有ORDER BY和LIMIT語(yǔ)法陨溅，在Propel中可通過(guò)orderByXXX()方法和limit()方法實(shí)現(xiàn)：

<?php
$authors = AuthorQuery::create()
      ->orderByLastName()
      ->limit(10)
      ->find();

如果想實(shí)現(xiàn)limit(1)的效果终惑，可直接調(diào)用findOne()：

<?php
$author = AuthorQuery::create()
      ->filterByFirstName('Jane')
      ->findOne();

上述語(yǔ)句可簡(jiǎn)寫(xiě)為一行：

<?php
$author = AuthorQuery::create()->findOneByFirstName('Jane');

• Using Custom SQL
  Propel作為orm框架，其提供的方法在給我們帶來(lái)便利的同時(shí)也帶來(lái)了局限门扇。為了避免這種限制雹有，Propel提供了自定義Sql語(yǔ)句的執(zhí)行方法：

<?php
use Propel\Runtime\Propel;
$con = Propel::getWriteConnection(\Map\BookTableMap::DATABASE_NAME);
$sql = "SELECT * FROM book WHERE id NOT IN "
        ."(SELECT book_review.book_id FROM book_review"
        ." INNER JOIN author ON (book_review.author_id=author.ID)"
        ." WHERE author.last_name = :name)";
$stmt = $con->prepare($sql);
$stmt->execute(array(':name' => 'Austen'));
// 上述代碼執(zhí)行的是查找作者姓氏不為`Austen`的書(shū)籍。

自定義Sql語(yǔ)句執(zhí)行得到的是一個(gè)結(jié)果集（resultset）臼寄，如果想把結(jié)果集轉(zhuǎn)為對(duì)象霸奕，可以調(diào)用ObjectFormatter類(lèi)的format方法：

<?php
use Propel\Runtime\Formatter\ObjectFormatter;
$con = Propel::getWriteConnection(\Map\BookTableMap::DATABASE_NAME);
$formatter = new ObjectFormatter();
$formatter->setClass('\Book'); 
$books = $formatter->format($con->getDataFetcher($stmt));

劃重點(diǎn)：使用自定義的Sql語(yǔ)句需要注意以下三點(diǎn)：
* 結(jié)果集列必須是數(shù)字索引（The resultset columns must be numerically indexed）
* 結(jié)果集必須包含數(shù)據(jù)表的所有列，延遲加載的列除外（The resultset must contain all the columns of the table (except lazy-load columns)）
* 結(jié)果集必須按照scheme.xml文件指定的順序以相同排序方式排序（The resultset must have columns in the same order as they are defined in the schema.xml file）

PS: 對(duì)于上述第一點(diǎn)吉拳，筆者不理解其表達(dá)的意思质帅，望過(guò)來(lái)人指點(diǎn)一二。

• Updating Objects
  修改數(shù)據(jù)庫(kù)基于讀取數(shù)據(jù)庫(kù)，通過(guò)讀取獲取對(duì)象煤惩，再通過(guò)setXXX()和save()方法對(duì)對(duì)象屬性進(jìn)行修改并存入數(shù)據(jù)庫(kù)：

<?php
$author = AuthorQuery::create()->findOneByFirstName('Jane');
$author->setLastName('Austen');
$author->save();

除上述方法外嫉嘀，Propel提供了update()方法，直接對(duì)數(shù)據(jù)進(jìn)行修改：

<?php
AuthorQuery::create()
      ->filterByFirstName('Jane')
      ->update(array('LastName' => 'Austen'));

官方推薦使用update()方法對(duì)數(shù)據(jù)做修改

• Deleting Objects
  刪除數(shù)據(jù)記錄與修改數(shù)據(jù)類(lèi)似盟庞，也是通過(guò)讀取獲取對(duì)象吃沪，再調(diào)用delete()方法對(duì)數(shù)據(jù)進(jìn)行刪除：

<?php
$author = AuthorQuery::create()->findOneByFirstName('Jane');
$author->delete();

同樣汤善，上述代碼還可以?xún)?yōu)雅地寫(xiě)為：

<?php
AuthorQuery::create()
      ->filterByFirstName('Jane')
      ->delete();

敲黑板Ｊ膊！红淡！這里注意一點(diǎn)不狮，被刪除的對(duì)象（如上面代碼中的author對(duì)象），依然可以通過(guò)getXXX()方法獲取被刪除的記錄的屬性值：

<?php
echo $author->isDeleted();    // true
echo $author->getFirstName(); // 'Jane'

• Query Termination Methods
  像上述提到的find()在旱、update()摇零、delete()這樣不返回當(dāng)前對(duì)象的方法稱(chēng)之為“終止方法（Termination Methods）”（官網(wǎng)原文：The Query methods that don’t return the current query object are called “Termination Methods”）。除了上述提到的終止方法外桶蝎，還有兩個(gè)方法：http://propelorm.org/documentation/03-basic-crud.html
  • count()
    該方法返回查詢(xún)結(jié)果的記錄條數(shù):

<?php
$nbAuthors = AuthorQuery::create()->count();

• paginate()
  通過(guò)調(diào)用該方法驻仅，傳入當(dāng)前頁(yè)和每頁(yè)記錄條數(shù)可實(shí)現(xiàn)實(shí)現(xiàn)分頁(yè)的效果：

<?php
$authorPager = AuthorQuery::create()->paginate($page = 1, $maxPerPage = 10);
foreach ($authorPager as $author) {
      echo $author->getFirstName();
}

pager對(duì)象可以有以下方法可以調(diào)用：

<?php
// total number of results if not paginated
echo $pager->getNbResults();
// 如果maxPerPage小于總的條數(shù)，則返回true登渣；否則反之
echo $pager->haveToPaginate(); 
// 返回第一頁(yè)記錄
echo $pager->getFirstIndex(); 
// 返回最后一頁(yè)記錄
echo $pager->getLastIndex();
 // array of page numbers around the current page; useful to display pagination controls
$links = $pager->getLinks(5); 
# 對(duì)于第一個(gè)方法和最后一個(gè)方法噪服，筆者擔(dān)心自己誤人子弟，讀者們可以根據(jù)英文注解胜茧，實(shí)際動(dòng)手寫(xiě)一下代碼驗(yàn)證一下

• Collections And On-Demand Hydration
  Propel對(duì)數(shù)據(jù)查詢(xún)進(jìn)行了優(yōu)化粘优，當(dāng)查詢(xún)數(shù)據(jù)量比較大時(shí)，Propel提供了“按需分配”的機(jī)制呻顽，這樣防止了內(nèi)存溢出的現(xiàn)象雹顺，其代碼實(shí)現(xiàn)上只需要加入一句代碼即可：

<?php
$authors = AuthorQuery::create()
  ->limit(50000)
  ->setFormatter(ModelCriteria::FORMAT_ON_DEMAND) // just add this line
  ->find();
foreach ($authors as $author) {
      echo $author->getFirstName();
}

ModelCriteria::FORMAT_ON_DEMAND用在與對(duì)象相關(guān)的查詢(xún)中，如果將查詢(xún)到的數(shù)據(jù)存在數(shù)組中廊遍，可以使用ModelCriteria::FORMAT_ARRAY嬉愧。

• Propel Instance Pool
  為了防止在同一個(gè)PHP腳本文件中用到多個(gè)相同的數(shù)據(jù)查詢(xún)，Propel提供了“實(shí)例池(Instance Pool)”的概念喉前，如下面代碼没酣，執(zhí)行完一條查詢(xún)一句后，再此執(zhí)行被饿，則第二次直接調(diào)用第一次的實(shí)例：

<?php
// first call
$author1 = AuthorQuery::create()->findPk(1);
// Issues a SELECT query
...
// second call
$author2 = AuthorQuery::create()->findPk(1);
// Skips the SQL query and returns the existing $author1 object

參考鏈接

http://propelorm.org/documentation/03-basic-crud.html

筆者正在學(xué)習(xí)中四康，文章稍后更新...