Table of Contents

• 1 Getting started
  • 1.1 Requirements
  • 1.2 Installation
    • 1.2.1 Sandbox Package
    • 1.2.2 SVN
    • 1.2.3 SVN externals
    • 1.2.4 PEAR
    • 1.2.5 Zip-package
  • 1.3 Starting new project
  • 1.4 Working with existing databases
    • 1.4.1 Introduction
    • 1.4.2 Making the first import
  • 1.5 Creating tables
    • 1.5.1 Introduction
    • 1.5.2 Getting export queries
    • 1.5.3 Export options
  • 1.6 Generating models
  • 1.7 Auto loading models
    • 1.7.1 Conservative
    • 1.7.2 Aggressive
  • 1.8 Command line interface
  • 1.9 My first project tutorial
    • 1.9.1 Introduction
    • 1.9.2 Download
    • 1.9.3 Package Contents
    • 1.9.4 Running the CLI
    • 1.9.5 Defining Schema
    • 1.9.6 Test Data Fixtures
    • 1.9.7 Building Everything
    • 1.9.8 Running Tests
    • 1.9.9 User CRUD
• 2 Connection management
  • 2.1 DSN, the Data Source Name
    • 2.1.1 Examples
  • 2.2 Opening a new connection
  • 2.3 Lazy-connecting to database
  • 2.4 Managing connections
  • 2.5 Connection-component binding
• 3 Basic schema mapping
  • 3.1 Introduction
  • 3.2 Table and class naming
  • 3.3 Table options
  • 3.4 Columns
    • 3.4.1 Column naming
    • 3.4.2 Column aliases
    • 3.4.3 Default values
    • 3.4.4 Data types
      • 3.4.4.1 Introduction
      • 3.4.4.2 Type modifiers
      • 3.4.4.3 Boolean
      • 3.4.4.4 Integer
      • 3.4.4.5 Float
      • 3.4.4.6 String
      • 3.4.4.7 Array
      • 3.4.4.8 Object
      • 3.4.4.9 Blob
      • 3.4.4.10 Clob
      • 3.4.4.11 Timestamp
      • 3.4.4.12 Time
      • 3.4.4.13 Date
      • 3.4.4.14 Enum
      • 3.4.4.15 Gzip
      • 3.4.4.16 Examples
  • 3.5 Constraints and validators
    • 3.5.1 Introduction
    • 3.5.2 Notnull
    • 3.5.3 Unique
    • 3.5.4 Check
  • 3.6 Record identifiers
    • 3.6.1 Introduction
    • 3.6.2 Natural
    • 3.6.3 Autoincremented
    • 3.6.4 Composite
    • 3.6.5 Sequence
  • 3.7 Indexes
    • 3.7.1 Introduction
    • 3.7.2 Adding indexes
    • 3.7.3 Index options
    • 3.7.4 Special indexes
• 4 Relations
  • 4.1 Introduction
  • 4.2 Foreign key associations
    • 4.2.1 One-To-One
    • 4.2.2 One-to-Many, Many-to-One
    • 4.2.3 Tree structure
  • 4.3 Join table associations
    • 4.3.1 Many-to-Many
    • 4.3.2 Self-referencing (Nest relations)
      • 4.3.2.1 Non-equal nest relations
      • 4.3.2.2 Equal nest relations
  • 4.4 Inheritance
    • 4.4.1 Simple inheritance
    • 4.4.2 Concrete inheritance
    • 4.4.3 Column aggregation inheritance
  • 4.5 Foreign key constraints
    • 4.5.1 Introduction
    • 4.5.2 Integrity actions
• 5 Schema Files
  • 5.1 Introduction
  • 5.2 Short Hand Syntax
  • 5.3 Expanded Syntax
  • 5.4 Relationships
    • 5.4.1 Detect Relations
    • 5.4.2 Customizing Relationships
    • 5.4.3 One to One
    • 5.4.4 One to Many
    • 5.4.5 Many to Many
  • 5.5 Features & Examples
    • 5.5.1 Connection Binding
    • 5.5.2 Attributes
    • 5.5.3 Enums
    • 5.5.4 Templates
    • 5.5.5 ActAs
    • 5.5.6 Options
    • 5.5.7 Indexes
    • 5.5.8 Inheritance
    • 5.5.9 Generate Accessors
    • 5.5.10 Column Aliases
    • 5.5.11 Packages
    • 5.5.12 Global Schema Information
  • 5.6 Using Schema Files
