Learn Laravel 11

In this edition of the Suess Labs' Learn repository, we'll dive into the Laravel PHP framework for web applications.

Author: Damian Suess
Website: suesslabs.com

Quick-Start Running Samples

1. Open a project
2. Rename, .env.example as .env
3. Install/reload packages (composer install)
4. Run database migrations and generate keys
5. Run the project (php artisan serve)

composer install
cp .env.example .env
php artisan migrate
php artisan key:generate
php artisan serve

Overview

The following projects dive into the basics and customization of Laravel.

Foreword

Looking back, I've usually always created custom micro-frameworks with PHP to keep things lean, quick, and target a project's needs. However, there are a few bottlenecks that can come of that. Namely, rapid prototyping, maintainability, and scalability can quickly pinch points throughout a product's lifecycle. As a consideration, frameworks like Laravel can assist with such things.

By all means, explore and build your frameworks! This will teach you a lot of solid fundamentals, especially the core functionality of PHP.

Guides

File	Description
laravel-terminology.md	New to Laravel? Check out the doc to understand the folder structures and terminology used.
install-guide.md	Quick-start guide to installing PHP, Laravel, Xdebug, Composer, etc.
debugging.md	How to debug your project using VS Code basics

Clearing Cache

The following commands are used to clear the cache

php artisan cache:clear
php artisan route:clear
php artisan config:clear
php artisan view:clear

For a deeper clean, delete the folder, /vendor/ (60 MB).

After doing so, you will need to execute composer install to reload the packages.

PascalCase

In the PascalCase sample projects the following mottos are applied:

1. The projects using PascalCase are an example of overriding Laravel's default naming conventions. In reality, most organizations have their own (legacy) conventions. As an example, variable names such as it be passwd vs. password, userName vs. name, or rememberToken instead of remember_token.

2. Most samples people provide are a 1-to-1 on the naming, leaning into the Laravel "magic glue".

3. A framework should be flexible and well-documented to suit the customer's needs. When it's too ridged, copious amounts of scaffolding and code smells will occur.

Creating a New Laravel Sample Project

# Create blank project
composer create-project laravel/laravel MyNewApp

# Create project using specific version "11.*" or "11.6"
composer create-project laravel/laravel SampleLaravel11App 11.*

# Add DB Migration Script (replace, "product", with your name)
# As a former DBA plural makes me cringe, Laravel likes plural like, "products" instead of "product"  ):
php artisan make:migration create_product_table --create=product

# Run DB Migrations
php artisan migrate

# Create new Form Validation class
# Path: Path: app/Http/Requests/ProductStoreRequest.php
php artisan make:request ProductStoreRequest

# Create Controller and Model classes
artisan make:controller ProductController --resource --model=Product`

Extensions and More

Before running a sample project please note the following

1. The .env files are not saved by default.
   • Copy .env.example as .env before running
   • Error 500 may occur when the .env file is missing.
2. Run with VS Code and the suggested Extensions
   1. See, .vscode/extensions.json for more info.
3. Execute, composer install to download the Vendor packages.
4. Execute, php artisan migrate to create the database before running
   • php artisan migrate:fresh - Drop tables and recreate
   • php artisan migrate:fresh --seed - Seed table with test data (when project states to do so)
5. Launch project, php artisan serve

Sample Projects

0. Template Projects
   1. VS Code Project Template
   2. Custom Database Naming Convention Template
1. CRUD - Basic webpage form with Create, Read, Update, and Delete operations
2. Form Validation - Form submission validator with recall of previously entered values
3. REST API Login and CRUD operation - Including VS Code tester using REST Client extension
4. REST API and CRUD - Slightly more complex implementation of the same thing
5. Custom DB Naming Conventions - Column names using PascalCase and not the gross snake_case.
   1. Pascal Case - Seeder - DB Factory and Seeder example using your PascalCase columns
   2. Pascal Case - API - Web API for creating "Customers and Products"
   3. Pascal Case - Filter Results
   4. Pascal Case - Include Invoice
   5. Pascal Case - POST PUT PATCH - Create and Update items
   6. Pascal Case - Upload Update - Massive upload information to store in DB
   7. Pascal Case - Unit Testing - How to test your Custom DB Naming Conventions
   8. Pivot Table - COMING SOON
6. Web API Service - COMING SOON - Use services to link both View and API logic.
7. Database - Pivot Table

Creating a Sample

composer create-project laravel/laravel #.#-AppName
composer require --dev friendsofphp/php-cs-fixer
./vendor/bin/php-cs-fixer fix       # Reformats EVERYTHING!
# ./vendor/bin/php-cs-fixer fix app # Reformats only /app/ folder

References

The projects listed here are based on the following examples. The examples in this repository have been modified and improved upon (bug fixes, added functionality, testability, etc.)

• REST API Example
• CRUD Example
• Form Validation Example

Coming Soon

• Deleting Multiple Records
• Publish API Route File
• File Upload Example
• AJAX Request Example
• JQuery Ajax Loading Spinner Example
• Generate and Read Sitemap XML File Example
• Testing Database with Factory and Seeders

Debugging Tips

Checkout debugging.md for more information

1. php artisan migrate --pretend
   1. Show the migration SQL queries before they're ran

Naming Conventions

There are many "rules" out there which veer off from one another, however, the following appears to be widely accepted. (Frankly, I often use Xeno Innovations' legacy rules.)

• Models - Always singular and PascalCase
• Controllers - Usually singular and ending with the word, Controller. i.e. PostController

Future Examples

• Sanctum vs Passport (OAuth2)
  • Sanctum - Lightweight, single page apps, mobile apps, token based APIs.
  • Passport - OAuth2
  • Installing:
    • Sanctum: php artisan install:api
    • Passport: php artisan install:api --passport
• Sail with Docker
• LiveWire (GitHub)
  • "Building dynamic, reactive, frontend UIs using just PHP."
  • UI with: Tailwindscss, FluxUI (github)

Other References

• Database: Query Builder
• Deleting Multiple Records
• Publish API Route File
• File Upload Example
• AJAX Request Example
• JQuery Ajax Loading Spinner Example
• Generate and Read Sitemap XML File Example
• Testing Database with Factory and Seeders - Blog, Video

Example From The Web

• Loan Application