Documentation

• What’s New in Propel 2.0 Users of previous versions can check the changes here.
• Changelog Updates of the version 2.0.
• API Documentation The generated API documentation.

Project Setup

• Installing Propel Install Propel using Git, or a zipball/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.
• 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.
• Configuration Configuring Propel

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.
• Compatibility index A list of primary limitations regarding different databases.
• Configuration file Complete list of Propel configuration properties.

Behaviors Reference

• Writing A Behavior How to write a custom behavior to reuse model code horizontally.
• aggregate_column
• archivable
• auto_add_pk
• delegate
• i18n
• nested_set
• query_cache
• sluggable
• timestampable
• sortable
• validate
• 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.
• How to Use 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.
• Working with Propel’s Test Suite How to work with Propel’s test suite if you want to add a missing case or attach a regression test with your patch.

Working with Silex

• Working with Silex

Working with Symfony2

• Working with Symfony2 (Introduction)
• Mastering Symfony2 Forms With Propel
• The Symfony2 Security Component And Propel

Working with Symfony 4.0

• Working with Symfony 4.0

TipThis is the up-to-date documentation for the last Propel version. To access the old documentation, please visit propelorm.org/Propel.