Tutorial ini memperkenalkan kerangka kerja aplikasi web Prado
ActiveRecord
dan Kontrol Aktif untuk membangun aplikasi web Chat. Diasumsikan bahwa Anda sudah terbiasa dengan PHP dan akan telah mengakses server web yang dapat melayani naskah PHP5.
Aplikasi chat dasar ini akan memanfaatkan ide/komponen berikut dalam Prado.
Membangun kelas kustom Manajer Pengguna.
Mengotentikasi dan menambahkan pengguna ke database.
Menggunakan ActiveRecord untuk berinteraksi dengan database.
Menggunakan Kontrol Aktif dan callbacks untuk menerapkan antarmuka pengguna.
Memisahkan logika aplikasi dan alur aplikasi.
Dalam tutorial ini Anda akan membangun sebuah aplikasi web Chat AJAX yang membolehkan
multipel pengguna untuk berkomunikasi melalui web browser mereka.
Aplikasi terdiri dari dua halaman: halaman masuk yang menanyakan pada
pengguna untuk memasukkan nama panggilannya dan halaman aplikasi chat utama.
Anda dapat mencoba aplikasi secara lokal atau di
Pradosoft.com.
Aplikasi chat utama ditampilkan di bawah ini.
class="figure" />
Download, Instalasi dan Buat Aplikasi Baru
Langkah download dan instalasi mirip dengan
Tutorial pengubah kurs.
Untuk membuat aplikasi, kita menjalankan dari baris perintah berikut.
Lihat Piranti Baris Perintah
untuk lebih jelasnya.
php prado/framework/prado-cli.php -c chat
Perintah di atas membuat struktur direktori yang diperlukan dan file minimal (termasuk "index.php" dan "Home.page") untuk menjalankan aplikasi web Prado.
Sekarang Anda dapat mengarahkan URL browser Anda ke server web untuk melayani
naskah index.php dalam direktori chat.
Anda seharusnya melihat pesan "Welcome to Prado!"
Otentikasi dan Otorisasi
Tugas pertama untuk aplikasi ini adalah memastikan bahwa setiap pengguna
dari aplikasi chat memiliki nama pengguna (dipilih oleh pengguna)
unik. Untuk melaksanakan ini, kita akan mengamankan halaman aplikasi chat utama
untuk menolak akses bagai pengguna anonim. Pertama, mari kita membuat halaman Login
dengan kode berikut. Kita simpan Login.php dan Login.page
dalam direktori chat/protected/pages/ (di sana harus ada file Home.page
yang dibuat oleh piranti baris perintah).
Halaman login berisi
a ,
a ,
a
dan . Halaman yang dihasilkan terlihat seperti berikut (setelah menerapkan beberapa style sheet).
class="figure" />
Jika Anda mengklik pada tombol Login tanpa memasukan teks
apapun dalam kotak teks nama pengguna, pesan kesalahan ditampilkan. Ini dikarenakan
memerlukan pengguna untuk memasukan beberapa teks dalam kotak teks sebelum melanjutkan.
Mengamankan halaman Home
Sekarang kita menginginkan bahwa jika pengguna mencoba untuk mengakses halaman aplikasi utama, Home.page, sebelum masuk, pengguna diberi Login.page lebih dulu. Kita menambahkan file konfigurasi chat/protected/application.xml untuk mengimpor beberapa kelas yang harus kita pakai nanti.
Selanjutnya, kita menambahkan file konfigurasi chat/protected/pages/config.xml guna mengamankan direktori pages.
Kita menyiapkan otentikasi menggunakan kelas standar seperti dijelaskan dalam
tutorial cepat otentikasi/otorisasi.
Dalam definisi otorisasi, kita membolehkan pengguna anonim untuk mengakses halaman Login (pengguna anonim dietapkan dengan the ? tanda tanya).
Kita membolehkan setiap pengguna dengan aturan yang sama dengan "normal" (didefinisikan nanti) untuk mengakses semua halaman, yakni halaman Login dan Home.
Terakhir, kita menolak semua pengguna tanpa aturan apapun untuk mengakses setiap halaman. Aturan otorisasi dijalankan pada basis sama pertama kali.
Jika Anda mencoba untuk mengakses halaman Home dengan mengarahkan browser Anda ke
index.php Anda akan dialihkan ke halaman Login.
Rekaman Aktif untuk tabel chat_users
Kelas
hanya menyediakan daftar pengguna hanya-baca. Kita perlu untuk bisa menambah atau memasukan pengguna baru secara dinamis. Maka kita perlu untuk membuat kelas manajer pengguna kita sendiri.
Pertama, kita menyiapkan database dengan tabel chat_users dan membuat sebuah ActiveRecord yang dapat bekerja pada tabel chat_users dengan mudah. Untuk demo, kita menggunakan sqlite sebagai database kita guna kemudahan menditribusikandemo. Demo dapat diperluas dengan mudah untuk memakai database lain seperti MySQL atau Postgres SQL.
Kita mendefinisikan tabel chat_users sebagai berikut.
CREATE TABLE chat_users
(
username VARCHAR(20) NOT NULL PRIMARY KEY,
last_activity INTEGER NOT NULL DEFAULT "0"
);
Selanjutnya kita mendefinisikan kelas ChatUserRecord dan menyimpannya sebagai chat/protected/App_Code/ChatUserRecord.php (Anda perlu untuk membuat direktori App_Code juga). Kita juga menyimpan file database sqlite sebagai App_Code/chat.db.
class ChatUserRecord extends TActiveRecord
{
const TABLE='chat_users';
public $username;
public $last_activity;
public static function finder($className=__CLASS__)
{
return parent::finder($className);
}
}
Sebelum menggunakan kelas ChatUserRecord kita perlu mengkonfigurasi koneksi database standar agar ActiveRecord berfungsi. Dalam chat/protected/application.xml
kita mengimpor kelas dari direktori App_Code dan menambahkan
modul konfigurasi ActiveRecord.
Kelas Manajer Pengguna Kustom
Untuk menerapkan modul kelas kustom manajer pengguna kita cukup memperluas kelas TModule dan menerapkan antarmuka IUserManager. Metode getGuestName(), getUser() dan validateUser() diperlukan oleh antarmuka IUserManager.
Kita menyimpan kelas manajer pengguna kustom sebagai App_Code/ChatUserManager.php.
class ChatUserManager extends TModule implements IUserManager
{
public function getGuestName()
{
return 'Guest';
}
public function getUser($username=null)
{
$user=new TUser($this);
$user->setIsGuest(true);
if($username !== null && $this->usernameExists($username))
{
$user->setIsGuest(false);
$user->setName($username);
$user->setRoles(array('normal'));
}
return $user;
}
public function addNewUser($username)
{
$user = new ChatUserRecord();
$user->username = $username;
$user->save();
}
public function usernameExists($username)
{
$finder = ChatUserRecord::finder();
$record = $finder->findByUsername($username);
return $record instanceof ChatUserRecord;
}
public function validateUser($username,$password)
{
return $this->usernameExists($username);
}
}
Metode getGuestName()
mengembalikan nama untuk pengguna tamu dan tidak dipakai dalam aplikasi kita.
Metode getUser() mengembalikan obyek TUser jika nama pengguna ada dalam database, obyek TUser disetel dengan aturan "normal"
yang terkait ke aturan <otorisasi> yang didefinisikan dalam file
config.xml kita.
Metode addNewUser() dan usernameExists()
menggunakan ActiveRecord terkait dengan tabel chat_users masing-masing untuk menambah pengguna baru dan untuk memeriksa apakah nama pengguna sudah ada atau belum.
Hal berikutnya yang dilakukan adalah mengubah konfigurasi config.xml untuk menggunakan kelas manajer pengguna kustom baru kita. Kita cukup mengubah konfigurasi <module>
dengan id="users".
Otentikasi
Untuk melakukan otentikasi, kita menginginkan pengguna untuk memasukkan nama pengguna unik. Kita menambahkan
untuk memvalidasi keunikan nama pengguna dan menambahkan pengendali event OnClick untuk tombol login.
<com:TCustomValidator
ControlToValidate="username"
Display="Dynamic"
OnServerValidate="checkUsername"
ErrorMessage="The username is already taken." />
...
<com:TButton Text="Login" OnClick="createNewUser" />
Dalam file Login.php, kita menambahkan 2 metode berikut.
function checkUsername($sender, $param)
{
$manager = $this->Application->Modules['users'];
if($manager->usernameExists($this->username->Text))
$param->IsValid = false;
}
function createNewUser($sender, $param)
{
if($this->Page->IsValid)
{
$manager = $this->Application->Modules['users'];
$manager->addNewUser($this->username->Text);
//do manual login
$user = $manager->getUser($this->username->Text);
$auth = $this->Application->Modules['auth'];
$auth->updateSessionUser($user);
$this->Application->User = $user;
$url = $this->Service->constructUrl($this->Service->DefaultPage);
$this->Response->redirect($url);
}
}
Metode checkUserName() menggunakan kelas ChatUserManager
(ingat bahwa dalam konfigurasi config.xml kita menyetel ID dari kelas manajer pengguna kustom sebagai "users") untuk memvalidasi nama pengguna belum dipakai.
Dalam metode createNewUser, Ketika validasi lulus (yaitu ketika nama pengguna belum dipakai) kita menambahkan pengguna baru. Setelah itu kita melakukan proses login secara manual:
Pertama kita peroleh turunan TUser dari kelas manajer
pengguna kita menggunakan metode $manager->getUser(...).
Menggunakan TAuthManager kita menetapkan/memutakhirkan obyek pengguna dalam data sesi saat ini.
Kemudian kita menetapkan/memutakhirkan turunan APlikasi pengguna dengan obyek pengguna baru kita.
Akhirnya, kita mengalihkan klien ke halaman standar Home.
Nilai Standar untuk ActiveRecord
Jika Anda mencoba untuk melakukan login sekarang, Anda akan menerima pesan kesalahan seperti
"Property 'ChatUserRecord::$last_activity' must not be null as defined
by column 'last_activity' in table 'chat_users'.". Ini berarti bahwa nilai properti $last_activity adalah null dalam kolom terkait pada tabel dan memboleh nilai null atau menetapkan nilai standar dalam kelas ChatUserRecord. Kita akan mendemonstrasikannya nanti dengan mengubah ChatUserRecord dengan tambahan dari metode setelan pengambil/pengetap untuk properti last_activity.
private $_last_activity;
public function getLast_Activity()
{
if($this->_last_activity === null)
$this->_last_activity = time();
return $this->_last_activity;
}
public function setLast_Activity($value)
{
$this->_last_activity = $value;
}
Catatan bahwa kita mengganti nama $last_activity menjadi $_last_activity (perhatikan garis bawah setelah tanda dolar).
Aplikasi Chat Utama
Sekarang kita siap untuk membangun aplikasi chat utama. Kita menggunakan tata letak sederhana yang terdiri dari satu panel yang menampung pesan chat, satu panel untuk menampung daftar pengguna, area teks untuk pengguna memasukan pesan teks dan tombol untuk mengirimkan pesan.
Prado Chat Demo
<com:TForm>
</com:TForm>
<com:TJavascriptLogger />
Kita menambahkan dua komponen Kontrol Aktif: a
dan
.
Kita juga menambahkan
yang akan sangat berguna untuk mengerti bagaimana Kontrol Aktif bekerja.
Menjelajah Kontrol Aktif
Kita sudah mempunyai beberapa kesenangan sebelum kita melanjutkan dengan penyiapan bufer chat. Kita ingin melihat bagaimana kita dapat memutakhirkan halaman saat ini ketika kita menerima sebuah pesan. Pertama, kita menambahkan sebuah tombol
OnClick event handler for the Send.
<com:TActiveButton ID="sendButton" CssClass="send-button"
Text="Send" OnClick="processMessage"/>
Dan metode pengendali event terkait dalam kelas Home.php (kita perlu untuk membuat file baru ini juga).
class Home extends TPage
{
function processMessage($sender, $param)
{
echo $this->userinput->Text;
}
}
Jika Anda sekarang mengetikan sesuatu dalam kotak teks aplikasi utama dan mengklik tombol kirim, Anda seharusnya melihat apapun yang Anda ketikan muncul dalam konsol TJavascriptLogger.
Untuk menambah atau menambahkan beberapa konten ke panel daftar pesan, kita perlu memakai beberapa metode dalam kelas
yang tersedia melalui properti CallbackClient property dari obyek TPage saat ini. Sebagai contoh, kita kita dapat melakukan
function processMessage($sender, $param)
{
$this->CallbackClient->appendContent("messages", $this->userinput->Text);
}
Ini adalah satu cara untuk memutakhirkan beberapa bagian dari halaman yang sudah ada selama callback (AJAX style event) dan akan menjadi cara utama yang akan kita gunakan untuk menerapkan aplikasi chat.
Rekaman Aktif untuk tabel chat_buffer
Untuk mengirimkan pesan ke seluruh pengguna yang tersambung kita memerlukan bufer atau menyimpan pesan untuk setiap pengguna. Kita dapat menggunakan database untuk membufer pesan. Tabel
chat_buffer didefinisikan sebagai berikut.
CREATE TABLE chat_buffer
(
id INTEGER PRIMARY KEY,
for_user VARCHAR(20) NOT NULL,
from_user VARCHAR(20) NOT NULL,
message TEXT NOT NULL,
created_on INTEGER NOT NULL DEFAULT "0"
);
Kelas ChatBufferRecord terkait disimpan sebagai
App_Code/ChatBufferRecord.php.
class ChatBufferRecord extends TActiveRecord
{
const TABLE='chat_buffer';
public $id;
public $for_user;
public $from_user;
public $message;
private $_created_on;
public function getCreated_On()
{
if($this->_created_on === null)
$this->_created_on = time();
return $this->_created_on;
}
public function setCreated_On($value)
{
$this->_created_on = $value;
}
public static function finder($className=__CLASS__)
{
return parent::finder($className);
}
}
Logika Aplikasi Chat
Akhirnya kita tiba di kanal logika aplikasi chat. Pertama, kita perlu menyimpan pesan yang diterima ke dalam bufer chat untuk semua pengguna saat ini. Kita menambahkan logika ini dalam kelas ChatBufferRecord.
public function saveMessage()
{
foreach(ChatUserRecord::finder()->findAll() as $user)
{
$message = new self;
$message->for_user = $user->username;
$message->from_user = $this->from_user;
$message->message = $this->message;
$message->save();
if($user->username == $this->from_user)
{
$user->last_activity = time(); //update the last activity;
$user->save();
}
}
}
Terlebih dahulu kita mencari semua pengguna saat ini menggunkan metode penemu ChatUserRecord. Kemudian kita gandakan pesan dan menyompannya ke dalam database. Sebagai tambahan, kita mutakhirkan cap waktu aktivitas terakhir pengirim pesan. Kode di atas memperlihatkan kesederhanaan dan keringkasan dari penggunaan ActiveRecords untuk desain database sederhana.
Logika berikutnya adalah untuk mengambil pesan pengguna dari bufer.
Kita cukup mengambil semua pesan untuk nama pengguna tertentu dan membentuk pesan itu secar benar (ingat untuk meng-escape output guna menghindari serangan Penaskahan Situs-Silang).
Setelah kita ambil pesan, kita hapus pesan yang diambil dan pesan lainnya yang lebih lama yang mungkin tertinggal dalam bufer.
public function getUserMessages($user)
{
$content = '';
foreach($this->findAll('for_user = ?', $user) as $message)
$content .= $this->formatMessage($message);
$this->deleteAll('for_user = ? OR created_on < ?',
$user, time() - 300); //5 min inactivity
return $content;
}
protected function formatMessage($message)
{
$user = htmlspecialchars($message->from_user);
$content = htmlspecialchars($message->message);
return "
{$user}:"
." {$content}
";
}
Untuk mengambil daftar dari pengguna saat ini (terformat), kita menambahkan logika kelas ini
ChatUserRecord. Kita menghapus setiap pengguna yang sudah tidak aktif untuk beberapa waktu.
public function getUserList()
{
$this->deleteAll('last_activity < ?', time()-300); //5 min inactivity
$content = '
';
foreach($this->findAll() as $user)
$content .= '
'.htmlspecialchars($user->username).'
';
$content .= '
';
return $content;
}
Catatan:
Untuk kemudahan kita membentuk pesan dalam kelas Rekaman Aktif. Untuk aplikasi besar, tugas pembentukan pesan ini harus dilakukan menggunakan komponen Prado (contohnya menggunakan TRepeater dalam template atau komponen kustom).
Menyatukan Semuanya
Sekarang waktunya untuk menyatukan alur aplikasi secara keseluruhan. Dalam Home.php kita memutakhirkan tombol Send pengendali event OnClick untuk menggunakan logika aplikasi yang baru saja kita implementasikan.
function processMessage($sender, $param)
{
if(strlen($this->userinput->Text) > 0)
{
$record = new ChatBufferRecord();
$record->message = $this->userinput->Text;
$record->from_user = $this->Application->User->Name;
$record->saveMessage();
$this->userinput->Text = '';
$messages = $record->getUserMessages($this->Application->User->Name);
$this->CallbackClient->appendContent("messages", $messages);
$this->CallbackClient->focus($this->userinput);
}
}
Kita cukup menyimpan pesan ke bufer chat dan kemudian meminta semua pesan untuk pengguna saat ini dan memutakhirkan pesan sisi klien menggunakan respon callback
(gaya AJAX).
Pada titik ini aplikasi sebenarnya sudah berfungsi, cuma tidak bersahabat. Jika Anda membuka dua browser berbeda, Anda seharusnya bisa berkomunikasi diantara dua pengguna kapan saja tombol Send diklik.
Bagian berikutnya barangkali lebih rumit dan mengakali daripada tugas lainnya. Kita perlu untuk meningkatkan pengalaman pengguna. Pertama, kita menginginkan daftar pengguna saat ini juga. Maka kita menambahkan metode berikut ke Home.php, kita dapat memanggil metode ini kapan saja beberapa event callback dimunculkan, misalnya saat tombol Send diklik.
protected function refreshUserList()
{
$lastUpdate = $this->getViewState('userList','');
$users = ChatUserRecord::finder()->getUserList();
if($lastUpdate != $users)
{
$this->CallbackClient->update('users', $users);
$this->setViewstate('userList', $users);
}
}
Sebenarnya, kita menginginkan untuk secara
periodik memutakhirkan pesan dan daftar pengguna saat pengguna baru bergabung
dan pesan baru yang datang dari pengguna lainnya. Maka kita perlu untuk menyegarkan
daftar pesan juga.
function processMessage($sender, $param)
{
...
$this->refreshUserList();
$this->refreshMessageList();
...
}
protected function refreshMessageList()
{
//refresh the message list
$finder = ChatBufferRecord::finder();
$content = $finder->getUserMessages($this->Application->User->Name);
if(strlen($content) > 0)
{
$anchor = (string)time();
$content .= "";
$this->CallbackClient->appendContent("messages", $content);
$this->CallbackClient->focus($anchor);
}
}
Jangkar menggunakan time() sebagai ID untuk titik fokus agar saat daftar
pesan pada sisi klien diperoleh sangat lama, metode fokus akan menggulung daftar
pesan ke pesan terbaru (ini bekerja baik pada umumnya browser).
Selanjutnya, kita perlu mengalihkan pengguna
kembali ke halaman login jika pengguna tidak aktif untuk beberapa waktum
katakanlah 5 menit, kita menambahkan pemeriksaan ini ke setiap tahap dari masa hidup
halaman. Mari menambahkannya ke tahapan onLoad().
public function onLoad($param)
{
$username = $this->Application->User->Name;
if(!$this->Application->Modules['users']->usernameExists($username))
{
$auth = $this->Application->Modules['auth'];
$auth->logout();
//redirect to login page.
$this->Response->Redirect($this->Service->ConstructUrl($auth->LoginPage));
}
}
Memperbaiki Pengalaman Pengguna
Beberapa rincian terakhir secara periodeik memeriksa
pesan baru dan menyegarkan daftar pengguna. Kita bisa melakukan ini dengan menanyakan
server menggunakan kontrol
.
Kita menambahkan tt>TTimeTriggeredCallback ke Home.page dan memanggil
metode pengendali refresh yang didefinisikan dalam Home.php.
Kita setel interval pertanyaan menjadi 2 detik.
<com:TTimeTriggeredCallback OnCallback="refresh"
Interval="2" StartTimerOnLoad="true" />
function refresh($sender, $param)
{
$this->refreshUserList();
$this->refreshMessageList();
}
Langkah terakhir memerlukan kita untuk menggunakan beberapa javascript. Kita menginginkan bahwa saat pengguna mengetikan beberapa teks dalam area teks dan menekan tombol Enter, kita menginginkannya untuk mengirimkan pesan tanpa mengklik tombol Send. Kita menambahkan beberapa javascript ke
Home.page.
<com:TClientScript>
Event.observe($("<%= $this->userinput->ClientID %>"), "keypress", function(ev)
{
if(Event.keyCode(ev) == Event.KEY_RETURN)
{
if(Event.element(ev).value.length > 0)
new Prado.Callback("<%= $this->sendButton->UniqueID %>");
Event.stop(ev);
}
});
</com:TClientScript>
Rincian sehubungan dengan javascript bisa dilihat dalam seksi
Pengenalan Javascript pada tutorial cepat.
Ini melengkapi tutorial untuk membuat aplikasi chat web menggunakan kerangka kerja Prado. Diharapkan Anda menikmatinya.