doctrine2/manual/docbook/doctrine.xml

<?xml version="1.0" encoding='ISO-8859-1'?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"

[
<!ENTITY version "2.0">
]>

<book id="doctrinebook">

  <bookinfo>
    <title>Doctrine Documentation</title>
    <author>
      <firstname>Ian</firstname>
      <surname>Christian</surname>
      <email>pookey@pookey.co.uk</email>
    </author>
    <author>
      <firstname>Konsta</firstname>
      <surname>Vesterinen</surname>
    </author>
    <copyright>
      <holder>Doctrine Project</holder>
      <year>2007</year>
    </copyright>
    <legalnotice id="legalnotice">
      <para>
        The contents of this document are licensed under the Creative Commons
        <ulink url="http://creativecommons.org/licenses/by-sa/2.0/">Attribution-ShareAlike License</ulink>.
      </para>
    </legalnotice>

    <abstract>
      <para>
        Documentation for the PHP Doctrine project
      </para>
    </abstract>
  </bookinfo>

  <chapter id="introduction">
    <title>Introduction</title>
    <para>
      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).
    </para>
    <para>
      Doctrine Query Language implements EJB 3 OQL specificiation and expands
      it a bit further (it has special LIMIT and OFFSET clauses).
    </para>
    <para>
      
    </para>

    <sect1 id="requirements">
      <title>Requirements</title>
      <para>
        Doctrine requires PHP >= 5.1, and it doesn't require any external libraries.
      </para>
      <para>
        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.
      </para>
    </sect1>

    <sect1 id="community">
      <title>Community</title>
      <para>
        Doctrine has 3 mailing lists, an IRC forum, and a wiki.
      </para>
      <sect2 id="community-mailinglist">
        <title>Mailing Lists</title>
        <para>
          The 'user' mailing list is for discussing the usage of doctrine.
          To subscribe to this list, send a blank email to
          <email>doctrine-user+subscribe@lists.pengus.net</email>
        </para>
        <para>
          The 'dev' mailing list is used for discussion of the development
          of doctrine.  To subscribe to this list, send a blank email to
          <email>doctrine-dev+subscribe@lists.pengus.net</email>
        </para>
        <para>
          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.
          To subscribe to this list, send a blank email to
          <email>doctrine-svn+subscribe@lists.pengus.net</email>
        </para>
      </sect2>
      <sect2 id="community-irc">
        <title>IRC</title>
        <para>
          The #doctrine IRC channel can be found on the freenode network.
        </para>
      </sect2>
    </sect1>

    <sect1 id="getting-started">
      <title>Getting Started</title>
      <para>
        The installation of doctrine is very easy. Just get the latest revision of Doctrine from
        <ulink url="http://doctrine.pengus.net/svn/trunk">http://doctrine.pengus.net/svn/trunk</ulink>.
      </para>
    </sect1>

    <sect1 id="contributing">
      <title>Contributing</title>
      <para>
        Doctrine is constantly under development, and is always happy for new
        developers to contribute to the project.
      </para>
      <para>
        To get an account on trac to submit bugs and make suggestions, or to get
        access to commit to the SVN repository, please visit the IRC channel, or
        email the users mailing list.
      </para>
    </sect1>
  </chapter>

  <chapter id="connection-management">
  <title>Connection Management</title>
  </chapter>

  <chapter id="object-relational-mapping">
  <title>Object Relational Mapping</title>
  </chapter>

  <chapter id="working-with-objects">
  <title>Working With Objects</title>
  </chapter>

  <chapter id="configuration">
  <title>Configuration</title>
  </chapter>

  <chapter id="advanced-components">
  <title>Advanced Components</title>
  </chapter>

  <chapter id="dql">
  <title>DQL (Doctrine Query Lanaguage)</title>
  </chapter>

  <chapter id="native-sql">
  <title>Native SQL</title>
  </chapter>

  <chapter id="transactions">
  <title>Transactions</title>
  </chapter>

  <chapter id="caching">
  <title>Caching</title>
  </chapter>

  <chapter id="database-abstraction">
  <title>Database Abstraction</title>
  </chapter>

  <chapter id="technology">
  <title>Technology</title>
  </chapter>

  <chapter id="real-world-examples">
  <title>Real World Examples</title>
  </chapter>

  <chapter id="coding-standards">
  <title>Coding Standards</title>
  </chapter>

</book>