From 49e56759c542e2a3ecb8632b666955b14ab6c6e7 Mon Sep 17 00:00:00 2001
From: hapo-tuanlh <tuan.lh@haposoft.com>
Date: Tue, 25 Apr 2023 08:46:11 +0700
Subject: [PATCH 1/2] create pull best practice

---
 docs/coding-practices/best-practices.md | 245 ++++++++++++++++++++++++
 1 file changed, 245 insertions(+)
 create mode 100644 docs/coding-practices/best-practices.md

diff --git a/docs/coding-practices/best-practices.md b/docs/coding-practices/best-practices.md
new file mode 100644
index 0000000..86f94cb
--- /dev/null
+++ b/docs/coding-practices/best-practices.md
@@ -0,0 +1,245 @@
+---
+sidebar_position: 3
+---
+
+# Khởi tạo biến (Variable Initialization)
+
+## Biến nên được khởi tạo trước khi sử dụng
+
+````php
+<?php
+
+// Acceptable
+<?php
+
+$movies = get_movies();
+
+// EOF
+
+cách viết trên có thể chấp nhận nhưng biến $movie nên được khai báo trước khi sử dụng
+
+//or
+
+<?php 
+
+if ( $expr ) {
+	 // .... 
+} $movies = array ();
+$movies = get_movie(); //EOF
+
+Cách viết này cũng có thể chấp nhận được nhưng nên khởi tạo trước cả câu điều kiện If()
+
+// Preferred
+<?php
+
+$movies = array();
+
+if ($expr) {
+	// ....
+}
+
+$movies = get_movies();
+
+// EOF
+````
+# Lệnh khởi tạo/khai báo (Initialization/Declaration Order)
+## Lệnh khởi tạo/khai báo
+1. trình tự khởi tạo/khai báo
+- Khởi tạo biến ở phạm vi global, tiếp đến là các constant và cuối cùng là các biến local
+- Khởi tạo với các thuộc tính sau đó mới đến các hàm trong class
+- Ưu tiên khởi tạo phương thức bằng public, sau đó đến protected và cuối cùng là private
+- Nên sắp xếp theo bảng chữ cái tiếng anh
+````php
+<?php
+
+//bad
+<?php
+
+define('ENVIRONMENT', 'PRODUCTION');
+
+$id = 0;
+
+global $app_config;
+
+// EOF
+Sai thứ tự, thứ tự đúng phải là phải khai báo biến $app_config đầu tiên, sau đó tiếp theo là khai báo biến môi trường ENVIRONMENT cuối cùng mới là khai báo biến $id
+
+//good 
+<?php
+
+global $app_config;
+
+define('ENVIRONMENT', 'PRODUCTION');
+
+$id = 0;
+// EOF
+
+//bad
+<?php
+
+namespace MyCompany\Model;
+
+class Office
+{
+	public function get_name() {
+		// ...
+	}
+
+	private $name
+}
+
+// EOF
+Sai vì khai báo function get_name() trước $name
+
+// good
+<?php
+
+namespace MyCompany\Model;
+
+class Office
+{
+    private $name
+	public function get_name() {
+		// ...
+	}
+}
+
+// EOF
+
+//bad
+<?php
+
+namespace MyCompany\Model;
+
+class Office
+{
+	private $id;
+	private $name;
+	private $status;
+
+	private function get_name() {
+		// ...
+	}
+
+	public function get_id() {
+		// ...
+	}
+
+	protected function get_status() {
+		// ...
+	}
+}
+// EOF
+Sai vì không khai báo get_id() trước tiên sau đó mới đến get_status() cuối cùng mới là get_name()
+
+//good 
+<?php
+
+namespace MyCompany\Model;
+
+class Office
+{
+	private $id;
+	private $name;
+	private $status;
+
+    public function get_id() {
+		// ...
+	}
+
+    protected function get_status() {
+		// ...
+	}
+
+	private function get_name() {
+		// ...
+	}	
+}
+// EOF
+//Acceptable
+<?php
+
+global $db_connection,
+	$app_config,
+	$cache;
+
+define('MODE', 1);
+define('ENVIRONMENT', 'PRODUCTION');
+
+$id = 0;
+$firstname = '';
+$lastname = '';
+
+// EOF
+Đoạn code này có thể chấp nhận được nhưng biến global và constant phải theo bảng chữ cái
+
+//good
+<?php
+
+global $app_config,
+	$cache,
+	$db_connection;
+
+define('ENVIRONMENT', 'PRODUCTION');
+define('MODE', 1);
+
+$id = 0;
+$firstname = '';
+$lastname = '';
+
+// EOF
+````
+# Globals
+- Globals không nên được sử dụng
+
+````php
+<?php
+//Acceptable
+<?php
+
+$pdo = new PDO('mysql:host=localhost;dbname=test', $user, $pass);
+
+function get_user($id) {
+	global $pdo;
+	// ...
+}
+// EOF
+Có thể chấp nhận được, nhưng global nên tránh việc khởi tạo biến.
+
+//good
+<?php
+
+function get_database_object() {
+	return new PDO('mysql:host=localhost;dbname=test', $user, $pass);
+}
+
+function get_user($id) {
+	$pdo = get_database_object();
+	// ...
+}
+
+// EOF
+````
+
+# Explicit Expressions
+- Nên sử dụng các biểu thức rõ ràng
+````php
+<?php
+//Acceptable
+<?php
+
+if ($expr == true) {
+	// ...
+}
+
+// EOF
+Có thể chấp nhận được, nhưng '===' có thể được sử dụng ở đây để thay thế.
+//Preferred
+<?php
+
+if ($expr === true) {
+	// ...
+}
+
+// EOF
+````

