yamf php

YAMF

YAMF (ยังเป็นเฟรมเวิร์ก MVC อื่น) เป็นเฟรมเวิร์ก PHP ขนาดเล็กที่ออกแบบมาเพื่อให้คุณเริ่มใช้กระบวนทัศน์ MVC ได้อย่างรวดเร็วโดยไม่ต้องติดตั้งจำนวนมาก สิ่งที่คุณต้องมีคือเว็บเซิร์ฟเวอร์ที่ยอมรับไฟล์ .htaccess และคุณค่อนข้างดีที่จะไป!

การตั้งค่า

ข้อกำหนดขั้นต่ำ: Php 7.0+

1. โคลนที่เก็บและ/หรือใช้โครงการนี้เป็นเทมเพลตสำหรับโครงการของคุณเองโดยคลิกที่ลิงค์นี้หรือคลิกปุ่ม Use this template บนหน้าโครงการซื้อใหม่
2. ตรวจสอบให้แน่ใจว่าเว็บเซิร์ฟเวอร์ของคุณได้รับการตั้งค่าเพื่ออ่านและใช้ไฟล์. htaccess (ถ้าคุณไม่รู้ว่านี่หมายถึงอะไรโปรด Google! บางทีเราอาจจะเพิ่มลิงค์ผู้ช่วยที่นี่ในภายหลัง)
3. กำหนดค่า config.php หากจำเป็น ปรับพารามิเตอร์ใด ๆ ที่คุณต้องการในนั้นหรือเพิ่มพารามิเตอร์ใหม่ลงใน $app เช่น Session Logic โดยค่าเริ่มต้นคุณไม่จำเป็นต้องปรับอะไรเพื่อให้ไซต์ของคุณทำงานและทำงาน
4. หากคุณมีข้อมูลรับรองฐานข้อมูลประเภทใด ๆ ปุ่มส่วนตัว ฯลฯ ที่ต้องใช้ในเว็บไซต์คัดลอก config-private.sample.php ไปยัง config-private.php และปรับให้เข้ากับความต้องการของคุณ ตัวอย่างเช่นคุณสามารถตั้งค่า $app->db เป็นอินสแตนซ์ PDO สำหรับฐานข้อมูลท้องถิ่นของคุณ โปรดทราบว่าจะโหลด config-private.php ก่อนที่สิ่งใดใน config.php จะเกิดขึ้น
5. เพื่อให้คำสั่ง use Yamf/XYZ ทำงานได้คุณจะต้องใช้นักแต่งเพลง การใช้นักแต่งเพลงนั้นค่อนข้างง่าย: เพียงไปที่หน้าดาวน์โหลดและเรียกใช้สคริปต์ที่ด้านบน (หมายเหตุ: หากคุณอยู่ใน Windows คุณจะต้องทำตามคำแนะนำที่นี่ในหน้าอินโทร)
6. composer install (หากคุณมีไฟล์ composer.phar ในไดเรกทอรีของคุณให้เรียกใช้ php composer.phar install ) มันจะนั่งและคิดสักครู่
7. เสร็จแล้ว! เพลิดเพลินไปกับเว็บไซต์ MVC ของคุณ! คุณสามารถฉีกรายการตัวอย่างเริ่มต้นและ CSS ได้แน่นอน!

รอ! ไลบรารีการโยกย้ายฐานข้อมูล / ดูเทมเพลตตรรกะ / หน่วยทดสอบหน่วยทดสอบ / {กรอบอื่น ๆ ที่นี่}!

