# Doctrine Documentation

Ian
Christian
pookey@pookey.co.uk
Konsta
Vesterinen
Doctrine Project
2007

The contents of this document are licensed under the Creative Commons Attribution-ShareAlike License.

Documentation for the PHP Doctrine project

## Introduction

Doctrine is a Object Relational Mapping and database abstraction framework for PHP. The DBAL part of Doctrine derives from MDB2. The key idea was to provide very intuitive and easy-to-use persistency solution (eg. RoR ActiveRecord) with all the advanced features from the more heavy-weight solutions (eg. Hibernate).

Doctrine Query Language implements EJB 3 OQL specificiation and expands it a bit further (it has special LIMIT and OFFSET clauses).

### Requirements

Doctrine requires PHP >= 5.1, and it doesn't require any external libraries.

For database abstraction Doctrine uses PDO which is bundled with php by default. Doctrine also requires a little adodb-hack for table creation, which comes with doctrine.

### Community

Doctrine has 3 mailing lists, an IRC forum, and a wiki.

#### Mailing Lists

The 'user' mailing list is for discussing the usage of doctrine. To subscribe to this list, send a blank email to doctrine-user+subscribe@lists.pengus.net

The 'dev' mailing list is used for discussion of the development of doctrine. To subscribe to this list, send a blank email to doctrine-dev+subscribe@lists.pengus.net

The 'svn' mailing list is a read-only list, which users and developers can subscribe to to receive commit logs to the SVN repository. This list is quite high traffic, as every commit to the repository results in an email containing the changelog entry and diffs of the changed files.

#### IRC

The #doctrine IRC channel can be found on the freenode network.

### Getting Started

The installation of doctrine is very easy. Just get the latest revision of Doctrine from http://doctrine.pengus.net/svn/trunk.