Documentation
- What's New in Propel 1.6 Users of previous versions can check the changes here.
- Changelog Updates in the 1.6 branch since the release of 1.6.0 stable.
- API Documentation The generated API documentation.
Project Setup
- Installing Propel Install Propel using Git, PEAR, or a tarball.
- Building A Project Generate a PHP model based on a XML schema
Propel Basics
- Basic CRUD The basics of Propel C.R.U.D. (Create, Retrieve, Update, Delete) operations
- Relationships Searching and manipulating data from related tables.
- Validators The validation framework checks data before insertion based on column type.
- Transactions Where and when to use transactions.
- Behaviors The behavior system allows to package and reuse common model features.
- Logging And Debugging Propel can log a lot of information, including the SQL queries it executes.
- Inheritance Single Table Inheritance, Class Table Inheritance, and Concrete Table Inheritance come free with Propel.
- Migrations Change the structure of the database without altering the data.
Reference
- XML Schema Format All the database, table, column and foreign key options explained
- Active Record Classes Complete list of the methods of Active Record classes.
- Active Query Classes Complete list of the methods of Propel Query classes.
- Build Properties Reference for the
build.properties
file (propel.ini
in symfony). - Runtime Configuration File Reference for the
runtime-conf.xml
file.
Behaviors Reference
aggregate_column
alternative_coding_standards
archivable
auto_add_pk
delegate
i18n
nested_set
query_cache
sluggable
soft_delete
(deprecated, usearchivable
instead)timestampable
sortable
versionable
- And
concrete_inheritance
, documented in the Inheritance Chapter even if it's a behavior
You can also look at user contributed behaviors.
Cookbook
Common Tasks
- Additional SQL Files How to execute custom SQL statements at buildtime
- Advanced Column Types How to work with BLOBs, serialized PHP objects, ENUM, and ARRAY column types.
- Customizing build How to customize the Phing build process.
- DB Designer How to import an XML schema from existing DBDesigner 4 file.
- How to Use PHP 5.3 Namespaces How to generate model classes with namespaces, and how to use them.
- Model Introspection At Runtime How to use the Map classes to discover table properties at runtime.
- Multi-Component Data Model How to generate model classes in subdirectories, and organize your model into independent packages / modules.
- Object Copy How to clone and copy persisted objects.
- Replication How to use Propel in a Master-Slave Replication Environment.
- Using Propel With MSSQL Server How to choose and configure Propel to persist data to a Microsoft SQL Server database.
- Using SQL Schemas How to organize tables into SQL schemas (only for MySQL, PostgreSQL, and MSSQL).
- Working With Existing Databases How to build an XML schema from an existing db structure, how to dump data to XML, how to import it into a new database, etc.
Contribute to Propel
- Writing A Behavior How to write a custom behavior to reuse model code horizontally.
- Testing Your Behaviors How to unit test your behaviors.
- Working with unit tests How to setup propel's required environment and use PHPUnit.
Working with symfony 1.4
- Using Propel as Default ORM How to initialize a symfony project with Propel as default ORM - the git way.
- Using the
i18n
behavior How to use Propel'si18n
behavior with symfony 1.4. - Using the legacy
symfony_i18n
behavior How to use the oldSfPropelBehaviori18n
(a.k.a.symfony_i18n
) with symfony 1.4.
Working with Symfony2
- Working with Symfony2 (Introduction)
- Symfony2 And Propel In Real Life
- Mastering Symfony2 Forms With Propel
- The Symfony2 Security Component And Propel
- Adding A New Behavior In Symfony2
- Testing
Working with Silex
Tip
This is the documentation for the latest Propel 1.x version. To access the old documentation, please visit trac.propelorm.org.
Found a typo ? Something is wrong in this documentation ? Just fork and edit it !