พวกเขาไม่ได้อยู่ที่นี่และพวกเขาไม่ได้อยู่ที่นี่! YAMF ถูกเขียนขึ้นอย่างมีจุดประสงค์เพื่อไม่ใช้การพึ่งพาภายนอกใด ๆ นอกเหนือจาก Autoloader ของนักแต่งเพลงเพื่อลดอุปสรรคในการเข้าสู่การใช้กระบวนทัศน์ MVC ใน PHP หากคุณต้องการสิ่งเหล่านั้นเพียงแค่ดึงพวกเขาเข้ากับตัวจัดการการพึ่งพาที่คุณชื่นชอบ (เช่นนักแต่งเพลง) เนื่องจากนักแต่งเพลงมีความจำเป็นในการเรียกใช้โครงการนี้สำหรับการโหลดอัตโนมัติ PSR-4 เราขอแนะนำให้ใช้นักแต่งเพลง vendor/autoload.php รวมอยู่แล้วสำหรับคุณใน init.php

สำหรับหมายเหตุเกี่ยวกับการดู templating ให้ดูที่ส่วนของ subclassing

เอกสาร

หากคุณอ่านเอกสารต่อไปนี้ใน YAMF คุณอาจจะดีกว่าแค่กระโดดเข้ามาและพยายามอ่านรหัสด้วยตัวเอง :) จะใช้เวลาเพียงไม่กี่นาทีและมันก็คุ้มค่า!

หมายเหตุเกี่ยวกับ $ แอป

เพื่ออำนวยความสะดวกในการผ่านพารามิเตอร์การกำหนดค่าได้อย่างง่ายดายเช่นการตั้งค่าฐานข้อมูล ฯลฯ YAMF จะผ่านตัวแปร $app ของคลาส YamfAppConfig ไปยังแต่ละฟังก์ชันคอนโทรลเลอร์ คุณสามารถตั้งค่าตัวแปรนี้เพื่อจัดเก็บวัตถุฐานข้อมูล PDO ของคุณเปลี่ยนส่วนขยายมุมมองหรือตำแหน่งโฟลเดอร์และการตั้งค่าอื่น ๆ อีกมากมาย หากคุณต้องการเพิ่มค่าของคุณเองเป็น $app คุณสามารถสร้างคลาสที่มาจาก YamfAppConfig และเปลี่ยนการตั้งค่า appConfigClass ใน config.php เพื่อชี้ไปที่คลาสที่กำหนดเอง โปรดทราบว่าคลาสที่กำหนดเองของคุณจะต้องได้รับจาก YamfAppConfig ! ดู config.php เพื่อดูการตั้งค่าและค่าทั้งหมดที่ส่งผ่านโดย YAMF ผ่าน $app โดยเฉพาะอย่างยิ่งคุณสามารถ:

• เปลี่ยนตำแหน่งของโฟลเดอร์ Views ของคุณ ( viewsFolderName )
• เปลี่ยนส่วนขยายของไฟล์มุมมองของคุณ ( viewExtension )
• เปลี่ยนชื่อส่วนหัวหรือส่วนท้ายเริ่มต้น ( defaultHeaderName / defaultFooterName )
• สามารถเข้าถึงฐานข้อมูล PDO/อื่น ๆ ของคุณได้ง่าย (ตั้งค่าใน config-private.php )

$app จะพร้อมใช้งานโดยอัตโนมัติในมุมมองของคุณสำหรับคุณ

การเพิ่มเส้นทางใหม่

สิ่งแรกที่คุณอาจต้องทำคือเพิ่มเส้นทางใหม่ ในการทำเช่นนั้นให้ทำตามขั้นตอนเหล่านี้:

1. หากคุณยังไม่มีคลาสคอนโทรลเลอร์สำหรับเส้นทางใหม่ของคุณไปข้างหน้าและเพิ่มหนึ่งในโฟลเดอร์ app/Controllers ของโครงการ โฟลเดอร์ย่อยก็โอเค คอนโทรลเลอร์ไม่จำเป็นต้องมี Controller ในชื่อ แต่ตรวจสอบให้แน่ใจว่าชื่อคลาสตรงกับชื่อไฟล์
2. เพิ่มต้นขั้วสำหรับวิธีคอนโทรลเลอร์ของคุณ อย่างน้อยที่สุดก็จะต้องเป็นฟังก์ชั่น public ที่ใช้พารามิเตอร์สองพารามิเตอร์: $app และ $request (ในลำดับนั้น)
3. เปิด routes.php และตรวจสอบให้แน่ใจว่าคุณเข้าใจเอกสารและตัวอย่างของวิธีการทำงานของเส้นทาง
4. เพิ่มเส้นทางของคุณไปยังอาร์เรย์ routes
   • ตรวจสอบให้แน่ใจว่าได้กำหนด POST หากจำเป็น
   • สตริงชื่อคอนโทรลเลอร์ต้องตรงกับชื่อไฟล์และชื่อคลาสสำหรับคอนโทรลเลอร์จากขั้นตอนที่หนึ่ง
   • หากคอนโทรลเลอร์อยู่ในโฟลเดอร์ย่อย (หรือโฟลเดอร์ย่อย) ตรวจสอบให้แน่ใจว่าคุณมีชื่อในรูปแบบ Parent-Folder/Controller-Name
   • ชื่อฟังก์ชั่นควรตรงกับชื่อฟังก์ชั่นจากขั้นตอนที่ 2
5. ณ จุดนี้เส้นทางกำลังทำงาน แต่วิธีการควบคุมของคุณจำเป็นต้องส่งคืน yamf/Responses/Response บางอย่างซึ่งอาจเป็นอะไรก็ได้ตั้งแต่ View จนถึงการตอบสนองของ JSON ไม่ว่าคุณจะต้องการอะไรก็ตาม ดูส่วนถัดไปสำหรับข้อมูลเพิ่มเติมที่นี่
6. กรณีการใช้งานปกติของคุณอาจส่งคืน yamf/Responses/View สร้างไฟล์ PHP (ดู) ในโฟลเดอร์ views - อีกครั้งโฟลเดอร์ย่อยจะโอเค - และในวิธีการควบคุมของคุณ return new View('name/of/view'); -
7. ตอนนี้เส้นทางควรใช้งานได้!

ในระยะสั้น:

1. เพิ่มวิธีการควบคุมและคอนโทรลเลอร์ลงในโฟลเดอร์ app/Controllers
2. เพิ่มเส้นทางไปยัง routes.php
3. สร้างมุมมองในโฟลเดอร์ views หากจำเป็น
4. แก้ไขเมธอดคอนโทรลเลอร์เพื่อ return new View('name/of/view');

ประเภทส่งคืนจากฟังก์ชั่นคอนโทรลเลอร์

วิธีการควบคุมทั้งหมดที่เรียกว่าเป็นผลมาจากเส้นทางควรส่งคืน yamf/Responses/Response หรือคลาสย่อยของคลาสดังกล่าว นี่คือคำอธิบายบางอย่างเกี่ยวกับวิธีการใช้แต่ละข้อ ส่วนใหญ่สามารถใช้ในบรรทัดเดียวที่มีเพียงตัวสร้าง

• Response - คลาสพื้นฐานสำหรับการตอบกลับจากเส้นทาง
  • รูปแบบตัวสร้าง: new Response($statusCode = 200)
  • เอาต์พุตรหัสสถานะ
  • เนื่องจากรายการย่อยอื่น ๆ ของ yamf/Responses/Response อื่น ๆ ทั้งหมดจากคลาสพาเรนต์นี้พวกเขาทั้งหมดสามารถส่งคืนรหัสสถานะ HTTP ที่กำหนดเองได้หากคุณต้องการ!
• ErrorMessage - wrapper ง่าย ๆ รอบมุมมองเพื่อส่งรหัสสถานะ 400 และมุมมอง Error.php
  • รูปแบบตัวสร้าง: new ErrorMessage($msg = '', $name = 'error', $title = '', $headerName = '', $footerName = '') $name คือชื่อของมุมมอง
  • โปรดทราบว่าพารามิเตอร์แรกคือข้อความแสดงข้อผิดพลาดไม่ใช่ชื่อของมุมมอง!
  • โดยค่าเริ่มต้นชื่อตัวแปรสำหรับข้อผิดพลาดในการส่งออกในมุมมองของคุณคือ $error คุณไม่สามารถเปลี่ยนสิ่งนี้ได้โดยไม่ต้องมีคลาสย่อย
  • โดยค่าเริ่มต้นส่วนหัวและส่วนท้ายที่ใช้คือ views/header.php และ views/footer.php
  • แน่นอนว่ารหัสสถานะสามารถเปลี่ยนแปลงได้
