Penggunaan fungsi PERSISTANT pada PHP

PHP & Framework Quality Guideline

PHP & Framework Quality Guideline DOT Indonesia merupakan sebuah standar dan panduan bagi backend engineer DOT Indonesia atau vendor yang menggunakan PHP atau framework PHP sebagai server side programming.

Kunjungi Development Stack & Tools untuk melihat daftar aplikasi dan perangkat development yang dibutuhkan

Table of Contents

1. General Standard
2. PHP Coding Standard
3. Laravel / Lumen / PHP Framework Engineering Guideline
4. Package & Libraries

1. General Standard

a .gitignore

Hal-hal berikut ini seharusnya dimasukkan ke dalam list .gitignore dan tidak boleh di push ke dalam repository:

• direktori vendors, node_modules
• file upload dari user
• file .env
• Informasi credential penting atau krusial

b. Variable Naming Conversion

Gunakan penamaan variable atau method yang singkat & jelas, serta tidak membingungkan.

good:

$user, $storeData, $debetAccount

bad:

$aaaa, $name1, $thisistoloongvariableyoumaynotseeit

c. CamelCase

Variable atau method menggunakan format CamelCase

d. Error message

Error message / debug message hanya boleh ditampilkan pada mode development atau staging. Gunakan default error message ketika di mode production

e. Sensitive Information

Tidak meletakkan endpoint atau informasi credential yang bersifat private secara hard code di dalam source code. Contoh:

protected $secretKey = 'ThisIsN0tSuppOs3dToBeHere';

protected $ProdUrl = '//someprivateip/api';

Manfaatkan file .env untuk menyimpan value sensitif tanpa terekspose di dalam source code.

f. Secure & Verified Code

Source code tidak boleh mengandung backdoor atau shell script yang berbahaya. Jika menggunakan script dari referensi luar, pastikan script tersebut aman & verified.

g. CSRF Token

Semua form harus menggunakan CSRF Protection

2. PHP Coding Standard

a. PSR-1

Harus mengikuti PHP PSR-1: Basic Coding Standard

b. PSR-2

Harus Mengikuti PHP PSR-2: Coding Style Guide

PSR-2 overview: