โครงสร้างไฟล์และไดเร็คทอรีพื้นฐานของ Kotchasan
โครงสร้างไฟล์และไดเร็คทอรีของ คชสาร (Kotchasan PHP Framework) ถูกออกแบบมาให้มีความชัดเจนและง่ายต่อการจัดการ โดยมีการแบ่งหมวดหมู่ของไฟล์ต่าง ๆ อย่างเป็นระเบียบ เพื่อให้ผู้พัฒนาสามารถทำงานได้อย่างมีประสิทธิภาพ
โครงสร้างพื้นฐานของ Kotchasan
- public_html/
- ckeditor/ เป็นไดเร็คทอรี่ติดตั้งของ CKEditor (ลบได้หากไม่ใช้งาน)
- datas/ เป็นไดเร็คทอรี่ใช้สำหรับเก็บไฟล์ต่างๆที่ระบบสร้างขึ้นขณะรัน เช่น cache, log และไฟล์ต่างๆที่ผู้ใช้อัปโหลดขึ้นไป ไดเรคทอรี่นี้ต้องสามารถเขียนได้ด้วย
- js/ เป็นไดเรคทอรี่สำหรับเก็บไฟล์ javascript ต่างๆ (Kotchasan ติดตั้งมาพร้อมกับ GAjax Javascript Library)
- Kotchasan/ เป็นไดเรคทอรี่ที่เก็บไฟล์หลักต่างๆของ Kotchasan PHP Framework
- language/ เป็นไดเร็คทอรี่สำหรับเก็บไฟล์ภาษาต่างๆ
- projects/ เก็บโปรเจ็คตัวอย่าง (ไม่ต้องอัปโหลดเมื่อใช้งานจริง)
- PDF/ เก็บไฟล์ของ FPDF (ลบได้หากไม่ใช้งาน)
- skin/ เป็นไดเร็คทอรี่สำหรับเก็บไฟล์ template และ ไฟล์ CSS (Kotchasan ติดตั้งมาพร้อมกับ GCSS CSS Framework)
- test/ เป็นไดเร็คทอรี่เก็บไฟล์ของ Unit Test (ไม่ต้องอัปโหลด)
- index.php ไฟล์หลักของ Application สำหรับการเรียกหน้าเว็บ (ค่าเริ่มต้นจะแสดงผลโปรเจ็คตัวอย่าง Welcome)
หมายเหตุ
- สีแดง เป็นไดเร็คทอรี่หลักของคชสาร
- สีเขียว เป็นไดเรคทอรี่หลักของแอพพลิเคชั่นซึ่งใช้ร่วมกัน (หากในโปรเจ็คประกอบด้วยแอพพลิเคชั่นมากกว่า 1 ตัว ยกตัวอย่างเช่น GCMS ซึ่งมีแอพพลิเคชั่นหลักที่แสดงหน้าเว็บ และ แอพพลิเคชั่นส่วนแอดมิน)
- สีน้ำเงิน เป็นไดเร็คทอรี่ของ Third party ที่คชสารสนับสนุนอยู่แล้ว ถ้าไม่มีการใช้งานสามารถลบออกได้
โครงสร้างไฟล์และไดเรคทอรี่ต่างๆของแอพพลิเคชั่น
- public_html/
- modules/ เป็นไดเร็คทอรี่ใช้สำหรับเก็บโค้ดโปรแกรม ภายในจะถูกแบ่งออกเป็นโมดูลต่างๆ และแต่ละโมดูลจะประกอบด้วย models, controllers และ views ตามโครงสร้างของ MVC
- settings/ เป็นไดเร็คทอรี่สำหรับเก็บค่าติดตั้งต่างๆ
- index.php เป็นไฟล์หลักของ Application ใช้สำหรับการเรียกหน้าเว็บ
- admin/
- modules/ เป็นไดเร็คทอรี่ใช้สำหรับเก็บโค้ดโปรแกรม สำหรับส่วน admin มีองค์ประกอบเหมือน public_html/modules/
- settings/ เป็นไดเร็คทอรี่สำหรับเก็บค่าติดตั้งต่างๆ เพิ่มเติมจาก public_html/settings/ ซึ่งจะถูกเรียกใช้เฉพาะส่วน admin เท่านั้น
- index.php เป็นไฟล์หลักหน้า admin
ข้อกำหนดของชื่อไฟล์และไดเรคทอรี่ของคชสาร
- ไฟล์ต่างๆ ในไดเร็คทอรี
modules
,settings
, และlanguage
ต้องใช้ภาษาอังกฤษตัวพิมพ์เล็กและตัวเลขเท่านั้น - สำหรับ Class ที่สร้างขึ้นเพิ่มเติม ชื่อไดเร็คทอรีต้องเป็น Case Sensitive และปฏิบัติตาม PSR-4
- แนะนำให้ใช้รูปแบบ StudlyCaps โดยขึ้นต้นด้วยตัวพิมพ์ใหญ่ เช่น
Gcms\Login
ซึ่งจะถูกเก็บใน/Gcms/Login.php
- แนะนำให้ใช้รูปแบบ StudlyCaps โดยขึ้นต้นด้วยตัวพิมพ์ใหญ่ เช่น
สรุป
โครงสร้างไฟล์และไดเร็คทอรีของ Kotchasan ถูกออกแบบมาอย่างมีระเบียบ ช่วยให้การพัฒนาแอพพลิเคชันทำได้ง่ายและมีประสิทธิภาพมากยิ่งขึ้น คุณสามารถดูโครงสร้างของไฟล์และไดเร็คทอรีแบบสมบูรณ์ได้ที่โปรเจ็ค GCMS เพื่อศึกษารายละเอียดเพิ่มเติมเกี่ยวกับการจัดการโค้ดในเฟรมเวิร์คนี้