Doctrine - Doctrine ORM for PHP

Introduction
- Code Examples
- What is Doctrine?
- What is an ORM?
- What is the Problem?
- Minimum Requirements
- Basic Overview
- Doctrine Explained
- Key Concepts
- Further Reading
- Conclusion
Getting Started
- Checking Requirements
- Installing
- Implementing
- Conclusion
Introduction to Connections
- DSN, the Data Source Name
  - Examples
- Opening New Connections
- Lazy Database Connecting
- Testing your Connection
- Conclusion
Configuration
- Levels of Configuration
- Defaults Attributes
  - Default Column Options
  - Default Added Auto Id
- Portability
  - Portability Mode Attributes
  - Examples
- Identifier quoting
- Hydration Overwriting
- Configure Table Class
- Configure Query Class
- Configure Collection Class
- Disabling Cascading Saves
- Exporting
- Naming convention attributes
- Conclusion
Connections
- Introduction
- Opening Connections
- Retrieve Connections
- Current Connection
- Change Current Connection
- Iterating Connections
- Get Connection Name
- Close Connection
- Get All Connections
- Count Connections
- Creating and Dropping Database
- Writing Custom Connections
- Conclusion
Introduction to Models
- Introduction
- Generating Models
  - Existing Databases
    - Making the first import
  - Schema Files
- Manually Writing Models
- Autoloading Models
  - Conservative
  - Aggressive
- Conclusion
Defining Models
- Columns
  - Column Lengths
  - Column Aliases
  - Default values
  - Data types
    - Introduction
    - Type modifiers
    - Boolean
    - Integer
    - Float
    - Decimal
    - String
    - Array
    - Object
    - Blob
    - Clob
    - Timestamp
    - Time
    - Date
    - Enum
    - Gzip
  - Examples
- Relationships
- Indexes
- Checks
- Table Options
- Record Filters
- Transitive Persistence
  - Application-Level Cascades
    - Save Cascades
    - Delete Cascades
  - Database-Level Cascades
- Conclusion
Working with Models
- Define Test Schema
- Dealing with Relations
- Many-to-Many Relations
  - Creating a New Link
  - Deleting a Link
- Fetching Objects
  - Sample Queries
  - Field Lazy Loading
- Arrays and Objects
- Overriding the Constructor
- Conclusion
DQL (Doctrine Query Language)
- Introduction
- SELECT queries
  - Aggregate values
- UPDATE queries
- DELETE Queries
- FROM clause
- JOIN syntax
  - ON keyword
  - WITH keyword
- INDEXBY keyword
- WHERE clause
- Conditional expressions
- Functional Expressions
  - String functions
  - Arithmetic functions
- Subqueries
  - Introduction
  - Comparisons using subqueries
- GROUP BY, HAVING clauses
- ORDER BY clause
- LIMIT and OFFSET clauses
  - Driver Portability
  - The limit-subquery-algorithm
- Named Queries
- BNF
- Magic Finders
- Debugging Queries
- Conclusion
Component Overview
- Manager
  - Retrieving Connections
- Connection
- Table
- Record
- Collection
- Validator
  - More Validation
  - Valid or Not Valid
    - Implicit Validation
    - Explicit Validation
- Profiler
  - Basic Usage
- Locking Manager
- Views
  - Using Views
- Conclusion
Native SQL
- Introduction
- Component Queries
- Fetching from Multiple Components
- Conclusion
YAML Schema Files
- Introduction
- Abbreviated Syntax
- Verbose Syntax
- Relationships
- Features & Examples
- Using Schema Files
- Conclusion
Data Validation
- Introduction
- Examples
  - Not Null
  - Email
  - Not Blank
  - No Space
  - Past
  - Future
  - Min Length
  - Country
  - IP Address
  - HTML Color
  - Range
  - Unique
  - Regular Expression
  - Credit Card
  - Read Only
  - Unsigned
  - US State
- Conclusion
Data Hydrators
- Core Hydration Methods
- Writing Hydration Method
Inheritance
- Simple
- Concrete
- Column Aggregation
- Conclusion
Behaviors
- Introduction
- Simple Templates
- Templates with Relations
- Delegate Methods
- Creating Behaviors
- Core Behaviors
  - Introduction
  - Versionable
  - Timestampable
  - Sluggable
  - I18n
  - NestedSet
  - Searchable
  - Geographical
  - SoftDelete
- Nesting Behaviors
- Generating Files
- Querying Generated Classes
- Conclusion
Searching
- Introduction
- Index structure
- Index Building
- Text Analyzers
- Query language
- Performing Searches
- File searches
- Conclusion
Hierarchical Data
- Introduction
- Nested Set
- Conclusion
Data Fixtures
- Importing
- Dumping
- Implement
- Writing
- Fixtures For Nested Sets
- Fixtures For I18n
- Conclusion
Database Abstraction Layer
- Export
- Import
- DataDict
- Drivers
  - Mysql
    - Setting table type
- Conclusion
Transactions
- Introduction
- Nesting
- Savepoints
- Isolation Levels
- Conclusion
Event Listeners
- Introduction
- Connection Listeners
- Hydration Listeners
- Record Listeners
- Record Hooks
- DQL Hooks
- Chaining Listeners
- The Event object
- Conclusion
Caching
- Introduction
- Drivers
  - Memcache
  - APC
  - Db
- Query Cache & Result Cache
- Conclusion
Migrations
- Performing Migrations
- Implement
- Writing Migration Classes
- Conclusion
Extensions
Utilities
- Pagination
- Facade
- Command Line Interface
  - Introduction
  - Tasks
  - Usage
- Sandbox
  - Installation
- Conclusion
Unit Testing
- Running tests
  - CLI
  - Browser
- Writing Tests
- Conclusion
Improving Performance
- Introduction
- Compile
- Conservative Fetching
- Bundle your Class Files
- Use a Bytecode Cache
- Free Objects
- Other Tips
- Conclusion
Technology
- Introduction
- Architecture
- Design Patterns Used
- Speed
- Conclusion
Exceptions and Warnings
- Manager exceptions
- Relation exceptions
- Connection exceptions
- Query exceptions
- Conclusion
Real World Examples
- User Management System
- Forum Application
- Conclusion
Coding Standards
- PHP File Formatting
- Naming Conventions
- Coding Style
- Conclusion

SVN

It is highly recommended that you use Doctrine via SVN and the externals option. This option is the best as you will receive the latest bug fixes from SVN to ensure the best experience using Doctrine.

Installing

To install Doctrine via SVN is very easy. You can download any version of Doctrine from the SVN server: http://svn.doctrine-project.org

To check out a specific version you can use the following command from your terminal:

svn co http://svn.doctrine-project.org/branches/1.2 .

If you do not have a SVN client, chose one from the list below. Find the Checkout option and enter http://svn.doctrine-project.org/branches/1.2 in the path or repository url parameter. There is no need for a username or password to check out Doctrine.

TortoiseSVN a Windows application that integrates into Windows Explorer
svnx a Mac OS X GUI svn application
Eclipse has SVN integration through the subeclipse plugin
Versions a subversion client for the mac

Updating

Updating Doctrine with SVN is just as easy as installing. Simply execute the following command from your terminal:

$ svn update

<< Sandbox

SVN Externals >>

Questions and Feedback

If you find a problem with the documentation or have a suggestion, please register and open a ticket.

If you need support or have a technical question, you can post to the user mailing-list.

SVN

Table of Contents

SVN

Installing

Updating

Questions and Feedback