From 654a9cae43358c7eecf3b522e9876aa7815e2453 Mon Sep 17 00:00:00 2001 From: Fabio Bas Date: Mon, 7 Dec 2015 15:57:51 +0100 Subject: Move urls from pradosoft.com to github's project page; drop unmaintained quickstart tutorial translations --- .../protected/pages/Database/ActiveRecord.page | 2 +- .../protected/pages/Database/SqlMap.page | 2 +- .../protected/pages/Database/id/ActiveRecord.page | 1000 ----------------- .../protected/pages/Database/id/DAO.page | 163 --- .../protected/pages/Database/id/Scaffold.page | 130 --- .../protected/pages/Database/id/SqlMap.page | 210 ---- .../protected/pages/Database/id/ar_objects.png | Bin 19837 -> 0 bytes .../protected/pages/Database/id/ar_relations.png | Bin 9693 -> 0 bytes .../protected/pages/Database/id/diagram.png | Bin 30320 -> 0 bytes .../protected/pages/Database/id/object_states.png | Bin 9596 -> 0 bytes .../pages/Database/id/sqlmap_active_record.png | Bin 17351 -> 0 bytes .../protected/pages/Database/pl/ActiveRecord.page | 1144 -------------------- .../protected/pages/Database/pl/ar_objects.png | Bin 20638 -> 0 bytes .../protected/pages/Database/pl/ar_relations.png | Bin 9693 -> 0 bytes .../protected/pages/Database/pl/diagram.png | Bin 30320 -> 0 bytes .../protected/pages/Database/pl/object_states.png | Bin 9596 -> 0 bytes .../pages/Database/pl/sqlmap_active_record.png | Bin 17351 -> 0 bytes 17 files changed, 2 insertions(+), 2649 deletions(-) delete mode 100755 demos/quickstart/protected/pages/Database/id/ActiveRecord.page delete mode 100755 demos/quickstart/protected/pages/Database/id/DAO.page delete mode 100755 demos/quickstart/protected/pages/Database/id/Scaffold.page delete mode 100755 demos/quickstart/protected/pages/Database/id/SqlMap.page delete mode 100755 demos/quickstart/protected/pages/Database/id/ar_objects.png delete mode 100755 demos/quickstart/protected/pages/Database/id/ar_relations.png delete mode 100755 demos/quickstart/protected/pages/Database/id/diagram.png delete mode 100755 demos/quickstart/protected/pages/Database/id/object_states.png delete mode 100755 demos/quickstart/protected/pages/Database/id/sqlmap_active_record.png delete mode 100755 demos/quickstart/protected/pages/Database/pl/ActiveRecord.page delete mode 100755 demos/quickstart/protected/pages/Database/pl/ar_objects.png delete mode 100755 demos/quickstart/protected/pages/Database/pl/ar_relations.png delete mode 100755 demos/quickstart/protected/pages/Database/pl/diagram.png delete mode 100755 demos/quickstart/protected/pages/Database/pl/object_states.png delete mode 100755 demos/quickstart/protected/pages/Database/pl/sqlmap_active_record.png (limited to 'demos/quickstart/protected/pages/Database') diff --git a/demos/quickstart/protected/pages/Database/ActiveRecord.page b/demos/quickstart/protected/pages/Database/ActiveRecord.page index cf1485bd..566dfe66 100755 --- a/demos/quickstart/protected/pages/Database/ActiveRecord.page +++ b/demos/quickstart/protected/pages/Database/ActiveRecord.page @@ -36,7 +36,7 @@ Active Record objects can be used to update the database. The "relationship" between Active Records and SqlMap is illustrated in the following diagram. More details regarding the SqlMap Data Mapper can be found in - the SqlMap Manual. + the SqlMap Manual. alt="Active Records and SqlMap DataMapper" id="fig:diagram.png" class="figure"/>

diff --git a/demos/quickstart/protected/pages/Database/SqlMap.page b/demos/quickstart/protected/pages/Database/SqlMap.page index be8cb03a..8c528070 100755 --- a/demos/quickstart/protected/pages/Database/SqlMap.page +++ b/demos/quickstart/protected/pages/Database/SqlMap.page @@ -189,7 +189,7 @@ $user = $sqlmap->queryForObject("SelectUsers");

The above example shows demonstrates only a fraction of the capabilities of the SqlMap Data Mapper. Further details can be found in the - SqlMap Manual. + SqlMap Manual.

Combining SqlMap with Active Records

diff --git a/demos/quickstart/protected/pages/Database/id/ActiveRecord.page b/demos/quickstart/protected/pages/Database/id/ActiveRecord.page deleted file mode 100755 index 8e81678e..00000000 --- a/demos/quickstart/protected/pages/Database/id/ActiveRecord.page +++ /dev/null @@ -1,1000 +0,0 @@ - -

Rekaman Aktif

- -

Rekaman Aktif adalah obyek yang melapisi baris dalam tabel atau view database, - melindungi akses database dan menambahkan logika domain pada data tersebut. - Dasar dari Rekaman Aktif adalah kelas bisnis, sebagai contoh, kelas - Products, yang hampir menyamai struktur rekaman dari tabel database - dibawahnya. Setiap Rekaman Aktif akan bertanggung jawab atas - penyimpanan dan pengambilan data ke dan dari database.

-
Info: - Struktur Rekaman Aktif harus sama dengan tabel dalam database. - Setiap kolom tabel harus mempunyai variabel atau properti anggota terkait dalam - kelas Rekaman Aktif yang mewakili tabel. -
- -

Kapan Menggunakannya

-

Rekaman Aktif adalah pilihan yang baik untuk logika domain yang tidak terlalu rumit, - seperti membuat, membaca, memutakhirkan, dan menghapus. Derivasi dan validasi - didasarkan pada satu rekaman yang bekerja denga baik dalam struktur ini. Rekaman Aktif mempunyai kuntungan utama dalam hal kesederhanaan. Mudah untuk membangun Rekaman Aktif, dan mudah untuk dimengerti.

- -

Akan tetapi, seiring dengan perkembangan logika bisnis Anda dalm hal kompleksitas, Anda akan segera ingin menggunakan hubungan langsung obyek Anda, koleksi, turunan, dan seterusnya. Ini tidak mudah diterapkan ke dalam Rekaman Aktif, dan menambahkannya sedikit demi sedikit menjadi sangat kacau. - Argumen lain terhadap Rekaman Aktif adalah kenyataan bahwa ia menyandingkan desin obyek ke desain database. Ini menjadikannya lebih sulit untuk merefraktorisasi karena proyek terus berjalan.

- -

Alternatifnya adalah menggunakan Pemeta Data yang yang memisahkan aturan dari obyek bisnis dan bagaimana obyek ini disimpan. - Prado menyediakan pilihan tambahan antara Rekaman Aktif dan - Pemeta Data SqlMap. - Pemeta Data SqlMap bisa dipakai untuk mengambil obyek Rekaman Aktif, hasilnya; obyek Rekaman Aktif ini bisa dipakai untuk memutakhirkan database. - "Hubungan" antara Rekaman Aktif dan SqlMap digambarkan dalam diagram berikut. Lebih rinci mengenai Pemeta Data SqlMap dapat ditemukan dalam - Manual SqlMap. - alt="Rekaman Aktif dan SqlMap DataMapper" id="fig:diagram.png" class="figure"/> -

- -

- Kelas Rekaman Aktif berfungsi untuk melakukan tugas-tugas berikut. -

-
    -
  • Membuat, Mengambil, Memutakhirkan dan Menghapus rekaman.
    • -
  • Metode pencari untuk melapisi queri SQL yang umum dipakai dan mengemalikan obyek Rekaman Aktif.
    • -
  • Mengambil hubungan (terkait dengan obyek asing) seperti "has many", "has one", "belongs to" dan "has many" melalui asosiasi tabel.
    • -
  • Pengambilan lazy atas hubungan.
    • -
-

Implikasi Desain

-

-Implementasi Prado terhadap Rekaman Aktif tidak memelihara identitas referensial. Setiap obyek diperoleh menggunakan Rekaman Aktif pada data dalam database. Sebagai contoh, jika Anda meminta kustomer tertentu dan mendapatkan kembali obyek Customer, kali berikutnya Anda meminta kustomer itu, Anda akan kembali mendapatkan turunan lain dari obyek Customer. Ini berarti bahwa perbandingan tepat (misalnya menggunakan ===) akan mengembalikan false, sementara perbandingan bebas (misalnya menggunakan ==) akan mengembalikan true jika nilai obyek sama menurut perbandingan bebas. -

-

-Implikasi desain ini terkait dengan pertanyaan berikut. -"Anda pikir kustomer sebagai obyek, di mana hanya satu, -atau Anda pikir obyek yang Anda operasikan sebagai duplikat dari database?" -Pemetaan O/R lain akan mengartikan bahwa hanya ada satu obyek Kustomer dengan custID 100, dan secara literal ia adalah kustomer. -Jika Anda mendapatkan kustomer dan mengubah field-nya, maka Anda sekarang telah mengubah kustomer itu. -"Itu berbatasan dengan: Anda telah mengubah duplikat kustomer ini, tapi bukan pada duplikat itu. -Dan jika dua orang memutakhirkan kustomer pada dua duplikat obyek, siapapun yang memutakhirkan pertama kali, atau mungkin yang terakhir yang menang." [A. Hejlsberg 2003] -

- -

Database yang Didukung

-

-Implementasi Rekaman Aktif memanfaatkan kelas Prado DAO untuk akses data. -Implementasi Rekaman Aktif saat ini mendukung database sebagai berikut. -

- -

Dukungan database lain dapat disediakan jika permintaan mencukupi.

- -

Mendefinisikan Rekaman Aktif

-

Mari kita anggap tabel - "users" berikut yang berisi dua kolom bernama "username" dan "email", - di mana "username" juga merupakan kunci primer. - -CREATE TABLE users -( - username VARCHAR( 20 ) NOT NULL , - email VARCHAR( 200 ) , - PRIMARY KEY ( username ) -); - -

-

