Propel 1.5 Documentation
User Guide
Everything you need to get started - from installation and setup to advanced object model.
- What's New in Propel 1.5
Users of previous versions can check the changes here.
Project Setup
- Installing Propel
Install Propel using PEAR, SVN or a tarball.
- Building A Project
Generate PHP model based on a XML schema
Using Propel
- Basic CRUD
The basics of Propel CRUD (Create, Retrieve, Update, Delete) operations
- Relationships
How to access related rows in Propel.
- Validators
How to use Propel's validation framework.
- Transactions
Some tips on how to use transactions with Propel.
- Behaviors
How to package and reuse common model features.- nested_set
- soft_delete
- sluggable
- timestampable
- sortable
- concrete_inheritance, documented in the Inheritance Chapter even though it's a behavior
- auto_add_pk
- Logging And Debugging
How to configure Propel to log info and track bugs.
- Inheritance
Single Table Inheritance and Concrete Table Inheritance come free with 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
- The ModelCriteria object
Complete list of Propel Query methods.
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.
- 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.
- 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.
- 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.
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.
