Last modified 3 weeks ago
Documentation Versions
Propel 1.6 Next version (TBR)
Propel 1.5 Current stable version (April, 2010)
Propel 1.4 (November 2009)
Propel 1.3, (October 2008)
Propel 1.2, (September 2006)
Trunk Version, abandoned
Propel 1.4 Documentation
User Guide
Everything you need to get started - from installation and setup to advanced object model.
- What's New in Propel 1.4
Users of previous versions can check the changes here.
- Changelog
Updates in the 1.4 branch since the release of 1.4.0 stable
The Basics
- Installation
How to configure a new installation of Propel.
- Quickstart Guide
How to start using Propel for your application
- Basic CRUD
The basics of Propel CRUD (Create, Retrieve, Update, Delete) operations
General Topics
- Criteria
More examples of using Propel's Criteria object to simplify query writing.
- Relationships
How to access related rows in Propel.
- Validators
How to use Propel's validation framework.
- Configure Logging
How to configure Propel to log info, errors, etc.
- Inheritance
Single-table inheritance in Propel.
Reference
- Database Schema
All the database, table, column and foreign key options explained
- Build Configuration
How to customize the Build Properties to fit your needs
- Runtime Configuration
Tweak the runtime-conf.xml
HowTos
Place for solutions to common problems, in no particular order.
- Additional SQL Files
How to add additional SQL files that will be run when you use the insert-sql Phing target.
- Behaviors
How to package and reuse common model features.
- Copying Objects
Information about cloning objects and performing persisted object copying.
- Customizing Build
Customizing the Phing build process
- Reverse Engineering From Existing Databases
Examples of how to build an XML schema from existing db structure, how to dump data to XML, how to import it into a new database, etc.
- Full Query Logging
How to use the DebugPDO object to log queries as they are sent to the database.
- LOB support
Working with LOBs in Propel.
- Many-to-Many Relationships
How to work with many-to-many relationships in Propel.
- Replication
Use Propel in a Master-Slave Replication Environment.
- Multi-Component Data Model
How to use Propel in an environment where you may have many components / modules that each have their own object model.
- Nested Set Tree support
Working with the tree support and the nested set implementation.
- Paginating Results
How to let Propel deal with OFFSET and LIMIT statements to get a nicely paginated list of results.
- Runtime Introspection
Using the Map classes to discover table properties at runtime.
- Transactions
Some tips on how to use transactions with Propel.
Tip: The documentation is maintained in the Subversion repository. For corrections and changes, please open a Ticket using the documentation component.
API Docs
Use these if you need to browse through the Propel classes and methods.