Panada PHP Framework 1.0.0 Documentation

Form Validation

Hal yang paling umum dilakukan pada aplikasi berbasis web adalah mengumpulkan data dari user. Data dikumpulkan melalui satu atau lebih form HTML. Data yang sudah terkumpul harus diolah, divalidasi dan kemudian ditampilkan pesan error jika ada data yang tidak sesuai.

Untuk mempermudah proses ini, Panada telah menyediakan tools validasi yang bisa digunakan untuk mempercepat pengolahan data yang bersumber dari form HTML.

Validation Rule

Petama-tama harus dibuat validation rule yang diletakkan di dalam sebuah class model. Class model ini harus extend dari class Resources\Validation. List rule di tempatkan pada sebuah method dengan nama setRules. Berikut adalah contoh rule untuk form registration:

<?php
namespace Models;
use
    Resources;

class Registration extends Resources\Validation {
    
    public function setRules()
    {
        return array(
            'name' => array(
                'rules' => array(
                    'required',
                    'min' => 3
                ),
                'label' => 'Full Name',
                'filter' => array('trim', 'strtolower', 'ucwords')
            ),
            'username' => array(
                'rules' => array(
                    'required',
                    'min' => 3,
                    'max' => 10,
                    'regex' => '/^([-a-z0-9_-])+$/i',
                    'callback' => 'usernameExists'
                ),
                'label' => 'Username',
                'filter' => array('trim', 'strtolower')
            ),
            'email' => array(
                'rules' => array(
                    'required',
                    'min' => 3,
                    'email',
                    'callback' => 'emailExists'
                ),
                'label' => 'Email',
                'filter' => array('trim', 'strtolower')
            ),
            'password' => array(
                'rules' => array(
                    'required',
                    'min' => 5,
                    'compare' => 'repassword'
                ),
                'label' => 'Password'
            ),
            'repassword' => array(
                'rules' => array(
                    'required'
                ),
                'label' => 'Retype Password'
            ),
            'photo' => array(
                'rules' => array(
                    'file'
                ),
                'label' => 'Profile Pic'
            )
        );
    }
    
    public function usernameExists($field, $value, $label)
    {
        if( $value != 'admin' )
            return true;
        
        $this->setErrorMessage($field, 'Username already exists.');
        
        return false;
    }
    
    public function emailExists($field, $value, $label)
    {
        if( $value != 'admin@site.com' )
            return true;
        
        $this->setErrorMessage($field, 'Email already exists.');
        
        return false;
    }
}

Keterangan

username, email, password, repassword dan photo adalah nama atribut name yang ada di setiap field form HTML.
rules adalah daftar rule yang ingin diimplementasikan.
label adalah nama label yang digunakan untuk memudahkan user melakukan input.
filter, adalah daftar nama fungsi yang digunakan untuk mem-filter nilai input. Fungsi yang digunakan adalah semua fungsi native PHP yang bisa menerima satu parameter.

Setelah ini kita kan buat sebuah file view.

View File

Langkah selanjutnya adalah membuat sebuah file view yang berisi tag HTML dengan field-field yang dibutuhkan. Berikut adalah sebuah file dengan nama registration_form.php

<!DOCTYPE html>
<html>
<head>
    <title>Panada Form Registration</title>
</head>
<body>

<ul><?php echo $registration->errorMessages(false, '<li>', '</li>');?></ul>

<?php echo $registration->errorMessages('name', '<p>', '</p>');?>

Full Name: <input type="text" name="name" value="<?php echo $registration->value('name');?>"><br>

<?php echo $registration->errorMessages('username', '<p>', '</p>');?>

Username: <input type="text" name="username" value="<?php echo $registration->value('username');?>"><br>

<?php echo $registration->errorMessages('email', '<p>', '</p>');?>

Email: <input type="text" name="email" value="<?php echo $registration->value('email');?>"><br>

<?php echo $registration->errorMessages('password', '<p>', '</p>');?>

Password: <input type="password" name="password" value="<?php echo $registration->value('password');?>"><br>

<?php echo $registration->errorMessages('repassword', '<p>', '</p>');?>

Retype Password: <input type="password" name="repassword" value="<?php echo $registration->value('repassword');?>"><br>

Profile Pic: <input type="file" name="photo"><br>

Keterangan

Pada file HTML di atas, kita sudah menggunakan method $registration->errorMessages(). Jika method ini digunakan tanpa parameter apapun, maka nilai returnnya adalah array yang berisi daftar pesan error.

Jika penggunaan parameternya seperti berikut $registration->errorMessages(false, '<li>', '</li>'), maka data ditampilkan berupa string yang setiap errornya diawali dengan tag <li> dan diakhiri dengan tag </li>.

Jika parameter pertama diisi dengan nama field maka error yang ditampilkan adalah error pada field tersebut.

Controller

Berikut adalah contoh controller untuk menerima request dari form HTML.

Method validate() akan memberikan nilai true atau false:


		    bool $registration->validate();

Jika method validate() memberikan nilai true maka nilai input yang sudah divalidasi bisa didapatkan dari method value().


		    array $registration->value();

Rule List

Berikut adalah datar rule yang bisa digunakan:

Rule	Keterangan	Contoh
required	Nilai field tidak boleh dikosongkan.	rules => array('required')
email	Nilai field harus berformat email.	rules => array('email')
min	Nilai field harus tidak kurang dari nilai yang telah ditentukan.	rules => array('min' => 3)
max	Nilai field harus tidak lebih dari nilai yang telah ditentukan.	rules => array('max' => 10)
compare	Membandingkan nilai sebuah field dengan field lain yang telah ditentukan.	rules => array('max' => 10)
file	Nilai field file tidak boleh dikosongkan.	rules => array('compare' => 'comparator_field')
in	Membandingkan nilai sebuah field dengan nilai yang sudah ditentukan sebelumnya.	rules => array('in' => array('male','female'))
regex	Membandingkan nilai sebuah field dengan pola regular expression yang sudah ditentukan sebelumnya.	rules => array('regex' => '/[^a-zA-Z0-9s .,"\']/')
url	Nilai field harus berformat URL.	rules => array('url')
alpha	Nilai sebuah field harus alphabet.	rules => array('alpha')
numeric	Nilai field harus berformat numeric.	rules => array('numeric')
alphanumeric	Nilai sebuah field harus alphabet dan atau numeric.	rules => array('alphanumeric')
match	Jumlah karakter nilai sebuah field sejumlah tertentu dengan ukuran yang sudah ditentukan sebelumnya.	rules => array('match' => 7)
callback	Nilai sebuah field divalidasi pada sebuah method yang kita buat sendiri.	rules => array('callback' => 'methodName')

Costume Error Message

Kita bisa melakukan kostumasi terhadap pesan error yang ingin ditampilkan. Untuk melakukan ini kita bisa menggunakan method setRuleErrorMessages() yang dipanggil pada constructor model seperti contoh berikut:

Nilai %label%, %size% dan %comparatorLabel% akan digantikan dengan nilai yang sudah ditentukan.

Panada Framework 1.0.0 Documentation

Form Validation

Validation Rule

Keterangan

View File

Keterangan

Controller

Rule List

Costume Error Message

Diskusi