User Guide

Wiki Documentation

We are rewriting the contents of the HTML user guide and providing new documentation topics in wiki format.

Please send a note to dev@… if you'd like to help write documentation. Any help is always appreciated. If you are helping, please see the wiki:Development/Guidelines/UserDocumentationGuidelines page for some style guidelines to keep things looking consistent.

The Basics

• Installation
  How to install and configure 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

• Relationships
  How to access related rows in Propel.

• Validators
  How to use Propel's validation framework.

• Naming
  How Propel translates identifier names to PHP names & how you can customize this.

• Configure Logging
  How to configure Propel to log info, errors,etc.

Advanced Topics

• Many-to-Many Relationships
  How to work with many-to-many relationships in Propel.

• Using MapBuilder Classes?

Reference

• Database Schema
• Propel Column Types?

• The Propel Build System?
• Build Properties?

• Criteria?

Standalone User Guide

The original Propel User Guide contains instructions on installing, configuring and using Propel. Some of these instructions (especially about installation) are no longer correct, however, it is provided here for historical reference.

View the original User Guide online in HTML format:

• (en) Online HTML User Guide
• (es) Online HTML User Guide - Spanish translation by John
• (pl) Online HTML User Guide - Polish translation

Franklin Ruiz Neira