Click to visit our site.

LacePHP: An Offline-First, API-First Microframework

Welcome to the official LacePHP documentation!

Here you’ll find everything you need to get started with our lightweight, shoe-themed PHP microframework.

We created this PHP framework not because the world needs another PHP framework trying to outdo the rest but because we believe there is still a need for an offline-first, API-first PHP micro-framework with a fresh approach to how we develop with framework.

LacePHP is a delightful, shoe-themed PHP microframework. This framework can be spun up quickly for small API projects. It offers simple approach to using a framwork, a light footprint, and a fluent coding style.

We built it for people with limited programming knowledge who do not care how the system works but just want to ship projects quickly, as well as for developers who enjoy exploring how things work. Senior developers will use the framework differently, and that is perfectly fine.

We have baked in some great ideas such as using AI to write code directly into the framework. There is a free tier for everyone and a premium tier for developers who want to enter god mode. We have also added an AI buddy that can serve as your peer-coding partner.

Whether you’re building a quick prototype or a production REST API, LacePHP helps you “lace” things together in minutes—no boilerplate, no heavy dependencies.

Enough said. Let us dive into this magical PHP framework.

Contents:

• Our Philosophy
• Installation
• LacePHP Structure
• Getting Started with LacePHP
  • Configuration via lace.json
  • Explanation of Key Settings in lace.json
  • Environment Variables with .env
  • Application Settings in config/lace.php
  • config/lace.php Overview
  • Starting the Built-In Server for Development
  • Public Folder & Document Root
  • Enabling Friendly URLs with .htaccess
• Routes
  • Closure Routes
  • Controller Routes
  • Route Parameters
  • Multiple Parameters
  • Route Grouping
  • Further Reading
• Using ShoeRequest
  • Helper Function
  • Reading Input Values
  • Headers, Server Data & Files
  • Cross-Site Request Forgery (CSRF)
  • Why Sanitization Matters
  • Putting It All Together
• Using ShoeResponder
  • HTML and Plain Text
  • JSON Responses
  • Error Responses
  • Custom Error Pages
  • Headers & Status Codes
  • Payload Data & Recording
  • Putting It All Together
• Controllers
  • Helper Functions
  • BaseController for Shared Logic
  • Example Controller
  • Why This Design?
  • Advanced Tips
• Request Validation
  • Helper Access
  • Defining Rules
  • Custom Rules
  • First-Error Mode (“lace_break”)
  • Throwing Exceptions
  • Running Validation
  • Inspecting Errors
  • Example Usage
  • Validation Syntax and Built-in Rules
  • Best Practices
• Using Middleware with Routes
  • Why Middleware Matters
  • Built-In Middleware You Can Use
  • Attaching Middleware to a Single Route
  • Grouping Multiple Routes
  • Best Practice Checklist
  • Common Pitfalls & Cautions
• Route Guards
  • Why guards matter
  • Configuration in config/lace.php
  • Applying a Guard to a Route
  • Built-In Guards Reference
• Models
  • Why Models Matter
  • Defining Your First Model
  • Basic CRUD Operations
  • Query Builder & Fluent Queries
  • Relations & Eager Loading
  • Best Practices
• Database
  • Why this matters
  • Configuration
  • ConnectionManager
  • QueryBuilder
  • Controller Example
  • Best Practices
• Migrations
  • Why Migrations Matter
  • MigrationManager
  • Blueprint
  • Welt
  • Taking Full Advantage
  • Best Practices
• Views
  • Helper Function
  • Basic Usage
  • Fallback Views
  • Best Practices
• Events and Hooks
  • Helper Functions
  • Basic Example
  • Advanced Usage
  • Best Practices
• LaceTimer (Scheduled Tasks)
  • Why Scheduled Tasks Matter
  • Configuration: schedule.json
  • Loading Code-Based Tasks
  • Inspecting Your Schedule
  • Running Due Tasks
  • Under the Hood
  • Best Practices
• HTTP Client
  • Why an HTTP Client Matters
  • cURL in a Nutshell
  • Introducing ShoeHttp
  • Examples
  • Controller Integration
  • Best Practices
• Mailer
  • Why a Mailer Matters
  • Configuration
  • Basic Usage
  • Attachments & Headers
  • Under the Hood
  • Controller Example
  • Best Practices
• GraphQL
  • Why GraphQL Matters
  • Exposing the Endpoint
  • Defining the Schema
  • Advanced Example
  • How It Works
  • Best Practices
• Testing Your API
  • Why Testing Matters
  • Introducing Tester
  • Best Practices
• API Doc Generator
  • Why API Docs Matter
  • Exposing the Swagger UI
  • Generating the OpenAPI Spec
  • CLI Integration
  • Best Practices
• Share Your URL
  • Why Share Your Local URL?
  • The dev:share Command
  • Usage Example
  • Under the Hood
  • Best Practices
• Deploying Your App
  • Why Deployment Automation Matters
  • The Deploy Command
  • Configuring Your Deployments
  • Under the Hood: ShoeDeploy::run()
  • Basic Deployment Flow
  • Advanced Hooks Example
  • Best Practices
• Plugins
  • Why Plugins Matter
  • PluginManager Overview
  • Creating a Simple Plugin
  • Built-in ShoeAI Plugin
  • Composer-Published Plugins
  • Registering CLI Commands Manually
  • Best Practices
• AI in LacePHP
  • Why LaceAI Matters
  • Getting a License
  • Activating Your License
  • Checking License Status
  • Scaffolding Code
  • Rolling Back Generated Code
  • Peer-Coding Buddy
  • Best Practices
• CLI Commands
  • Why the CLI Matters
  • Getting Started
  • Detailed Command Guide
  • Best Practices
• Helper Functions
  • Why Helpers Matter
  • Best Practices
• HWID
  • Why HWID Matters
  • How It Works (Conceptually)
  • Using HWID in Your Code
  • Advanced Example: Locking a Trial Period
  • Best Practices
• Shoebox
  • Directory Structure
  • Out-of-the-Box Service Endpoints
  • IP Restrictions (Whitelist / Blacklist)
  • Putting It All Together
• Security & Common Attacks
  • How to Make Sure You’re Covered
• Contributing to LacePHP
  • Why Contribute?
  • Getting Started
  • Code Contributions
  • Documentation Contributions
  • Best Practices
  • Code of Conduct