PhalconKit User Guide
Use PhalconKit as the application layer between Phalcon and your project. These guides describe the current API and use the App skeleton's paths unless an example explicitly says otherwise.
Build Your First Application
- Get started: install, configure, and run the skeleton.
- Build your first resource: create a table, generate its model, expose a controlled API, and verify requests and responses.
- Add authentication and permissions.
- Run your application behind a web server.
Already have a project? Start with Application Integration.
REST API Handbook
| Guide | What you will find |
|---|---|
| REST Controllers | Every built-in action, controller setup, field policies, and extension points |
| Requests And Responses | URLs, HTTP methods, JSON/form/query inputs, response envelopes, errors, and client examples |
| Filtering And Pagination | Filter objects, all operator families, nested AND/OR groups, search, sorting, limits, and offsets |
| Writes And Batches | Create/update/save intent, validation, partial batch success, delete, restore, and reorder |
| Relationships | Eager loading, client-selected graphs, related filters, nested writes, and safe exposure |
| Counts, Aggregates, And Exports | List totals, grouped counts, distinct facets, calculations, and CSV downloads |
| API Scenario Checklist | Request/result cases to verify for your own resource |
Examples distinguish the complete HTTP envelope from a view fragment. Each resource controls its exposed fields, enabled actions, and row access, so copy the accompanying controller configuration as well as the request.
Application Development
| Task | Guide |
|---|---|
| Decide where application code belongs | Architecture |
| Configure environments, modules, and services | Configuration |
| Connect Core to your own bootstrap | Application Integration |
| Manage application tables | Database Migrations |
| Generate and regenerate models | Database And Scaffolding |
| Work with model relationships and behaviors | Models And Eager Loading |
| Choose the tables and services a feature needs | Feature Setup |
| Sign in, refresh tokens, and sign out | Authentication |
| Grant actions and restrict rows | Identity And Permissions |
| Configure keys, CORS, and sensitive fields | Application Security |
| Write a command | CLI Tasks |
| Serve HTTP and WebSockets | Web Servers And WebSockets |
| Check PHP and Phalcon in each runtime | Runtime Requirements |
| Test your application's behavior | Application Testing |
| Find a focused implementation example | Application Cookbook |
| Resolve a failure | Troubleshooting |
Existing Applications
Use the migration index for package/namespace changes, older REST resources, Core 4, and App layout/dependency changes. These guides share a consistent preparation, change, verification, and rollback structure.
Reference And Help
- Class reference: exact classes, methods, and signatures.
- Phalcon documentation: the underlying PHP framework's APIs.
- Discussions: application questions and examples.
- Issue tracker: reproducible bugs and documentation corrections.
For changes to PhalconKit itself, use the contribution guide. Project maintenance and release procedures are separate from application setup.