You are browsing a version that has not yet been released.

Tutorials

Reference

Architecture
- Using an Object-Relational Mapper
- Requirements
- Doctrine ORM Packages
- Terminology
Installation and Configuration
- Class loading
- Obtaining an EntityManager
- Setting up the Commandline Tool
Frequently Asked Questions
- Database Schema
  - How do I set the charset and collation for MySQL tables?
- Entity Classes
  - How can I add default values to a column?
- Mapping
  - Why do I get exceptions about unique constraint failures during $em->flush()?
- Associations
- Inheritance
  - Can I use Inheritance with Doctrine ORM?
  - Why does Doctrine not create proxy objects for my inheritance hierarchy?
- EntityGenerator
  - Why does the EntityGenerator not do X?
  - Why does the EntityGenerator not generate inheritance correctly?
- Performance
  - Why is an extra SQL query executed every time I fetch an entity with a one-to-one relation?
- Doctrine Query Language
- A Query fails, how can I debug it?
Basic Mapping
- Creating Classes for the Database
- Property Mapping
  - PHP Types Mapping
- Doctrine Mapping Types
- Identifiers / Primary Keys
- Quoting Reserved Words
Association Mapping
- Many-To-One, Unidirectional
- One-To-One, Unidirectional
- One-To-One, Bidirectional
- One-To-One, Self-referencing
- One-To-Many, Bidirectional
- One-To-Many, Unidirectional with Join Table
- One-To-Many, Self-referencing
- Many-To-Many, Unidirectional
- Many-To-Many, Bidirectional
  - Owning and Inverse Side on a ManyToMany Association
- Many-To-Many, Self-referencing
- Mapping Defaults
- Collections
- Initializing Collections
Inheritance Mapping
- Mapped Superclasses
- Entity Inheritance
  - Performance impact on to-one associations
- Single Table Inheritance
- Class Table Inheritance
- Overrides
  - Association Override
  - Attribute Override
- Query the Type
Working with Objects
- Entities and the Identity Map
- Entity Object Graph Traversal
- Persisting entities
- Removing entities
  - Join-table management when removing from many-to-many collections
  - Performance of different deletion strategies
- Detaching entities
- Synchronization with the Database
- Querying
Working with Associations
- Association Example Entities
- Establishing Associations
- Removing Associations
- Association Management Methods
- Synchronizing Bidirectional Collections
- Transitive persistence / Cascade Operations
  - Persistence by Reachability: Cascade Persist
- Orphan Removal
- Filtering Collections
Implementing a TypedFieldMapper
- DefaultTypedFieldMapper
- TypedFieldMapper interface
- ChainTypedFieldMapper
- Implementing a TypedFieldMapper
Events
- The Event System
  - Registering Event Handlers
- Events Overview
  - Naming convention
- Lifecycle Callbacks
- Lifecycle Callbacks Event Argument
- Listening and subscribing to Lifecycle Events
- Implementing Event Listeners
- Entity listeners
  - Entity listeners class
  - Entity listeners resolver
- Load ClassMetadata Event
- SchemaTool Events
  - postGenerateSchemaTable
  - postGenerateSchema
Doctrine Internals explained
- How Doctrine keeps track of Objects
- How Doctrine Detects Changes
- Query Internals
- The different ORM Layers
Association Updates: Owning Side and Inverse Side
- Bidirectional Associations
- Important concepts
Transactions and Concurrency
- Transaction Demarcation
- Locking Support
  - Optimistic Locking
  - Pessimistic Locking
Batch Processing
- Bulk Inserts
- Bulk Updates
  - DQL UPDATE
  - Iterating results
- Bulk Deletes
  - DQL DELETE
  - Iterating results
- Iterating Large Results for Data-Processing
Doctrine Query Language
- Types of DQL queries
- SELECT queries
- UPDATE queries
- DELETE queries
- Comments in queries
- Functions, Operators, Aggregates
- Querying Inherited Classes
  - Single Table
  - Class Table Inheritance
- The Query class
- EBNF
The QueryBuilder
- Constructing a new QueryBuilder object
- Working with QueryBuilder
Native SQL
- The NativeQuery class
- ResultSetMappingBuilder
- The ResultSetMapping
Change Tracking Policies
- Deferred Implicit
- Deferred Explicit
Attributes Reference
- Index
- Reference
XML Mapping
- Simplified XML Driver
  - Example
  - XML-Element Reference
- Defining an Entity
- Defining Fields
- Defining Identity and Generator Strategies
- Defining a Mapped Superclass
- Defining Inheritance Mappings
- Defining Lifecycle Callbacks
- Defining One-To-One Relations
- Defining Many-To-One Associations
- Defining One-To-Many Associations
- Defining Many-To-Many Associations
- Cascade Element
- Join Column Element
- Defining Order of To-Many Associations
- Defining Indexes or Unique Constraints
- Derived Entities ID syntax
PHP Mapping
- Static Function
- ClassMetadataBuilder
- ClassMetadata API
Caching
- Types of Caches
- Clearing the Cache
- Cache Chaining
- Cache Slams
Improving Performance
- Bytecode Cache
- Metadata and Query caches
- Alternative Query Result Formats
- Read-Only Entities
- Extra-Lazy Collections
- Temporarily change fetch mode in DQL
- Apply Best Practices
- Change Tracking policies
Tools
- Doctrine Console
- Database Schema Generation
- Runtime vs Development Mapping Validation
- Adding own commands
- Re-use console application
Metadata Drivers
- Core Metadata Drivers
- Implementing Metadata Drivers
- ClassMetadata
- Getting ClassMetadata Instances
Best Practices
- Constrain relationships as much as possible
- Avoid composite keys
- Use events judiciously
- Use cascades judiciously
- Don't use special characters
- Don't use identifier quoting
- Initialize collections in the constructor
- Don't map foreign keys to fields in an entity
- Use explicit transaction demarcation
Limitations and Known Issues
- Current Limitations
- Known Issues
Pagination
Filters
- Example filter class
- Configuration
- Disabling/Enabling Filters and Setting Parameters
- Suspending/Restoring Filters
Implementing a NamingStrategy
- Configuring a naming strategy
- Underscore naming strategy
- Naming strategy interface
- Implementing a naming strategy
Advanced Configuration
- Doctrine and Caching
- Configuration Options
- Development vs Production Configuration
- Connection
- Proxy Objects
- Autoloading Proxies
- Multiple Metadata Sources
- Default Repository (***OPTIONAL***)
- Ignoring entities (***OPTIONAL***)
- Setting up the Console
The Second Level Cache
- Caching Regions
- Cache Regions
- Caching mode
  - Built-in cached persisters
- Configuration
- Entity cache definition
- Association cache definition
  - Cache usage
- Using the query cache
  - Cache mode
  - DELETE / UPDATE queries
- Using the repository query cache
- Cache API
- Limitations
Security
- User input and Doctrine ORM
- Preventing Mass Assignment Vulnerabilities

Maintained

Unmaintained

Tutorials

Reference

Cookbook