Selanjutnya kelas Rekaman Aktif kita yang terkait dengan tabel "users". - -class UserRecord extends TActiveRecord -{ - const TABLE='users'; //nama tabel - - public $username; //kolom bernama "username" dalam tabel "users" - public $email; - - /** - * @return TActiveRecord active record finder instance - */ - public static function finder($className=__CLASS__) - { - return parent::finder($className); - } -} - -

-

Setiap kolom dari tabel "users" harus mempunyai properti terkait atas nama yang sama seperti nama kolom dalam kelas UserRecord. - Tentunya, Anda juga mendefinisikan variabel atau properti tambahan yang tidak ada dalam struktur tabel. - Konstan kelas - TABLE adalah opsional saat nama kelas adalah sama seperti nama tabel dalam database, sebaliknya TABLE harus - menetapkan nama tabel yang terkait dengan kelas Rekaman Aktif Anda. -

- -
Tip: -Anda dapat menetapkan nama-nama tabel yang memenuhi syarat. Contohnya untuk MySQL, TABLE = "`database1`.`table1`". -
- -

- Karena TActiveRecord memperluas TComponent, metode penyetel dan pengambil dapat didefinisikan guna membolehkan kontrol melalui bagaimana variabel disetel dan dikembalikan. Sebagai contoh, menambah properti $level untuk menggunakan kelas UserRecord: -

- -class UserRecord extends TActiveRecord { - ... //definisi yang sudah ada seprti di atas - - private $_level; - public function setLevel($value) { - $this->_level=TPropertyValue::ensureInteger($value,0); - } - public function getLevel($value){ - return $this->_level; - } -} - -

Lebih jelas mengenai TComponent dapat ditemukan dalam Dokumentasi komponen. -Nantinya kita harus dapat menggunakan pengambil/penyetel guna membolehkan pengambilan malas atas obyek yang berhubungan. -

- -
Info: -TActiveRecord juga dapat bekerja dengan view database dengan menetapkan konstan TABLE terkait ke nama view. Akan tetapi, -obyek yang dikembalikan dari view hanya-baca, memanggil metode -save() atau delete() akan memunculkan eksepsi. -
- -

- Metode statis finder() mengembalilkan turunan UserRecord - yang dapat dipakai untuk mengambil rekaman dari database. Pengambilan rekaman menggunakan metode finder akan didiskusikan nanti. Metode statis TActiveRecord::finder() mengambil nama kelas Rekaman Aktif sebagai parameter. -

- -

Menyiapkan koneksi database

-

- Koneksi database standar untuk Rekaman Aktif dapat disetel sebagai berikut. - Lihat Menetapkan Koneksi Database untuk - rincian lebih jauh mengenai pembuatan koneksi database secara umum. -

- -//buat koneksi dan berikan kepada manajer Rekaman Aktif. -$dsn = 'pgsql:host=localhost;dbname=test'; //Postgres SQL -$conn = new TDbConnection($dsn, 'dbuser','dbpass'); -TActiveRecordManager::getInstance()->setDbConnection($conn); - - -

Alternatifnya, Anda dapat membuat basis kelas dan mengganti metode getDbConnection() untuk mengembalikan -koneksi database. Ini adalah cara sederhana untuk mengijinkan koneksi database multipel. Kode berikut mendemonstrasikan penetapan koneksi database dalam sebuah basis kelas (tidak perlu menyetel koneksi DB di manapun juga). -

- -class MyDb1Record extends TActiveRecord -{ - public function getDbConnection() - { - static $conn; - if($conn===null) - $conn = new TDbConnection('xxx','yyy','zzz'); - return $conn; - } -} -class MyDb2Record extends TActiveRecord -{ - public function getDbConnection() - { - static $conn; - if($conn===null) - $conn = new TDbConnection('aaa','bbb','ccc'); - return $conn; - } -} - - - -

Menggunakan application.xml di dalam Kerangka Kerja Prado

-
-

- Koneksi database standar dapat juga dikonfigurasi menggunakan tag <module> dalam application.xml - atau config.xml seperti berikut. - - - - - - - -

Tip: - Atribut EnableCache ketika disetel ke "true" akan melakukan cache meta data tabel, yakni nama kolom tabel, indeks dan batasan yang disimpan dalam cache dan dipakai ulang. Anda harus membersihkan atau mematikan cache jika Anda ingin melihat perubahan terhadap definisi tabel Anda. Modul cache juga harus didefinisikan agar cache berfungsi. -
-

- -

Properti ConnectionID dapat ditetapkan dengan nilai yang terkait ke nilai ID konfigurasi modul TDataSourceConfig lain. Ini membolehkan koneksi database yang sama untuk dipakai dalam modul lainnya seperti SqlMap. - - - - - - - - - - - -

-
- -

Mengambil data dari database

-

- Kelas TActiveRecord menyediakan banyak metode yang sesuai untuk mencari rekaman dari database. Yang paling sederhana adalah mencari satu rekaman yang sama dengan kunci primer atau kunci komposit (kunci primer yang terdiri dari multipel kolom). - Lihat untuk lebih jelasnya. -

- -
Info: -Semua metode finder yang dapat mengembalikan hanya 1 rekaman akan mengembalikan null jika tidak ada data yang sama yang ditemukan. Semua metode finder yang mengembalikan array rekaman akan mengembalikan array kosong jika tidak ada data yang ditemukan. -
- -

findByPk()

-

Mencari satu rekaman hanya menggunakan kunci primer atau kunci gabungan. - -$finder = UserRecord::finder(); -$user = $finder->findByPk($primaryKey); - -//ketika tabel menggunakan kunci gabungan -$record = $finder->findByPk($key1, $key2, ...); -$record = $finder->findByPk(array($key1, $key2,...)); - -

- -

findAllByPks()

-

Mencari multipel rekaman menggunakan sebuah daftar kunci primer atau kunci gabungan. -Berikut adalah persamaan untuk kunci primer (kunci primer terdiri dari hanya satu kolom/field). -

- -$finder = UserRecord::finder(); -$users = $finder->findAllByPks($key1, $key2, ...); -$users = $finder->findAllByPks(array($key1, $key2, ...)); - -Berikut adalah persamaan untuk kunci gabungan. - -//ketika tabel menggunakan kunci gabungan -$record = $finder->findAllByPks(array($key1, $key2), array($key3, $key4), ...); - -$keys = array( array($key1, $key2), array($key3, $key4), ... ); -$record = $finder->findAllByPks($keys); - - - -

find()

-

Mencari satu rekaman tunggal yang memenuhi kriteria. Kriteria dapat berupa bagian string SQL atau obyek TActiveRecordCriteria.

- -$finder = UserRecord::finder(); - -//:name dan :pass adalah tempat untuk nilai $name dan $pass tertentu -$finder->find('username = :name AND password = :pass', - array(':name'=>$name, ':pass'=>$pass)); - -//menggunakan tempat posisi -$finder->find('username = ? AND password = ?', array($name, $pass)); -//same as above -$finder->find('username = ? AND password = ?', $name, $pass); - -//$criteria adalah TActiveRecordCriteria -$finder->find($criteria); //the 2nd parameter for find() is ignored. - - -

Kelas TActiveRecordCriteria mempunyai properti sebagai berikut: -

-
    -
  • Parameters -- pasangan parameter nama nilai.
    • -
  • OrdersBy -- pasangan nama kolom dan urutan.
    • -
  • Condition -- bagian dari kondisi SQL WHERE.
    • -
  • Limit -- jumlah maksimum rekaman diambil.
    • -
  • Offset -- ofset rekaman dalam tabel.
    • -
- - -$criteria = new TActiveRecordCriteria; -$criteria->Condition = 'username = :name AND password = :pass'; -$criteria->Parameters[':name'] = 'admin'; -$criteria->Parameters[':pass'] = 'prado'; -$criteria->OrdersBy['level'] = 'desc'; -$criteria->OrdersBy['name'] = 'asc'; -$criteria->Limit = 10; -$criteria->Offset = 20; - - -
Catatan: -Untuk MSSQL dan saat Limit serta Offset berisi nilai integer positif. Query aktual yang dijalankan diubah oleh kelas - -berdasarkan pada -http://troels.arvin.dk/db/rdbms/ -untuk mengemulasikan kondisi Limit dan Offset. -
- -

findAll()

-

Sama seperti find() tapi mengembalikan array obyek.

- -

findBy*() dan findAllBy*()

-

Metode find dinamis menggunakan bagian dari nama metode sebagai kriteria pencarian. -Nama metode dimulai dengan findBy mengembalikan hanya 1 rekaman dan nama metode yang dimulai dengan findAllBy mengembalikan array rekaman. -Kondisi diambil sebagai bagian dari nama metode setelah findBy atau findAllBy. - -Blok kode berikut adalah sama: -

- -$finder->findByName($name) -$finder->find('Name = ?', $name); - - - -$finder->findByUsernameAndPassword($name,$pass); -$finder->findBy_Username_And_Password($name,$pass); -$finder->find('Username = ? AND Password = ?', $name, $pass); - - - -$finder->findAllByAge($age); -$finder->findAll('Age = ?', $age); - - -
Tip: -Anda juga dapat menggunakan kombinasi AND dan OR sebagai kondisi dalam metode dinamis. -
- -

findBySql() dan findAllBySql()

-

Mencari rekaman menggunakan SQL penuh di mana findBySql() mengembalikan Rekaman Aktif dan findAllBySql()mengembalikan array obyek rekaman. -Untuk setiap kolom yang dikembalikan, kelas Rekaman Aktif terkait harus mendefinisikan variabel atau properti untuk setiap nama kolom terkait. - -class UserRecord2 extends UserRecord -{ - public $another_value; -} -$sql = "SELECT users.*, 'hello' as another_value FROM users"; -$users = TActiveRecord::finder('UserRecord2')->findAllBySql($sql); - -

-

count()

-

Mencari jumlah rekaman yang sama, menerima beberapa parameters seperti metode findAll().

- -

Menyisipkan dan memutakhirkan rekaman

-

-Menambah rekaman baru menggunakan TActiveRecord sangat sederhana, cukup buat obyek Rekaman Aktif baru dan panggil metode save(). Misalnya -

- -$user1 = new UserRecord(); -$user1->username = "admin"; -$user1->email = "admin@example.com"; -$user1->save(); //sisipkan rekaman baru - -$data = array('username'=>'admin', 'email'=>'admin@example.com'); -$user2 = new UserRecord($data); //buat dengan mengirimkan beberapa data yang sudah ada -$user2->save(); //sisipkan rekaman baru - -
Tip: -Obyek dimutakhirkan dengan kunci primer dari tabel itu yang berisi definisi yang secara otomatis membuat kunci primer untuk rekaman yang baru saja disisipkan. -Sebagai contoh, jika Anda menyisipkan sebuah rekaman baru ke dalam tabel MySQL yang kolomnya didefinisikan dengan "autoincrement", obyek Rekaman Aktif akan dimutakhirkan dengan nilai yang ditambahkan.
- -

-Untuk memutakhirkan rekaman dalam database, cukup ubah satu atau lebih properti obyek Rekaman Aktif yang sudah diambil dari database dan kemudian panggil metode save(). - - -$user = UserRecord::finder()->findByName('admin'); -$user->email="test@example.com"; //ubah properti -$user->save(); //mutakhirkan. - -

- -

-Obyek Rekaman Aktif mempunyai masa-hidup sederhana seperti digambarkan dalam diagram berikut. -

- alt="Active Records Life Cycle" id="fig:cycle.png" class="figure"/> -

-Kita melihat bahwa obyek TActiveRecord baru dibuat dengan menggunakan salah satu metode find*() ataupun membuat turunan baru dengan menggunakan kata kunci PHP new. Obyek yang dibuat dengan metode find*() dimulai dengan kondisi clean. Turunan baru TActiveRecord membuat selain metode find*() yang dimulai dengan kondisi new. -Kapan saja Anda memanggil metode save() pada obyek TActiveRecord, obyek memasuki keadaan clean. Obyek dalam clean menjadi dirty ketika satu atau lebih keadaan internalnya diubah. Pemanggilan metode delete() pada obyek mengakhiri masa-hidup obyek, tidak ada aksi lanjutan yang dilakukan pada obyek. -

- -

Menghapus rekaman yang sudah ada

-

- Untuk menghapus rekaman yang sudah ada dan diambil, cukup panggil metode delete(). - Anda juga dapat menghapus rekaman dalam database dengan kunci primer tanpa mengambil rekaman apapun menggunakan metode deleteByPk() (dan metode yang sama deleteAllByPks()). - Sebagai contoh, untuk menghapus satu atau beberapa rekaman dengan menggunakan satu atau lebih kunci primer. -

- -$finder->deleteByPk($primaryKey); //hapus 1 rekaman -$finder->deleteAllByPks($key1,$key2,...); //hapus multipel rekaman -$finder->deleteAllByPks(array($key1,$key2,...)); //hapus multipel rekaman - - -

-Untuk kunci gabungan (ditentukan secara otomatis dari definisi tabel): -

- -$finder->deleteByPk(array($key1,$key2)); //hapus 1 rekaman - -//hapus multipel rekaman -$finder->deleteAllByPks(array($key1,$key2), array($key3,$key4),...); - -//hapus multipel rekaman -$finder->deleteAllByPks(array( array($key1,$key2), array($key3,$key4), .. )); - - -

deleteAll() dan deleteBy*()

-

-Untuk menghapus dengan kriteria, gunakan deleteAll($criteria) dan deleteBy*() -yang sintaksnya mirip dengan findAll($criteria) dan findAllBy*() seperti dijelaskan di atas. -

- -//hapus semua rekaman dengan Name yang sama -$finder->deleteAll('Name = ?', $name); -$finder->deleteByName($name); - -//hapus dengan username dan password -$finder->deleteBy_Username_And_Password($name,$pass); - - -

Transaksi

-

Semua obyek Rekaman Aktif berisi properti DbConnection yang dapat dipakai untuk mendapatkan obyek transaksi. - -$finder = UserRecord::finder(); -$finder->DbConnection->Active=true; //buka bila perlu -$transaction = $finder->DbConnection->beginTransaction(); -try -{ - $user = $finder->findByPk('admin'); - $user->email = 'test@example.com'; //ubah obyek $user - $user->save(); - $transaction->commit(); -} -catch(Exception $e) // eksepsi dimunculkan jika query gagal -{ - $transaction->rollBack(); -} - - -

Event

-

-TActiveRecord menawarkan dua event, OnCreateCommand dan OnExecuteCommand. -

- -

Event OnCreateCommand dimunculkan ketika perintah disiapkan dan penyatuan parameter lengkap. Obyek parameter adalah TDataGatewayEventParameter di mana properti -Command bisa diperiksa agar SQL query dijalankan. -

- -

-Event OnExecuteCommand dimunculkan ketika perintah dijalankan dan hasil dari database dikembalikan. Obyek parameter TDataGatewayResultEventParameter -dari properti Result berisi data yang dikembalikan dari database. -Data yang dikembalikan dapat diubah dengan setelan properti Result. -

- -

Contoh Pencatatan

-

Menggunakan OnExecuteCommand kita dapat menempelkan pengendali event untuk mencatat seluruh query SQL yang dijalankan untuk kelas TActiveRecord atau turunan yang diberikan. Sebagai contoh, kita mendefinisikan sebuah basis kelas dan mengganti getDbConnection() atau konstruktornya. -

- - -class MyDb1Record extends TActiveRecord -{ - public function getDbConnection() - { - static $conn; - if($conn===null) - { - $conn = new TDbConnection('xxx','yyy','zzz'); - $this->OnExecuteCommand[] = array($this,'logger'); - } - return $conn; - } - public function logger($sender,$param) - { - var_dump($param->Command->Text); - } -} -//alternatifnya sebagai per turunan dari per obyek finder -function logger($sender,$param) -{ - var_dump($param->Command->Text); -} -TActiveRecord::finder('MyRecord')->OnExecuteCommand[] = 'logger'; -$obj->OnExecuteCommand[] = array($logger, 'log'); //setiap PHP callback yg benar. - - -

Hubungan Rekaman Aktif

- -

-Implementasi Rekaman Aktif Prado mendukung pemetaan kunci asing untuk database -yang mendukung batasan kunci asing. Agar hubungan Rekaman Aktif berfungsi, database di bawahnya harus mendukung batasan kunci asing (misalnya MySQL menggunakan InnoDB). -

- -

-Dalam bagian berikut kita akan menganggap hubungan tabel antara -Teams, Players, Skills dan Profiles. -

- class="figure" /> - - -

Tujuannya adalah untuk mendapatkan model obyek yang mewakili ke beberapa derajat hubungan entitas dalam gambar di atas. -

- - class="figure" /> - -

-Ada ketidak cocokan antara hubungan dengan obyek dan hubungan tabel. Pertama, ada perbedaan dalam penyajian. Penghubung kendali obyek dengen menyimpan referensi yang dipegang oleh lingkungan memori-teratur runtime. Database relasional menangani kaitan dengan membentuk sebuah kunci ke dalam tabel lainnya. Keuda, obyek dapat dengan mudah menggunakan koleksi guna menangani multipel referensi dari satu field, sementara normalisasi memaksa seluruh relasi entitas mengaitkan ke nilai tunggal. Ini menyebabkan pembalikan struktur data antara obyek dan tabel. Pendekatan yang diambil dalam desain Rekaman Aktif Prado adalah untuk menggunakan batasan kunci asing guna memperoleh hubungan obyek. Ini berarti bahwa database di bawahnya harus mendukung batasan kunci asing. -

-
Tip: -Untuk database SQLite, Anda dapat membuat tabel yang mendefinisikan batasan kunci asing seperti contoh di bawah ini. Akan tetapi, batasan ini TIDAK -dipaksakan oleh database SQLite itu sendiri. - -CREATE TABLE foo -( - id INTEGER NOT NULL PRIMARY KEY, - id2 CHAR(2) -); -CREATE TABLE bar -( - id INTEGER NOT NULL PRIMARY KEY, - foo_id INTEGER - CONSTRAINT fk_foo_id REFERENCES foo(id) ON DELETE CASCADE -); - -
- -

Pemetaan Kunci Asing

-

Hubungan entitas antara tabel Teams dan Players adalah apa yang dikenal sebagai hubungan 1-M. Yaitu, satu Tim dapat berisi 0 atau lebih Pemain. Dalam batasan hubungan obyek, kita katakan bahwa obyek TeamRecord memiliki banyak obyek PlayerRecord. -(Perhatikan kebalikan dari arah hubungan antara tabel dan obyek.) -

- -

Hubungan Has Many

-

-Kita membuat model obyek Team sebagai kelas Rekaman Aktif berikut. -

- -class TeamRecord extends TActiveRecord -{ - const TABLE='Teams'; - public $name; - public $location; - - public $players=array(); // deklarasi ini tidak diperlukan lagi sejak v3.1.2 - - //mendefinisikan anggota $player yang memiliki hubungan banyak dengan PlayerRecord - public static $RELATIONS=array - ( - 'players' => array(self::HAS_MANY, 'PlayerRecord', 'team_name'), - ); - - public static function finder($className=__CLASS__) - { - return parent::finder($className); - } -} - -

-Properti statis $RELATIONS dari TeamRecord mendefinisikan bahwa properti $players has many PlayerRecord. Multipel hubungan dibolehkan dengan mendefinisikan setiap hubungan dengan sebuah entitas dalam array $RELATIONS di mana kunci array untuk entri menunjukan nama properti. -Dalam array(self::HAS_MANY, 'PlayerRecord'), elemen pertama mendefinisikan tipe hubungan, tipe yang benar adalah self::HAS_MANY, -self::HAS_ONE dan self::BELONGS_TO. -Elemen kedua adalah string 'PlayerRecord' yang menunjukan nama kelas dari kelas PlayerRecord. -

- -
Catatan: -Seperti dijelaska dalam komentar kode di atas, sejak versi 3.1.2, properti terkait tidak tidak lagi perlu dideklarasikan secara eksplisit. Standarnya, akan secara implisit dideklarasikan berdasarkan pada kunci array $RELATIONS. Keuntungan utama atas properti terkait yang dideklarasikan secara implisit adalah obyek terkait dapat diambil secara otomatis dengan cara malas. Sebagai contoh, anggap kita mempunyai TeamRecord turunan $team. Kita dapat mengakses players via $team->players, -meskipun kita tidak pernah menerbitkan perintah mengambil untuk players. Jika $players dideklarasikan secara eksplisit, kita harus menggunakan pendekatan with seperti dijelaskan dalam contoh berikut untuk mengambil rekaman player. -
- -

-Batasan kunci asing tabel Players dipakai untuk menentukan nama kunci tabel Teams terkait. Ini dikerjakan secara otomatis, ditangani dalam Rekaman Aktif dengan memeriksa definisi tabel Players dan Teams. -

- -
Info: -Sejak versi 3.1.2, Rekaman Aktif mendukung multipel referensi kunci asing pada tabel yang sama. Kerancuan diantara multipel referensi kunci asing dipecahkan dengan penyediaan nama kolom kunci asing sebagai parameter ke-3 dalam array relationship. -Sebagai contoh, kedua kunci asing owner_id dan reporter_id -merujuk tabel yang sama, didefinisikan dalam UserRecord. - -class TicketRecord extends TActiveRecord -{ - public $owner_id; - public $reporter_id; - - public $owner; // deklarasi ini tidak diperlukan lagi sejak v3.1.2 - public $reporter; // deklarasi ini tidak diperlukan lagi sejak v3.1.2 - - public static $RELATION=array - ( - 'owner' => array(self::BELONGS_TO, 'UserRecord', 'owner_id'), - 'reporter' => array(self::BELONGS_TO, 'UserRecord', 'reporter_id'), - ); -} - -Ini berlaku untuk hubungan termasuk BELONGS_TO, HAS_ONE dan -HAS_MANY. Lihat seksi Tabel Asosiaasi Merujuk Dirinya Sendiri untuk memecahkan kerancuan atas hubungan MANY_TO_MANY. -
- -

Hubungan "has many" tidak diambil secara otomatis ketika Anda menggunakan salah satu metode finder Rekaman Aktif. -Anda perlu untuk mengambil secara eksplisit obyek terkait seperti berikut. Dalam kode di bawah ini, kedua baris adalah sama dan nama metode tidak sensitif huruf. -

- -$team = TeamRecord::finder()->withPlayers()->findAll(); -$team = TeamRecord::finder()->with_players()->findAll(); //equivalent - -

-Metode with_xxx() (di mana xxx adalah nama properti hubungan, dalam hal ini, players) mengambil PlayerRecords terkait menggunakan query kedua (bukan menggunakan join). with_xxx() menerima argumen yang sama seperti metode finder lainnya dari TActiveRecord, misalnya with_players('age = ?', 35). -

- -
Catatan: -Penting untuk dimengerti bahwa obyek terkait diambil menggunakan query tambahan. Query pertama mengambil obyek sumber, misalnya TeamRecord dalam contoh kode di atas. -Query kedua dipakai untuk mengambil obyek PlayerRecord terkait. -Penggunaan dua query mirip dengan query tunggal menggunakan Left-Outer join dengan eksepsi bahwa hasil null pada tabel kanan tidak dikembalikan. Konsekuensi pemakaian dua tau lebih query adalah kondisi agregat dan join tidak layak menggunakan Rekaman Aktif. Untuk query di luar lingkup Rekaman Aktif, Pemeta Data SqlMap diapat dupertimbangkan. -
- -
Info: -Pendekatan with di atas juga bekerja dengan properti terkait yang dideklarasikan secara implisit (diperkenalkan dalam versi 3.1.2). Lalu apa perbedaan antara pendekatan with dan pendekatan pengambilan malas? Pengambilan malas berarti kita menerbitkan query SQL jika obyek terkait awalnya diakses dan tidak siap, -sementara query pendekatan with untuk obyek terkait sekaligus, tida peduli obyek terkait diakses atau tidak. Pendekatan pengambilan malas sangat cocok karena kita tidak perlu secara eksplisit mengambil obyek terkait, sementara pendekatan with lebih efisien jika multipel rekaman yang dikembalikan, masing-masing dengan beberapa obyek terkait. -
- -

Hubungan Belongs To

-

Hubungan "has many" dalam bagian di atas mendefinisikan koleksi obyek asing. Dalam keadaan tertentu, kita mempunyai TeamRecord memiliki banyak (nol atau lebih) obyek PlayerRecord. Kita juga dapat menambah penunjuk kembali dengan menambahkan properti dalam kelas PlayerRecord yang mengaitkan kembali ke obyek TeamRecord, secara efektif membuat asosiasi dua arah. -Kita katakan bahwa properti $team dalam kelas PlayerRecord belongs to obyek TeamRecord. -Kode berikut mendefinisikan kelas PlayerRecord lengkap dengan 3 hubungan. -

- -class PlayerRecord extends TActiveRecord -{ - const TABLE='Players'; - public $player_id; - public $age; - public $team_name; - - public $team; // deklarasi ini tidak diperlukan lagi sejak v3.1.2 - public $skills=array(); // deklarasi ini tidak diperlukan lagi sejak v3.1.2 - public $profile; // deklarasi ini tidak diperlukan lagi sejak v3.1.2 - - public static $RELATIONS=array - ( - 'team' => array(self::BELONGS_TO, 'TeamRecord', 'team_name'), - 'skills' => array(self::MANY_TO_MANY, 'SkillRecord', 'Player_Skills'), - 'profile' => array(self::HAS_ONE, 'ProfileRecord', 'player_id'), - ); - - public static function finder($className=__CLASS__) - { - return parent::finder($className); - } -} - -

-Properti $RELATIONS dari PlayerRecord mendefinisikan properti $team milik TeamRecord. -Array $RELATIONS juga mendefinisikan dua hubungan lainnya yang nanti akan kita uji dalam seksi di bawah ini. -Dalam array(self::BELONGS_TO, 'TeamRecord'), elemen pertama mendefinisikan tipe hubungan, dalam hal ini self::BELONGS_TO dan -elemen kedua adalah string 'TeamRecord' yang terkait ke nama kelas dari kelas TeamRecord. -Obyek pemain dengan obyek tim terkait dapat diambil serperti berikut. -

- -$players = PlayerRecord::finder()->with_team()->findAll(); - - -

- Metode with_xxx() (di mana xxx adalah nama properti hubungan dalam hal ini, team) mengambil TeamRecords terkait menggunakan query kedua (bukan menggunakan join). with_xxx() menerima argumen yang sama seperti metode finder lainnya dari TActiveRecord, contohnya with_team('location = ?', 'Madrid'). -

- -
Tip: -Hubungan tambahan dapat diambil dengan mengaitkan with_xxx() bersama seperti yang didemonstrasikan berikut. - -$players = PlayerRecord::finder()->with_team()->with_skills()->findAll(); - -Setiap metode with_xxx() akan menjalankan query SQL tambahan. Setiap with_xxx() menerima argumen mirip dengan apa yang ada di dalam metode findAll() dan hanya diterapkan ke query hubungan tertentu tersebut. -
- -

Hubungan "belongs to" dari kelas ProfileRecord didefinisikan hampir sama.

- -class ProfileRecord extends TActiveRecord -{ - const TABLE='Profiles'; - public $player_id; - public $salary; - - public $player; // deklarasi ini tidak diperlukan lagi sejak v3.1.2 - - public static $RELATIONS=array - ( - 'player' => array(self::BELONGS_TO, 'PlayerRecord'), - ); - - public static function finder($className=__CLASS__) - { - return parent::finder($className); - } -} - - -

Intinya, ada hubungan "belongs to" untuk obyek yang mengaitkan entitas yang memmpunyai kolom yakni kunci asing. Dalam keadaan tertentu, kita melihat bahwa tabel Profiles mempunyai batasan kunci asing pada kolom player_id yang terkait ke tabel -Players kolom player_id. Selanjutnya, obyek ProfileRecord -memiliki properti ($player) yang adalah milik obyek PlayerRecord. -Demikian juga, tabel Players mempunyai batasan kunci asing pada kolom team_name yang terkait ke tabel Teams kolom name. -Kemudian, obyek PlayerRecord mempunyai properti ($team) yang adalah milik obyek TeamRecord. -

- -

Hubungan Has One

-

Hubungan entitas antara Players dan Profiles adalah satu ke satu. Yaitu, setiap obyek -PlayerRecord has one obyek ProfileRecord (mungkin tidak ada atau null). -Hubungan has one hampir identik ke hubungan has many dengan eksepsi bahwa obyek terkait hanya satu obyek (bukan koleksi obyek). -

- -

Hubungan Leluhur Anak

-

Hubungan leluhur anak bisa didefinisikan menggunakan kombinasi hubungan has many dan belongs to yang -merujuk ke kelas yang sama. Contoh berikut memperlihatkan hubungan leluhur dan anaknya antara "kategori" dan "leluhur kategori". -

- - -class Category extends TActiveRecord -{ - public $cat_id; - public $category_name; - public $parent_cat_id; - - public $parent_category; // deklarasi ini tidak diperlukan lagi sejak v3.1.2 - public $child_categories=array(); // deklarasi ini tidak diperlukan lagi sejak v3.1.2 - - public static $RELATIONS=array - ( - 'parent_category' => array(self::BELONGS_TO, 'Category', 'parent_cat_id'), - 'child_categories' => array(self::HAS_MANY, 'Category', 'parent_cat_id'), - ); -} - - -

Kriteria Query untuk Obyek Terkait

-

-Dalam contoh di atas, kami memperlihatkan bahwa obyek Rekaman Aktif dapat mereferensi ke obyek terkaitnya sendiri dengan -mendeklarasikan anggota kelas statis $RELATIONS yang menetapkan sebuah daftar relasi. Setiap relasi -ditetapkan sebagai array yang terdiri dari tiga elemen: tipe relasi, nama kelas AR terkait, -dan kunci asing. Sebagai contoh, kami menggunakan array(self::HAS_MANY, 'PlayerRecord', 'team_name') -untuk menetapkan pemain dalam sebuah tim. Ada dua elemen opsional berikutnya yang dapat ditetapkan -dalam array ini: kondisi query (elemen keempat) dan parameters (elemen kelima). -Elemen tersebut dipakai untuk mengontrol bagaimana untuk melakukan query terhadap obyek terkait. Sebagai contoh, jika kita ingin memperoleh -para pemain yang diurut dengan usianya, kita dapat menetapkan array(self::HAS_MANY, 'PlayerRecord', 'team_name', 'ORDER BY age'). -Jika kita ingin mendapatkan para pemain yang usianya kurang dari 30, kita dapat menggunakan -array(self::HAS_MANY, 'PlayerRecord', 'team_name', 'age<:age', array(':age'=>30)). Secara umum, -dua elemen tambahan ini mirip seperti parameter yang dikirimkan ke metode find() dalam AR. -

- -

Pemetaan Tabel Asosiasi

-

-Obyek dapat dengan mudah menangani field multi nilai dengan menggunakan koleksi sebagai nilai field. Database relasional tidak memiliki fitur ini dan dibatasi hanya ke field nilai-tunggal. Ketika Anda memetakan asosiasi satu-ke-banyak, Anda bisa menangani ini menggunakan hubungan has many, intinya menggunakan kunci asing untuk nilai-tunggal akhir dari asosiasi. Tapi asosiasi banyak-ke-banyak tidak bisa melakukan ini karena tidak ada nilai-tunggal akhir ke kunci asing yang dipegangnya. -

-

-Jawabannya adalah resolusi klasik yang telah dipakai oleh orang selama dekade ini yakni: buat tabel ekstra (tabel asosiasi) untuk merekam asosiasi. -Ide dasarnya adalah menggunakan tabel asosiasi untuk menyimpan asosiasi. Tabel ini memiliki ID kunci asing untuk dua tabel yang dikaitkan bersama, masing-masing memiliki pasangan dari obyek yang diasosiasikan. -

-

-Tabel asosiasi tidak mempunyai kaitan obyek dalam-memori dan kunci primernya adalah gabungan dari dua kunci primer dari tabel yang diasosiasikan. -Dalam batasan yang sederhana, tuntuk mengambil data dari tabel asosiasi, Anda melakukan dua query (secara umum, ini juga bisa dicapai menggunakan satu query yang terdiri dari join). -Anggap pengambilan koleksi SkillRecord untuk daftar obyek PlayerRecord. -Dalam hal ini, Anda melakukan query dalam dua tahap. Tahap pertama meng-query tabel Players untuk mencari seluruh baris dari pemain yang Anda inginkan. Tahap kedua mencari obyek SkillRecord ID pemain terkait untuk setiap barisnya dalam tabel asosiasi Player_Skills menggunakan sebuah inner join. -

- -

Desain Rekaman Aktif Prado mengimplementasikan dua tahap pendekatan. Untuk hubungan entitas Players-Skills M-N (many-to-many), kita perlu mendefinisikan sebuah hubungan has many dalam kelas PlayerRecord dan sebagai tambahan mendefinisikan hubungan has many dalam kelas SkillRecord juga. -Kode contoh berikut mendefinisikan kelas SkillRecord lengkap dengan hubungan banyak-ke-banyak dengan kelas PlayerRecord. (Lihat definisi kelas PlayerRecord di atas untuk mengaitkan hubungan banyak-ke-banyak dengan kelas SkillRecord.) -

- - -class SkillRecord extends TActiveRecord -{ - const TABLE='Skills'; - public $skill_id; - public $name; - - public $players=array(); // deklarasi ini tidak diperlukan lagi sejak v3.1.2 - - public static $RELATIONS=array - ( - 'players' => array(self::MANY_TO_MANY, 'PlayerRecord', 'Player_Skills'), - ); - - public static function finder($className=__CLASS__) - { - return parent::finder($className); - } -} - - -

-Properti statis $RELATIONS dari SkillRecord mendefinisikan bahwa properti $players memiliki banyak PlayerRecords melalui tabel asosiasi 'Player_Skills'. -Dalam array(self::MANY_TO_MANY, 'PlayerRecord', 'Player_Skills'), elemen pertama mendefinisikan tipe hubungan, dalam hal ini self::HAS_MANY, -elemen kedua adalah string 'PlayerRecord' yang terkait ke nama kelas dari kelas PlayerRecord, dan elemen ketiga adalah nama dari nama tabel asosiasi. -

- -
Catatan: -Sebelum versi 3.1.2 (versi sampai dengan 3.1.1), hubungan many-to-many didefinisikan menggunakan self::HAS_MANY. Untuk versi 3.1.2 dan seterusnya, ini harus diubah ke self::MANY_TO_MANY. Ini bisa dikerjakan dengan mencari HAS_MANY dalam kode sumber dan hati-hati mengubah definisi terkait. -
- -

-Daftar obyek pemain dengan koleksi obyek skil terkait bisa diambil seperti berikut. -

- -$players = PlayerRecord::finder()->withSkills()->findAll(); - -

-Metode with_xxx() (di mana xxx adalah nama properti hubungan, dalam hal ini, Skill) mengambil SkillRecords terkait menggunakan query kedua (tidak dengan menggunakan join). with_xxx() menerima argumen yang sama seperti metode finder dari TActiveRecord. -

- -

Tabel Asosiasi Mereferensi Dirinya

-

-Untuk tabel asosiasi yang mererefensi dirinya sendiri, yaitu titik asosiasi ke tabel yang sama. Sebagai contoh, anggap tabel items dengan item terkait M-N melalui tabel asosiasi related_items. Sintaks dalam contoh berikut adalah benar untuk database PostgreSQL. Untuk database lain, lihat dokumentasinya masing-masing untuk mendefinisikan batasan kunci asing. - -CREATE TABLE items -( - "item_id" SERIAL, - "name" VARCHAR(128) NOT NULL, - PRIMARY KEY("item_id") -); -CREATE TABLE "related_items" -( - "item_id" INTEGER NOT NULL, - "related_item_id" INTEGER NOT NULL, - CONSTRAINT "related_items_pkey" PRIMARY KEY("item_id", "related_item_id"), - CONSTRAINT "related_items_item_id_fkey" FOREIGN KEY ("item_id") - REFERENCES "items"("item_id") - ON DELETE CASCADE - ON UPDATE NO ACTION - NOT DEFERRABLE, - CONSTRAINT "related_items_related_item_id_fkey" FOREIGN KEY ("related_item_id") - REFERENCES "items"("item_id") - ON DELETE CASCADE - ON UPDATE NO ACTION - NOT DEFERRABLE -); - - -

Nama tabel asosiasi dalam elemen ketiga dari array hubungan dapat berisi nama kolom tabel asing. Kolom yang didefinisikan dalam tabel asosiasi harus juga didefinisikan dalam kelas rekaman (contohnya properti $related_item_id terkait ke kolom related_item_id dalam tabel related_items). -

- -class Item extends TActiveRecord -{ - const TABLE="items"; - public $item_id; - public $details; - - //id item asing tambahan didefinisikan dalam tabel asosiasi - public $related_item_id; - public $related_items=array(); // deklarasi ini tidak diperlukan lagi sejak v3.1.2 - - public static $RELATIONS=array - ( - 'related_items' => array(self::MANY_TO_MANY, - 'Item', 'related_items.related_item_id'), - ); -} - -
Tip: -Kunci gabungan dalam tabel asing dapat ditetapkan sebagai nilai dipisahkan koma diantara kurung buka/tutup. Contohnya 'related_items.(id1,id2)'. -
- - - -

Pengambilan Malas Obyek Terkait

- -
Catatan: -Secara implisit mendeklarasikan properti terkait yang diperkenalkan dalam versi 3.1.2 secara otomatis memiliki fitur pengambilan malas. Oleh karena itu, teknik pengambilan malas dijelaskan berikut ini tidak lagi diperlukan dalam banyak kasus, kecuali Anda ingin memanipulasi obyek terkait melalui pengambil/penyetel. -
- -

Menggunakan metode with_xxx() akan mengambil hubungan rekaman sesuai permintaan. Mengambil rekaman terkait dengan lazy loading (yaitu, hanya obyek terkait itu saja yang diakses) bisa dicapai dengan menggunakan sebuah fitur TComponent yang menyediakan metode pengakses. Dalam keadaan tertentu, kita mendefinisikan pasangan metode pengambil dan penyetel di mana metode pengambil akan mengambil hubungan secara kondisional. Contoh berikut menggambarkan bahwa PlayerRecord dapat mengambil obyek asing $skills secara kondisional. -

- -class PlayerRecord extends BaseFkRecord -{ - //... properti dan metode lainnya seperti sebelumnya - - private $_skills; //ubah ke private dan standar sebagai null - - public function getSkills() - { - if($this->_skills===null && $this->player_id !==null) - { - //lazy load rekaman skill - $this->setSkills($this->withSkills()->findByPk($this->player_id)->skills); - } - else if($this->_skills===null) - { - //buat TList baru; - $this->setSkills(new TList()); - } - - return $this->_skills; - } - - public function setSkills($value) - { - $this->_skills = $value instanceof TList ? $value : new TList($value); - } -} - -

Pertama kita perlu mengubah deklarasi $skills=array() ke properti private $_skills (perhatikan garis bawah) dan sebaliknya setel ke null. Ini membolehkan kita untuk mendefinisikan properti skills menggunakan metode pengambil/penyetel -(lihat Komponen untuk lebih jelasnya). Metode pengambil getSkills() untuk properti skills akan mengambil malas rekaman skill terkait saat ia dipakai sebagai berikut. Catatan bahwa kita hanya melakukan pengambilan malas ketika $player_id tidak null (yakni, ketika rekaman sudah diambil dari database ataau id player sudah disetel). -

- -$player = PlayerRecord::finder()->findByPk(1); -var_dump($player->skills); //pengambilan malas saat akses pertama -var_dump($player->skills[0]); //properti skills sudah diambil -$player->skills[] = new SkillRecord(); //menambah skill - - -

The setSkills() memastikan bahwa properti skills akan selalu berupa TList. -Menggunakan TList yang membolehkan kita untuk menyetel elemen properti skills seolah-olah mereka -sebuah array. Contohnya $player->skills[] = new SkillRecord(). Jika array dipakai, kesalahan PHP -akan dikeluarkan. -

- -

Pemetaan Kolom

-

-Sejak v3.1.1, Rekaman Aktif mulai mendukung pemetaan kolom. Pemetaan kolom membolehkan para -pengembang untuk mengalamatkan kolom dalam Rekaman Aktif menggunakan konvensi penamaan lebih -konsisten. Dalam keadaan tertentu, menggunakan pemetaan kolom, seseorang dapat mengakses kolom -menggunakan apapun namanya yang disukainya, daripada nama terbatas yang didefinisikan dalam -skema database. -

-

-Untuk menggunakan pemetaan kolom, deklarasikan array statis bernama COLUMN_MAPPING dalam kelas Rekaman Aktif. -Kunci dari array adalah nama kolom (disebut nama kolom fisik) yang didefinisikan dalam skema database, -sementara nilai terkait dengan nama properti (disebut nama kolom logika) didefinisikan dalam -kelas Rekaman Aktif. Nama properti dapat nama variabel anggota kelas public atau nama properti komponen -yang didefinisikan via pengambil/penyetel. Jika nama kolom fisik terjadi sama seperti nama kolom logika, -keduanya tidak perlu didaftarkan dalam COLUMN_MAPPING. -

- -class UserRecord extends TActiveRecord -{ - const TABLE='users'; - public static $COLUMN_MAPPING=array - ( - 'user_id'=>'id', - 'email_address'=>'email', - 'first_name'=>'firstName', - 'last_name'=>'lastName', - ); - public $id; - public $username; // nama kolom fisik dan logika sama - public $email; - public $firstName; - public $lastName; - //.... -} - -

-Dengan pemetaan kolom di atas, kita mengalamatkan first_name menggunakan $userRecord->firstName -daripada $userRecord->first_name. Ini membantu pemisahan dari logika dengan model. -

- -

Referensi

- - - diff --git a/demos/quickstart/protected/pages/Database/id/DAO.page b/demos/quickstart/protected/pages/Database/id/DAO.page deleted file mode 100755 index 8ccfb149..00000000 --- a/demos/quickstart/protected/pages/Database/id/DAO.page +++ /dev/null @@ -1,163 +0,0 @@ - -

Data Access Object (DAO)

- -

-Obyek Akses Data atau Data Access Object (DAO) memisahkan data sumber daya antarmuka klien dari mekanisme akses datanya. Ia mengadaptasi API akses sumber daya ke antarmuka klien generik. Hasilnya, mekanisme akses data dapat diubah tersendiri atas kode yang menggunakan data. -

-

-Sejak versi 3.1, PRADO mulai menyediakan DAO yang adalah pelapis tipis sekitar PHP Data Objects (PDO). Meskipun PDO memiliki set fitur bagus dan API yang baik, kami memilih untuk mengimplementasikan PRADO DAO di atas PDO karena kelas PRADO DAO adalah kelas komponen dan bisa dikonfigurasi dalam aplikasi PRADO. Para pengguna dapat menggunakan kelas DAO ini dalam cara yang lebih disukai-PRADO. -

-
Catatan: -Karena PRADO DAO didasarkan pada PDO, ekstensi PDO PHP perlu diinstalasi. Sebagai tambahan, Anda perlu menginstalasi driver PDO database terkait untuk digunakan dalam aplikasi Anda. Lihat lebih jelasnya dalam PHP Manual. -
-

-PRADO DAO sebagian besar terdiri dari empat kelas (kebalikan dari PDO yang hanya dua kelas, PDO dan PDOStatement): -

-
    -
  • TDbConnection - mewakili koneksi ke database.
    • -
  • TDbCommand - mewakili pernyataan SQL yang dijalankan terhadap database.
    • -
  • TDbDataReader - mewakili stream hanya-maju atas stream baris dari set hasil query.
    • -
  • TDbTransaction - mewakili transaksi DB.
    • -
-

-Berikutnya, kami memperkenalkan penggunaan PRADO DAO dalam skenario yang berbeda. -

- -

Menetapkan Koneksi Database

-

-Untuk menetapkan koneksi database, seseorang membuat turunan TDbConnection dan mengaktifkannya. Nama sumber data (DSN) diperlukan guna menetapkan informasi yang dibutuhkan untuk menyambung ke database. Nama pengguna dan kata sandi database mungkin perlu disertakan untuk menetapkan koneksi. -

- -$connection=new TDbConnection($dsn,$username,$password); -// panggil setAttribute() untuk mengirim parameter koneksi tambahan -// $connection->Persistent=true; // gunakan koneksi persisten -$connection->Active=true; // koneksi terlaksana -.... -$connection->Active=false; // koneksi ditutup - -

-Spesifikasi lengkap terhadap DSN dapat ditemukan dalam dokumentasi PDO. Di bawah ini adalah daftar format DNS paling umum dipakai: -

-
    -
  • MySQL - mysql:host=localhost;dbname=test
    • -
  • SQLite - sqlite:/path/to/dbfile
    • -
  • ODBC - odbc:SAMPLE -
-

-Dalam hal terjadi kesalahan ketika menetapkan koneksi (seperti DSN atau nama pengguna/sandi salah), TDbException akan dimunculkan. -

- -

Menjalankan Pernyataan SQL

-

-Sekali koneksi database terlaksana, pernyataan SQL dapat dijalankan melalui TDbCommand. Seseorang membuat TDbCommand dengan memanggil TDbConnection.createCommand() dengan pernyataan SQL yang ditetapkan: -

- -$command=$connection->createCommand($sqlStatement); -// jika diperlukan, pernyataan SQL dapat dimutakhirkan seperti berikut: -$command->Text=$newSqlStatement; - - -

-Pernyataan SQL dijalankan melalui TDbCommand dalam salah satu dari dua cara berikut: -

-
    -
  • execute() - melakukan pernyataan SQL non-query, seperti INSERT, UPDATE dan DELETE. Jika berhasil, ia mengembalikan jumlah baris yang dipengaruhi oleh eksekusi.
    • -
  • query() - melakukan pernyataan SQL yang mengembalikan baris data, seperti SELECT. Jika berhasil, ia mengembalikan turunan TDbDataReader dari salah satu yang bisa mengambil hasil baris data. -
    • -
- -$affectedRowCount=$command->execute(); // jalankan SQL non-query -$dataReader=$command->query(); // jalankan query SQL -$row=$command->queryRow(); // jalankan query SQL dan kembalikan hasil baris pertama -$value=$command->queryScalar(); // jalankan query SQL dan kembalikan nilai kolom pertama - -

-Dalam hal terjadi kesalahan selama eksekusi pernyataan SQL, TDbException akan dimunculkan. -

- -

Mengambil Hasil Query

-

-Setelah TDbCommand.query() membuat turunan TDbDataReader, seseorang dapat mengambil baris dari data hasil dengan memanggil TDbDataReader.read() secara berulang. Seseorang juga bisa menggunakan TDbDataReader dalam konstruksi bahasa PHP foreach untuk mengambil baris demi baris. -

- -// memanggil read() secara berulang sampai ia mengembalikan false -while(($row=$dataReader->read())!==false) { ... } -// menggunakan foreach untuk menjelajah melalui setiap baris data -foreach($dataReader as $row) { ... } -// mengambil semua baris sekaligus dalam satu array tunggal -$rows=$dataReader->readAll(); - - -

Menggunakan Transaksi

-

-Ketika aplikasi menjalankan beberapa query, setiap pembacaan dan/atau penulisan informasi dalam database, penting untuk memastikan bahwa datanase tidak dibiarkan dengan hanya beberapa query yang dibawanya. Transaksi, mewakili turunan TDbTransaksi dalam PRADO, dapat diinisialisasi dalam hal ini: -

-
    -
  • Mulai transaksi.
    • -
  • Jalankan query satu demi satu. Setiap memutakhirkan ke database tidak terlihat bagi dunia luar.
    • -
  • Komit transaksi. Pemutakhiran menjadi terlihat jika transaksi berhasil.
    • -
  • Jika salah satu query gagal, seluruh transaksi digulung kembali.
    • -
- -$transaction=$connection->beginTransaction(); -try -{ - $connection->createCommand($sql1)->execute(); - $connection->createCommand($sql2)->execute(); - //.... eksekusi SQL lain - $transaction->commit(); -} -catch(Exception $e) // eksepsi dimunculkan jika query gagal -{ - $transaction->rollBack(); -} - - - -

Mengikat Parameter

-

-Guna menghindari serangan injeksi SQL dan untuk meningkatkan performansi dari eksekusi pernyataan SQL yang dipakai secara berulang-ulang, seseorang dapat "menyiapkan" pernyataan SQL dengan tempat parameter opsional yang akan diganti dengan parameter sebenarnya selama proses pengikatan parameter. -

-

-Tempat parameter dapat bernama (diwakili dengan token unik) ataupun tidak bernama (diwakili dengan tanda tanya). Panggil TDbCommand.bindParameter() atau TDbCommand.bindValue() untuk mengganti tempat ini dengan parameter aktual. Parameter tidak perlu diberi tanda kutip: driver database melakukan ini bagi Anda. Pengikatan parameter harus dikerjakan sebelum pernyataan SQL dijalankan. -

- -// sebuah SQL dengan dua tempat ":username" dan ":email" -$sql="INSERT INTO users(username, email) VALUES(:username,:email)"; -$command=$connection->createCommand($sql); -// ganti tempat ":username" dengan nilai username sebenarnya -$command->bindParameter(":username",$username,PDO::PARAM_STR); -// ganti tempat ":email" dengan nilai email sebenarnya -$command->bindParameter(":email",$email,PDO::PARAM_STR); -$command->execute(); -// sisipkan baris lain dengan set parameter baru -$command->bindParameter(":username",$username2,PDO::PARAM_STR); -$command->bindParameter(":email",$email2,PDO::PARAM_STR); -$command->execute(); - -

-Metode bindParameter() dan bindValue() sangat mirip. Perbedaanya hanyalah pembentuk mengikat parameter dengan referensi variabel PHP sementara yang terkahir dengan nila. Untuk parameters yang mewakili blok memori data besar, pembentuk lebih disukai untuk pertimbangan performansi. -

-

-Untuk lebih jelasnya mengenai pengikatan parameter, lihat dokumentasi PHP terkait. -

- - -

Mengikat Kolom

-

-Ketika mengambil hasil query, seseorang dapat juga mengikat kolom dengan bariabel PHP agar dipopulasikan secara otomatis dengan data terbaru setiap kali baris diambil. -

- -$sql="SELECT username, email FROM users"; -$dataReader=$connection->createCommand($sql)->query(); -// ikat kolom ke-1 (username) dengan variabel $username -$dataReader->bindColumn(1,$username); -// ikat kolom ke-2 (email) dengan variabel $email -$dataReader->bindColumn(2,$email); -while($dataReader->read()!==false) -{ - // $username dan $email berisi username dan email dalam baris sekarang -} - - - diff --git a/demos/quickstart/protected/pages/Database/id/Scaffold.page b/demos/quickstart/protected/pages/Database/id/Scaffold.page deleted file mode 100755 index e9f15b39..00000000 --- a/demos/quickstart/protected/pages/Database/id/Scaffold.page +++ /dev/null @@ -1,130 +0,0 @@ - -

Tampilan Scaffold Rekaman Aktif

- -

Kelas Rekaman Aktif dapat digunakan dengan - -dan - -( -mengaitkan TScaffoldListView dan TScaffoldEditView) untuk membuat aplikasi web Create/Read/Update/Delete (CRUD) sederhana.

- -

Tampilan scaffold dimaksudkan untuk membantu dalam membuat prototipe aplikasi web, tidak didesain sebagai yang bisa dikustomisasi atau serumit komponen misalnya -TDataGrid. Tampilan scaffold menyediakan fungsionalitas builtin: -

- -
    -
  • Mendaftar semua item rekaman aktif.
    • -
  • Mencari rekaman.
    • -
  • Memilah halaman dan mengurut.
    • -
  • Menghapus item.
    • -
  • Menyisipkan item baru.
    • -
  • Memutakhirkan item yang ada.
    • -
  • Memvalidasi field dan tipe data dasar yang diperlukan.
    • -
  • Menyajikan kontrol khusus seperti pengambil tanggal.
    • -
- -

Tampilan Scaffold berdiri sendiri pada Rekaman Aktif dan saat ini mendukung database: Mysql, Sqlite dan Postgres SQL. Dukungan untuk database lain dapat diputuskan bila ada permintaan yang cukup.

- -

Menyiapkan Tampilan Scaffold

-

Untuk menggunakan tampilan scaffold, pertama kita mendefinisikan kelas Rekaman Aktif yang mewakili tabel atau view dalam database. Tetapkan kelas Rekaman Aktif berikut yang berkaitan dengan tabel users -seperti didefinisikan dalam halaman Rekaman Aktif. -

- - -class UserRecord extends TActiveRecord -{ - const TABLE='users'; - - public $username; - public $email; -} - - -

Kelas tampilan scaffold ada di System.Data.ActiveRecord.Scaffold.* -namespace. -namespace ini bisa diimpor ke -Konfigurasi Aplikasi -menggunakan file application.xml atau melalui kode php menggunakan metode Prado::using(). Untuk mulai menggunakan - -cukup setel nilai properti RecordClass sama dengan nama kelas Rekaman Aktif. -

- - -<com:TScaffoldView RecordClass="UserRecord" /> - - -

Kode di atas akan mendaftar rekaman saat ini dalam tabel users. -Setiap rekaman dapat diedit dengan mengklik tombol "edit" dan dihapus dengan mengklik tombol "delete". Rekaman baru bisa ditambahkan dengan mengklik pada tombol "Add new record", masukkan beberapa data (perhatikan validasi otomatis terhadap field dan tipe data yang diperlukan), dan klik tombol "save". -Menetapkan batas pencarian dalam kotak teks cari guna menemukan rekaman tertentu. Akhirnya, daftar rekaman bisa disimpan pada setiap kolom dengan mengubah kolom pengurutan serta urutan. -

- -

TScaffoldView adalah kontrol template yang dibuat dari kontrol scaffold lainnya. -Properti berikut memberikan akses ke kontrol gabungan ini.

-
    -
  • ListView -- TScaffoldListView menampilkan daftar rekaman.
    • -
  • EditView -- TScaffoldEditView yang menyajikan input untuk mengedit dan menambah rekaman.
    • -
  • SearchControl -- TScaffoldSearch bertanggung jawab atas pencarian antarmuka pengguna.
    • -
-

- Semua kontrol gabungan ini bisa dikustomisasi seperti yang akan kita lihat di bawah. -

- -

TScaffoldListView

- -

Daftar Rekaman Aktif dapat ditampilkan menggunakan TScaffoldListView dengan properti berguna berikut.

-
    -
  • Header -- TRepeater menampilkan properti/nama field Rekaman Aktif.
    • -
  • Sort -- TDropDownList menampilkan kombinasi properti dan kemungkinan urutannya.
    • -
  • Pager -- kontrol TPager menampilkan link dan/atau tombol yang menavigasi ke halaman berbeda dalam data Rekaman Aktif.
    • -
  • List -- TRepeater yang menyajikan baris data Rekaman Aktif.
    • -
- -

Penyajian kustom dari Rekaman Aktif dapat dicapai dengan menetapkan properti ItemTemplate dan/atau AlternatingItemTemplate dari pengulang List. -TScaffoldListView akan mendengarkan dua event perintah bernama "delete" dan "edit". Perintah "delete" akan menghapus rekaman untuk baris di mana perintah "delete" berasal. -Perintah "edit" akan memaksa data rekaman untuk diedit oleh -TScaffoldEditView dengan ID yang ditetapkan dengan properti EditViewID. -Contoh berikut mendaftar nama pengguna hanya dengan format tebal. -

- - -<com:TScaffoldListView RecordClass="UserRecord" > - <prop:List.ItemTemplate> - <strong><%# $this->Data->username %></strong> - </prop:List.ItemTemplate> -</com:TScaffoldListView> - - -
Info: -Untuk TScaffoldView, tampilan daftar dapat diakses melalui properti ListView dari TScaffoldView. -Selanjutnya, subproperti ListView.List.ItemTemplate pada TScaffoldView -adalah sama dengan subproperti List.ItemTemplate dari TScaffoldListView dalam contoh di atas. -
- -

Properti SearchCondition dan properti SearchParameters (mengambil nilai array) bisa ditetapkan untuk mengkustomisasi rekaman yang ditampilkan. SearchCondition -akan dipakai sebagai properti Condition dari TActiveRecordCriteria -dan properti SearchParameters berkaitan dengan properti -Parameters dari TActiveRecordCriteria.

- -

TScaffoldEditView

- -<com:TScaffoldEditView RecordPk="user1" RecordClass="UserRecord" /> - - -

Menggabungkan tampilan daftar + edit

- - -<com:TScaffoldEditView ID="edit_view" RecordClass="UserRecord" /> -<com:TScaffoldListView EditViewID="edit_view" RecordClass="UserRecord" /> - - -

Mengkustomisasi TScaffoldView

- -<com:TScaffoldView RecordClass="UserRecord" > - <prop:ListView.List.ItemTemplate> - <%# $this->DataItem->username %> - <com:TLinkButton Text="Edit" CommandName="edit" /> - </prop:ListView.List.ItemTemplate> -</com:TScaffoldView/> - - - diff --git a/demos/quickstart/protected/pages/Database/id/SqlMap.page b/demos/quickstart/protected/pages/Database/id/SqlMap.page deleted file mode 100755 index 4b5041cc..00000000 --- a/demos/quickstart/protected/pages/Database/id/SqlMap.page +++ /dev/null @@ -1,210 +0,0 @@ - - -

Pemeta Data

- -

Pemeta Data memindahkan data antara obyek dan database sementara memeliharanya berdiri sendiri satu sama lain dan pemetanya sendiri. Jika Anda mulai dengan - Active Records, mungkin nantinya Anda dihadapkan dengan obyek bisnis lebih kompleks seiring denga kemajuan proyek Anda. Ketika Anda membangun model obyek dengan banyak logika bisnis, sangat berharga untuk memakai mekanisme ini untuk mengatur data lebih baik dan perilaku bersamanya. Melakukan itu menyebabkan skema varian; yakni skema obyek dan skema relasional tidak sama. -

- -

Pemeta Data memisahkan obyek dalam-memori dari database. Tanggung jawabnya adalah mentransfer data diantara keduanya dan juga saling mengisolasinya. - Dengan Pemeta Data obyek dalam-memori tidak perlu mengetahui meskipun ada sebuah database; tidak perlu kode antarmuka SQL, dan tentunya tidak mengetahui skema database. (Skema database selalu diabaikan dari obyek yang memakainya.) -

- -

Kapan Menggunakannya

-

Tujuan utama menggunakan Pemeta Data ialah ketika Anda menginginkan skema database dan model obyek tumbuh secara independen. Keuntungan utama dari Pemeta Data adalah bahwa saat bekerja pada obyek bisnis (atau domain) Anda bisa mengabaikan database, baik dalam desain maupun pembangunan propes pengujian. Obyek domain tidak mengetahui struktur databasenya karena semua ini dikerjakan oleh pemeta. -

- -

Ini membantu Anda dalam kode karena Anda bisa mengerti serta bekerja dengan obyek domain tanpa harus mengerti bagaimana ia disimpan dalam. Anda bisa memodifikasi model bisnis atau database tanpa harus mengubahnya. Dengan pemetaan rumit, terutama yang menyangkut database yang sudah ada, ini sangat berharga. -

- -

Harga tentunya merupakan lapisan ekstra yang tidak Anda peroleh dengan Rekaman Aktif, maka pengujian menggunakan pola ini adalah kompleksitas dari logika bisnis. Jika Anda memiliki logika bisa cukup sederhana, Rekaman Aktif mungkin akan mencukupi. -Untuk logika yang lebih rumit, Pemeta Data mungkin lebih cocok. -

- -

Pemeta Data SqlMap

-

Kerangka kerja Pemeta Data SqlMap memudahkan untuk menggunakan database dengan aplikasi PHP. - PemetaData SqlMap memasangkan obyek dengan prosedur tersimpan atau pernyataan SQL menggunakan deskriptor XML. Kesederhanaan adalah keuntungan terbesar dari PemetaData SqlMap di atas piranti pemetaan relasional obyek. Untuk menggunakan PemetaData SqlMap Anda bergantung pada obyek Anda sendiri, - XML, dan SQL. Anda sedikit yang harus mempelajari yang belum Anda ketahui. - Dengan Pemeta Data SqlMap Anda mempunyai tenaga penuh pada SQL dan prosedur tersimpan di tangan Anda. -

- -

- alt="Tinjauan Pemeta Data SqlMap" id="fig:sqlmap.png" class="figure"/> - - Ini adalah penjelasan tingkat tinggi atas alur kerja yang dilukiskan pada gambar di atas. - Menyediakan parameter, baik sebagai obyek ataupun tipe primitif. Parameter bisa dipakai untuk menyetel nilai runtime dalam pernyataan SQL atau prosedur. Jika nilai runtime tidak diperlukan, parameter dapat diabaikan. -

-

Menjalankan pemetaan dengan mengirimkan parameter dan nama yang Anda berikan pada deskriptor XML Anda. Langkah ini adalah saat di mana keajaiban terjadi. Kerangka kerja akan menyiapkan pernyataan SQL atau prosedur tersimpan, menyetel setiap nilai runtime menggunakan parameter Anda, menjalankan prosedur atau pernyataan, dan mengembalikan hasil. -

- -

Dalam hal pemutakhiran, jumlah baris yang dipengaruhi dikembalikan. Dalam hal query, obyek tunggal, atau koleksi obyek dikembalikan. Seperti parameter, obyek hasil, atau koleksi obyek, bisa berupa obyek biasa ataupun tipe PHP primitif. -

- -

Menyiapkan koneksi database dan menginisialisasi SqlMap

-

- Koneksi database untuk SqlMap dapat disetel seperti berikut. - Lihat Menetapkan Koneksi Database untuk lebih jelasnya mengenai pembuatan koneksi database secara umum. - -//buat koneksi dan berikan ke manajer SqlMap. -$dsn = 'pgsql:host=localhost;dbname=test'; //Postgres SQL -$conn = new TDbConnection($dsn, 'dbuser','dbpass'); -$manager = new TSqlMapManager($conn); -$manager->configureXml('my-sqlmap.xml'); -$sqlmap = $manager->getSqlMapGateway(); - -

- -

- TSqlMapManager bertanggung jawab untuk menyiapkan koneksi database dan mengkonfigurasi SqlMap dengan file XML yang diberikan. metode configureXml() menerima string yang merujuk ke file konfigurasi XML SqlMap. Sekali dikonfigurasi, panggil metode getSqlMapGateway() untuk memperoleh turunan dari antarmuka gateway SqlMap (pakai obyek ini untuk menyisipkan/menghapus/mencari rekaman). -

- -

- Koneksi database SqlMap juga bisa dikonfigurasi menggunakan tag <module> dalam application.xml atau - config.xml seperti berikut. - - - - - - - -

- -

- Atribut ConfigFile harus menunjuk ke file konfigurasi SqlMap (dijelaskan nanti) baik menggunakan path absolut, path relatif ataupun path notasi titik namespace Prado (harus mengabaikan ekstensi ".xml"). - -

Tip: - Atribut EnableCache saat disetel "true" akan men-cache - konfigurasi yang diurai. Anda harus membersihkan atau menghapus cache jika Anda mengubah file konfigurasinya. - modul cache juga harus didefinisikan agar cache berfungsi. -
-

- -

Untuk mendapatkan antarmuka gateway SqlMap dari konfigurasi <module>, cukup lakukan misalnya - -class MyPage extends TPage -{ - public function onLoad($param) - { - parent::onLoad($param); - $sqlmap = $this->Application->Modules['my-sqlmap']->Client; - $sqlmap->queryForObject(...); //query beberapa obyek - } -} - -

- -

Contoh cepat

-

Mari kita anggap tabel "users" berikut yang berisi dua kolom bernama "username" dan "email", di mana "username" juga merupakan kunci primer. - -CREATE TABLE users -( - username VARCHAR( 20 ) NOT NULL , - email VARCHAR( 200 ) , - PRIMARY KEY ( username ) -); - -

-

Kemudian kita mendefinisikan kelas User biasa seperti berikut. Perhatikan bahwa User sangat sederhana. - -class User -{ - public $username; - public $email; -} - -

-

- -

Selanjutnya, kita perlu mendefinisikan file konfigurasi XML SqlMap, mari namai file sebagai my-sqlmap.xml. - - - - - - -

-

Tag <select> mengembalikan definisi pernyataan SQL. Atribut id akan dipakai sebagai pengenal untuk query. Nilai atribut resultClass adalah nama kelas obyek yang dikembalikan. - Sekarang kita dapat melakukan query obyek sebagai berikut: - - -//anggap bahwa $sqlmap adalah turunan TSqlMapGateway -$userList = $sqlmap->queryForList("SelectUsers"); - -//Atau hanya satu, jika hanya itu yang Anda butuhkan: -$user = $sqlmap->queryForObject("SelectUsers"); - -

- -

Contoh di atas hanya menampilkan demonstrasi sedikit kemampuan Pemeta Data SqlMap. Rincian selanjutnya dapat ditemukan dalam - SqlMap Manual. -

- -

Menggabung SqlMap dengan Rekaman Aktif

-

Contoh di atas nampaknya seperti sepele dan ia juga seperti banyak pekerjaan hanya untuk mengambil data. Akan tetapi, perhatikan bahwa kelas User sama sekali tidak mengetahui telah disimpan dalam database, dan database tidak mengetahui kelas User. -

-

- Salah satu keuntungan dari SqlMap adalah kemampuan memetakan hubungan - obyek yang kompleks, koleksi dari datbase yang sudah ada. Dilain pihak, - Rekaman Aktif menyediakan cara - yang sangat sederhana untuk berinteraksi dengan database tapi tidak bisa - melakukan hubungan atau koleksi yang lebih rumit. Kompromi yang baik adalah - menggunakan SqlMap untuk mengambil hubungan dan koleksi rumit sebagai - obyek Rekaman Aktif dan kemudian menggunakan Rekaman Aktif ini untuk memutakhirkan, menyisipkan dan menghapus. -

-

Melanjutkan contoh sebelumnya, kita mengubah definisi kelas User menjadi sebuah Rekaman Aktif. - -class UserRecord extends TActiveRecord -{ - const TABLE='users'; //nama tabel - - public $username; //kolom bernama "username" dalam tabel "users" - public $email; - - /** - * @return TActiveRecord active record finder instance - */ - public static function finder($className=__CLASS__) - { - return parent::finder($className); - } -} - -

- -

Kita juga perlu mengubah definisi dari konfigurasi XML SqlMap XML configuration. Kita cukup perlu mengubah nilai atribut resultClass ke UserRecord. - - - - - - -

- - -

Kode PHP untuk mengambil pengguna tetap sama, tapi sebaliknya SqlMap mengembalikan Rekaman Aktif, dan kita bisa mengambil keuntungan dari metode Rekaman Aktif. - - -//anggap bahwa $sqlmap adalah turunan TSqlMapGateway -$user = $sqlmap->queryForObject("SelectUsers"); - -$user->email = 'test@example.com'; //ubah data -$user->save(); //simpan menggunakan Rekaman Aktif - -

- -

Referensi

-
    -
  • Fowler et. al. Patterns of Enterprise Application Architecture, - Addison Wesley, 2002.
    • -
  • iBatis Team. iBatis Data Mapper, - http://ibatis.apache.org.
    • -
- - diff --git a/demos/quickstart/protected/pages/Database/id/ar_objects.png b/demos/quickstart/protected/pages/Database/id/ar_objects.png deleted file mode 100755 index 50ab812d..00000000 Binary files a/demos/quickstart/protected/pages/Database/id/ar_objects.png and /dev/null differ diff --git a/demos/quickstart/protected/pages/Database/id/ar_relations.png b/demos/quickstart/protected/pages/Database/id/ar_relations.png deleted file mode 100755 index 48e29f48..00000000 Binary files a/demos/quickstart/protected/pages/Database/id/ar_relations.png and /dev/null differ diff --git a/demos/quickstart/protected/pages/Database/id/diagram.png b/demos/quickstart/protected/pages/Database/id/diagram.png deleted file mode 100755 index 0a0ca73d..00000000 Binary files a/demos/quickstart/protected/pages/Database/id/diagram.png and /dev/null differ diff --git a/demos/quickstart/protected/pages/Database/id/object_states.png b/demos/quickstart/protected/pages/Database/id/object_states.png deleted file mode 100755 index db194783..00000000 Binary files a/demos/quickstart/protected/pages/Database/id/object_states.png and /dev/null differ diff --git a/demos/quickstart/protected/pages/Database/id/sqlmap_active_record.png b/demos/quickstart/protected/pages/Database/id/sqlmap_active_record.png deleted file mode 100755 index 6d958d33..00000000 Binary files a/demos/quickstart/protected/pages/Database/id/sqlmap_active_record.png and /dev/null differ diff --git a/demos/quickstart/protected/pages/Database/pl/ActiveRecord.page b/demos/quickstart/protected/pages/Database/pl/ActiveRecord.page deleted file mode 100755 index 3a073e57..00000000 --- a/demos/quickstart/protected/pages/Database/pl/ActiveRecord.page +++ /dev/null @@ -1,1144 +0,0 @@ - -

Rekord Aktywny (ang. Active Record)

- -

Rekordy Aktywne są obiektami, które opakowują wiersz w bazie danych lub widoku, - obudowują (ang. encapsulate) dostęp do bazy danych oraz dziedziny logiki dla tych danych. - Podstawą Rekordu Aktywnego są klasy biznesowe np. klasa - Produkty, które są bardzo podobne do struktury rekordu należącego do bazy danych. Każdy Rekord Aktywny jest odpowiedzialny - za zapisywanie i łądowanie danych do i z bazy danych.

-
Info: - Struktura danych Rekordu Sktywnego powinna zgadzać się ze strukturą tablicy w bazie danych. - Każda kolumna w bazie danych powinna posiadać odpowiadający element: zmienną lub właściwość w klasie Rekordu Aktywnego reprezentującego tablicę. -
- -

Kiedy używać?

-

Rekord Aktywne jest dobrym wyborem dla dziedziny logiki, która nie jest zbyt złożona, tak jak tworzenie, odczyty, aktualizacje oraz usuwanie. - Pochocne (ang. derivations) oraz sprawdzenia bazujące na pojedyńczym rekordzie sprawdzają się dobrze w tej konstrukcji. - Rekord Aktywne ma podstawową zaletę, którą jest prostota. Łatwo jest stworzyć Rekord Aktywny, łatwo go również zrozuieć. -

- -

Jednakże, jeśli twoja logika biznesowa staje się coraz bardziej złożona, wkrótce będziesz chciał - używać bezpośrednich relacji, zbiorów, dziedziczenia twojego obiektu i tak dalej. Nie da się tego łatwo odwzorować za pomocą Rekordu Aktywnego, - a dodawanie ich po kawałku staje się bardzo kłopotliwe. Innym argumentem przeciw Rekordowi Aktywnemu jest fakt, że łączy model obiektowy z modelem baz danych. - To czyni trudniejszym refaktoring, gdy projekt idzie naprzód. -

- -

Alternatywą jest używanie wzorca Data Mapper (mapa danych), który odseparowuje role obiektu biznesowego od tego jak te obiekty są przechowywane. - Prado dostarcza - Prado provides a darmowy wybór pomiędzy rekordem aktywnym a SqlMap Data Mapper. - SqlMap Data Mapper może być uzywany do wczytania obiektów Rekordu Aktywnego, i na odwrót, te Rekordy Aktywne mogą zostać użyte do aktualizacji bazy danych. - Związek pomiędzy Rekordem Aktywnym a SqlMap przedstawiony jest na kolejnym diagramie. Więcej informacji związanych z SqlMap Data Mapper można znaleźć w - manualu SqlMap. - alt="Active Records and SqlMap DataMapper" id="fig:diagram.png" class="figure"/> -

- -

- Klasa Rekordu aktywnego posiada funkcjonalność do przeprowadzenia następujących zadań: -

-
    -
  • Tworzenie, zwracanie, aktualizowani i usuwanie recordów (CRUD)
    • -
  • metody wyszukujące obudowujące powszechnie używane zapytania SQL i zwracające obiekty Rekordu Aktywnego
    • -
  • Wydobywają relacje (powiazanych obcych obiektów) takie jak "posiada wiele" (ang. has many), "posiada jedno" (ang. has one), "należy do" (ang. belongs to) oraz wiele do wielu "many to many" poprzez tablice asocjacyjne.
    • -
  • Opóźnione ładowanie (ang. Lazy loading) relacji
    • -
-

Implikacje modelu

-

-Implementacja wzorca Aktywnego Rekordu w PRADO nie zapewnia referencyjnej tożsamości (ang. referential identity). Każdy istniejący obiekt używający -Rekordu Aktywnego jest koopią danych z bazy danych. Na przykład jeśli zapytasz o konkretnego klienta i zostanie zwrócony obiekt Klient, -to następnym razem kiedy zapytasz o tego klienta otrzymasz spowrotem inną instancję obiektu Klient. To implikuje, że ścisłe porównianie (np. używając ===) -zwróci fałsz, natomiast luźne porównianie (np. używając ==) zwróci prawdę jeśli wartości obiektu są równe poprzez luźne porónanie. -

-

-Jest to implikacja modelu wynikająca z następującego pytania: -"Czy myślisz o kliencie jako o obiekcie, którego któy jest tylko jeden, czy też myślisz o obiekcie na którym działasz jako o kopii bazy danych. -Inne mapowania O/R implikują, że istnieje tylko jeden obiekt Klienta z KlientID 100 -Other O/R mappings will imply that there is only one Customer object with custID 100 i to dosłownie jest ten klient. -Jeśli pobierzesz klienta i zmienisz pole w nim, wtedy masz zmienionego tego klienta. -"To kontroastuje z: zmieniłeś tą kopię klienta ale nie tamtą kopię. -Jeśli dwóch ludzi zaktualizuje kleinta z dwóch kopii obiektu, kto zaktualizuje pierwszy lub być może ostanie wygrywa." [A. Hejlsberg 2003] -

- -

Wspierane bazy danych

-

-Implementacja Aktywnego Rekordu wykorzystuje kalsy Prado DAO by uzyskać dostęp do danych. Aktualna implementacja Aktywnego Rekordu wspiera następujace bazy danych -

- -

Wsparcie dla pozostałych baz danych może zostać wprowadzone, keidy będzie dostatecne zapotrzebowanie

- -

Definiowanie Aktywnego Rekordu

-

Rozważmy następującą tablicę "users", która zawiera dwie kolumny nazwane "username" oraz "email", - gdzie "username" jest kluczem głównym. - -CREATE TABLE users -( - username VARCHAR( 20 ) NOT NULL , - email VARCHAR( 200 ) , - PRIMARY KEY ( username ) -); - -

-

Następnie zdefiniujemy naszą klasę Rekordu Aktywnego odpowiadającą tablicy "users". - -class UserRecord extends TActiveRecord -{ - const TABLE='users'; //nazwa tablicy - - public $username; //kolumna nazwana "username" w tablicy "users" - public $email; - - /** - * @return TActiveRecord intancja finder rekordu aktywnego - */ - public static function finder($className=__CLASS__) - { - return parent::finder($className); - } -} - -

-

Każda kolumna tablicy "users" musi posiadać odpowiadającą jej właściwość o tej samej nazwie co kolumna w tablicy w klasie UserRecord. - Oczywiście, możesz zdefiniować dodatkowe zmienne lub właściwości, które nie istnieją w strukturze tablicy. - Stała TABLE jest opcjonalna w klasie , kiedy nazwa klasy jest taka sama jak nazwa tablicy w bazie danych, w przeciwnym przypadku TABLE - musi określać nazwę tablicy, która odpowiada klasie Rekordu Aktywnego. -

- -
Tip: -Możesz określić kwalifikowane (ang. qualified) nazwy tablic np dla MySQL, TABLE = "`bazadanych1`.`tablica1`". -
- -

- Odkąd TActiveRecord rozszerza TComponent, metody setter i getter mogą zostać zdefiniowane - by umożliwić kontrolę nad tym jak zmienne są ustawiane i zwracane. Na przykłąd dodanie właściwości $level - do klasy UserRecord: -

- -class UserRecord extends TActiveRecord { - ... //istniejąca uprzednio część definicji - - private $_level; - public function setLevel($value) { - $this->_level=TPropertyValue::ensureInteger($value,0); - } - public function getLevel($value){ - return $this->_level; - } -} - -

Więcej szczegółów dotyczących TComponent można znaleźć dokumentacji komponentów. -Później użyjemy metod getter/setters by umożliwić opóźnione ładowanie (ang. lazy loading) obiektów relacji. -

- -
Info: -TActiveRecord może również działać z widokami poprzez przypisanie do stałej TABLE - odpowiedniej nazwy widoku. Jednakże obiektu zwracane przez widoki są tylko do odczytu, wywołanie metod save() lub delete() -spowoduje wywołanie wyjątku. -
- -

- Metoda statyczna finder() zwraca instancję UserRecord, która może zostać użyta do załadowania rekordów z bazy. - Ładowanie rekordów za pomocą tej metody będzie omówione później. Statyczna metoda TActiveRecord::finder() - pobiera nazwę klasy Rekord Aktywnego jako parametr. -

- -

Ustanawianie połączenia z bazą danych

-

- Domyślne połączenie z bazą dla Rekordu Aktywnego może zostać ustawione następujaco. - Zobacz Ustanawianie połączenia z bazą - by uzyskać ogólnie dalsze szczegóły odnośnie tworzenia połączenia z bazą danych. -

- -//utwóz połączenie i przekaż je do menadżera Rekordu Aktywnego -$dsn = 'pgsql:host=localhost;dbname=test'; //Postgres SQL -$conn = new TDbConnection($dsn, 'dbuser','dbpass'); -TActiveRecordManager::getInstance()->setDbConnection($conn); - - -

Alternatywnie, możesz stworzyć klasę bazową i nadpisać metodę getDbConnection() -do zwracania połączenia z bazą. To jest prosty spodób, by umożliwić wielkokrotne połączenia do wielu baz danych. - Następujący kod demonstruje definiowanie połączenia z bazą danych w klasie bazowej (nie ma potrzeby by ustawiać połączenie DB gdziekolwiek indziej). -

- -class MyDb1Record extends TActiveRecord -{ - public function getDbConnection() - { - static $conn; - if($conn===null) - $conn = new TDbConnection('xxx','yyy','zzz'); - return $conn; - } -} -class MyDb2Record extends TActiveRecord -{ - public function getDbConnection() - { - static $conn; - if($conn===null) - $conn = new TDbConnection('aaa','bbb','ccc'); - return $conn; - } -} - - - -

Używanie application.xml w frameworku Prado

-
-

- Domyślne połączenie z bazą może zostać również skonfigurowane używając tagu <module> - w pliku application.xml - lub config.xml następująco: - - - - - - - -

Wskazówka: - Atrybut EnableCache gdy ustawiony na "true" będzie keszował metadane tablicy, to oznacza, że nazwy kolumn, indeksy i ograniczenia (ang. constraints) - są zapisywane w keszu i używane ponownie. Musisz wyczyścić lub wyłączyć kesz jeśli chcesz zobaczyć wprowadzone zmiany do definicji twoich tablic. - Moduł keszowania musi być również zdefiniowany dla keszu by zadziałał. -
-

- -

Do właściwość ConnectionID może zostać przypisana wartość ID z konfiguracji z innego modułu - TDataSourceConfig. To pozwala uyżywać to połączenie z bazą danych w innych modułach, takich jak SqlMap (mapa SQL). - - - - - - - - - - - -

-
- -

Ładowanie danych z tablicy

-

- Klasa TActiveRecord dostarcza wielu wygodnych metod do wyszukiwania rekordów z bazy danych. - Najprostszym jest znajdowanie jednego rekordu poprzez dopasowanie klucza głównego lub klucza złożonego (ang. composite key) - (klucz główny skłądający się z wielu kolumn). - Zobacz by dowiedzieć się więcej. -

- -
Info: -Wszystkie metody wyszukujące, które mogą zwrócić tylko 1 rekord zwrócą null jeśli nie znajdą pasujących danych. -Wszystkie metody wyszukujące, które zwracają tablicę rekordów zwrócą pustą tablicęm jeśli nie znajdą pasujących danych. -
- -

findByPk()

-

Znajduje jeden rekord używając klucza głównego lub klucza złożonego. - -$finder = UserRecord::finder(); -$user = $finder->findByPk($primaryKey); - -//kiedy tablica używa klucza złożonego -$record = $finder->findByPk($key1, $key2, ...); -$record = $finder->findByPk(array($key1, $key2,...)); - -

- -

findAllByPks()

-

Znajduje wiele rekordów używając listy kluczy głównych lub kluczy złożonych. -Co następuje jest odpowiednie dla kluczów głównych (klucz główny składa się tylko z jednego pola/kolumny) -

- -$finder = UserRecord::finder(); -$users = $finder->findAllByPks($key1, $key2, ...); -$users = $finder->findAllByPks(array($key1, $key2, ...)); - -Co następuje jest odpowiednie dla kluczów złożonych: - -//kiedy tablica używa klucza złożonego -$record = $finder->findAllByPks(array($key1, $key2), array($key3, $key4), ...); - -$keys = array( array($key1, $key2), array($key3, $key4), ... ); -$record = $finder->findAllByPks($keys); - - - -

find()

-

Znajduje pojedyńczy rekord, który spełnia kryteria. Kryteria mogą być częściowym łąńcuchem SQL lub obiektem TActiveRecordCriteria

- -$finder = UserRecord::finder(); - -//:name oraz :pass są pojemnikami dla konkretnych wartości $name oraz $pass -$finder->find('username = :name AND password = :pass', - array(':name'=>$name, ':pass'=>$pass)); - -//użycie znaków zastępczych -$finder->find('username = ? AND password = ?', array($name, $pass)); -//jak wyżej -$finder->find('username = ? AND password = ?', $name, $pass); - -//$criteria są typu TActiveRecordCriteria -$finder->find($criteria); //drugi parametr dla find() jest zignorowany. - - -

Klasa TActiveRecordCriteria ma następujące właściwości: -

-
    -
  • Parameters -- pary wartość nazwa parametru.
    • -
  • OrdersBy -- nazwa kolumny i sortowanie par
    • -
  • Condition -- część WHERE zapytania SQL
    • -
  • Limit -- maksymalna ilość rekordów, któe zostaną zwrócone.
    • -
  • Offset -- offset rekordów w tablicy.
    • -
- - -$criteria = new TActiveRecordCriteria; -$criteria->Condition = 'username = :name AND password = :pass'; -$criteria->Parameters[':name'] = 'admin'; -$criteria->Parameters[':pass'] = 'prado'; -$criteria->OrdersBy['level'] = 'desc'; -$criteria->OrdersBy['name'] = 'asc'; -$criteria->Limit = 10; -$criteria->Offset = 20; - - -
Przypis: -For MSSQL and when Limit and Offset are positive integer values. The -actual query to be executed is modified by the - -class according to -http://troels.arvin.dk/db/rdbms/ -to emulate the Limit and Offset conditions. -
- -

findAll()

-

Podobnie jak find() ale zwraca tablicę obiektów.

- -

findBy*() oraz findAllBy*()

-

Dynamiczne metody wyszukujące używające część nazwy metody jako kryteria wyszukiwania. -Metody zaczynające się od słów findBy zwracają tylko 1 rekord natomiast metody zaczynające się findAllBy zwracają tablicę obiektów. -Warunej jest wzięty jako część nazwy metody po przedrostku findBy lub findAllBy. - -Następujące bloki kodów są sobie równoważne: -

- -$finder->findByName($name) -$finder->find('Name = ?', $name); - - - -$finder->findByUsernameAndPassword($name,$pass); -$finder->findBy_Username_And_Password($name,$pass); -$finder->find('Username = ? AND Password = ?', $name, $pass); - - - -$finder->findAllByAge($age); -$finder->findAll('Age = ?', $age); - - -
Tip: -Możesz również użyć połączenia AND oraz OR jako warunek w dynamicznych metodach. -
- -

findBySql() oraz findAllBySql()

-

Znajdują rekordy używając pełnego zapytania SQL z tym, że findBySql() -zwraca Rekord Aktywny a findAllBySql()zwraca tablicę obiektów rekordów. -Dla każdej zwróconej kolumny, odpowiadająca klasa Rekordu Aktywnego musi posiadać zdefiniowaną zmienną lub właściwość odpowiadającą nazwie kolumny. - -class UserRecord2 extends UserRecord -{ - public $another_value; -} -$sql = "SELECT users.*, 'hello' as another_value FROM users"; -$users = TActiveRecord::finder('UserRecord2')->findAllBySql($sql); - -

-

count()

-

Zlicza ilość pasujących rekordów, akceptuje te same parametry co metoda findAll()

- -

Wstawianie i aktualizowanie rekordów

-

-Dodanie nowego rekordu za pomocą TActiveRecord jest bardzo łatwe, po prostu stwórz nowy obiekt Rekordu Aktywnego i wywołaj metodę save(). Na przykład -

- -$user1 = new UserRecord(); -$user1->username = "admin"; -$user1->email = "admin@example.com"; -$user1->save(); //wstaw nowy rekord - -$data = array('username'=>'admin', 'email'=>'admin@example.com'); -$user2 = new UserRecord($data); //stwórz przekazując istniejące dane -$user2->save(); //wstaw nowy rekord - -
Wskazówka: -Obiekty są aktualizowe automatycznie o wartość klucza głównego dla tych tablic, które zawierają definicję -określającą automatyczne tworzenie klucza głównego dla nowo tworzonych rekordów (przyp. tłum. autoincrement). -Na przykład jeśli wstawiasz nowy rekord do tablicy MySQL która posiada kolumnę zdefiniowaną jako to obiekt Rekordu Aktywnego -zostanie zaktualizowant o nową zwiększoną wartość.
- -

-Aby zaktualizować rekord w bazie danych po prostu zmień jedną lub więcej właściwości obiektu Rekordu Aktywnego które zostały odczytane z bazy a następnie wywołaj metodę save(). - - -$user = UserRecord::finder()->findByName('admin'); -$user->email="test@example.com"; //zmiana właściwości -$user->save(); //zaktualizuj ją - -

- -

-Obiekt Rekordu Aktywnego posiada prosty cykl życia zilustrowany następujący diagram. -

- alt="Active Records Life Cycle" id="fig:cycle.png" class="figure"/> -

-Widzimy, że nowe obiekty Rekordu Aktywnego są tworzone zarówno przez jedną z metod find*() -lub poprzez stworzenie nowej instancji poprzez użycie polecenia PHP new. Obiekty stworzone przez metodę find*() -zaczynają ze stanem czysty (ang. clean). Nowa instancja TActiveRecord stworzona inaczej niż za pomocą metod find*() zaczyna ze stanem nowy (ang. new). -Kiedykolwiek wywołasz metodę save() na obiekcie TActiveRecord, obiekt przyjmuje stan czysty. -Obiekty będące czystymi stają się brudne (ang. dirty) kiedy jeden lub więcej ze stwoich wewnętrznych stanów ulegnie zmianie. -Wywoałanie metody delete() obiektu kończy cykl życia, żadne inne akcje nie mogą być wywołane na obiekcie. -

- -

Usuwanie istniejących obiektów

-

- Aby usunąc istniejący rekord, który jest załadowany, po prostu wywołaj metodę delete. - Możesz rónież usunąć rekord w bazie danych poprzez klucz główny bez ładowania żadnego rekordu używając metody - deleteByPk() (również metoda deleteAllByPks()). - Na przykład, aby usunąć jeden lub więcej rekordów z tabeli używając jednego lub wielu kluczów głównych: -

- -$finder->deleteByPk($primaryKey); //usuwanie 1 rekordu -$finder->deleteAllByPks($key1,$key2,...); //usuwanie wielu rekordów -$finder->deleteAllByPks(array($key1,$key2,...)); //usuwanie wielu rekordów - - -

-Dla klucza złożonego (ustalanego automatycznie na podstawie definicji tablicy): -

- -$finder->deleteByPk(array($key1,$key2)); //usuwanie 1 rekordu - -//usuwanie wielu rekordów -$finder->deleteAllByPks(array($key1,$key2), array($key3,$key4),...); - -//usuwanie wielu rekordów -$finder->deleteAllByPks(array( array($key1,$key2), array($key3,$key4), .. )); - - -

deleteAll() oraz deleteBy*()

-

-Aby usunąć używając kryteria użyj deleteAll($criteria) oraz deleteBy*() -z podobną składnią jak findAll($criteria) oraz findAllBy*() opisaną wcześniej. -

- -//usuwanie wszystkich rekordów z pasującym Name -$finder->deleteAll('Name = ?', $name); -$finder->deleteByName($name); - -//usuwanie na podstawie Name oraz Password -$finder->deleteBy_Username_And_Password($name,$pass); - - -

Tranzakcje

-

Wszystkie obiekkty Rekordu Aktywnego zawierają właściwość DbConnection, - która może być używana by uzyskać obiekt tranzakcyjny. - -$finder = UserRecord::finder(); -$finder->DbConnection->Active=true; //otwórz jeśli to konieczne -$transaction = $finder->DbConnection->beginTransaction(); -try -{ - $user = $finder->findByPk('admin'); - $user->email = 'test@example.com'; //zmień obiekt użytkownika $user - $user->save(); - $transaction->commit(); -} -catch(Exception $e) // wyjątek jest wołany jeśli zapytanie nie powiedzie się -{ - $transaction->rollBack(); -} - - -

Zdarzenia

-

-Rekord Aktywny oferuje dwa zdarzenia: OnCreateCommand oraz OnExecuteCommand. -

- -

Zdarzenie OnCreateCommand jest wołane gdy polecenie jest przygotowywane i przypisywanie (ang. binding) parametrów jest zakończone. - Parametrem obiektu jest TDataGatewayEventParameter, którego właściwość Command może być sprawdzona by otrzymać zapytanie, które będzie wykonane wykonywane. -

- -

-Zdarzenie OnExecuteCommand jest wywoływane kiedy polecenie jest wykonane i rezultat z bazy danych został zwrócony. - Parametrem obiektu jest TDataGatewayResultEventParameter, którego właściwość Result zawiera dane zwrócone z bazy danych. - Dane zwrócone mogą zostać zmienione poprzez ustawienie właściwości Result. -

- -

Przykład z logowaniem

-

Używając OnExecuteCommand możemy przypiąć uchwyt zdarzenia by logować całe -zapytanie SQL wwywoływane dla danej instancji lub klasy TActiveRecord. Na przykład definiujemy klasę bazową i nadpisujemy -metodę getDbConnection() lub konstruktor. -

- - -class MyDb1Record extends TActiveRecord -{ - public function getDbConnection() - { - static $conn; - if($conn===null) - { - $conn = new TDbConnection('xxx','yyy','zzz'); - $this->OnExecuteCommand[] = array($this,'logger'); - } - return $conn; - } - public function logger($sender,$param) - { - var_dump($param->Command->Text); - } -} -//alternatively as per instance of per finder object -function logger($sender,$param) -{ - var_dump($param->Command->Text); -} -TActiveRecord::finder('MyRecord')->OnExecuteCommand[] = 'logger'; -$obj->OnExecuteCommand[] = array($logger, 'log'); //dowolny poprawny callback PHP - - -

Relacje dla Rekordu Aktywnego

- -

-Implementacja Rekordu Aktywnego w Prado wspiera mapowanie kluczów obcych dla baz, które wspierają ograniczenia (ang. constraints) kluczów obcych. - Aby relacje dla Rekordu Aktywnego działały używana baza danych musi wspierać ograniczenia klucza głównego (np. MySQL używająca InnoDB) -

- -

-W następnych sekcjach będziemy rozważać nastepujące relacje pomiędzy tabelami Teams, Players, Skills oraz Profiles. -

- class="figure" /> - - -

Celem jest uzyskanie modelu obiektowego, który będzie reprezetnował w pewnym stopniu relacje pomiędzy polami z powyższego rysunku. -

- - class="figure" /> - -

-Istnieje rozbieżność pomiędzy relacjami w obiektach i relacjami w tablicach. - Po pierwsze jest różnica w reprezentacji. Obiekty trzymają powiązanie poprzez przechowywanie referencji, -które są trzymane poprzez zarządzające pamięcią środowiko uruchomieniowe. Bazy relacyjne trzymają powiązanie poprzez utworzenie klucza do innej tablicy. - Po drugie, obiekty mogą łatwo uzywać kolekcji by trzymać wielokrotnie referencje z jednego pola, -to handle multiple references from a single field, gdyż normalizacja zmusza wszystkie powiązania relacji encji by były pojedyńczymi wartościami. -To prowadzi do odwrócenia struktury danych pomiędzy obiektami i tablicami. -Podejście zastosowane w modelu Rekordu Aktywnego Prado uzywa ograniczeń kluczów obcych tablicy do wyprowadzenia relacji obiektów. -To implikuje fakt wspierania ograniczeń kluczów obcych dla bazy danych. -

-
Tip: -Dla baz danych SQLite możesz stworzyć tablice, które definiują ograniczenia kluczó obcych tak jak na przykładzie poniżej. -Jednakże te ograniczenia NIE SĄ narzucane przez samą bazę SQLite. - -CREATE TABLE foo -( - id INTEGER NOT NULL PRIMARY KEY, - id2 CHAR(2) -); -CREATE TABLE bar -( - id INTEGER NOT NULL PRIMARY KEY, - foo_id INTEGER - CONSTRAINT fk_foo_id REFERENCES foo(id) ON DELETE CASCADE -); - -
- -

Mapowanie kluczów obcych

-

Relacja pól pomiędzy tablicami Teams and Players jest znana jako relacja jeden-do-wielu (ang. 1-M). Oznacza to, że jeden Team moze zawierać zero lub więcej Players. Z punktu widzenia relacji obiektów -powiemy, że obiekt TeamRecord posiada wiele (ang. has many) obiektów PlayerRecord. -(Zauważ odwrócenie kierunku relacji pomiędzy tablicami a obiektami) -

- -

Relacja posiada wiele (ang. has Many Relationship)

-

-Zamodelujemy obiekt Team jako następującą klasę Rekordu Aktywnego. -

- -class TeamRecord extends TActiveRecord -{ - const TABLE='Teams'; - public $name; - public $location; - - public $players=array(); // this declaration is no longer needed since v3.1.2 - - //define the $player member having has many relationship with PlayerRecord - public static $RELATIONS=array - ( - 'players' => array(self::HAS_MANY, 'PlayerRecord', 'team_name'), - ); - - public static function finder($className=__CLASS__) - { - return parent::finder($className); - } -} - -

-The static $RELATIONS property of TeamRecord defines that the -property $players has many PlayerRecords. Multiple relationships -is permitted by defining each relationship with an entry in the $RELATIONS -array where array key for the entry corresponds to the property name. -In array(self::HAS_MANY, 'PlayerRecord'), the first element defines the -relationship type, the valid types are self::HAS_MANY, self::HAS_ONE, -self::BELONGS_TO and self::MANY_TO_MANY. -The second element is a string 'PlayerRecord' that corresponds to the -class name of the PlayerRecord class. -And the third element 'team_name' refers to the foreign key column in the Players table that -references to the Teams table. -

- -
Note: -As described in the code comment above, since version 3.1.2, related properties no longer -need to be explicitly declared. By default, they will be implicitly declared according to -keys of the $RELATIONS array. A major benefit of declared related properties implicitly -is that related objects can be automatically loaded in a lazy way. For example, assume we have -a TeamRecord instance $team. We can access the players via $team->players, -even if we have never issued fetch command for players. If $players is explicitly declared, -we will have to use the with approach described in the following to fetch the player records. -
- -

-The foreign key constraint of the Players table is used to determine the corresponding -Teams table's corresponding key names. This is done automatically handled -in Active Record by inspecting the Players and Teams table definitions. -

- -
Info: -Since version 3.1.2, Active Record supports multiple foreign key -references of the same table. Ambiguity between multiple foreign key references to the same table is -resolved by providing the foreign key column name as the 3rd parameter in the relationship array. -For example, both of the following foreign keys owner_id and reporter_id -references to the same table defined in UserRecord. - -class TicketRecord extends TActiveRecord -{ - public $owner_id; - public $reporter_id; - - public $owner; // this declaration is no longer needed since v3.1.2 - public $reporter; // this declaration is no longer needed since v3.1.2 - - public static $RELATION=array - ( - 'owner' => array(self::BELONGS_TO, 'UserRecord', 'owner_id'), - 'reporter' => array(self::BELONGS_TO, 'UserRecord', 'reporter_id'), - ); -} - -This is applicable to relationships including BELONGS_TO, HAS_ONE and -HAS_MANY. See section Self Referenced Association Tables for solving ambiguity of MANY_TO_MANY -relationships. -
- -

The "has many" relationship is not fetched automatically when you use any of the Active Record finder methods. -You will need to explicitly fetch the related objects as follows. In the code below, both lines -are equivalent and the method names are case insensitive. -

- -$team = TeamRecord::finder()->withPlayers()->findAll(); -$team = TeamRecord::finder()->with_players()->findAll(); //equivalent - -

-The method with_xxx() (where xxx is the relationship property -name, in this case, players) fetches the corresponding PlayerRecords using -a second query (not by using a join). The with_xxx() accepts the same -arguments as other finder methods of TActiveRecord, e.g. with_players('age = ?', 35). -

- -
Note: -It is essential to understand that the related objects are fetched using additional -queries. The first query fetches the source object, e.g. the TeamRecord in the above example code. -A second query is used to fetch the corresponding related PlayerRecord objects. -The usage of the two query is similar to a single query using Left-Outer join with the -exception that null results on the right table -are not returned. The consequence of using two or more queries is that the aggregates -and other join conditions are not feasible using Active Records. For queries outside the -scope of Active Record the SqlMap Data Mapper may be considered. -
- -
Info: -The above with approach also works with implicitly declared related properties (introduced -in version 3.1.2). So what is the difference between the with approach and the lazy loading -approach? Lazy loading means we issue an SQL query if a related object is initially accessed and not ready, -while the with approach queries for the related objects once for all, no matter the related objects -are accessed or not. The lazy loading approach is very convenient since we do not need to explictly -load the related objects, while the with approach is more efficient if multiple records are -returned, each with some related objects. -
- -

Has One Relationship

-

The entity relationship between Players and Profiles is one to one. That is, -each PlayerRecord object has one ProfileRecord object (may be none or null). -A has one relationship is nearly identical to a has many relationship with the exception -that the related object is only one object (not a collection of objects). -

- -

Belongs To Relationship

-

The "has many" relationship in the above section defines a collection of foreign -objects. In particular, we have that a TeamRecord has many (zero or more) -PlayerRecord objects. We can also add a back pointer by adding a property -in the PlayerRecord class that links back to the TeamRecord object, -effectively making the association bidirectional. -We say that the $team property in PlayerRecord class belongs to a TeamRecord object. -The following code defines the complete PlayerRecord class with 3 relationships. -

- -class PlayerRecord extends TActiveRecord -{ - const TABLE='Players'; - public $player_id; - public $age; - public $team_name; - - public $team; // this declaration is no longer needed since v3.1.2 - public $skills=array(); // this declaration is no longer needed since v3.1.2 - public $profile; // this declaration is no longer needed since v3.1.2 - - public static $RELATIONS=array - ( - 'team' => array(self::BELONGS_TO, 'TeamRecord', 'team_name'), - 'skills' => array(self::MANY_TO_MANY, 'SkillRecord', 'Player_Skills'), - 'profile' => array(self::HAS_ONE, 'ProfileRecord', 'player_id'), - ); - - public static function finder($className=__CLASS__) - { - return parent::finder($className); - } -} - -

-The static $RELATIONS property of PlayerRecord defines that the -property $team belongs to a TeamRecord. -The $RELATIONS array also defines two other relationships that we -shall examine in later sections below. -In array(self::BELONGS_TO, 'TeamRecord', 'team_name'), the first element defines the -relationship type, in this case self::BELONGS_TO; -the second element is a string 'TeamRecord' that corresponds to the -class name of the TeamRecord class; and the third element 'team_name' refers -to the foreign key of Players referencing Teams. -A player object with the corresponding team object may be fetched as follows. -

- -$players = PlayerRecord::finder()->with_team()->findAll(); - - -

- The method with_xxx() (where xxx is the relationship property - name, in this case, team) fetches the corresponding TeamRecords using - a second query (not by using a join). The with_xxx() accepts the same -arguments as other finder methods of TActiveRecord, e.g. -with_team('location = ?', 'Madrid'). -

- -
Tip: -Additional relationships may be fetched by chaining the with_xxx() together as the following -example demonstrates. - -$players = PlayerRecord::finder()->with_team()->with_skills()->findAll(); - -Each with_xxx() method will execute an additional SQL query. Every -with_xxx() accepts arguments similar to those in the findAll() method and is only -applied to that particular relationship query. -
- -

The "belongs to" relationship of ProfileRecord class is defined similarly.

- -class ProfileRecord extends TActiveRecord -{ - const TABLE='Profiles'; - public $player_id; - public $salary; - - public $player; // this declaration is no longer needed since v3.1.2 - - public static $RELATIONS=array - ( - 'player' => array(self::BELONGS_TO, 'PlayerRecord'), - ); - - public static function finder($className=__CLASS__) - { - return parent::finder($className); - } -} - - -

In essence, there exists a "belongs to" relationship for objects corresponding to -entities that has column which are foreign keys. In particular, we see that -the Profiles table has a foreign key constraint on the column player_id -that relates to the Players table's player_id column. Thus, the ProfileRecord -object has a property ($player) that belongs to a PlayerRecord object. -Similarly, the Players table has a foreign key constraint on the column team_name that relates to the -Teams table's name column. -Thus, the PlayerRecord object has a property ($team) that belongs to a -TeamRecord object. -

- -

Parent Child Relationships

-

A parent child relationship can be defined using a combination of has many and belongs to -relationship that refers to the same class. The following example shows a parent children relationship between -"categories" and a "parent category". -

- - -class Category extends TActiveRecord -{ - public $cat_id; - public $category_name; - public $parent_cat_id; - - public $parent_category; // this declaration is no longer needed since v3.1.2 - public $child_categories=array(); // this declaration is no longer needed since v3.1.2 - - public static $RELATIONS=array - ( - 'parent_category' => array(self::BELONGS_TO, 'Category', 'parent_cat_id'), - 'child_categories' => array(self::HAS_MANY, 'Category', 'parent_cat_id'), - ); -} - - -

Query Criteria for Related Objects

-

-In the above, we show that an Active Record object can reference to its related objects by -declaring a static class member $RELATIONS which specifies a list of relations. Each relation -is specified as an array consisting of three elements: relation type, related AR class name, -and the foreign key(s). For example, we use array(self::HAS_MANY, 'PlayerRecord', 'team_name') -to specify the players in a team. There are two more optional elements that can be specified -in this array: query condition (the fourth element) and parameters (the fifth element). -They are used to control how to query for the related objects. For example, if we want to obtain -the players ordered by their age, we can specify array(self::HAS_MANY, 'PlayerRecord', 'team_name', 'ORDER BY age'). -If we want to obtain players whose age is smaller than 30, we could use -array(self::HAS_MANY, 'PlayerRecord', 'team_name', 'age<:age', array(':age'=>30)). In general, -these two additional elements are similar as the parameters passed to the find() method in AR. -

- - - -

Association Table Mapping

-

-Objects can handle multivalued fields quite easily by using collections as field values. -Relational databases don't have this feature and are constrained to single-valued fields only. -When you're mapping a one-to-many association you can handle this using has many relationships, -essentially using a foreign key for the single-valued end of the association. -But a many-to-many association can't do this because there is no single-valued end to -hold the foreign key. -

-

-The answer is the classic resolution that's been used by relational data people -for decades: create an extra table (an association table) to record the relationship. -The basic idea is using an association table to store the association. This table -has only the foreign key IDs for the two tables that are linked together, it has one -row for each pair of associated objects. -

-

-The association table has no corresponding in-memory object and its primary key is the -compound of the two primary keys of the tables that are associated. -In simple terms, to load data from the association table you perform two queries (in general, it may also be achieved using one query consisting of joins). -Consider loading the SkillRecord collection for a list PlayerRecord objects. -In this case, you do queries in two stages. -The first stage queries the Players table to find all the rows of the players you want. -The second stage finds the SkillRecord object for the related player ID for each row -in the Player_Skills association table using an inner join. -

- -

The Prado Active Record design implements the two stage approach. For the -Players-Skills M-N (many-to-many) entity relationship, we -define a many-to-many relationship in the PlayerRecord class and -in addition we may define a many-to-many relationship in the SkillRecord class as well. -The following sample code defines the complete SkillRecord class with a -many-to-many relationship with the PlayerRecord class. (See the PlayerRecord -class definition above to the corresponding many-to-many relationship with the SkillRecord class.) -

- - -class SkillRecord extends TActiveRecord -{ - const TABLE='Skills'; - public $skill_id; - public $name; - - public $players=array(); // this declaration is no longer needed since v3.1.2 - - public static $RELATIONS=array - ( - 'players' => array(self::MANY_TO_MANY, 'PlayerRecord', 'Player_Skills'), - ); - - public static function finder($className=__CLASS__) - { - return parent::finder($className); - } -} - - -

-The static $RELATIONS property of SkillRecord defines that the -property $players has many PlayerRecords via an association table 'Player_Skills'. -In array(self::MANY_TO_MANY, 'PlayerRecord', 'Player_Skills'), the first element defines the -relationship type, in this case self::MANY_TO_MANY, -the second element is a string 'PlayerRecord' that corresponds to the -class name of the PlayerRecord class, and the third element is the name -of the association table name. -

- -
Note: -Prior to version 3.1.2 (versions up to 3.1.1), the many-to-many relationship was -defined using self::HAS_MANY. For version 3.1.2 onwards, this must be changed -to self::MANY_TO_MANY. This can be done by searching for the HAS_MANY in your -source code and carfully changing the appropriate definitions. -
- -

-A list of player objects with the corresponding collection of skill objects may be fetched as follows. -

- -$players = PlayerRecord::finder()->withSkills()->findAll(); - -

-The method with_xxx() (where xxx is the relationship property -name, in this case, Skill) fetches the corresponding SkillRecords using -a second query (not by using a join). The with_xxx() accepts the same -arguments as other finder methods of TActiveRecord. -

- -

Self Referenced Association Tables

-

-For self referenced association tables, that is, the association points to the same -table. For example, consider the items table with M-N related -item via the related_items association table. The syntax in the following -example is valid for a PostgreSQL database. For other database, consult their respective documentation for -defining the foreign key constraints. - -CREATE TABLE items -( - "item_id" SERIAL, - "name" VARCHAR(128) NOT NULL, - PRIMARY KEY("item_id") -); -CREATE TABLE "related_items" -( - "item_id" INTEGER NOT NULL, - "related_item_id" INTEGER NOT NULL, - CONSTRAINT "related_items_pkey" PRIMARY KEY("item_id", "related_item_id"), - CONSTRAINT "related_items_item_id_fkey" FOREIGN KEY ("item_id") - REFERENCES "items"("item_id") - ON DELETE CASCADE - ON UPDATE NO ACTION - NOT DEFERRABLE, - CONSTRAINT "related_items_related_item_id_fkey" FOREIGN KEY ("related_item_id") - REFERENCES "items"("item_id") - ON DELETE CASCADE - ON UPDATE NO ACTION - NOT DEFERRABLE -); - - -

The association table name in third element of the relationship array may -contain the foreign table column names. The columns defined in the association -table must also be defined in the record class (e.g. the $related_item_id property -corresponds to the related_item_id column in the related_items table). -

- -class Item extends TActiveRecord -{ - const TABLE="items"; - public $item_id; - public $details; - - //additional foreign item id defined in the association table - public $related_item_id; - public $related_items=array(); // this declaration is no longer needed since v3.1.2 - - public static $RELATIONS=array - ( - 'related_items' => array(self::MANY_TO_MANY, - 'Item', 'related_items.related_item_id'), - ); -} - -
Tip: -Compound keys in the foreign table can -be specified as comma separated values between brackets. E.g. -'related_items.(id1,id2)'. -
- - - -

Lazy Loading Related Objects

- -
Note: -Implicitly declared related properties introduced in version 3.1.2 automatically have lazy -loading feature. Therefore, the lazy loading technique described in the following is no longer -needed in most of the cases, unless you want to manipulate the related objects through getter/setter. -
- -

Using the with_xxx() methods will load the relationship record on demand. Retrieving the -related record using lazy loading (that is, only when those related objects are accessed) can be -achieved by using a feature of the TComponent that provides accessor methods. In particular, -we define a pair of getter and setter methods where the getter method will retrieve the relationship -conditionally. The following example illustrates that the PlayerRecord can retrieve its -$skills foreign objects conditionally. -

- -class PlayerRecord extends BaseFkRecord -{ - //... other properties and methods as before - - private $_skills; //change to private and default as null - - public function getSkills() - { - if($this->_skills===null && $this->player_id !==null) - { - //lazy load the skill records - $this->setSkills($this->withSkills()->findByPk($this->player_id)->skills); - } - else if($this->_skills===null) - { - //create new TList; - $this->setSkills(new TList()); - } - - return $this->_skills; - } - - public function setSkills($value) - { - $this->_skills = $value instanceof TList ? $value : new TList($value); - } -} - -

We first need to change the $skills=array() declaration to a private property -$_skills (notice the underscore) and set it to null instead. This allows us -to define the skills property using getter/setter methods -(see Components for details). The getSkills() -getter method for the skills property will lazy load the corresponding skills foreign record -when it is used as follows. Notice that we only do a lazy load when its $player_id is -not null (that is, when the record is already fetched from the database or player id was already set). -

- -$player = PlayerRecord::finder()->findByPk(1); -var_dump($player->skills); //lazy load it on first access -var_dump($player->skills[0]); //already loaded skills property -$player->skills[] = new SkillRecord(); //add skill - - -

The setSkills() ensures that the skills property will always be a TList. -Using a TList allows us to set the elements of the skills property as if they were -arrays. E.g. $player->skills[] = new SkillRecord(). If array was used, a PHP error -will be thrown. -

- -

Column Mapping

-

-Since v3.1.1, Active Record starts to support column mapping. Column mapping allows developers -to address columns in Active Record using a more consistent naming convention. In particular, -using column mapping, one can access a column using whatever name he likes, rather than limited by -the name defined in the database schema. -

-

-To use column mapping, declare a static array named COLUMN_MAPPING in the Active Record class. -The keys of the array are column names (called physical column names) as defined in the database -schema, while the values are corresponding property names (called logical column names) defined -in the Active Record class. The property names can be either public class member variable names or -component property names defined via getters/setters. If a physical column name happens to be the same -as the logical column name, they do not need to be listed in COLUMN_MAPPING. -

- -class UserRecord extends TActiveRecord -{ - const TABLE='users'; - public static $COLUMN_MAPPING=array - ( - 'user_id'=>'id', - 'email_address'=>'email', - 'first_name'=>'firstName', - 'last_name'=>'lastName', - ); - public $id; - public $username; // the physical and logical column names are the same - public $email; - public $firstName; - public $lastName; - //.... -} - -

-With the above column mapping, we can address first_name using $userRecord->firstName -instead of $userRecord->first_name. This helps separation of logic and model. -

- -

References

- - - diff --git a/demos/quickstart/protected/pages/Database/pl/ar_objects.png b/demos/quickstart/protected/pages/Database/pl/ar_objects.png deleted file mode 100755 index ac33b88b..00000000 Binary files a/demos/quickstart/protected/pages/Database/pl/ar_objects.png and /dev/null differ diff --git a/demos/quickstart/protected/pages/Database/pl/ar_relations.png b/demos/quickstart/protected/pages/Database/pl/ar_relations.png deleted file mode 100755 index 48e29f48..00000000 Binary files a/demos/quickstart/protected/pages/Database/pl/ar_relations.png and /dev/null differ diff --git a/demos/quickstart/protected/pages/Database/pl/diagram.png b/demos/quickstart/protected/pages/Database/pl/diagram.png deleted file mode 100755 index 0a0ca73d..00000000 Binary files a/demos/quickstart/protected/pages/Database/pl/diagram.png and /dev/null differ diff --git a/demos/quickstart/protected/pages/Database/pl/object_states.png b/demos/quickstart/protected/pages/Database/pl/object_states.png deleted file mode 100755 index db194783..00000000 Binary files a/demos/quickstart/protected/pages/Database/pl/object_states.png and /dev/null differ diff --git a/demos/quickstart/protected/pages/Database/pl/sqlmap_active_record.png b/demos/quickstart/protected/pages/Database/pl/sqlmap_active_record.png deleted file mode 100755 index 6d958d33..00000000 Binary files a/demos/quickstart/protected/pages/Database/pl/sqlmap_active_record.png and /dev/null differ -- cgit v1.2.3