• 6 Utilities
  • 6.1 Pagination
    • 6.1.1 Introduction
    • 6.1.2 Working with pager
    • 6.1.3 Controlling range styles
      • 6.1.3.1 Sliding
      • 6.1.3.2 Jumping
    • 6.1.4 Advanced layouts with pager
      • 6.1.4.1 Mask
      • 6.1.4.2 Template
    • 6.1.5 Customizing pager layout
  • 6.2 Facade
    • 6.2.1 Creating & Dropping Databases
    • 6.2.2 Convenience Methods
    • 6.2.3 Tasks
  • 6.3 Command Line Interface
    • 6.3.1 Introduction
    • 6.3.2 Tasks
    • 6.3.3 Usage
  • 6.4 Sandbox
    • 6.4.1 Installation
• 7 Working with objects
  • 7.1 Dealing with relations
    • 7.1.1 Creating related records
    • 7.1.2 Retrieving related records
    • 7.1.3 Updating related records
    • 7.1.4 Deleting related records
    • 7.1.5 Working with related records
      • 7.1.5.1 Testing the existance of a relation
  • 7.2 Many-to-Many relations
    • 7.2.1 Creating a new link
    • 7.2.2 Deleting a link
  • 7.3 Fetching objects
    • 7.3.1 Field lazy-loading
  • 7.4 Arrays and objects
    • 7.4.1 toArray
    • 7.4.2 fromArray
    • 7.4.3 synchronizeWithArray
  • 7.5 Overriding the constructor
• 8 Component overview
  • 8.1 Record
    • 8.1.1 Properties
    • 8.1.2 Retrieving existing records
    • 8.1.3 Updating records
    • 8.1.4 Refreshing records
      • 8.1.4.1 Refreshing relationships
    • 8.1.5 Deleting records
    • 8.1.6 Using expression values
    • 8.1.7 Getting record state
    • 8.1.8 Getting object copy
    • 8.1.9 Saving a blank record
    • 8.1.10 Mapping custom values
    • 8.1.11 Serializing
    • 8.1.12 Checking existence
    • 8.1.13 Function callbacks for columns
  • 8.2 Collection
    • 8.2.1 Accessing elements
    • 8.2.2 Adding new elements
    • 8.2.3 Getting collection count
    • 8.2.4 Saving the collection
    • 8.2.5 Deleting collection
    • 8.2.6 Key mapping
    • 8.2.7 Loading related records
  • 8.3 Connection
    • 8.3.1 Available drivers
    • 8.3.2 Getting a table object
    • 8.3.3 Flushing the connection
    • 8.3.4 Querying the database
  • 8.4 Table
    • 8.4.1 Getting column information
    • 8.4.2 Getting relation information
    • 8.4.3 Finder methods
      • 8.4.3.1 Custom table classes
    • 8.4.4 Custom finders
  • 8.5 Validators
    • 8.5.1 Introduction
    • 8.5.2 More Validation
    • 8.5.3 Valid or Not Valid
      • 8.5.3.1 Implicit validation
      • 8.5.3.2 Explicit validation
  • 8.6 Profiler
    • 8.6.1 Introduction
    • 8.6.2 Basic usage
  • 8.7 Locking manager
    • 8.7.1 Introduction
    • 8.7.2 Examples
    • 8.7.3 Technical Details
  • 8.8 View
    • 8.8.1 Introduction
    • 8.8.2 Managing views
    • 8.8.3 Using views
• 9 Hierarchical data
  • 9.1 Introduction
  • 9.2 Nested set
    • 9.2.1 Introduction
    • 9.2.2 Setting up
    • 9.2.3 More than 1 tree in a single table
    • 9.2.4 Working with the tree(s)
      • 9.2.4.1 Creating a root node
      • 9.2.4.2 Inserting a node
      • 9.2.4.3 Deleting a node
      • 9.2.4.4 Moving a node
      • 9.2.4.5 Examining a node
      • 9.2.4.6 Examining and retrieving siblings
      • 9.2.4.7 Examining and retrieving children / parents / descendants / ancestors
      • 9.2.4.8 Simple Example: Displaying a tree
    • 9.2.5 Advanced usage
      • 9.2.5.1 Fetching a tree with relations
  • 9.3 Examples
