Rekaman Aktif

Tersedia mulai dari Prado versi 3.1a dan selanjutnya.

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. Rekaman Aktif dan SqlMap DataMapper

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.

<modules>
  <module class="System.Data.ActiveRecord.TActiveRecordConfig" EnableCache="true">
    <database ConnectionString="pgsql:host=localhost;dbname=test"
        Username="dbuser" Password="dbpass" />
  </module>
</modules>
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.

<modules>
  <module class="System.Data.TDataSourceConfig" id="db1">
    <database ConnectionString="pgsql:host=localhost;dbname=test"
        Username="dbuser" Password="dbpass" />
  </module>
 
  <module class="System.Data.ActiveRecord.TActiveRecordConfig" 
        ConnectionID="db1" EnableCache="true"  />
 
  <module class="System.Data.SqlMap.TSqlMapConfig"
        ConnectionID="db1"  ... />
</modules>

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 API Manual 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 TMssqlCommandBuilder 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.

Active Records Life Cycle

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

Tersedia mulai dari Prado versi 3.1rc1 dan selanjutnya.

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.

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

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