Panada Framework 1.0.0 Documentation

Inisialisasi

Untuk menggunakan Active Record pastikan konfigurasi koneksi ke database sudah benar. Untuk detail panduan koneksi database, silahkan klik di halaman configuration.

Class Model

Untuk menggunakan Active Record Anda harus membuat sebuah class model yang di extend ke class Resources\ActiveRecord. Setiap class yang dibuat mewakili sebuah tabel yang ada di database. Berikut adalah contoh model dari tabel users:

<?php namespace Models; use Resources; class Users extends Resources\ActiveRecord { public function __construct(){ call_user_func_array( 'parent::__construct', func_get_args() ); } }

Nama Tabel

Secara default, nama tabel yang akan digunakan mengikuti nama class model. Sebagai contoh jika nama classnya adalah Users, maka nama tabel yang diwakili adalah users dan jika nama modelnya adalah Comments maka class ini mewakili tabel comments.

Namun Anda juga bisa menentukan nama lain yang tidak sama dengan nama class. Untuk melakukan hal ini Anda bisa mendeklarasikannya di properti $this->table. Berikut adalah contohnya:

<?php namespace Models; use Resources; class Users extends Resources\ActiveRecord { public function __construct(){ call_user_func_array( 'parent::__construct', func_get_args() ); $this->table = 'table_name'; } }

Primary Key

Setiap class model membutuhkan properti primaryKey. Secara default Panada menggunakan nama id, namun Anda bisa menggunakan nama lain untuk konfigurasi ini. Berikut adalah contoh mendefenisikan nama primary key sesuai dengan nama yang ada di tabel:

<?php namespace Models; use Resources; class Posts extends Resources\ActiveRecord { public function __construct(){ $this->primaryKey = 'table_key'; call_user_func_array( 'parent::__construct', func_get_args() ); } }

Koneksi

Jika Anda memiliki koneksi database lebih dari satu dan ingin menggunakan koneksi tersebut pada class model ini, Anda bisa menggunakannya dengan memberikan nama koneksinya pada properti $this->connection. Berikut adalah contohnya:

<?php namespace Models; use Resources; class Posts extends Resources\ActiveRecord { public function __construct(){ $this->connection = 'dbconnection2'; call_user_func_array( 'parent::__construct', func_get_args() ); } }

Cara lain yang bisa digunakan tanpa perlu mendeklarasikannya di dalam class model adalah dengan meberikan argument string nama koneksi ketika membuat instance class model.

$users = new Models\Users( 'dbconnection2' );

Penggunaan

Tabel Contoh

Untuk mempermudah penjelasan setiap feature yang ada, berikut adalah tabel contoh yang digunakan dalam dokumentasi ini.

CREATE TABLE users ( id INTEGER NOT NULL AUTO_INCREMENT, name varchar(50) NOT NULL, email varchar(50) NOT NULL, password varchar(32) NOT NULL, PRIMARY KEY (id) ) ; CREATE TABLE profiles ( id INTEGER NOT NULL AUTO_INCREMENT, user_id INTEGER NOT NULL, description text NOT NULL, PRIMARY KEY (id) ); CREATE TABLE posts ( id INTEGER NOT NULL AUTO_INCREMENT, post_author INTEGER NOT NULL, title varchar(200) NOT NULL, post text NOT NULL, PRIMARY KEY (id) ); CREATE TABLE categories ( id INTEGER NOT NULL AUTO_INCREMENT, name varchar(200) NOT NULL, PRIMARY KEY (id) ); CREATE TABLE post_category ( post_id INTEGER NOT NULL, category_id INTEGER NOT NULL );

Sebelum proses manipulasi database dilakukan, Anda harus mendeklarasikan instance class yang namanya sesuai dengan nama tabel.

