Commit 085dc9d6 authored by zYne's avatar zYne

Enhanced class doc blocks, fixes #228

parent 799102b2
......@@ -19,15 +19,17 @@
* <http://www.phpdoctrine.com>.
*/
require_once("Doctrine/Exception.php");
/**
* Doctrine
* the base class of Doctrine framework
*
* @package Doctrine
* @author Konsta Vesterinen
* @license LGPL
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
*/
final class Doctrine {
/**
......
......@@ -24,9 +24,13 @@
* the purpose of Doctrine_Access is to provice array access
* and property overload interface for subclasses
*
* @package Doctrine ORM
* @url www.phpdoctrine.com
* @license LGPL
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
*/
abstract class Doctrine_Access implements ArrayAccess {
/**
......
......@@ -21,10 +21,14 @@
/**
* Doctrine_Adapter_Statement
*
* @author Konsta Vesterinen
* @license LGPL
* @package Doctrine
*/
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @package Doctrine
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
*/
abstract class Doctrine_Adapter_Statement {
public function bindValue($no, $value) {
}
......
......@@ -23,10 +23,14 @@ Doctrine::autoload("Access");
* Doctrine_Collection
* Collection of Doctrine_Record objects.
*
* @package Doctrine ORM
* @url www.phpdoctrine.com
* @license LGPL
*/
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
*/
class Doctrine_Collection extends Doctrine_Access implements Countable, IteratorAggregate, Serializable {
/**
* @var array $data an array containing the data access objects of this collection
......
......@@ -24,12 +24,14 @@ Doctrine::autoload('Doctrine_Collection');
* with batch load strategy
*
*
* @author Konsta Vesterinen
* @package Doctrine ORM
* @url www.phpdoctrine.com
* @license LGPL
* @version 1.0 alpha
*/
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @version $Revision$
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
*/
class Doctrine_Collection_Batch extends Doctrine_Collection {
/**
* @var integer $batchSize batch size
......
......@@ -21,8 +21,12 @@
/**
* Doctrine_Collection_Exception
*
* @package Doctrine ORM
* @url www.phpdoctrine.com
* @license LGPL
*/
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
*/
class Doctrine_Collection_Exception extends Doctrine_Exception { }
<?php
Doctrine::autoload('Doctrine_Collection');
/**
* @author Konsta Vesterinen
* @package Doctrine ORM
* @url www.phpdoctrine.com
* @license LGPL
* @version 1.0 alpha
*/
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @version $Revision$
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
*/
class Doctrine_Collection_Immediate extends Doctrine_Collection {
/**
* @param Doctrine_DQL_Parser $graph
......
......@@ -22,10 +22,14 @@
* Doctrine_Collection_Iterator
* iterates through Doctrine_Collection
*
* @package Doctrine ORM
* @url www.phpdoctrine.com
* @license LGPL
*/
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
*/
abstract class Doctrine_Collection_Iterator implements Iterator {
/**
* @var Doctrine_Collection $collection
......
......@@ -22,10 +22,14 @@ Doctrine::autoload('Doctrine_Collection_Iterator');
/**
* Doctrine_Collection_Iterator_Normal
*
* @package Doctrine ORM
* @url www.phpdoctrine.com
* @license LGPL
*/
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
*/
class Doctrine_Collection_Iterator_Expandable extends Doctrine_Collection_Iterator {
public function valid() {
if($this->index < $this->count)
......
......@@ -22,10 +22,14 @@ Doctrine::autoload('Doctrine_Collection_Iterator');
/**
* Doctrine_Collection_Iterator_Normal
*
* @package Doctrine ORM
* @url www.phpdoctrine.com
* @license LGPL
*/
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
*/
class Doctrine_Collection_Iterator_Normal extends Doctrine_Collection_Iterator {
/**
* @return boolean whether or not the iteration will continue
......
......@@ -22,10 +22,14 @@ Doctrine::autoload('Doctrine_Collection_Iterator');
/**
* Doctrine_Collection_Iterator_Normal
*
* @package Doctrine ORM
* @url www.phpdoctrine.com
* @license LGPL
*/
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
*/
class Doctrine_Collection_Iterator_Offset extends Doctrine_Collection_Iterator {
public function valid() { }
}
......
......@@ -3,7 +3,14 @@ require_once("Batch.php");
/**
* a collection of Doctrine_Record objects with lazy load strategy
* (batch load strategy with batch size 1)
*/
* @package Doctrine
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @since 1.0
* @version $Revision$
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
*/
class Doctrine_Collection_Lazy extends Doctrine_Collection_Batch {
/**
* constructor
......
......@@ -23,10 +23,14 @@ Doctrine::autoload('Doctrine_Collection_Offset');
* Doctrine_Collection_Offset
* Collection of Doctrine_Record objects.
*
* @package Doctrine ORM
* @url www.phpdoctrine.com
* @license LGPL
*/
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
*/
class Doctrine_Collection_Offset extends Doctrine_Collection {
/**
* @var integer $limit
......
......@@ -18,14 +18,17 @@
* and is licensed under the LGPL. For more information, see
* <http://www.phpdoctrine.com>.
*/
/**
* Doctrine_Compiler
* This class can be used for compiling the entire Doctrine framework into a single file
*
* @package Doctrine
* @author Konsta Vesterinen
* @license LGPL
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
*/
class Doctrine_Compiler {
/**
......
......@@ -18,12 +18,15 @@
* and is licensed under the LGPL. For more information, see
* <http://www.phpdoctrine.com>.
*/
/**
* Doctrine_Compiler_Exception
*
* @package Doctrine
* @author Konsta Vesterinen
* @license LGPL
*/
* @package Doctrine
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
*/
class Doctrine_Compiler_Exception extends Doctrine_Exception { }
......@@ -23,9 +23,13 @@
* the base for Doctrine_Table, Doctrine_Manager and Doctrine_Connection
*
*
* @package Doctrine ORM
* @url www.phpdoctrine.com
* @license LGPL
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
*/
abstract class Doctrine_Configurable {
......
......@@ -18,14 +18,17 @@
* and is licensed under the LGPL. For more information, see
* <http://www.phpdoctrine.com>.
*/
/**
* Doctrine_Connection
*
* @package Doctrine ORM
* @url www.phpdoctrine.com
* @license LGPL
*/
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
*/
abstract class Doctrine_Connection extends Doctrine_Configurable implements Countable, IteratorAggregate {
/**
* @var $dbh the database handler
......
......@@ -2,7 +2,14 @@
Doctrine::autoload('Doctrine_Connection');
/**
* standard connection, the parent of pgsql, mysql and sqlite
*/
* @package Doctrine
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @since 1.0
* @version $Revision$
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
*/
class Doctrine_Connection_Common extends Doctrine_Connection {
/**
* Adds an driver-specific LIMIT clause to the query
......
......@@ -22,8 +22,12 @@ Doctrine::autoload('Doctrine_Exception');
/**
* Doctrine_Exception
*
* @package Doctrine ORM
* @url www.phpdoctrine.com
* @license LGPL
*/
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
*/
class Doctrine_Connection_Exception extends Doctrine_Exception { }
......@@ -22,14 +22,16 @@ Doctrine::autoload('Doctrine_Connection');
/**
* Doctrine_Connection_Firebird
*
* @package Doctrine ORM
* @url www.phpdoctrine.com
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @author Konsta Vesterinen
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
* @author Lukas Smith <smith@pooteeweet.org> (PEAR MDB2 library)
* @author Lorenzo Alberton <l.alberton@quipo.it> (PEAR MDB2 library interbase driver)
* @version $Id$
*/
* @version $Revision$
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
*/
class Doctrine_Connection_Firebird extends Doctrine_Connection {
/**
* @var string $driverName the name of this connection driver
......
......@@ -22,8 +22,12 @@ Doctrine::autoload('Doctrine_Connection_Exception');
/**
* Doctrine_Connection_Firebird_Exception
*
* @package Doctrine ORM
* @url www.phpdoctrine.com
* @license LGPL
*/
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
*/
class Doctrine_Connection_Firebird_Exception extends Doctrine_Connection_Exception { }
......@@ -22,10 +22,14 @@ Doctrine::autoload('Doctrine_Connection');
/**
* Doctrine_Connection_Mysql
*
* @package Doctrine ORM
* @url www.phpdoctrine.com
* @license LGPL
*/
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
*/
class Doctrine_Connection_Informix extends Doctrine_Connection {
/**
* @var string $driverName the name of this connection driver
......
......@@ -22,8 +22,12 @@ Doctrine::autoload('Doctrine_Connection_Exception');
/**
* Doctrine_Connection_Informix_Exception
*
* @package Doctrine ORM
* @url www.phpdoctrine.com
* @license LGPL
*/
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
*/
class Doctrine_Connection_Informix_Exception extends Doctrine_Connection_Exception { }
......@@ -22,13 +22,15 @@ Doctrine::autoload('Doctrine_Connection');
/**
* Doctrine_Connection_Mssql
*
* @package Doctrine ORM
* @url www.phpdoctrine.com
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @author Konsta Vesterinen
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
* @author Lukas Smith <smith@pooteeweet.org> (PEAR MDB2 library)
* @version $Id$
*/
* @version $Revision$
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
*/
class Doctrine_Connection_Mssql extends Doctrine_Connection {
/**
* @var string $driverName the name of this connection driver
......
......@@ -22,14 +22,15 @@ Doctrine::autoload('Doctrine_Connection_Exception');
/**
* Doctrine_Connection_Mssql_Exception
*
* @package Doctrine
* @url http://www.phpdoctrine.com
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @author Konsta Vesterinen
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
* @author Lukas Smith <smith@pooteeweet.org> (PEAR MDB2 library)
* @since 1.0
* @version $Id$
*/
* @since 1.0
* @version $Revision$
* @category Object Relational Mapping
* @link www.phpdoctrine.com
*/
class Doctrine_Connection_Mssql_Exception extends Doctrine_Connection_Exception {
/**
* @var array $errorRegexps an array that is used for determining portable
......
......@@ -22,13 +22,15 @@ Doctrine::autoload('Doctrine_Connection_Common');
/**
* Doctrine_Connection_Mysql
*
* @package Doctrine ORM
* @url www.phpdoctrine.com
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @author Konsta Vesterinen
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
* @author Lukas Smith <smith@pooteeweet.org> (PEAR MDB2 library)
* @version $Id$
*/
* @version $Revision$
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
*/
class Doctrine_Connection_Mysql extends Doctrine_Connection_Common {
/**
* @var string $driverName the name of this connection driver
......
......@@ -22,14 +22,15 @@ Doctrine::autoload('Doctrine_Connection_Exception');
/**
* Doctrine_Connection_Mysql_Exception
*
* @package Doctrine
* @url http://www.phpdoctrine.com
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @author Konsta Vesterinen
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
* @author Lukas Smith <smith@pooteeweet.org> (PEAR MDB2 library)
* @since 1.0
* @version $Id$
*/
* @since 1.0
* @version $Revision$
* @category Object Relational Mapping
* @link www.phpdoctrine.com
*/
class Doctrine_Connection_Mysql_Exception extends Doctrine_Connection_Exception {
/**
* @var array $errorRegexps an array that is used for determining portable
......
......@@ -22,10 +22,14 @@ Doctrine::autoload('Doctrine_Connection');
/**
* Doctrine_Connection_Oracle
*
* @package Doctrine ORM
* @url www.phpdoctrine.com
* @license LGPL
*/
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
*/
class Doctrine_Connection_Oracle extends Doctrine_Connection {
/**
* @var string $driverName the name of this connection driver
......
......@@ -22,14 +22,15 @@ Doctrine::autoload('Doctrine_Connection_Exception');
/**
* Doctrine_Connection_Oracle_Exception
*
* @package Doctrine
* @url http://www.phpdoctrine.com
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @author Konsta Vesterinen
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
* @author Lukas Smith <smith@pooteeweet.org> (PEAR MDB2 library)
* @since 1.0
* @version $Id$
*/
* @since 1.0
* @version $Revision$
* @category Object Relational Mapping
* @link www.phpdoctrine.com
*/
class Doctrine_Connection_Oracle_Exception extends Doctrine_Connection_Exception {
/**
* @var array $errorRegexps an array that is used for determining portable
......
......@@ -22,13 +22,15 @@ Doctrine::autoload("Doctrine_Connection_Common");
/**
* Doctrine_Connection_Pgsql
*
* @package Doctrine ORM
* @url www.phpdoctrine.com
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @author Konsta Vesterinen
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
* @author Lukas Smith <smith@pooteeweet.org> (PEAR MDB2 library)
* @version $Id$
*/
* @version $Revision$
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
*/
class Doctrine_Connection_Pgsql extends Doctrine_Connection_Common {
/**
* @var string $driverName the name of this connection driver
......
......@@ -22,8 +22,12 @@ Doctrine::autoload('Doctrine_Connection_Exception');
/**
* Doctrine_Connection_Pgsql_Exception
*
* @package Doctrine ORM
* @url www.phpdoctrine.com
* @license LGPL
*/
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
*/
class Doctrine_Connection_Pgsql_Exception extends Doctrine_Connection_Exception { }
......@@ -22,14 +22,15 @@ Doctrine::autoload("Doctrine_Connection_Common");
/**
* Doctrine_Connection_Sqlite
*
* @package Doctrine ORM
* @url www.phpdoctrine.com
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @author Konsta Vesterinen
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
* @author Lukas Smith <smith@pooteeweet.org> (PEAR MDB2 library)
* @version $Id$
*/
* @version $Revision$
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
*/
class Doctrine_Connection_Sqlite extends Doctrine_Connection_Common {
/**
* @var string $driverName the name of this connection driver
......
......@@ -22,14 +22,15 @@ Doctrine::autoload('Doctrine_Connection_Exception');
/**
* Doctrine_Connection_Sqlite_Exception
*
* @package Doctrine
* @url http://www.phpdoctrine.com
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @author Konsta Vesterinen
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
* @author Lukas Smith <smith@pooteeweet.org> (PEAR MDB2 library)
* @since 1.0
* @version $Id$
*/
* @since 1.0
* @version $Revision$
* @category Object Relational Mapping
* @link www.phpdoctrine.com
*/
class Doctrine_Connection_Sqlite_Exception extends Doctrine_Connection_Exception {
/**
* @var array $errorRegexps an array that is used for determining portable
......
......@@ -18,13 +18,16 @@
* and is licensed under the LGPL. For more information, see
* <http://www.phpdoctrine.com>.
*/
/**
* Doctrine_Connection_Transaction
*
* @package Doctrine ORM
* @url www.phpdoctrine.com
* @license LGPL
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
*/
class Doctrine_Connection_Transaction implements Countable, IteratorAggregate {
/**
......
......@@ -18,14 +18,17 @@
* and is licensed under the LGPL. For more information, see
* <http://www.phpdoctrine.com>.
*/
/**
* Doctrine_Connection_UnitOfWork
*
* @package Doctrine ORM
* @url www.phpdoctrine.com
* @license LGPL
*/
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
*/
class Doctrine_Connection_UnitOfWork implements IteratorAggregate, Countable {
/**
* @var Doctrine_Connection $conn the connection object
......
......@@ -18,14 +18,17 @@
* and is licensed under the LGPL. For more information, see
* <http://www.phpdoctrine.com>.
*/
/**
* Doctrine_DataDict
*
* @package Doctrine ORM
* @url www.phpdoctrine.com
* @license LGPL
*/
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
*/
class Doctrine_DataDict {
protected $dbh;
......
......@@ -22,8 +22,12 @@ Doctrine::autoload('Doctrine_Exception');
/**
* Doctrine_DataDict_Exception
*
* @package Doctrine ORM
* @url www.phpdoctrine.com
* @license LGPL
*/
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
*/
class Doctrine_DataDict_Exception extends Doctrine_Exception { }
......@@ -20,11 +20,13 @@
*/
Doctrine::autoload('Doctrine_DataDict');
/**
* @package Doctrine
* @url http://www.phpdoctrine.com
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @author Konsta Vesterinen
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
* @author Lukas Smith <smith@pooteeweet.org> (PEAR MDB2 library)
* @version $Id$
*/
* @version $Revision$
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
*/
class Doctrine_DataDict_Informix extends Doctrine_DataDict { }
......@@ -22,8 +22,12 @@ Doctrine::autoload('Doctrine_DataDict_Informix_Exception');
/**
* Doctrine_DataDict_Sqlite_Exception
*
* @package Doctrine ORM
* @url www.phpdoctrine.com
* @license LGPL
*/
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
*/
class Doctrine_DataDict_Informix_Exception extends Doctrine_DataDict_Exception { }
......@@ -18,16 +18,16 @@
* and is licensed under the LGPL. For more information, see
* <http://www.phpdoctrine.com>.
*/
/**
* @package Doctrine
* @url http://www.phpdoctrine.com
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @author Konsta Vesterinen
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
* @author Lukas Smith <smith@pooteeweet.org> (PEAR MDB2 library)
* @version $Id$
*/
* @version $Revision$
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
*/
class Doctrine_DataDict_Mssql extends Doctrine_DataDict {
/**
* Obtain DBMS specific SQL code portion needed to declare an text type
......
......@@ -22,8 +22,12 @@ Doctrine::autoload('Doctrine_DataDict_Exception');
/**
* Doctrine_DataDict_Mssql_Exception
*
* @package Doctrine ORM
* @url www.phpdoctrine.com
* @license LGPL
*/
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
*/
class Doctrine_DataDict_Mssql_Exception extends Doctrine_Exception { }
......@@ -18,16 +18,16 @@
* and is licensed under the LGPL. For more information, see
* <http://www.phpdoctrine.com>.
*/
/**
* @package Doctrine
* @url http://www.phpdoctrine.com
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @author Konsta Vesterinen
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
* @author Lukas Smith <smith@pooteeweet.org> (PEAR MDB2 library)
* @version $Id$
*/
* @version $Revision$
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
*/
class Doctrine_DataDict_Mysql extends Doctrine_DataDict {
/**
* Obtain DBMS specific SQL code portion needed to declare an text type
......
......@@ -22,8 +22,12 @@ Doctrine::autoload('Doctrine_DataDict_Exception');
/**
* Doctrine_DataDict_Mysql_Exception
*
* @package Doctrine ORM
* @url www.phpdoctrine.com
* @license LGPL
*/
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
*/
class Doctrine_DataDict_Mysql_Exception extends Doctrine_DataDict_Exception { }
......@@ -18,15 +18,15 @@
* and is licensed under the LGPL. For more information, see
* <http://www.phpdoctrine.com>.
*/
/**
* @package Doctrine
* @url http://www.phpdoctrine.com
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @author Konsta Vesterinen
* @version $Id$
*/
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
* @version $Revision$
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
*/
class Doctrine_DataDict_Oracle extends Doctrine_DataDict {
/**
* Obtain DBMS specific SQL code portion needed to declare an text type
......
......@@ -22,8 +22,12 @@ Doctrine::autoload('Doctrine_DataDict_Exception');
/**
* Doctrine_DataDict_Oracle_Exception
*
* @package Doctrine ORM
* @url www.phpdoctrine.com
* @license LGPL
*/
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
*/
class Doctrine_DataDict_Oracle_Exception extends Doctrine_DataDict_Exception { }
......@@ -18,17 +18,17 @@
* and is licensed under the LGPL. For more information, see
* <http://www.phpdoctrine.com>.
*/
/**
* @package Doctrine
* @url http://www.phpdoctrine.com
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @author Konsta Vesterinen
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
* @author Paul Cooper <pgc@ucecom.com>
* @author Lukas Smith <smith@pooteeweet.org> (PEAR MDB2 library)
* @version $Id$
*/
* @version $Revision$
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
*/
class Doctrine_DataDict_Pgsql extends Doctrine_DataDict {
/**
* Obtain DBMS specific SQL code portion needed to declare an text type
......
......@@ -22,8 +22,12 @@ Doctrine::autoload('Doctrine_DataDict_Exception');
/**
* Doctrine_DataDict_Pgsql_Exception
*
* @package Doctrine ORM
* @url www.phpdoctrine.com
* @license LGPL
*/
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
*/
class Doctrine_DataDict_Pgsql_Exception extends Doctrine_DataDict_Exception { }
......@@ -20,13 +20,15 @@
*/
Doctrine::autoload('Doctrine_DataDict');
/**
* @package Doctrine
* @url http://www.phpdoctrine.com
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @author Konsta Vesterinen
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
* @author Lukas Smith <smith@pooteeweet.org> (PEAR MDB2 library)
* @version $Id$
*/
* @version $Revision$
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
*/
class Doctrine_DataDict_Sqlite extends Doctrine_DataDict {
/**
* Obtain DBMS specific SQL code portion needed to declare an text type
......
......@@ -22,8 +22,12 @@ Doctrine::autoload('Doctrine_DataDict_Exception');
/**
* Doctrine_DataDict_Sqlite_Exception
*
* @package Doctrine ORM
* @url www.phpdoctrine.com
* @license LGPL
*/
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
*/
class Doctrine_DataDict_Sqlite_Exception extends Doctrine_DataDict_Exception { }
......@@ -18,7 +18,6 @@
* and is licensed under the LGPL. For more information, see
* <http://www.phpdoctrine.com>.
*/
/**
* Doctrine_Db
* A thin wrapper layer on top of PDO / Doctrine_Adapter
......@@ -29,10 +28,14 @@
* Aspects such as logging, query profiling and caching can be easily implemented through
* the use of these listeners
*
* @author Konsta Vesterinen
* @license LGPL
* @package Doctrine
*/
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @package Doctrine
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
*/
class Doctrine_Db implements Countable, IteratorAggregate, Doctrine_Adapter_Interface {
/**
* error constants
......
......@@ -21,10 +21,14 @@
/**
* Doctrine_Db_Event
*
* @author Konsta Vesterinen
* @license LGPL
* @package Doctrine
*/
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @package Doctrine
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
*/
class Doctrine_Db_Event {
const QUERY = 1;
const EXEC = 2;
......
......@@ -21,10 +21,14 @@
/**
* Doctrine_Db_EventListener
*
* @author Konsta Vesterinen
* @license LGPL
* @package Doctrine
*/
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @package Doctrine
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
*/
class Doctrine_Db_EventListener implements Doctrine_Db_EventListener_Interface {
public function onPreQuery(Doctrine_Db_Event $event) { }
public function onQuery(Doctrine_Db_Event $event) { }
......
......@@ -20,14 +20,17 @@
*/
Doctrine::autoload('Doctrine_Access');
Doctrine::autoload('Doctrine_Db_EventListener_Interface');
/**
* Doctrine_Db_EventListener
*
* @author Konsta Vesterinen
* @license LGPL
* @package Doctrine
*/
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @package Doctrine
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
*/
class Doctrine_Db_EventListener_Chain extends Doctrine_Access implements Doctrine_Db_EventListener_Interface {
private $listeners = array();
......
......@@ -21,8 +21,12 @@
/**
* Doctrine_Db_Exception
*
* @author Konsta Vesterinen
* @license LGPL
* @package Doctrine
*/
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @package Doctrine
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
*/
class Doctrine_Db_Exception extends Doctrine_Exception { }
......@@ -20,13 +20,15 @@
*/
Doctrine::autoload('Doctrine_Db');
/**
* @package Doctrine
* @url http://www.phpdoctrine.com
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @author Konsta Vesterinen
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
* @author Lukas Smith <smith@pooteeweet.org> (PEAR MDB2 library)
* @version $Id$
*/
* @version $Revision$
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
*/
class Doctrine_Db_Firebird extends Doctrine_Db {
}
......@@ -20,13 +20,15 @@
*/
Doctrine::autoload('Doctrine_Db');
/**
* @package Doctrine
* @url http://www.phpdoctrine.com
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @author Konsta Vesterinen
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
* @author Lukas Smith <smith@pooteeweet.org> (PEAR MDB2 library)
* @version $Id$
*/
* @version $Revision$
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
*/
class Doctrine_Db_Informix extends Doctrine_Db {
}
......@@ -20,13 +20,15 @@
*/
Doctrine::autoload('Doctrine_Db');
/**
* @package Doctrine
* @url http://www.phpdoctrine.com
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @author Konsta Vesterinen
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
* @author Lukas Smith <smith@pooteeweet.org> (PEAR MDB2 library)
* @version $Id$
*/
* @version $Revision$
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
*/
class Doctrine_Db_Mssql extends Doctrine_Db {
}
......@@ -20,13 +20,15 @@
*/
Doctrine::autoload('Doctrine_Db');
/**
* @package Doctrine
* @url http://www.phpdoctrine.com
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @author Konsta Vesterinen
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
* @author Lukas Smith <smith@pooteeweet.org> (PEAR MDB2 library)
* @version $Id$
*/
* @version $Revision$
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
*/
class Doctrine_Db_Mysql extends Doctrine_Db {
protected static $errorCodeMap = array(
1004 => Doctrine_Db::ERR_CANNOT_CREATE,
......
......@@ -20,13 +20,15 @@
*/
Doctrine::autoload('Doctrine_Db');
/**
* @package Doctrine
* @url http://www.phpdoctrine.com
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @author Konsta Vesterinen
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
* @author Lukas Smith <smith@pooteeweet.org> (PEAR MDB2 library)
* @version $Id$
*/
* @version $Revision$
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
*/
class Doctrine_Db_Oracle extends Doctrine_Db {
}
......@@ -20,13 +20,15 @@
*/
Doctrine::autoload('Doctrine_Db');
/**
* @package Doctrine
* @url http://www.phpdoctrine.com
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @author Konsta Vesterinen
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
* @author Lukas Smith <smith@pooteeweet.org> (PEAR MDB2 library)
* @version $Id$
*/
* @version $Revision$
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
*/
class Doctrine_Db_Pgsql extends Doctrine_Db {
}
......@@ -22,10 +22,14 @@ Doctrine::autoload('Doctrine_Overloadable');
/**
* Doctrine_Db_Profiler
*
* @author Konsta Vesterinen
* @license LGPL
* @package Doctrine
*/
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @package Doctrine
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
*/
class Doctrine_Db_Profiler implements Doctrine_Overloadable {
/**
* @param array $listeners an array containing all availible listeners
......
......@@ -22,8 +22,12 @@ Doctrine::autoload('Doctrine_Db_Exception');
/**
* Doctrine_Db_Exception
*
* @author Konsta Vesterinen
* @license LGPL
* @package Doctrine
*/
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @package Doctrine
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
*/
class Doctrine_Db_Profiler_Exception extends Doctrine_Db_Exception { }
......@@ -18,14 +18,17 @@
* and is licensed under the LGPL. For more information, see
* <http://www.phpdoctrine.com>.
*/
/**
* Doctrine_Db_Profiler_Query
*
* @author Konsta Vesterinen
* @license LGPL
* @package Doctrine
*/
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @package Doctrine
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
*/
class Doctrine_Db_Profiler_Query {
/**
* @var string SQL query string or user comment, set by $query argument in constructor.
......
......@@ -21,10 +21,14 @@
/**
* Doctrine_Db_Statement
*
* @author Konsta Vesterinen
* @license LGPL
* @package Doctrine
*/
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @package Doctrine
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
*/
class Doctrine_Db_Statement extends PDOStatement {
protected $dbh;
......
......@@ -24,11 +24,14 @@ Doctrine::autoload('Doctrine_EventListener_Interface');
* the empty methods allow child classes to only implement the methods they need to implement
*
*
* @author Konsta Vesterinen
* @package Doctrine ORM
* @url www.phpdoctrine.com
* @license LGPL
*/
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
*/
class Doctrine_EventListener implements Doctrine_EventListener_Interface {
public function onLoad(Doctrine_Record $record) { }
......
......@@ -22,11 +22,14 @@ Doctrine::autoload('Doctrine_EventListener');
/**
* Doctrine_EventListener_AccessorInvoker
*
* @author Konsta Vesterinen
* @package Doctrine ORM
* @url www.phpdoctrine.com
* @license LGPL
*/
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
*/
class Doctrine_EventListener_AccessorInvoker extends Doctrine_EventListener {
/**
* @var boolean $lockGetCall a simple variable to prevent recursion
......
......@@ -20,17 +20,19 @@
*/
Doctrine::autoload('Doctrine_Access');
Doctrine::autoload('Doctrine_EventListener_Interface');
/**
* Doctrine_EventListener_Chain
* this class represents a chain of different listeners,
* useful for having multiple listeners listening the events at the same time
*
* @author Konsta Vesterinen
* @package Doctrine ORM
* @url www.phpdoctrine.com
* @license LGPL
*/
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
*/
class Doctrine_EventListener_Chain extends Doctrine_Access implements Doctrine_EventListener_Interface {
/**
* @var array $listeners an array containing all listeners
......
<?php
/**
* an emtpy listener all components use this by default
*/
* @package Doctrine
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @since 1.0
* @version $Revision$
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
*/
class Doctrine_EventListener_Empty extends Doctrine_EventListener { }
......@@ -18,12 +18,15 @@
* and is licensed under the LGPL. For more information, see
* <http://www.phpdoctrine.com>.
*/
/**
* Doctrine_Exception
*
* @package Doctrine ORM
* @url www.phpdoctrine.com
* @license LGPL
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
*/
class Doctrine_Exception extends Exception { }
......@@ -18,14 +18,17 @@
* and is licensed under the LGPL. For more information, see
* <http://www.phpdoctrine.com>.
*/
/**
* Doctrine_Export
*
* @package Doctrine
* @author Konsta Vesterinen
* @license LGPL
*/
* @package Doctrine
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
*/
class Doctrine_Export {
/**
* @var Doctrine_Connection $conn Doctrine_Connection object
......
......@@ -22,8 +22,12 @@ Doctrine::autoload('Doctrine_Exception');
/**
* Doctrine_Export_Exception
*
* @package Doctrine ORM
* @url www.phpdoctrine.com
* @license LGPL
*/
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
*/
class Doctrine_Export_Exception extends Doctrine_Exception { }
......@@ -22,11 +22,15 @@ Doctrine::autoload('Doctrine_Export');
/**
* Doctrine_Export_Mysql
*
* @package Doctrine
* @author Konsta Vesterinen
* @package Doctrine
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
* @author Lukas Smith <smith@pooteeweet.org> (PEAR MDB2 library)
* @license LGPL
*/
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
*/
class Doctrine_Export_Mysql extends Doctrine_Export {
/**
* create a new database
......
......@@ -22,11 +22,15 @@ Doctrine::autoload('Doctrine_Export');
/**
* Doctrine_Export_Pgsql
*
* @package Doctrine
* @author Konsta Vesterinen
* @package Doctrine
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
* @author Lukas Smith <smith@pooteeweet.org> (PEAR MDB2 library)
* @license LGPL
*/
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
*/
class Doctrine_Export_Pgsql extends Doctrine_Export {
/**
* create a new database
......
......@@ -22,11 +22,15 @@ Doctrine::autoload('Doctrine_Export');
/**
* Doctrine_Export_Sqlite
*
* @package Doctrine
* @author Konsta Vesterinen
* @package Doctrine
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
* @author Lukas Smith <smith@pooteeweet.org> (PEAR MDB2 library)
* @license LGPL
*/
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
*/
class Doctrine_Export_Sqlite extends Doctrine_Export {
/**
* Get the stucture of a field into an array
......
......@@ -18,14 +18,17 @@
* and is licensed under the LGPL. For more information, see
* <http://www.phpdoctrine.com>.
*/
/**
* Doctrine_Expression
*
* @package Doctrine ORM
* @url www.phpdoctrine.com
* @license LGPL
*/
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
*/
class Doctrine_Expression {
/**
......
......@@ -22,10 +22,14 @@ Doctrine::autoload('Doctrine_Expression');
/**
* Doctrine_Expression_Firebird
*
* @package Doctrine ORM
* @url www.phpdoctrine.com
* @license LGPL
*/
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
*/
class Doctrine_Expression_Firebird extends Doctrine_Expression {
/**
* return string for internal table used when calling only a function
......
......@@ -22,8 +22,12 @@ Doctrine::autoload('Doctrine_Expression');
/**
* Doctrine_Expression_Informix
*
* @package Doctrine ORM
* @url www.phpdoctrine.com
* @license LGPL
*/
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
*/
class Doctrine_Expression_Informix extends Doctrine_Expression { }
......@@ -22,10 +22,14 @@ Doctrine::autoload('Doctrine_Expression');
/**
* Doctrine_Expression_Mssql
*
* @package Doctrine ORM
* @url www.phpdoctrine.com
* @license LGPL
*/
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
*/
class Doctrine_Expression_Mssql extends Doctrine_Expression {
/**
* Return string to call a variable with the current timestamp inside an SQL statement
......
......@@ -22,10 +22,14 @@ Doctrine::autoload('Doctrine_Expression');
/**
* Doctrine_Expression_Mysql
*
* @package Doctrine ORM
* @url www.phpdoctrine.com
* @license LGPL
*/
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
*/
class Doctrine_Expression_Mysql extends Doctrine_Expression {
/**
* returns the regular expression operator
......
......@@ -22,10 +22,14 @@ Doctrine::autoload('Doctrine_Expression');
/**
* Doctrine_Expression_Sqlite
*
* @package Doctrine ORM
* @url www.phpdoctrine.com
* @license LGPL
*/
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
*/
class Doctrine_Expression_Oracle extends Doctrine_Expression {
/**
* Returns a series of strings concatinated
......
......@@ -22,10 +22,14 @@ Doctrine::autoload('Doctrine_Expression');
/**
* Doctrine_Expression_Pgsql
*
* @package Doctrine ORM
* @url www.phpdoctrine.com
* @license LGPL
*/
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
*/
class Doctrine_Expression_Pgsql extends Doctrine_Expression {
/**
* Returns the md5 sum of a field.
......
......@@ -22,10 +22,14 @@ Doctrine::autoload('Doctrine_Expression');
/**
* Doctrine_Expression_Sqlite
*
* @package Doctrine ORM
* @url www.phpdoctrine.com
* @license LGPL
*/
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
*/
class Doctrine_Expression_Sqlite extends Doctrine_Expression {
/**
* Returns the md5 sum of the data that SQLite's md5() function receives.
......
......@@ -24,10 +24,14 @@ Doctrine::autoload('Doctrine_Access');
* Its purpose is to populate object graphs.
*
*
* @package Doctrine ORM
* @url www.phpdoctrine.com
* @license LGPL
*/
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
*/
abstract class Doctrine_Hydrate extends Doctrine_Access {
/**
* @var array $fetchmodes an array containing all fetchmodes
......
......@@ -18,15 +18,17 @@
* and is licensed under the LGPL. For more information, see
* <http://www.phpdoctrine.com>.
*/
/**
* Doctrine_Identifier
*
* @author Konsta Vesterinen
* @package Doctrine ORM
* @url www.phpdoctrine.com
* @license LGPL
*/
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
*/
class Doctrine_Identifier {
/**
* constant for auto_increment identifier
......
......@@ -25,15 +25,18 @@
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @author Jukka Hassinen <Jukka.Hassinen@BrainAlliance.com>
* @version $Id$
*/
/**
* class Doctrine_Import
* Main responsible of performing import operation. Delegates database schema
* reading to a reader object and passes the result to a builder object which
* builds a Doctrine data model.
* @package Doctrine
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @since 1.0
* @version $Revision$
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
*/
class Doctrine_Import {
/**
......
......@@ -25,13 +25,16 @@
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @author Jukka Hassinen <Jukka.Hassinen@BrainAlliance.com>
* @version $Id$
*/
/**
* class Doctrine_Import_Builder
* Is responsible of building Doctrine structure based on a database schema.
* @package Doctrine
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @since 1.0
* @version $Revision$
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
*/
class Doctrine_Import_Builder {
......
......@@ -26,12 +26,16 @@ Doctrine::autoload('Doctrine_Import_Builder');
* @author Jukka Hassinen <Jukka.Hassinen@BrainAlliance.com>
* @version $Id$
*/
/**
* class Doctrine_Import_Builder_BaseClass
* Builds a Doctrine_Record base class definition based on a schema.
* @package Doctrine
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @since 1.0
* @version $Revision$
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
*/
class Doctrine_Import_Builder_BaseClass extends Doctrine_Import_Builder {
}
......@@ -26,8 +26,14 @@ Doctrine::autoload('Doctrine_Import_Exception');
* @author Jukka Hassinen <Jukka.Hassinen@BrainAlliance.com>
* @version $Id$
*/
/**
* class Doctrine_Import_Builder_Exception
* @package Doctrine
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @since 1.0
* @version $Revision$
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
*/
class Doctrine_Import_Builder_Exception extends Doctrine_Import_Exception { }
......@@ -25,8 +25,14 @@ Doctrine::autoload('Doctrine_Exception');
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @version $Id$
*/
/**
* class Doctrine_Import_Exception
*/
* @package Doctrine
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @since 1.0
* @version $Revision$
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
*/
class Doctrine_Import_Exception extends Doctrine_Exception { }
......@@ -25,14 +25,17 @@
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @author Jukka Hassinen <Jukka.Hassinen@BrainAlliance.com>
* @version $Id$
*/
/**
* class Doctrine_Import_Reader
* Is responsible of reading a database definitions from a source and costructing a
* database schema
* @package Doctrine
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @since 1.0
* @version $Revision$
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
*/
abstract class Doctrine_Import_Reader
{
......
......@@ -26,13 +26,17 @@ Doctrine::autoload('Doctrine_Import_Reader');
* @author Jukka Hassinen <Jukka.Hassinen@BrainAlliance.com>
* @version $Id$
*/
/**
* class Doctrine_Import_Reader_Db
* Reads a database using the given PDO connection and constructs a database
* schema
* @package Doctrine
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @since 1.0
* @version $Revision$
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
*/
class Doctrine_Import_Reader_Db extends Doctrine_Import_Reader
{
......
......@@ -25,12 +25,15 @@
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @author Jukka Hassinen <Jukka.Hassinen@BrainAlliance.com>
* @version $Id$
*/
/**
* class Doctrine_Import_Reader_Exception
* @package Doctrine
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @since 1.0
* @version $Revision$
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
*/
class Doctrine_Import_Reader_Exception
{
......
......@@ -26,11 +26,15 @@ Doctrine::autoload('Doctrine_Import_Reader');
* @author Jukka Hassinen <Jukka.Hassinen@BrainAlliance.com>
* @version $Id$
*/
/**
* class Doctrine_Import_Reader_Xml_Propel
* @package Doctrine
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @since 1.0
* @version $Revision$
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
*/
class Doctrine_Import_Reader_Xml_Propel extends Doctrine_Import_Reader
{
......
......@@ -18,14 +18,17 @@
* and is licensed under the LGPL. For more information, see
* <http://www.phpdoctrine.com>.
*/
/**
* @package Doctrine ORM
* @url www.phpdoctrine.com
* @license LGPL
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
*
* Doctrine_Lib has not commonly used static functions, mostly for debugging purposes
*/
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
*/
class Doctrine_Lib {
/**
* @param integer $state the state of record
......
<?PHP
/**
* Locking exception class
*
* A loking exception represents an error that occured during a locking process
* (obtain/release locks).
* @package Doctrine
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @since 1.0
* @version $Revision$
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
*/
class Doctrine_Locking_Exception extends Doctrine_Exception {}
......@@ -19,15 +19,19 @@
* <http://www.phpdoctrine.com>.
*/
/**
* Class for handling the pessimistic offline locking of {@link Doctrine_Record}s.
* @link www.phpdoctrine.com
* Offline locking of records comes in handy where you need to make sure that
* a time-consuming task on a record or many records, which is spread over several
* page requests can't be interfered by other users.
*
* @author Roman Borschel <roman@code-factory.org>
* @author Pierre Minnieur <pm@pierre-minnieur.de>
* @license LGPL
* @since 1.0
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @since 1.0
* @package Doctrine
* @category Object Relational Mapping
* @version $Revision$
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
*/
class Doctrine_Locking_Manager_Pessimistic {
/**
......
......@@ -18,14 +18,17 @@
* and is licensed under the LGPL. For more information, see
* <http://www.phpdoctrine.com>.
*/
/**
* @package Doctrine ORM
* @url www.phpdoctrine.com
* @license LGPL
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
*
* Doctrine_Manager is the base component of all doctrine based projects.
* It opens and keeps track of all connections (database connections).
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
*/
class Doctrine_Manager extends Doctrine_Configurable implements Countable, IteratorAggregate {
/**
......
......@@ -18,12 +18,15 @@
* and is licensed under the LGPL. For more information, see
* <http://www.phpdoctrine.com>.
*/
/**
* Doctrine_Manager_Exception
*
* @package Doctrine ORM
* @url www.phpdoctrine.com
* @license LGPL
*/
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
*/
class Doctrine_Manager_Exception extends Doctrine_Exception { }
......@@ -24,8 +24,12 @@
* Simple empty class representing a null value
* used for extra fast null value testing with isset() rather than array_key_exists()
*
* @package Doctrine ORM
* @url www.phpdoctrine.com
* @license LGPL
*/
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
*/
final class Doctrine_Null { }
......@@ -18,13 +18,16 @@
* and is licensed under the LGPL. For more information, see
* <http://www.phpdoctrine.com>.
*/
/**
* Doctrine_Query
*
* @package Doctrine ORM
* @url www.phpdoctrine.com
* @license LGPL
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
*/
class Doctrine_Query extends Doctrine_Hydrate implements Countable {
/**
......
......@@ -22,10 +22,14 @@ Doctrine::autoload('Doctrine_Query_Part');
/**
* Doctrine_Query_Orderby
*
* @package Doctrine ORM
* @url www.phpdoctrine.com
* @license LGPL
*/
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
*/
class Doctrine_Query_Orderby extends Doctrine_Query_Part {
/**
* DQL ORDER BY PARSER
......
......@@ -22,10 +22,14 @@ Doctrine::autoload("Doctrine_Access");
/**
* Doctrine_Query_Part
*
* @package Doctrine ORM
* @url www.phpdoctrine.com
* @license LGPL
*/
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
*/
abstract class Doctrine_Query_Part extends Doctrine_Access {
/**
* @var Doctrine_Query $query the query object associated with this parser
......
......@@ -18,14 +18,17 @@
* and is licensed under the LGPL. For more information, see
* <http://www.phpdoctrine.com>.
*/
/**
* Doctrine_Query
*
* @package Doctrine ORM
* @url www.phpdoctrine.com
* @license LGPL
*/
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
*/
class Doctrine_Query_Set extends Doctrine_Query_Part {
public function parse($dql) {
$e = Doctrine_Query::sqlExplode($dql, '=');
......
......@@ -22,10 +22,14 @@ Doctrine::autoload('Doctrine_Hydrate');
/**
* Doctrine_RawSql
*
* @package Doctrine ORM
* @url www.phpdoctrine.com
* @license LGPL
*/
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
*/
class Doctrine_RawSql extends Doctrine_Hydrate {
/**
* @var array $fields
......
......@@ -22,8 +22,12 @@ Doctrine::autoload('Doctrine_Exception');
/**
* Doctrine_RawSql_Exception
*
* @package Doctrine ORM
* @url www.phpdoctrine.com
* @license LGPL
*/
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
*/
class Doctrine_RawSql_Exception extends Doctrine_Exception { }
......@@ -23,11 +23,14 @@ Doctrine::autoload('Doctrine_Access');
* Doctrine_Record
* All record classes should inherit this super class
*
* @author Konsta Vesterinen
* @license LGPL
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @package Doctrine
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
*/
abstract class Doctrine_Record extends Doctrine_Access implements Countable, IteratorAggregate, Serializable {
/**
* STATE CONSTANTS
......
......@@ -22,8 +22,12 @@ Doctrine::autoload('Doctrine_Exception');
/**
* Doctrine_Exception
*
* @package Doctrine ORM
* @url www.phpdoctrine.com
* @license LGPL
*/
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
*/
class Doctrine_Record_Exception extends Doctrine_Exception { }
......@@ -22,8 +22,12 @@ Doctrine::autoload('Doctrine_Record_Exception');
/**
* Doctrine_Exception
*
* @package Doctrine ORM
* @url www.phpdoctrine.com
* @license LGPL
*/
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
*/
class Doctrine_Record_State_Exception extends Doctrine_Record_Exception { }
......@@ -22,10 +22,14 @@
* Doctrine_Relation
* This class represents a relation between components
*
* @package Doctrine ORM
* @url www.phpdoctrine.com
* @license LGPL
*/
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
*/
abstract class Doctrine_Relation {
/**
* RELATION CONSTANTS
......
......@@ -25,10 +25,14 @@ Doctrine::autoload('Doctrine_Relation');
* which holds 2 foreign keys)
*
*
* @package Doctrine ORM
* @url www.phpdoctrine.com
* @license LGPL
*/
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
*/
class Doctrine_Relation_Association extends Doctrine_Relation {
/**
* @var Doctrine_Table $associationTable
......
......@@ -22,10 +22,14 @@ Doctrine::autoload('Doctrine_Relation_Association');
/**
* Doctrine_Relation_Association_Self
*
* @package Doctrine ORM
* @url www.phpdoctrine.com
* @license LGPL
*/
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
*/
class Doctrine_Relation_Association_Self extends Doctrine_Relation_Association {
/**
* getRelationDql
......
......@@ -23,10 +23,14 @@ Doctrine::autoload('Doctrine_Relation');
* Doctrine_Relation_ForeignKey
* This class represents a foreign key relation
*
* @author Konsta Vesterinen
* @license LGPL
* @package Doctrine
*/
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @package Doctrine
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
*/
class Doctrine_Relation_ForeignKey extends Doctrine_Relation {
/**
* processDiff
......
......@@ -23,10 +23,14 @@ Doctrine::autoload('Doctrine_Relation');
* Doctrine_Relation_LocalKey
* This class represents a local key relation
*
* @author Konsta Vesterinen
* @license LGPL
* @package Doctrine
*/
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @package Doctrine
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
*/
class Doctrine_Relation_LocalKey extends Doctrine_Relation {
/**
* processDiff
......
......@@ -25,13 +25,16 @@
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @author Jukka Hassinen <Jukka.Hassinen@BrainAlliance.com>
* @version $Id$
*/
/**
* class Doctrine_Schema
* Holds information on one to many databases
* @package Doctrine
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @since 1.0
* @version $Revision$
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
*/
class Doctrine_Schema extends Doctrine_Schema_Object implements Countable, IteratorAggregate {
/**
......
......@@ -26,12 +26,16 @@ Doctrine::autoload('Doctrine_Schema_Object');
* @author Jukka Hassinen <Jukka.Hassinen@BrainAlliance.com>
* @version $Id$
*/
/**
* class Doctrine_Schema_Column
* Holds information on a database table field
* @package Doctrine
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @since 1.0
* @version $Revision$
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
*/
class Doctrine_Schema_Column extends Doctrine_Schema_Object implements IteratorAggregate {
/**
......
......@@ -26,11 +26,16 @@ Doctrine::autoload('Doctrine_Schema_Object');
* @author Jukka Hassinen <Jukka.Hassinen@BrainAlliance.com>
* @version $Id$
*/
/**
* class Doctrine_Schema_Database
* Holds information on a database
* @package Doctrine
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @since 1.0
* @version $Revision$
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
*/
class Doctrine_Schema_Database extends Doctrine_Schema_Object {
......
......@@ -26,10 +26,14 @@ Doctrine::autoload('Doctrine_Exception');
* @author Jukka Hassinen <Jukka.Hassinen@BrainAlliance.com>
* @version $Id$
*/
/**
* class Doctrine_Schema_Exception
* @package Doctrine
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @since 1.0
* @version $Revision$
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
*/
class Doctrine_Schema_Exception extends Exception { }
......@@ -27,10 +27,16 @@ Doctrine::autoload('Doctrine_Access');
* @author Konsta Vesterinen
* @version $Id$
*/
/**
* class Doctrine_Schema_Object
* Catches any non-property call from child classes and throws an exception.
* @package Doctrine
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @since 1.0
* @version $Revision$
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
*/
abstract class Doctrine_Schema_Object extends Doctrine_Access implements IteratorAggregate, Countable {
......
......@@ -26,12 +26,16 @@ Doctrine::autoload('Doctrine_Schema_Object');
* @author Jukka Hassinen <Jukka.Hassinen@BrainAlliance.com>
* @version $Id$
*/
/**
* class Doctrine_Schema_Relation
* Holds information on a foreign key relation.
* @package Doctrine
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @since 1.0
* @version $Revision$
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
*/
class Doctrine_Schema_Relation extends Doctrine_Schema_Object {
......
......@@ -26,12 +26,16 @@ Doctrine::autoload('Doctrine_Schema_Object');
* @author Jukka Hassinen <Jukka.Hassinen@BrainAlliance.com>
* @version $Id$
*/
/**
* class Doctrine_Schema_Table
* Holds information on a database table
* @package Doctrine
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @since 1.0
* @version $Revision$
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
*/
class Doctrine_Schema_Table extends Doctrine_Schema_Object implements Countable, IteratorAggregate {
......
......@@ -18,18 +18,19 @@
* and is licensed under the LGPL. For more information, see
* <http://www.phpdoctrine.com>.
*/
/**
* Doctrine_Table represents a database table
* each Doctrine_Table holds the information of foreignKeys and associations
*
*
* @author Konsta Vesterinen
* @package Doctrine ORM
* @url www.phpdoctrine.com
* @license LGPL
* @version 1.0 alpha
*/
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @version $Revision$
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
*/
class Doctrine_Table extends Doctrine_Configurable implements Countable {
/**
* @var array $data temporary data which is then loaded into Doctrine_Record::$data
......
......@@ -23,10 +23,14 @@ Doctrine::autoload('Doctrine_Exception');
* thrown when user tries to initialize a new instance of Doctrine_Table,
* while there already exists an instance of that table
*
* @package Doctrine ORM
* @url www.phpdoctrine.com
* @license LGPL
*/
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
*/
class Doctrine_Table_Exception extends Doctrine_Exception {
public function __construct($message = "Couldn't initialize table. One instance of this
table already exists. Always use Doctrine_Session::getTable(\$name)
......
......@@ -23,11 +23,14 @@
* each record is added into Doctrine_Repository at the same time they are created,
* loaded from the database or retrieved from the cache
*
* @author Konsta Vesterinen
* @package Doctrine ORM
* @url www.phpdoctrine.com
* @license LGPL
*/
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
*/
class Doctrine_Table_Repository implements Countable, IteratorAggregate {
/**
* @var object Doctrine_Table $table
......
......@@ -22,8 +22,12 @@ Doctrine::autoload('Doctrine_Exception');
/**
* Doctrine_Table_Repository_Exception
*
* @package Doctrine ORM
* @url www.phpdoctrine.com
* @license LGPL
*/
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
*/
class Doctrine_Table_Repository_Exception extends Doctrine_Exception { }
......@@ -22,9 +22,13 @@
* Doctrine_Validator
* Doctrine_Validator performs validations in record properties
*
* @package Doctrine ORM
* @url www.phpdoctrine.com
* @license LGPL
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
*/
class Doctrine_Validator {
/**
......
......@@ -18,14 +18,17 @@
* and is licensed under the LGPL. For more information, see
* <http://www.phpdoctrine.com>.
*/
/**
* Doctrine_Validator_ErrorStack
*
* @author Konsta Vesterinen
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
* @author Roman Borschel
* @license LGPL
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @package Doctrine
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
*/
class Doctrine_Validator_ErrorStack extends Doctrine_Access implements Countable, IteratorAggregate {
......
......@@ -22,10 +22,14 @@ Doctrine::autoload('Doctrine_Exception');
/**
* Doctrine_Validator_Exception
*
* @author Konsta Vesterinen
* @license LGPL
* @package Doctrine
*/
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @package Doctrine
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
*/
class Doctrine_Validator_Exception extends Doctrine_Exception implements Countable, IteratorAggregate {
/**
* @var array $invalid
......
......@@ -25,10 +25,14 @@ Doctrine::autoload('Doctrine_Access');
* intend to save / delete the object.
*
*
* @package Doctrine ORM
* @url www.phpdoctrine.com
* @license LGPL
*/
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
*/
class Doctrine_ValueHolder extends Doctrine_Access implements Countable {
public $data = array();
......
......@@ -23,11 +23,14 @@
*
* this class represents a database view
*
* @author Konsta Vesterinen
* @package Doctrine ORM
* @url www.phpdoctrine.com
* @license LGPL
*/
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
* @package Doctrine
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @category Object Relational Mapping
* @link www.phpdoctrine.com
* @since 1.0
* @version $Revision$
*/
class Doctrine_View {
/**
* SQL DROP constant
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment