phpRollAdmin

ini adalah class yang di panggil oleh {pea#roll pea} ketika ingin membuat form untuk melihat daftar data dalam database

includes/lib/pea/phpRollAdmin.php

phpRollAdmin

class untuk membuat form listing data dalam database

ini adalah class yang di panggil oleh pea ketika ingin membuat form untuk melihat listing data dalam database, berikut contoh penggunaan:

$form = _lib('pea',  'table_name');
$form->initRoll("WHERE 1 ORDER BY id DESC"); // ORDER BY wajib digunakan demi keamanan

$form->roll->setLanguage();
$form->roll->setSaveTool(true);

$form->roll->addInput('title','sqlplaintext');
$form->roll->input->title->setTitle('Title');
$form->roll->input->title->setLanguage();

$form->roll->action();
echo $form->roll->getForm();

setNumRows

menentukan maximal jumlah baris yang ditampilkan dalam satu halaman, jika jumlah data melebihi dari yang ditentukan maka akan di tempatkan pada halaman selanjutnya

setNumRows($int_num_rows = 0);

setActionExecute

menentukan apakah proses dalam method action akan dieksekusi ataukah tidak

setActionExecute($bool=true, $msg='');

onDelete

untuk menentukan function apa yang akan dieksekusi ketika tombol delete di submit

onDelete ($func_name_on_delete = '', $arr_on_delete_args = array(), $call_after_saved = false);

Jika function dari $func_name_on_delete return FALSE maka action dari PEA bawaan tidak akan dieksekusi

onEachDelete

untuk menentukan function apa yang akan dieksekusi ketika tombol delete di submit, dan dieksekusi disetiap data/baris yang dihapus

onEachDelete ($func_name_on_each_delete = '');

function $func_name_on_each_delete akan dieksekusi SETELAH data dihapus setiap barisnya, sedangkan input/argument dari fungsi tersebut (value dari $func_name_on_each_delete) adalah ID dari row/baris yang telah dihapus. function ini akan dipanggil ber ulang-ulang setiap ada data yang dihapus, misal anda menghapus 3 baris maka function $func_name_on_each_delete akan dieksekusi tiga kali setiap kali satu baris terhapus dalam database table

onSave

untuk menentukan function apa yang akan di panggil ketika form di submit menggunakan tombol save

onSave ($func_name_on_save = '', $arr_on_save_args = array(), $call_after_saved = false);

onEachSave

untuk menentukan function apa yang akan di panggil ketika form di submit menggunakan tombol save, dan dieksekusi disetiap data/baris yang disimpan

onEachSave ($func_name_on_each_save = '');

function $func_name_on_each_save akan dieksekusi SETELAH data disimpan setiap barisnya, sedangkan input/argument dari fungsi tersebut (value dari $func_name_on_each_save) adalah ID dari row/baris yang telah disimpan. function ini akan dipanggil ber ulang-ulang setiap menyimpan per baris

getDeletedId

mengambil Array ID apa saja dari database table yang dihapus

getDeletedId();

setIsChangeBc

menentukan apakah ingin merubah warna background ketika baris di hover

setIsChangeBc($bool_change_bc = false);

setResetTool

menentukan apakah tombol reset ingin ditampilkan ataukah tidak

setResetTool($bool_reset_tool = false);

getCheckAll

membuat checkbox di judul kolom untuk mencentang semua checkbox di bawah nya

getCheckAll($input);

method ini sudah dipanggil otomatis

getOrderUrl

mengambil URL yang saat itu di akses dengan menambahkan variable GET untuk pengurutan berdasarkan kolom

getOrderUrl($input, $title);

method ini sudah dipanggil otomatis

getOrderQuery

mengambil query MySQL untuk pengurutan baris berdasarkan kolom (field name dari table database)

getOrderQuery($query);

addSystemInput

menambahkan input field sebagai penanda untuk setiap baris, juga untuk menambahkan kolom hapus data jika setDeleteTool ditentukan TRUE

addSystemInput();

getSaveSuccessPage

mengambil pesan succes jika setelah submit berhasil menyimpan data ke dalam database table

getSaveSuccessPage();

getDeleteSuccessPage

mengambil pesan succes jika data berhasil dihapus dalam database table

getDeleteSuccessPage();

getReport

menampilkan tag HTML untuk icon2 export jika sudah memanggil addReport atau addReportAll

getReport($page=0);

jika ada field dalam form ini yang menggunakan setDisplayColumn maka juga akan menampilkan button untuk pilihan kolom mana saja yang ingin ditampilkan

getMainForm

mengambil tag HTML semua input field yang telah ditentukan (sudah dipanggil otomatis oleh getForm)

getMainForm();

getForm

mengambil form listing data keseluruhan dan mengkesekusi action jika belum dipanggil sebelumnya

getForm();

actionOnDelete

method yang mengeksekusi function yang ditentukan oleh onDelete jika ditentukan. function ini sudah dipanggil di dalam action

actionOnDelete($call_after_saved);

anda tidak perlu memanggil function method ini karena sudah dipanggil otomatis ketika form delete disubmit

actionOnEachDelete

method yang mengeksekusi function yang ditentukan oleh onEachDelete jika ditentukan. function ini sudah dipanggil di dalam action di tiap baris yang dihapus

actionOnEachDelete($id);

actionOnSave

method yang mengeksekusi function yang ditentukan oleh onSave jika ditentukan. function ini sudah dipanggil di dalam action

actionOnSave($call_after_saved);

anda tidak perlu memanggil function method ini karena sudah dipanggil otomatis ketika form disubmit

actionOnEachSave

method yang mengeksekusi function yang ditentukan oleh onEachSave jika ditentukan. function ini sudah dipanggil di dalam action di tiap baris yang di save

actionOnEachSave($id);

actionSecurity

method yang dieksekusi sebelum meng-eksekusi proses yang ada di action untuk validasi jika ada perubahan pada nilai input field yang dibuat oleh addSystemInput maka eksekusi akan digagalkan

actionSecurity();

action

mengeksekusi semua action dan query jika form di submit

action();

initialize

untuk menginisialisasi object2 yang diperlukan untuk menampilkan form field

initialize( $type, $str_table, $str_table_id='id', $str_sql_condition='');

setFormName

menentukan nama form yang akan dibuat

setFormName($string_form_name='');

setDB

menentukan object database yang pakai sesuai urutan dalam file confg.php yaitu $db, $db1, $db2 dst

setDB( $db = '' );

setQuoteSQL

mengamankan nama field yang ingin digunakan dalam query MySQL

setQuoteSQL($sql);

setSqlCondition

menentukan query SQL Condition jika dalam menampilkan data value memerlukan clause "WHERE" dalam Query MySQL

setSqlCondition( $sql_condition = '' );

setActionUrl

menentukan target url apabila form disubmit

setActionUrl($url='');

setMethodForm

menentukan method form

setMethodForm($method);

addInput

untuk menambah input field dimana akan menambahkan object nama field pada object "input"

addInput( $name, $type, $noColumn = 1);

berikut contoh $type untuk tipe field:

setColumn

menentukan jumlah kolom yang digunakan untuk menampilkan form, ini hanya berlaku untuk phpEditAdmin dan phpAddAdmin

setColumn($columnNumber);

jika anda menggunakan form dengan multi kolom maka untuk input field yang ingin dimasukkan ke kolom 2 dan seterusnya harus ditentukan menggunakan method setNoColumn berikut contoh tampilan dari form multi kolomContoh penggunaan nya bisa anda lihat di FormText::setNoColumn

setLanguage

menentukan apakah form ini menggunakan database yang support multiple language ataukah tidak

setLanguage($LanguageTableId = '', $LanguageTable = '', $add_query=array());

contoh Array SQL Condition untuk variable $add_query:
$add_query = array(
  'class_id' => 2,
  'room_id'  => 3
 );

addHeader

untuk menambahkan header pada form

addHeader( $name, $value = '' );

setIsFormRequire

untuk menentukan apakah form memerlukan validasi input sebelum disubmit

setIsFormRequire();
method ini tidak perlu anda panggil secara langsung karena sudah dipanggil otomatis ketika ada input yang memanggil {Form::setRequire setRequire}

getDefaultValue

mengambil default value dari semua input

getDefaultValue($input, $arrResult = array(), $i='');

getMultiElementObject

mengambil semua object yang masuk kedalam input field dengan tipe FromMultiinput

getMultiElementObject ( $input, $arrResult, $i );

replaceTrailingComma

menghilangkan koma (,) jika tidak digunakan sebagai pemisah

replaceTrailingComma( $sql );

setSuccessSaveMessage

menentukan pesan success

setSuccessSaveMessage( $suc_message );

setFailSaveMessage

menentukan pesan error

setFailSaveMessage( $fail_message );

setSuccessDeleteMessage

menentukan pesan berhasil ketika hapus data

setSuccessDeleteMessage( $suc_message );

setFailDeleteMessage

menentukan pesan gagal hapus data

setFailDeleteMessage( $fail_message );

addHelp

menambahkan icon bantuanyang akan muncul pesan ketika di hover

addHelp( $field = '', $value = '' );

method ini bisa di panggil ditiap input field juga

addTip

menambahkan text bantuan pada input field

addTip( $field = '', $value = '' );

method ini bisa di panggil ditiap input field juga

addExtraField

menambahkan field tambahan dengan value yang sudah ditentukan ketika form disubmit

addExtraField( $field = '', $value = '', $formType='' );

addReport

menampilkan icon export khusus untuk phpEditAdmin dan phpRollAdmin

addReport( $type = 'all' );

Jika fungsi export diatas diaktifkan, maka anda bisa menggunakan setExportFunction pada tiap field jika ingin merubah data sebelum ditampilkan dalam file hasil export

addReportAll

menampilkan semua icon export khusus untuk phpEditAdmin dan phpRollAdmin

addReportAll();
method ini sama seperti memanggil ->addReport('all');
Jika fungsi export diatas diaktifkan, maka anda bisa menggunakan setExportFunction pada tiap field jika ingin merubah data sebelum ditampilkan dalam file hasil export

setSaveButton

mengatur tombol save jika setSaveTool berisi TRUE

setSaveButton( $name = 'submit_update', $value = 'SAVE', $icon = 'floppy-disk', $label='value' );

setResetButton

mengatur tombol reset jika setResetTool berisi TRUE

setResetButton( $name = 'submit_update', $value = 'RESET', $icon = 'repeat', $label='value' );

setDeleteButton

mengatur tombol reset jika setDeleteTool berisi TRUE

setDeleteButton( $name = 'submit_delete', $value = 'DELETE', $icon = 'trash', $label='value' );

setSaveTool

menentukan apakah tombol save ingin ditampilkan ataukah tidak

setSaveTool( $bool_save_tool = false );

setDeleteTool

menentukan apakah tombol delete ingin ditampilkan ataukah tidak

setDeleteTool( $bool_delete_tool = false );

getSuccessPage

menampilkan pesan ketika form disubmit

getSuccessPage( $success_message = 'Succeed', $fail_message = 'Failed' );

isError

mengambil status error atau tidak nya form ketika disubmit

isError();
method ini akan mereturnkan boolean baik TRUE ataupun FALSE eksekusi yang dilakukan ketika form disubmit

getErrorMsg

mengambil pesan error

getErrorMsg();

getHeaderType

mengambil judul dari input field

getHeaderType();

setHideTool

menentukan apakah form ingin dibuat berbentuk toogle yang bisa di sembunyikan dan ditampilkan

setHideTool( $bool_is_hide_tool = false, $init = 'HIDE' );

setHideToolTitle

menentukan judul header yang digunakan untuk show/hide dari form yang berbentuk toogle

setHideToolTitle( $str_hide_tool_title = ' ' );

setTitle

method alias dari method setHideToolTitle

setTitle( $str_hide_tool_title = ' ' );

setHideToolInit

menentukan status default toogle dari form pertama kali dibuka

setHideToolInit( $init = 'HIDE' );

setDisableInput

menentukan field yang akan di disable ketika sesuai dengan kondisi

setDisableInput($input_name, $value, $preprocessor='==', $field_name = '');

setDisableInputRecovery

dipanggil oleh setDisableInput untuk membuat field tersembunyi agar ketika disubmit value dari input tersebut tidak berubah

setDisableInputRecovery($values, $input_name);

setDefaultExtra

menentukan Attribut html apa yang dimasukkan ketika membuat tag input field

setDefaultExtra($input);

getHideFormToolStart

membuat HTML wrapper untuk membungkus form jika form dibuat toogle oleh setHideTool
dimana method ini harus ditutup dengan getHideFormToolEnd

getHideFormToolStart();

getHideFormToolEnd

mengambil tag HTML penutup dari getHideFormToolStart

getHideFormToolEnd();

cleanSQL

membersihkan text dari karakter yang akan merusak query MySQL hasil dari form

cleanSQL($q);

debug

menampilkan hasil debug

debug($bool_check, $string_debug = "", $string_ok_message="", $string_error_message = "");

setDebug

menentukan pakah form ini meng-aktifkan debug ataukah tidak

setDebug($bool_debug="on");