• 10 Configuration
  • 10.1 Introduction
  • 10.2 Levels of configuration
  • 10.3 General attributes
    • 10.3.1 Portability
      • 10.3.1.1 Portability Mode Constants
      • 10.3.1.2 Examples
    • 10.3.2 Identifier quoting
    • 10.3.3 Exporting
    • 10.3.4 Event listener
  • 10.4 Naming convention attributes
    • 10.4.1 Index name format
    • 10.4.2 Sequence name format
    • 10.4.3 Table name format
    • 10.4.4 Database name format
  • 10.5 Validation attributes
    • 10.5.1 Validation mode constants
    • 10.5.2 Examples
• 11 Data fixtures
  • 11.1 Exporting
  • 11.2 Importing
  • 11.3 Dummy Data
  • 11.4 Writing
  • 11.5 Fixtures For Nested Sets
  • 11.6 Fixtures For I18n
• 12 DQL (Doctrine Query Language)
  • 12.1 Introduction
  • 12.2 SELECT queries
    • 12.2.1 DISTINCT keyword
    • 12.2.2 Aggregate values
  • 12.3 UPDATE queries
  • 12.4 DELETE queries
  • 12.5 FROM clause
  • 12.6 JOIN syntax
    • 12.6.1 ON keyword
    • 12.6.2 WITH keyword
  • 12.7 INDEXBY keyword
  • 12.8 WHERE clause
  • 12.9 Conditional expressions
    • 12.9.1 Literals
    • 12.9.2 Input parameters
    • 12.9.3 Operators and operator precedence
    • 12.9.4 Between expressions
    • 12.9.5 In expressions
    • 12.9.6 Like Expressions
    • 12.9.7 Null Comparison Expressions
    • 12.9.8 Empty Collection Comparison Expressions
    • 12.9.9 Collection Member Expressions
    • 12.9.10 Exists Expressions
    • 12.9.11 All and Any Expressions
    • 12.9.12 Subqueries
  • 12.10 Functional Expressions
    • 12.10.1 String functions
    • 12.10.2 Arithmetic functions
    • 12.10.3 Datetime functions
  • 12.11 Subqueries
    • 12.11.1 Introduction
    • 12.11.2 Comparisons using subqueries
    • 12.11.3 Conditional expressions
      • 12.11.3.1 ANY, IN and SOME
      • 12.11.3.2 ALL
      • 12.11.3.3 EXISTS and NOT EXISTS
    • 12.11.4 Correlated subqueries
    • 12.11.5 Subqueries in FROM clause
  • 12.12 GROUP BY, HAVING clauses
  • 12.13 ORDER BY clause
    • 12.13.1 Introduction
    • 12.13.2 Sorting by an aggregate value
    • 12.13.3 Using random order
  • 12.14 LIMIT and OFFSET clauses
    • 12.14.1 Driver portability
    • 12.14.2 The limit-subquery-algorithm
  • 12.15 Examples
  • 12.16 The Query Registry
    • 12.16.1 Namespaces
  • 12.17 BNF
  • 12.18 Magic Finders
• 13 Native SQL
  • 13.1 Introduction
  • 13.2 Component queries
  • 13.3 Fetching from multiple components
• 14 Transactions
  • 14.1 Introduction
  • 14.2 Nesting
  • 14.3 Savepoints
  • 14.4 Locking strategies
    • 14.4.1 Pessimistic locking
    • 14.4.2 Optimistic locking
  • 14.5 Lock modes
  • 14.6 Isolation levels
  • 14.7 Deadlocks
• 15 Caching
  • 15.1 Introduction
  • 15.2 Drivers
    • 15.2.1 Memcache
    • 15.2.2 APC
    • 15.2.3 Db
  • 15.3 Query Cache & Result Cache
    • 15.3.1 Introduction
    • 15.3.2 Query Cache
      • 15.3.2.1 Using the query cache
      • 15.3.2.2 Fine-tuning
    • 15.3.3 Result Cache
      • 15.3.3.1 Using the result cache
      • 15.3.3.2 Fine-tuning
• 16 Event listeners
  • 16.1 Introduction
  • 16.2 Connection listeners
    • 16.2.1 Creating a new listener
    • 16.2.2 Attaching listeners
    • 16.2.3 preConnect, postConnect
    • 16.2.4 Transaction listeners
    • 16.2.5 Query execution listeners
  • 16.3 Query listeners
  • 16.4 Record listeners
  • 16.5 Record hooks
  • 16.6 Chaining listeners
  • 16.7 The Event object
    • 16.7.1 Getting the invoker
    • 16.7.2 Event codes
    • 16.7.3 getInvoker()
    • 16.7.4 skipOperation()
    • 16.7.5 skipNextListener()