• JsonResponse - ตัวอย่างเกี่ยวกับวิธีที่คุณสามารถส่งการตอบกลับ JSON จากคอนโทรลเลอร์ของคุณได้อย่างไร
  • รูปแบบตัวสร้าง: new JsonResponse($data, $jsonEncodeOptions = 0)
  • เอาต์พุต $data ผ่าน echo json_encode($this->data, $this->jsonEncodeOptions);
• NotFound - ใช้สำหรับการส่งคืน 404 ที่ไม่พบข้อความกลับไปยังไคลเอนต์
  • รูปแบบตัวสร้าง: new NotFound($name = '404', $data = [], $title = '', $headerName = '', $footerName = '') $name คือชื่อของมุมมอง
  • โดยค่าเริ่มต้นส่วนหัวและส่วนท้ายที่ใช้คือ views/header.php และ views/footer.php
  • หากคุณต้องการส่งกลับเพียง 404 (เช่นสำหรับ API) ให้ใช้ Response
• Redirect - อนุญาตให้เปลี่ยนเส้นทาง 302 ไปยังหน้าหรือเส้นทางอื่น ๆ
  • รูปแบบตัวสร้าง: new Redirect($redirectPath, $isInternalRedirect = true)
  • รหัสสถานะคือ 302 โดยค่าเริ่มต้น
  • $isInternalRedirect ใช้เพื่อเปลี่ยนเส้นทางไปยังเส้นทาง ภายในเว็บไซต์/ routes.php ข้อมูลปัจจุบัน php หากคุณต้องการเปลี่ยนเส้นทางไปยังเส้นทางภายในให้ใช้ Redirect แบบนี้: new Redirect('/route/name); (หมายเหตุการเริ่มต้น / ) ถ้าไม่ใช้ Redirect เช่นนี้: new Redirect('https://example.com', false); -
• View -ใช้สำหรับการคืนมุมมอง HTML ที่ใช้ PHP
  • รูปแบบตัวสร้าง: new View($name, $data = [], $title = '', $headerName = '', $footerName = '') $name คือชื่อของมุมมอง
  • ในการส่งข้อมูลไปยังมุมมองของคุณวิธีที่ง่ายที่สุดอาจใช้ฟังก์ชั่น compact ดู BlogController ของตัวอย่าง
  • โดยค่าเริ่มต้นส่วนหัวและส่วนท้ายที่ใช้คือ views/header.php และ views/footer.php

หากคุณมีแนวคิดสำหรับประเภท Response เพิ่มเติมที่ควรรวมอยู่ใน YAMF โปรดเปิดคำขอคุณสมบัติ (ผ่านแท็บปัญหา) หรือเปิดคำขอดึง!

ข้อมูลที่ส่งไปยังวิธีคอนโทรลเลอร์

ตัวแปรหลักสองตัวถูกส่งไปยังวิธีการควบคุมของคุณจากเส้นทาง: $app และ $request โปรดทราบว่าเอาต์พุต View ทั้งหมดจะมี $app และ $request ที่ใช้งานได้ คุณไม่จำเป็นต้องส่งพวกเขาเป็นพารามิเตอร์ $data

AppConfig $app

$app เป็นตัวแปรการกำหนดค่าส่วนใหญ่ที่คุณตั้งค่าใน config.php ตรวจสอบไฟล์นั้นเพื่อดูสิ่งที่มีอยู่อย่างรวดเร็ว บางรายการที่สำคัญกว่าคือ:

• $app->db สำหรับการเชื่อมต่อฐานข้อมูล
• ชื่อไฟล์ส่วนหัวเริ่มต้นสำหรับมุมมองทั้งหมดหน้า 404 และหน้าข้อผิดพลาด คุณสามารถตั้งค่าสิ่งเหล่านี้ให้เป็น null เพื่อหลีกเลี่ยงการใช้งานได้เลย

นอกจากนั้นยังมีตัวแปรสองตัวที่ตั้งค่าใน init.php :

• $app->isLocalHost ไม่ว่าแอปพลิเคชันจะทำงานบนโฮสต์ท้องถิ่น ( 127.0.0.1 หรือ ::1 )
• $app->basePath ไดเรกทอรีพื้นฐานสำหรับเว็บแอปพลิเคชันปัจจุบันของคุณ สามารถใช้เพื่ออนุญาตให้ใช้เว็บแอปพลิเคชันที่ซ้อนกันบนเว็บเซิร์ฟเวอร์ของคุณ ฉัน ขอ แนะนำให้ใช้ตัวแปรนี้ใน views ของคุณเมื่อทำลิงค์เว็บไซต์ในท้องถิ่นเพื่อที่ว่าหากคุณย้ายไฟล์ไปรอบ ๆ หรือย้ายสิ่งต่าง ๆ ไปยังโฟลเดอร์ย่อยทุกอย่างจะไม่แตก ในการเชื่อมโยงไปยังหน้าอื่นในเว็บไซต์ของคุณเพียงแค่ใช้ฟังก์ชั่น $app->yurl(string) (YAMF URL) เช่นนี้: <?= $app->yurl('/path/to/page') ?>

$request

$request จะมีข้อมูลทั้งหมดของคุณเกี่ยวกับเส้นทางของคุณและพารามิเตอร์ต่าง ๆ ที่มาพร้อมกับคำขอของคุณ เป็นประเภท yamf/Request มีสมาชิกสาธารณะเหล่านี้:

• $request->route -สตริงเส้นทางดิบสำหรับคำขอนี้
• $request->controller -ชื่อสตริงของคอนโทรลเลอร์
• $request->function ชื่อสตริงของฟังก์ชันคอนโทรลเลอร์เพื่อโทร
• $request->routeParams พารามิเตอร์ใด ๆ ในเส้นทางเช่น {id} รูปแบบ: ['id' => ค่า]
• $request->get พารามิเตอร์ใด ๆ ที่พบใน URL-รูปแบบเดียวกับ $ _get (ไม่มีการประมวลผลเพิ่มเติม)
• $request->post -พารามิเตอร์โพสต์ใด ๆ-รูปแบบเดียวกับ $ _post (ไม่มีการประมวลผลเพิ่มเติม)
• $request->anchor ถ้าใช้ส่วน # ของ URL (ไม่มี #) เราเตอร์ฉลาดพอที่จะไม่ตรงกับ URL เช่น /blah/#/foo

subclassing สำหรับการขยายเฟรมเวิร์ก

วิธีที่ง่ายที่สุดสำหรับคุณในการขยายกรอบนี้คือการได้รับจาก Response (หรือ Response อื่น ๆ ของคลาสเด็ก) และ/หรือสร้างคลาสหลักสำหรับคอนโทรลเลอร์ของคุณ ตัวอย่างเช่นโดยการรับมาจาก View คุณสามารถเปลี่ยนเอาต์พุตมุมมองเพื่อใช้เครื่องยนต์เทมเพลต Twig แทนเอาต์พุต PHP ง่ายๆ ด้วยการสร้างคลาสพาเรนต์สำหรับตัวควบคุมของคุณคุณสามารถเพิ่มสิ่งต่าง ๆ เช่นการตรวจสอบความถูกต้องหรือการประมวลผลข้อมูลพิเศษอื่น ๆ ที่เกิดขึ้นสำหรับเส้นทาง API ทั้งหมดของคุณเช่นการตรวจสอบชื่อผู้ใช้/รหัสผ่านหรือโทเค็น ตัวเลือกไม่มีที่สิ้นสุดและมีศักยภาพที่ยอดเยี่ยม!

มีตัวอย่างของการใช้กิ่งไม้แทน PHP ดิบในสาขากิ่งไม้!

ความเรียบง่ายของหน้าคง

หนึ่งในคุณสมบัติที่ดีที่ YAMF รองรับคือหน้าเว็บคงที่ที่ไม่ต้องการ route หรือ controller หากคุณต้องการ /about กับเพียงแค่หน้าง่าย ๆ ให้โยนหน้า about.php ใน views/static/ โฟลเดอร์และ - BAM! - /about ผลงานบนเว็บไซต์ของคุณ แล้วโฟลเดอร์ย่อยชอบ /blog/post-name ล่ะ? ใช้งานได้เช่นกัน! เพิ่ม views/static/blog/post-name.php และใช้งานได้ (TM)! คุณสามารถใช้สิ่งนี้เพื่อยังคงมี URL ที่สวยบนเว็บไซต์ของคุณโดยไม่ต้องกังวลกับการเพิ่มเส้นทางและตัวควบคุม

คุณสามารถกำหนดค่าตำแหน่งมุมมองแบบคงที่ใน config.php

โปรดทราบว่าเราเตอร์พยายามที่จะจับคู่เส้นทาง router.php ก่อนที่จะตรวจสอบหน้าคงที่

ตัวย่อ URL

คุณสมบัติที่เราเตอร์รองรับที่ไม่ได้เปิดใช้งานทันทีคือการลด URL ให้สั้นลง-เช่น https://example.com/short-url ต้องใช้การเชื่อมต่อฐานข้อมูล แต่ถ้าคุณเพิ่มการเชื่อมต่อฐานข้อมูลและมีตารางฐานข้อมูลที่เหมาะสม (สคีมาอยู่ใน config.sample.php ) สามารถใช้การย่อ URL ได้หากคุณต้องการ คุณไม่จำเป็นต้องเปิดใช้งานคุณสมบัตินี้

ตรรกะเซสชันเริ่มต้น

ฉันได้รวมตรรกะเซสชันเริ่มต้นความคิดเห็นใน config.sample.php อย่าลังเลที่จะใช้มันปรับเปลี่ยนหรือโยนมันออกไป หากคุณมีคำแนะนำเกี่ยวกับวิธีการปรับปรุงฟังก์ชั่นนี้โปรดเปิดคำขอดึงหรือปัญหาเพื่อสร้างการสนทนาเพิ่มเติม

ฉันสามารถช่วยมีส่วนร่วมได้หรือไม่?

ดีใจที่ถาม! มีสิ่งต่าง ๆ ที่สามารถทำได้ในโครงการโอเพนซอร์ซ: แก้ไขข้อบกพร่องคุณสมบัติใหม่และอื่น ๆ อีกมากมาย! ตรวจสอบแท็บปัญหาของที่เก็บนี้และดูว่ามีการรายงานข้อบกพร่องใดและมีการร้องขอคุณสมบัติใด มีข้อมูลเพิ่มเติมเกี่ยวกับการมีส่วนร่วมในเอกสารที่มีส่วนร่วม

ใบอนุญาต

ใบอนุญาต MIT โปรดตรวจสอบให้แน่ใจว่าได้รวมใบอนุญาตสำหรับเฟรมเวิร์กนี้ (พร้อมกับลิงค์ GitHub หากคุณรู้สึกใจกว้าง!) เมื่อใช้งานบนเว็บไซต์ของคุณ ขอบคุณ! -

ขอบคุณเป็นพิเศษ

ขอขอบคุณเป็นพิเศษสำหรับ bootswatch สำหรับชุดรูปแบบกระดาษ bootstrap ที่ใช้ในตัวอย่าง