From 66dd625a21bfbf4213164fc7b744203fb2f431b7 Mon Sep 17 00:00:00 2001
From: hapo-tuanlh <tuan.lh@haposoft.com>
Date: Wed, 26 Apr 2023 08:29:28 +0700
Subject: [PATCH 2/2] add coding pratice for php

---
 docs/coding-practices/best-practices.md | 291 ++++++------------------
 docs/coding-practices/function.md       | 128 +++++++++++
 docs/coding-practices/psr-1.md          | 142 ++++++++++++
 3 files changed, 344 insertions(+), 217 deletions(-)
 create mode 100644 docs/coding-practices/function.md
 create mode 100644 docs/coding-practices/psr-1.md

diff --git a/docs/coding-practices/best-practices.md b/docs/coding-practices/best-practices.md
index 86f94cb..019f6f8 100644
--- a/docs/coding-practices/best-practices.md
+++ b/docs/coding-practices/best-practices.md
@@ -2,244 +2,101 @@
 sidebar_position: 3
 ---
 
-# Khởi tạo biến (Variable Initialization)
-
-## Biến nên được khởi tạo trước khi sử dụng
-
-````php
-<?php
-
-// Acceptable
-<?php
-
-$movies = get_movies();
-
-// EOF
-
-cách viết trên có thể chấp nhận nhưng biến $movie nên được khai báo trước khi sử dụng
-
-//or
-
-<?php 
-
-if ( $expr ) {
-	 // .... 
-} $movies = array ();
-$movies = get_movie(); //EOF
-
-Cách viết này cũng có thể chấp nhận được nhưng nên khởi tạo trước cả câu điều kiện If()
-
-// Preferred
-<?php
-
-$movies = array();
-
-if ($expr) {
-	// ....
-}
-
-$movies = get_movies();
-
-// EOF
-````
-# Lệnh khởi tạo/khai báo (Initialization/Declaration Order)
-## Lệnh khởi tạo/khai báo
-1. trình tự khởi tạo/khai báo
-- Khởi tạo biến ở phạm vi global, tiếp đến là các constant và cuối cùng là các biến local
-- Khởi tạo với các thuộc tính sau đó mới đến các hàm trong class
-- Ưu tiên khởi tạo phương thức bằng public, sau đó đến protected và cuối cùng là private
-- Nên sắp xếp theo bảng chữ cái tiếng anh
+## if, elseif, else
+- Bạn hãy chú ý đến các dấu ngoặc đơn, khoảng trắng và dấu ngoặc nhọn; các từ khóa như else và elseif phải được đặt dùng dòng với dấu ngoặc nhọn đóng của phần thân cấu trúc điều khiển phía trước và nên sử dụng elseif hơn là else if..
 ````php
-<?php
-
 //bad
 <?php
-
-define('ENVIRONMENT', 'PRODUCTION');
-
-$id = 0;
-
-global $app_config;
-
-// EOF
-Sai thứ tự, thứ tự đúng phải là phải khai báo biến $app_config đầu tiên, sau đó tiếp theo là khai báo biến môi trường ENVIRONMENT cuối cùng mới là khai báo biến $id
-
-//good 
-<?php
-
-global $app_config;
-
-define('ENVIRONMENT', 'PRODUCTION');
-
-$id = 0;
-// EOF
-
-//bad
-<?php
-
-namespace MyCompany\Model;
-
-class Office
+ 
+if ($expr1) 
 {
-	public function get_name() {
-		// ...
-	}
-
-	private $name
-}
-
-// EOF
-Sai vì khai báo function get_name() trước $name
-
-// good
-<?php
-
-namespace MyCompany\Model;
-
-class Office
-{
-    private $name
-	public function get_name() {
-		// ...
-	}
-}
-
-// EOF
-
-//bad
-<?php
-
-namespace MyCompany\Model;
-
-class Office
+    // if body
+} 
+elseif ($expr2) 
 {
-	private $id;
-	private $name;
-	private $status;
-
-	private function get_name() {
-		// ...
-	}
-
-	public function get_id() {
-		// ...
-	}
-
-	protected function get_status() {
-		// ...
-	}
-}
-// EOF
-Sai vì không khai báo get_id() trước tiên sau đó mới đến get_status() cuối cùng mới là get_name()
-
-//good 
-<?php
-
-namespace MyCompany\Model;
-
-class Office
+    // elseif body
+} 
+else 
 {
-	private $id;
-	private $name;
-	private $status;
-
-    public function get_id() {
-		// ...
-	}
-
-    protected function get_status() {
-		// ...
-	}
-
-	private function get_name() {
-		// ...
-	}	
+    // else body;
 }
-// EOF
-//Acceptable
-<?php
-
-global $db_connection,
-	$app_config,
-	$cache;
-
-define('MODE', 1);
-define('ENVIRONMENT', 'PRODUCTION');
-
-$id = 0;
-$firstname = '';
-$lastname = '';
-
-// EOF
-Đoạn code này có thể chấp nhận được nhưng biến global và constant phải theo bảng chữ cái
 
 //good
 <?php
-
-global $app_config,
-	$cache,
-	$db_connection;
-
-define('ENVIRONMENT', 'PRODUCTION');
-define('MODE', 1);
-
-$id = 0;
-$firstname = '';
-$lastname = '';
-
-// EOF
+ 
+if ($expr1) {
+    // if body
+} elseif ($expr2) {
+    // elseif body
+} else {
+    // else body;
+}
 ````
-# Globals
-- Globals không nên được sử dụng
-
+- Biểu thức ở giữa cặp dấu ngoặc đơn có thể được viết trên nhiều dòng, với mỗi dòng sẽ được thù lề thêm một cấp. Điều kiện đầu tiên sẽ phải được viết trên dòng tiếp theo. Dấu ngoặc đơn đóng và dấu ngoặc nhọn mở phải được viết trên cùng một dòng và ngăn cách bằng một khoảng trắng.
 ````php
+//bad
 <?php
-//Acceptable
-<?php
-
-$pdo = new PDO('mysql:host=localhost;dbname=test', $user, $pass);
-
-function get_user($id) {
-	global $pdo;
-	// ...
+ 
+if ( $expr1 && $expr2 ) {
+    // if body
+} elseif ( $expr3 && $expr4 ) {
+    // elseif body
 }
-// EOF
-Có thể chấp nhận được, nhưng global nên tránh việc khởi tạo biến.
-
-//good
+//good 
 <?php
-
-function get_database_object() {
-	return new PDO('mysql:host=localhost;dbname=test', $user, $pass);
-}
-
-function get_user($id) {
-	$pdo = get_database_object();
-	// ...
+ 
+if (
+    $expr1
+    && $expr2
+) {
+    // if body
+} elseif (
+    $expr3
+    && $expr4
+) {
+    // elseif body
 }
-
-// EOF
 ````
 
-# Explicit Expressions
-- Nên sử dụng các biểu thức rõ ràng
+## switch, case
+- Bạn hãy để ý tới vị trí của các dấu ngoặc đơn, khoảng trắng và dấu ngoặc nhọn. Từ khóa case phải được thụt lề thêm một cấp so với từ khóa switch, và từ khóa break (hoặc từ khóa kết thúc như return) phải được thụt lề thêm một cấp so với case.
 ````php
+//bad
 <?php
-//Acceptable
-<?php
-
-if ($expr == true) {
-	// ...
+ 
+switch ($expr) {
+    case 0:
+        echo 'First case, with a break';
+    break;
+    case 1:
+        echo 'Second case, which falls through';
+    case 2:
+    case 3:
+    case 4:
+        echo 'Third case, return instead of break';
+    return;
+    default:
+        echo 'Default case';
+    break;
 }
 
-// EOF
-Có thể chấp nhận được, nhưng '===' có thể được sử dụng ở đây để thay thế.
-//Preferred
+//good
 <?php
-
-if ($expr === true) {
-	// ...
+ 
+switch ($expr) {
+    case 0:
+        echo 'First case, with a break';
+        break;
+    case 1:
+        echo 'Second case, which falls through';
+        // no break
+    case 2:
+    case 3:
+    case 4:
+        echo 'Third case, return instead of break';
+        return;
+    default:
+        echo 'Default case';
+        break;
 }
-
-// EOF
-````
+````
\ No newline at end of file
diff --git a/docs/coding-practices/function.md b/docs/coding-practices/function.md
new file mode 100644
index 0000000..c3e021f
--- /dev/null
+++ b/docs/coding-practices/function.md
@@ -0,0 +1,128 @@
+---
+sidebar_position: 3
+---
+
+## Tham số của method và function
+- Trong danh sách các tham số, không được có khoảng trắng ở trươc dấu phẩy, và phía sau dấu phẩy luôn phải có một khoảng trắng.
+
+Các tham số mà có giá trị mặc định phải nằm ở các vị trí sau cùng trong danh sách các tham số.
+````php
+//bad
+<?php
+ 
+namespace Vendor\Package;
+ 
+class ClassName
+{
+    public function foo(int $arg1 , &$arg3 = [] , $arg2)
+    {
+        // method body
+    }
+}
+//good
+<?php
+ 
+namespace Vendor\Package;
+ 
+class ClassName
+{
+    public function foo(int $arg1, &$arg2, $arg3 = [])
+    {
+        // method body
+    }
+}
+````
+
+- Khi bạn khai báo kiểu dữ liệu trả về, thì phải có một khoảng trắng nằm giữa dấu hai chấm : và kiểu dữ liệu. Dấu hai chấm và kiểu dữ liệu phải nằm cùng dòng với dấu ngoặc đơn đóng.
+````php
+//bad
+<?php
+ 
+declare(strict_types=1);
+ 
+namespace Vendor\Package;
+ 
+class ReturnTypeVariations
+{
+    public function functionName(int $arg1, $arg2):string
+    {
+        return 'foo';
+    }
+ 
+    public function anotherFunction(
+        string $foo,
+        string $bar,
+        int $baz
+    ): string {
+        return 'foo';
+    }
+}
+// good 
+<?php
+ 
+declare(strict_types=1);
+ 
+namespace Vendor\Package;
+ 
+class ReturnTypeVariations
+{
+    public function functionName(int $arg1, $arg2): string
+    {
+        return 'foo';
+    }
+ 
+    public function anotherFunction(
+        string $foo,
+        string $bar,
+        int $baz
+    ): string {
+        return 'foo';
+    }
+}
+````
+- Nếu khai khai bảo trả về kiểu nullable, thì không được có khoảng trắng giữa dấu hỏi chấm và kiểu dữ liệu.
+
+Nếu sử dụng toán tử & trước các tham số, thì không được có khoảng trắng ở phía sau nó.
+````php
+//bad
+<?php
+ 
+declare(strict_types=1);
+ 
+namespace Vendor\Package;
+ 
+class ReturnTypeVariations
+{
+    public function functionName(?string $ arg1, ?int & $arg2): ? string
+    {
+        return 'foo';
+    }
+}
+//good
+<?php
+ 
+declare(strict_types=1);
+ 
+namespace Vendor\Package;
+ 
+class ReturnTypeVariations
+{
+    public function functionName(?string $arg1, ?int &$arg2): ?string
+    {
+        return 'foo';
+    }
+}
+````
+- Không được có khoảng trắng giữa dấu ba chấm ... và tên tham số:
+````php
+//bad
+public function process(string $algorithm, ... $parts)
+{
+    // processing
+}
+//good
+public function process(string $algorithm, ...$parts)
+{
+    // processing
+}
+````
diff --git a/docs/coding-practices/psr-1.md b/docs/coding-practices/psr-1.md
new file mode 100644
index 0000000..be50825
--- /dev/null
+++ b/docs/coding-practices/psr-1.md
@@ -0,0 +1,142 @@
+---
+sidebar_position: 3
+---
+
+# Files
+
+## php tags
+## Đối với file PHP
+- Nguyên tắc 1: File PHP chỉ được phép sử dụng <?php và <?=. <?php được sử dụng để mở đầu cho code PHP, và <?= là cú pháp short-echo (thay vì code là <?php echo $a ?>, bạn có thể code là <?= $a ?>)
+
+- Nguyên tắc 2: File code PHP sử dụng encode UTF-8 without BOM.
+
+- Nguyên tắc 3: File PHP NÊN dùng để khai báo các thành phần của PHP (class, function, const) và các hiệu ứng phụ (include, thiết lập init PHP), nhưng KHÔNG NÊN dùng cả hai trong một file. Để hiểu rõ hơn nguyên tắc này, bạn hãy xem ví dụ sau
+````php
+//bad
+
+<?php
+// hiệu ứng phụ: đổi thiết lập ini
+ini_set('error_reporting', E_ALL);
+ 
+// hiệu ứng phụ: nạp file vào
+include "file.php";
+ 
+// hiệu ứng phụ: xuất dữ liệu
+echo "<html>\n";
+ 
+// khai báo hàm
+function foo()
+{
+    // function body
+}
+
+//good
+//file functions.php
+<?php
+// functions.php
+ 
+// khai báo hàm
+function foo()
+{
+    // function body
+}
+
+//file index.php
+
+<?php
+// index.php
+ 
+// hiệu ứng phụ: đổi thiết lập ini
+ini_set('error_reporting', E_ALL);
+ 
+// hiệu ứng phụ: nạp file vào
+include "file.php";
+include "functions.php";
+ 
+// hiệu ứng phụ: xuất dữ liệu
+echo "<html>\n";
+````
+
+## Đối với khai báo namespace và class
+- Nguyên tắc 1: namespace và class phải thuân theo chuẩn “autoload” PSR-0, PSR-4.
+
+Mỗi class được khai báo trên một file PHP riêng và có namespace tối thiểu một cấp, cấp đầu tiên là tên vendor (tên đơn vị phát hành)
+
+Tên class PHẢI được viết dạng ClassName thay vì classname, Classname, class_name hay Class_Name
+
+Từ PHP 5.3, PHẢI sử dụng namespace khi khai báo class.
+
+````php
+//bad
+<?php
+ 
+class Classname
+{
+    //
+}
+
+//good
+<?php
+ 
+namespace Vendor;
+ 
+class ClassName
+{
+    //
+}
+````
+
+##  Hằng, thuộc tính và phương thức của class
+- Quy tắc 1: Hằng khai báo trong class phải được viết hoa và ngăn cách bằng dấu gạch dưới.
+
+````php
+//bad
+<?php
+namespace Vendor\Model;
+ 
+class Foo
+{
+    const version = '1.0';
+    const date_approved = '2012-06-01';
+}
+
+//good
+<?php
+namespace Vendor\Model;
+ 
+class Foo
+{
+    const VERSION = '1.0';
+    const DATE_APPROVED = '2012-06-01';
+}
+````
+
+- Tên phương thực phải được đặt ở dang tenPhuongThuc()
+
+````php
+//bad
+<?php
+ 
+namespace Vendor\Model;
+  
+class Foo
+{
+    public function method_name()
+    {
+        //
+    }
+}
+
+//good
+<?php
+ 
+namespace Vendor\Model;
+  
+class Foo
+{
+    public function methodName()
+    {
+        //
+    }
+}
+````
\ No newline at end of file