• 17 Class templates
  • 17.1 Introduction
  • 17.2 Simple templates
  • 17.3 Templates with relations
  • 17.4 Delegate methods
  • 17.5 Working with multiple templates
  • 17.6 Core Templates
    • 17.6.1 Versionable
    • 17.6.2 Timestampable
    • 17.6.3 Sluggable
    • 17.6.4 I18n
    • 17.6.5 NestedSet
    • 17.6.6 Searchable
    • 17.6.7 Geographical
• 18 Plugins
  • 18.1 Internationalization with I18n
    • 18.1.1 Creating the I18n table
    • 18.1.2 Using I18n
  • 18.2 AuditLog and versioning
    • 18.2.1 Creating the version table
    • 18.2.2 Using versioning
    • 18.2.3 Reverting changes
    • 18.2.4 Advanced usage
  • 18.3 Soft-delete
  • 18.4 Creating plugins
  • 18.5 Nesting plugins
• 19 File parser
  • 19.1 Dumping
  • 19.2 Loading
• 20 Migration
  • 20.1 Writing Migration Classes
    • 20.1.1 Methods
    • 20.1.2 Altering Data
  • 20.2 Performing Migrations
• 21 Searching
  • 21.1 Introduction
  • 21.2 Index structure
  • 21.3 Index building
  • 21.4 Text analyzers
  • 21.5 Query language
  • 21.6 File searches
• 22 Database abstraction
  • 22.1 Modules
  • 22.2 Export
    • 22.2.1 Introduction
    • 22.2.2 Creating a database
    • 22.2.3 Creating tables
    • 22.2.4 Creating foreign keys
    • 22.2.5 Altering table
    • 22.2.6 Creating indices
    • 22.2.7 Deleting database elements
  • 22.3 Import
    • 22.3.1 Introduction
    • 22.3.2 Listing databases
    • 22.3.3 Listing sequences
    • 22.3.4 Listing constraints
    • 22.3.5 Listing table fields
    • 22.3.6 Listing table indices
    • 22.3.7 Listing tables
    • 22.3.8 Listing views
  • 22.4 DataDict
    • 22.4.1 Introduction
    • 22.4.2 Getting portable declaration
    • 22.4.3 Getting native declaration
  • 22.5 Drivers
    • 22.5.1 Mysql
      • 22.5.1.1 Setting table type
• 23 Improving Performance
  • 23.1 Introduction
  • 23.2 Compile
  • 23.3 Fetch only what you need
  • 23.4 Bundle your class files
  • 23.5 Use a bytecode cache
  • 23.6 Other tips
• 24 Technology
  • 24.1 Architecture
  • 24.2 Design patterns used
  • 24.3 Speed
  • 24.4 Internal optimizations
• 25 Exceptions and warnings
  • 25.1 Manager exceptions
  • 25.2 Relation exceptions
  • 25.3 Connection exceptions
  • 25.4 Query exceptions
• 26 Real world examples
  • 26.1 User management system
  • 26.2 Forum application
• 27 Coding standards
  • 27.1 Overview
    • 27.1.1 Scope
    • 27.1.2 Goals
  • 27.2 PHP File Formatting
    • 27.2.1 General
    • 27.2.2 Indentation
    • 27.2.3 Maximum line length
    • 27.2.4 Line termination
  • 27.3 Naming Conventions
    • 27.3.1 Classes
    • 27.3.2 Interfaces
    • 27.3.3 Filenames
    • 27.3.4 Functions and methods
    • 27.3.5 Variables
    • 27.3.6 Constants
    • 27.3.7 Record columns
  • 27.4 Coding Style
    • 27.4.1 PHP code demarcation
    • 27.4.2 Strings
    • 27.4.3 Arrays
    • 27.4.4 Classes
    • 27.4.5 Functions and methods
    • 27.4.6 Control statements
    • 27.4.7 Inline documentation
  • 27.5 Testing
    • 27.5.1 Running tests
      • 27.5.1.1 CLI
      • 27.5.1.2 Browser
    • 27.5.2 Writing tests
      • 27.5.2.1 Methods for testing
      • 27.5.2.2 Mock drivers
      • 27.5.2.3 Test Class Guidelines
      • 27.5.2.4 Test Method Guidelines