<?php namespace Controller; use Resources, Models; class Home extends Resources\Controller { public function __construct(){ parent::__construct(); } public function index(){ // Tabel users $users = new Models\Users; } }

Save

Untuk menyimpan data baru ada dua cara yang bisa dilakukan. Cara pertama:

$users = new Models\Users; $users->name = 'Budi'; $users->email = 'budi@budi.com'; $users->password = 'mypassword'; $users->save();

Atau dengan cara yang lebih cepat:

$users = new Models\Users( array('name' => 'Budi', 'email' => 'budi@budi.com', 'password' => 'mypassword') );

Kedua cara di atas merepresentasikan SQL:

INSERT INTO users (name, email, password) VALUES ('Budi', 'budi@budi.com', 'mypassword')

Jika argument pertama berupa array, maka jika diinginkan argument ke dua bisa diisikan nama koneksi database yang digunakan.

$users = new Models\Users( array('name' => 'Budi', 'email' => 'budi@budi.com', 'password' => 'mypassword'), 'dbconnection2' );

Find

Secara default method find() tanpa argument apapun akan menampilkan semua data yang ada di dalam tabel.

$users = new Models\Users;
print_r( $users->get() );

Untuk mendapatkan data dengan id 28, bisa dilakukan dengan cara:

$users = new Models\Users;
print_r( $users->get(28) );

Method ini merepresentasikan output SQL:

SELECT * FROM users WHERE id = 28

Atau jika ingin mendapatkan beberapa data sekaligus:

$users = new Models\Users;
print_r( $users->get(1,2,3) );

Method ini merepresentasikan output SQL:

SELECT * FROM users WHERE id IN (1, 2, 3)

Find First

Mendapatkan record pertama dari tabel:

$users = new Models\Users;
print_r( $users->first() );

Method ini merepresentasikan output SQL:

SELECT * FROM users ORDER BY id ASC LIMIT 1

Find Last

Mendapatkan record terakhir dari tabel:

$users = new Models\Users;
print_r( $users->last() );

Method ini merepresentasikan output SQL:

SELECT * FROM users ORDER BY id DESC LIMIT 1

Dynamic Finder

Cara lainnya adalah menggunakan Dynamic Finder. Cara ini ditujukan untuk mendapatkan record berdasarkan nama kolom tertentu.

Gunakan method getBy dan dikuti dengan nama_kolom yang akan dijadikan kriteria. Berikut adalah contohnya:

$users = new Models\Users; print_r( $users->getByemail( 'foo@fooweb.com' ) ); //SELECT * FROM users WEHRE email = 'foo@fooweb.com' print_r( $users->getByname( 'Rasmus Lerdorf' ) ); //SELECT * FROM users WEHRE title = 'Rasmus Lerdorf' print_r( $users->getBycategory_id( 5 ) ); //SELECT * FROM users WEHRE category_id = 5

Jika data yang ditemukan hanya satu, maka nilai returnnya hanya sebuah object tunggal. Dan jika lebih dari satu, maka nilai returnya terdiri dari beberapa array object.

Condition

Untuk memfilter data berdasarkan kriteria tertentu, method condition() bisa digunakan.

object condition( string $column, string $operator, string $value, mix $seperator = false);

Parameter

Variable	Tipe Data	Keterangan
$column	string	Nama kolom yang menjadi kriteria penyeleksian.
$operator	string	Operator SQL: IN, BETWEEN, >, =<, !=
$value	string | array	Nilai yang akan dibandingkan dengan kolom.
$seperator	mix	Operator pemisah antara kondisi sebelum dan kondisi sesudah. Contoh: OR, AND

Berikut contoh penggunaan method ini:

$users = new Models\Users; $users->condition('id', '>', 1, 'and'); $users->condition('id', '<', 12); print_r($users->get());

Select

Untuk mendapatkan beberapa kolom dari tabel:

$users = new Models\Users;
$users->select('name');
print_r($users->get());

Limit Offset

object limit( int $limit , int $offset = null );

Berikut contoh penggunaanya:

$users = new Models\Users;
$users->limit(10);
print_r($users->get());

Order

object order( string $column , string $order = null );

Contoh penggunaan method order():

$users = new Models\Users;
$users->order('id', 'desc');
$users->limit(10);
print_r($users->get());

Group

object group( string $column1, $column2, $column3 ... );

Contoh penggunaan method group():

$users = new Models\Users;
$users->group('id', 'name');
$users->order('id', 'desc');
$users->limit(10);
print_r($users->get());

Update

Untuk memperbaharui data dengan id 28 caranya adalah:

$users = new Models\Users; $users->get(28); $users->name = 'Jhon Budi'; $users->password = 'mynewpassword'; $users->save();

Method ini merepresentasikan output SQL:

UPDATE users SET name = 'Jhon Budi', password = 'mynewpassword' WHERE id =28

Cara di atas adalah dengan me-load data terlebih dahulu, dalam hal ini id 28. Untuk melakukan update tanpa perlu meload data cara yang bisa dilakukan adalah:

$users = new Models\Users; $users->name = 'Jhon Budi'; $users->password = 'mynewpassword'; $users->update(28);

Cara lainnya:

$users = new Models\Users; $users->name = 'Jhon Budi'; $users->password = 'mynewpassword'; $users->update( array( 'id' => '28' ) );

Update dengan kondisi:

$users = new Models\Users; $users->name = 'Jhon Budi'; $users->password = 'mynewpassword'; $users->condition('id', '>', 1, 'AND'); $users->condition('id', '<', 3); $users->update();

Delete

Berikut adalah cara untuk menghapus data dengan id 28:

$users = new Models\Users;
$users->delete(28);

Method ini merepresentasikan output SQL:

DELETE FROM table_name WHERE id = 28

Cara alternatif:

$users = new Models\Users; $users->delete( array('id' => '14') ); // or $users->condition('id', '>', 11, 'and'); $users->condition('id', '<', 14); $users->delete();

Relational Active Record

Panada Active Record juga mendukung Object Relasional. Tipe relasional yang sudah didukung adalah BELONGS_TO, HAS_MANY, HAS_ONE dan MANY_MANY. Object Relasional digunakan untuk melakukan relasi tabel database antara satu model dengan model lainnya.

Untuk melakukan konfigurasi relasi, Anda harus membuat sebuah method bernama relations() di dalam class model dengan isi seperti berikut:

<?php namespace Models; use Resources; class Posts extends Resources\ActiveRecord { public function __construct(){ call_user_func_array( 'parent::__construct', func_get_args() ); } public function relations(){ return array( 'author' => array(self::BELONGS_TO, 'users', 'post_author') ); } }

Dimana nilai array yang harus diisikan adalah:

return array( string 'nama_properti' => array( int self::TIPE_RELASI, string 'NamaModel', string 'foreignKey' ) );

Keterangan

Variable	Tipe Data	Keterangan
nama_properti	string	Adalah nama properties yang akan digunakan untuk memanggil model yang menjadi relasi.
self::TIPE_RELASI	int	Pilihan tipe relasi. Terdiri dari: self::BELONGS_TO, self::HAS_ONE, self::HAS_MANY dan self::MANY_MANY.
NamaModel	string	Nama class dari model yang akan direlasikan.
foreignKey	string | array	Nama kolom dari tabel yang merelasikan dengan sebuah model.

Belongs To

Relasi BELONGS_TO menunjukan relasi sebuah model yang memiliki satu nilai atau lebih terhadap sebuah model lain yang memiliki satu nilai. Contoh relasi ini adalah sejumlah artikel yang ada di dalam tabel posts yang dimiliki oleh satu orang penulis yang ada di tabel users.

Berikut adalah contoh dari model posts yang berelasi BELONGS_TO terhadap model users.

Model posts:

<?php namespace Models; use Resources; class Posts extends Resources\ActiveRecord { public function __construct(){ call_user_func_array( 'parent::__construct', func_get_args() ); } public function relations(){ return array( 'author' => array(self::BELONGS_TO, 'users', 'post_author'), 'categories' => array(self::MANY_MANY, 'categories', array('post_category', 'category_id', 'post_id') ) ); } }

Model users:

<?php namespace Models; use Resources; class Users extends Resources\ActiveRecord { public function __construct(){ call_user_func_array( 'parent::__construct', func_get_args() ); } public function relations(){ return array( 'posts' => array(self::HAS_MANY, 'posts', 'post_author'), 'profile' => array(self::HAS_ONE, 'profiles', 'user_id') ); } }

Berikut adalah contoh penggunaan model posts di dalam controller:

<?php namespace Controllers; use Resources, Models; class Home extends Resources\Controller { public function __construct(){ parent::__construct(); } public function index(){ $posts = new Models\Posts; $data = $posts->get(10); if( $data ) { // Output artikel dengan id 10 echo 'id: '.$data->id.' Title: '.$data->title.'<br />'; // Output penulis dari artikel ber id 10 print_r($posts->author); } } public function allPosts(){ $posts = new Models\Posts; $data = $posts->get(); foreach($data as $post){ echo $post->title . ' Writen by: ' . $post->author->name . '<br />'; } } }

Has Many

Pada contoh di atas, relasi dilihat dari sudut pandang model posts. Contoh yang sama bisa juga diterapkan pada relasi HAS_MANY, tetapi yang membedakan adalah sudut pandang relasi dilihat dari model users.

Seorang user atau penulis dapat dipastikan bisa memiliki post atau artikel lebih dari satu.

Berikut adalah contoh penggunaan relasi HAS_MANY di dalam controller:

<?php namespace Controllers; use Resources, Models; class Home extends Resources\Controller { public function __construct(){ parent::__construct(); } public function index(){ $user = new Models\Users; $data = $user->get(20); // Output data user dengan id 20 print_r($data); // Listing semua post dari user dengan id 20 foreach( $user->posts->get() AS $post) echo $post->title . '<br />'; } public function postsSelection(){ $users = new Models\Users; $users->get(20); $posts = $users->posts; /** * Object post yang sudah didapat bisa * diolah dan dimanipuliasi dengan method-method * yang sudah tersedia pada library Active Record * seperti select(), condition(), group(), order(), * limit() dll... */ // Pilih hanya id dan title saja $posts->select('id', 'title'); // WHERE kriteria $posts->condition('status', '=', 'publish', 'and'); $posts->condition('id', '>', 100); // Urutkan berdasarkan tanggal $posts->order('post_date', 'desc'); // Tampilkan 10 terbaru $posts->limit(10); foreach( $posts->get() AS $post) echo 'ID: '. $post->id .' Title: '. $post->title . '<br />'; } }

Has One

Relasi HAS_ONE adalah relasi sebuah record yang hanya berrelasi dengan sebuah record dari model yang lain. Contohnya adalah, tabel user berelasi dengan tabel profile. Dalam contoh ini seorang user hanya memiliki satu record data di dalam tabel profile.

Pada contoh class model users di atas, selain relasi HAS_MANY terhadap model posts, kita juga melihat relasi lain yaitu HAS_ONE terhadap model profiles. Untuk itu, kita membutuhkan satu buah model lagi yang bernama profiles.

Model profiles:

<?php namespace Models; use Resources; class Profiles extends Resources\ActiveRecord { public function __construct(){ call_user_func_array( 'parent::__construct', func_get_args() ); } }

Berikut adalah contoh penggunaan relasi HAS_ONE model users terhadap model profiles di dalam controller:

<?php namespace Controllers; use Resources, Models; class Home extends Resources\Controller { public function __construct(){ parent::__construct(); } public function index(){ $user = new Models\Users; // Tampilkan semua data user dengan id 3 yang ada di tabel users. print_r($user->get(3)); echo '<br />'; // Tampilkan semua profile user dengan id 3 yang ada di tabel profiles. print_r($user->profile); } }

Many Many

Relasi MANY_MANY adalah kombinasi BELONGS_TO dan HAS_MANY. Sebagai contoh, post atau artikel bisa memiliki banyak kategori. Dan begitupula bila dilihat dari sudut pandang yang lain, kategori bisa memiliki lebih dari satu post atau artikel.

Untuk melakukan relasi ini, dibutuhkan sebuah tabel bantuan yang menghubungkan antara tabel posts dan categories. Tabel ini sebagai contoh kita beri nama post_category, yang kolomnya terdiri dari post_id dan category_id.

Untuk menjalankan relasi ini, dibutuhkan sebuah class model yang bernama Categories. Berikut contohnya:

<?php namespace Models; use Resources; class Categories extends Resources\ActiveRecord { public function __construct(){ call_user_func_array( 'parent::__construct', func_get_args() ); } public function relations(){ return array( 'posts' => array(self::MANY_MANY, 'posts', array('post_category', 'post_id', 'category_id') ) ); } }

Yang perlu diperhatikan adalah array dari nilai return method condition. Parameter forignKey diisikan dengan data array seperti contoh berikut:

return array(
     string 'nama_properti' => array(
          int self::MANY_MANY,
          string 'nama_model',
          array array( string 'tabel_penghubung', string 'forignKey1', string 'forignKey2' )
     )
);

Dan kalau kita lihat kembali konfigurasi method relations() Model Posts yang berelasi terhadap Cetegories, nilainya adalah kebalikan dari konfigurasi di atas.

'categories' => array(self::MANY_MANY, 'Categories', array('post_category', 'category_id', 'post_id') )

Berikut adalah contoh penggunaan relasi MANY_MANY di dalam controller:

<?php namespace Controllers; use Resources; class Home extends Resources\Controller { public function __construct(){ parent::__construct(); } public function index(){ $posts = new Models\posts; // Dapatkan artikel dengan id 76 $post = $posts->get(76); $categories = $post->categories; // Tampilkan semua kategori dari artikel ber id 76 foreach($categories->get() as $category) echo $category->name.'<br />'; } public function getPostsByCategory(){ $categories = new Models\Categories; // Dapatkan kategori ber id 3 $category = $categories->get(3); $posts = $category->posts; // Tampilkan semua artikel dengan kategori yang ber id 3 foreach($posts->get() as $post) echo $post->title.'<br />'; } }

Diskusi