RetailCRM-Mirror/doctrine2
1
0
Fork 0
mirror of synced 2025-01-18 14:31:40 +03:00
Code Issues Projects Releases Wiki Activity

Merge upstream into lock-support branch

Browse Source
This commit is contained in:
Benjamin Eberlei 2010-05-15 09:41:32 +02:00
commit 64b57bbcfb
609 changed files with 1382 additions and 90679 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
bin/doctrine.php
View File

@ -52,6 +52,7 @@ $cli->addCommands(array(
new \Doctrine\ORM\Tools\Console\Command\GenerateProxiesCommand(),
new \Doctrine\ORM\Tools\Console\Command\ConvertMappingCommand(),
new \Doctrine\ORM\Tools\Console\Command\RunDqlCommand(),
new \Doctrine\ORM\Tools\Console\Command\ValidateSchemaCommand(),
));
$cli->run();

2
lib/Doctrine/Common/Annotations/AnnotationReader.php
View File

@ -179,7 +179,7 @@ class AnnotationReader
// Attempt to grab data from cache
if (($data = $this->_cache->fetch($cacheKey)) !== false) {
return $data;
}
}
$context = 'method ' . $method->getDeclaringClass()->getName() . '::' . $method->getName() . '()';
$annotations = $this->_parser->parse($method->getDocComment(), $context);

37
lib/Doctrine/DBAL/Connection.php
View File

@ -19,7 +19,7 @@
namespace Doctrine\DBAL;
use PDO, Closure,
use PDO, Closure, Exception,
Doctrine\DBAL\Types\Type,
Doctrine\DBAL\Driver\Connection as DriverConnection,
Doctrine\Common\EventManager,
@ -310,9 +310,8 @@ class Connection implements DriverConnection
* @param string $statement The SQL query.
* @param array $params The query parameters.
* @return array
* @todo Rename: fetchAssoc
*/
public function fetchRow($statement, array $params = array())
public function fetchAssoc($statement, array $params = array())
{
return $this->executeQuery($statement, $params)->fetch(PDO::FETCH_ASSOC);
}
@ -583,10 +582,10 @@ class Connection implements DriverConnection
* represents a row of the result set.
* @return mixed The projected result of the query.
*/
public function project($query, array $params = array(), Closure $function)
public function project($query, array $params, Closure $function)
{
$result = array();
$stmt = $this->executeQuery($query, $params);
$stmt = $this->executeQuery($query, $params ?: array());
while ($row = $stmt->fetch()) {
$result[] = $function($row);
@ -706,6 +705,28 @@ class Connection implements DriverConnection
return $this->_conn->lastInsertId($seqName);
}
/**
* Executes a function in a transaction.
*
* The function gets passed this Connection instance as an (optional) parameter.
*
* If an exception occurs during execution of the function or transaction commit,
* the transaction is rolled back and the exception re-thrown.
*
* @param Closure $func The function to execute transactionally.
*/
public function transactional(Closure $func)
{
$this->beginTransaction();
try {
$func($this);
$this->commit();
} catch (Exception $e) {
$this->rollback();
throw $e;
}
}
/**
* Starts a transaction by suspending auto-commit mode.
*
@ -789,7 +810,7 @@ class Connection implements DriverConnection
* Gets the SchemaManager that can be used to inspect or change the
* database schema through the connection.
*
* @return Doctrine\DBAL\Schema\AbstractSchemaManager
* @return Doctrine\DBAL\Schema\SchemaManager
*/
public function getSchemaManager()
{
@ -820,7 +841,7 @@ class Connection implements DriverConnection
* @return boolean
* @throws ConnectionException If no transaction is active.
*/
public function getRollbackOnly()
public function isRollbackOnly()
{
if ($this->_transactionNestingLevel == 0) {
throw ConnectionException::noActiveTransaction();
@ -911,4 +932,4 @@ class Connection implements DriverConnection
}
}
}
}
}

19
lib/Doctrine/DBAL/Driver.php
View File

@ -1,4 +1,21 @@
<?php
/*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* This software consists of voluntary contributions made by many individuals
* and is licensed under the LGPL. For more information, see
* <http://www.doctrine-project.org>.
*/
namespace Doctrine\DBAL;
@ -51,5 +68,5 @@ interface Driver
* @param Doctrine\DBAL\Connection $conn
* @return string $database
*/
public function getDatabase(\Doctrine\DBAL\Connection $conn);
public function getDatabase(Connection $conn);
}

2
lib/Doctrine/DBAL/Driver/Connection.php
View File

@ -1,7 +1,5 @@
<?php
/*
* $Id$
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR

11
lib/Doctrine/DBAL/Driver/IBMDB2/DB2Driver.php
View File

@ -1,7 +1,5 @@
<?php
/*
* $Id$
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
@ -25,13 +23,10 @@ use Doctrine\DBAL\Driver,
Doctrine\DBAL\Connection;
/**
* IBM Db2 Driver
* IBM DB2 Driver
*
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @link www.doctrine-project.com
* @since 1.0
* @version $Revision$
* @author Benjamin Eberlei <kontakt@beberlei.de>
* @since 2.0
* @author Benjamin Eberlei <kontakt@beberlei.de>
*/
class DB2Driver implements Driver
{

29
lib/Doctrine/DBAL/Driver/PDOMsSql/Connection.php
View File

@ -1,7 +1,5 @@
<?php
/*
* $Id$
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
@ -21,17 +19,17 @@
namespace Doctrine\DBAL\Driver\PDOMsSql;
use PDO, Doctrine\DBAL\Driver\Connection as DriverConnection;
/**
* MsSql Connection implementation.
*
* @since 2.0
*/
class Connection extends \PDO implements \Doctrine\DBAL\Driver\Connection
class Connection extends PDO implements DriverConnection
{
/**
* Performs the rollback.
*
* @override
* {@inheritdoc}
*/
public function rollback()
{
@ -39,9 +37,7 @@ class Connection extends \PDO implements \Doctrine\DBAL\Driver\Connection
}
/**
* Performs the commit.
*
* @override
* {@inheritdoc}
*/
public function commit()
{
@ -49,12 +45,21 @@ class Connection extends \PDO implements \Doctrine\DBAL\Driver\Connection
}
/**
* Begins a database transaction.
*
* @override
* {@inheritdoc}
*/
public function beginTransaction()
{
$this->exec('BEGIN TRANSACTION');
}
/**
* {@inheritdoc}
*/
public function lastInsertId($name = null)
{
$stmt = $this->query('SELECT SCOPE_IDENTITY()');
$id = $stmt->fetchColumn();
$stmt->closeCursor();
return $id;
}
}

2
lib/Doctrine/DBAL/Driver/PDOMySql/Driver.php
View File

@ -1,7 +1,5 @@
<?php
/*
* $Id$
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR

2
lib/Doctrine/DBAL/Driver/PDOSqlite/Driver.php
View File

@ -1,7 +1,5 @@
<?php
/*
* $Id$
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR

2
lib/Doctrine/DBAL/DriverManager.php
View File

@ -1,7 +1,5 @@
<?php
/*
* $Id$
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR

2
lib/Doctrine/DBAL/Platforms/AbstractPlatform.php
View File

@ -1901,4 +1901,4 @@ abstract class AbstractPlatform
{
return 'TRUNCATE '.$tableName;
}
}
}

6
lib/Doctrine/DBAL/Types/IntegerType.php
View File

@ -25,7 +25,7 @@ use Doctrine\DBAL\Platforms\AbstractPlatform;
/**
* Type that maps an SQL INT to a PHP integer.
*
*
* @author Roman Borschel <roman@code-factory.org>
* @since 2.0
*/
@ -43,9 +43,9 @@ class IntegerType extends Type
public function convertToPHPValue($value, AbstractPlatform $platform)
{
return (int) $value;
return (null === $value) ? null : (int) $value;
}
public function getBindingType()
{
return \PDO::PARAM_INT;

50
lib/Doctrine/ORM/EntityManager.php
View File

@ -1,7 +1,5 @@
<?php
/*
* $Id$
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
@ -21,7 +19,8 @@
namespace Doctrine\ORM;
use Doctrine\Common\EventManager,
use Closure, Exception,
Doctrine\Common\EventManager,
Doctrine\DBAL\Connection,
Doctrine\ORM\Mapping\ClassMetadata,
Doctrine\ORM\Mapping\ClassMetadataFactory,
@ -30,10 +29,7 @@ use Doctrine\Common\EventManager,
/**
* The EntityManager is the central access point to ORM functionality.
*
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @link www.doctrine-project.org
* @since 2.0
* @version $Revision$
* @author Benjamin Eberlei <kontakt@beberlei.de>
* @author Guilherme Blanco <guilhermeblanco@hotmail.com>
* @author Jonathan Wage <jonwage@gmail.com>
@ -154,11 +150,12 @@ class EntityManager
*
* Example:
*
* [php]
* <code>
* $qb = $em->createQueryBuilder();
* $expr = $em->getExpressionBuilder();
* $qb->select('u')->from('User', 'u')
* ->where($expr->orX($expr->eq('u.id', 1), $expr->eq('u.id', 2)));
* </code>
*
* @return ExpressionBuilder
*/
@ -172,14 +169,44 @@ class EntityManager
/**
* Starts a transaction on the underlying database connection.
*
* @deprecated Use {@link getConnection}.beginTransaction().
*/
public function beginTransaction()
{
$this->_conn->beginTransaction();
}
/**
* Executes a function in a transaction.
*
* The function gets passed this EntityManager instance as an (optional) parameter.
*
* {@link flush} is invoked prior to transaction commit.
*
* If an exception occurs during execution of the function or flushing or transaction commit,
* the transaction is rolled back, the EntityManager closed and the exception re-thrown.
*
* @param Closure $func The function to execute transactionally.
*/
public function transactional(Closure $func)
{
$this->_conn->beginTransaction();
try {
$func($this);
$this->flush();
$this->_conn->commit();
} catch (Exception $e) {
$this->close();
$this->_conn->rollback();
throw $e;
}
}
/**
* Commits a transaction on the underlying database connection.
*
* @deprecated Use {@link getConnection}.commit().
*/
public function commit()
{
@ -187,13 +214,13 @@ class EntityManager
}
/**
* Performs a rollback on the underlying database connection and closes the
* EntityManager as it may now be in a corrupted state.
* Performs a rollback on the underlying database connection.
*
* @deprecated Use {@link getConnection}.rollback().
*/
public function rollback()
{
$this->_conn->rollback();
$this->close();
}
/**
@ -274,6 +301,9 @@ class EntityManager
* Flushes all changes to objects that have been queued up to now to the database.
* This effectively synchronizes the in-memory state of managed objects with the
* database.
*
* @throws Doctrine\ORM\OptimisticLockException If a version check on an entity that
* makes use of optimistic locking fails.
*/
public function flush()
{

31
lib/Doctrine/ORM/Id/IdentityGenerator.php
View File

@ -21,23 +21,36 @@ namespace Doctrine\ORM\Id;
use Doctrine\ORM\EntityManager;
/**
* Id generator that obtains IDs from special "identity" columns. These are columns
* that automatically get a database-generated, auto-incremented identifier on INSERT.
* This generator obtains the last insert id after such an insert.
*/
class IdentityGenerator extends AbstractIdGenerator
{
/** @var string The name of the sequence to pass to lastInsertId(), if any. */
private $_seqName;
/**
* Generates an ID for the given entity.
*
* @param object $entity
* @return integer|float
* @override
* @param string $seqName The name of the sequence to pass to lastInsertId()
* to obtain the last generated identifier within the current
* database session/connection, if any.
*/
public function generate(EntityManager $em, $entity)
public function __construct($seqName = null)
{
return $em->getConnection()->lastInsertId();
$this->_seqName = $seqName;
}
/**
* @return boolean
* @override
* {@inheritdoc}
*/
public function generate(EntityManager $em, $entity)
{
return $em->getConnection()->lastInsertId($this->_seqName);
}
/**
* {@inheritdoc}
*/
public function isPostInsertGenerator()
{

46
lib/Doctrine/ORM/Id/SequenceIdentityGenerator.php
View File

@ -1,46 +0,0 @@
<?php
/*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* This software consists of voluntary contributions made by many individuals
* and is licensed under the LGPL. For more information, see
* <http://www.doctrine-project.org>.
*/
namespace Doctrine\ORM\Id;
use Doctrine\ORM\EntityManager;
class SequenceIdentityGenerator extends IdentityGenerator
{
private $_sequenceName;
public function __construct($sequenceName)
{
$this->_sequenceName = $sequenceName;
}
public function generate(EntityManager $em, $entity)
{
return $em->getConnection()->lastInsertId($this->_sequenceName);
}
/**
* @return boolean
* @override
*/
public function isPostInsertGenerator()
{
return true;
}
}

28
lib/Doctrine/ORM/Mapping/ClassMetadataFactory.php
View File

@ -19,8 +19,10 @@
namespace Doctrine\ORM\Mapping;
use Doctrine\ORM\ORMException,
Doctrine\DBAL\Platforms\AbstractPlatform,
use ReflectionException,
Doctrine\ORM\ORMException,
Doctrine\ORM\EntityManager,
Doctrine\DBAL\Platforms,
Doctrine\ORM\Events;
/**
@ -53,7 +55,7 @@ class ClassMetadataFactory
*
* @param $driver The metadata driver to use.
*/
public function __construct(\Doctrine\ORM\EntityManager $em)
public function __construct(EntityManager $em)
{
$this->_em = $em;
}
@ -94,15 +96,15 @@ class ClassMetadataFactory
if ( ! $this->_initialized) {
$this->_initialize();
}
$metadata = array();
foreach ($this->_driver->getAllClassNames() as $className) {
$metadata[] = $this->getMetadataFor($className);
}
return $metadata;
}
/**
* Lazy initialization of this stuff, especially the metadata driver,
* since these are not needed at all when a metadata cache is active.
@ -252,7 +254,7 @@ class ClassMetadataFactory
// Invoke driver
try {
$this->_driver->loadMetadataForClass($className, $class);
} catch(\ReflectionException $e) {
} catch(ReflectionException $e) {
throw MappingException::reflectionFailure($className, $e);
}
@ -275,9 +277,9 @@ class ClassMetadataFactory
} else {
$this->_completeIdGeneratorMapping($class);
}
if ($parent && $parent->isInheritanceTypeSingleTable()) {
$class->setTableName($parent->getTableName());
$class->setPrimaryTable($parent->table);
}
$class->setParentClasses($visited);
@ -376,7 +378,13 @@ class ClassMetadataFactory
// Create & assign an appropriate ID generator instance
switch ($class->generatorType) {
case ClassMetadata::GENERATOR_TYPE_IDENTITY:
$class->setIdGenerator(new \Doctrine\ORM\Id\IdentityGenerator());
// For PostgreSQL IDENTITY (SERIAL) we need a sequence name. It defaults to
// <table>_<column>_seq in PostgreSQL for SERIAL columns.
// Not pretty but necessary and the simplest solution that currently works.
$seqName = $this->_targetPlatform instanceof Platforms\PostgreSQLPlatform ?
$class->table['name'] . '_' . $class->columnNames[$class->identifier[0]] . '_seq' :
null;
$class->setIdGenerator(new \Doctrine\ORM\Id\IdentityGenerator($seqName));
break;
case ClassMetadata::GENERATOR_TYPE_SEQUENCE:
// If there is no sequence definition yet, create a default definition

28
lib/Doctrine/ORM/Mapping/ClassMetadataInfo.php
View File

@ -317,7 +317,7 @@ class ClassMetadataInfo
* READ-ONLY: The ID generator used for generating IDs for this class.
*
* @var AbstractIdGenerator
* @todo Remove
* @todo Remove!
*/
public $idGenerator;
@ -335,6 +335,7 @@ class ClassMetadataInfo
* </code>
*
* @var array
* @todo Merge with tableGeneratorDefinition into generic generatorDefinition
*/
public $sequenceGeneratorDefinition;
@ -343,6 +344,7 @@ class ClassMetadataInfo
* TABLE generation strategy.
*
* @var array
* @todo Merge with tableGeneratorDefinition into generic generatorDefinition
*/
public $tableGeneratorDefinition;
@ -395,7 +397,7 @@ class ClassMetadataInfo
public function getReflectionClass()
{
if ( ! $this->reflClass) {
$this->reflClass = new ReflectionClass($entityName);
$this->reflClass = new ReflectionClass($this->name);
}
return $this->reflClass;
}
@ -901,8 +903,8 @@ class ClassMetadataInfo
/**
* Sets the name of the primary table the class is mapped to.
*
* @param string $tableName The table name.
* @deprecated
* @param string $tableName The table name.
* @deprecated Use {@link setPrimaryTable}.
*/
public function setTableName($tableName)
{
@ -910,18 +912,22 @@ class ClassMetadataInfo
}
/**
* Sets the primary table definition. The provided array must have the
* Sets the primary table definition. The provided array supports the
* following structure:
*
* name => <tableName>
* schema => <schemaName>
* catalog => <catalogName>
* name => <tableName> (optional, defaults to class name)
* indexes => array of indexes (optional)
* uniqueConstraints => array of constraints (optional)
*
* @param array $primaryTableDefinition
* @param array $table
*/
public function setPrimaryTable(array $primaryTableDefinition)
public function setPrimaryTable(array $table)
{
$this->table = $primaryTableDefinition;
if (isset($table['name']) && $table['name'][0] == '`') {
$table['name'] = trim($table['name'], '`');
$table['quoted'] = true;
}
$this->table = $table;
}
/**

15
lib/Doctrine/ORM/Mapping/Driver/AnnotationDriver.php
View File

@ -1,7 +1,5 @@
<?php
/*
* $Id$
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
@ -31,14 +29,11 @@ require __DIR__ . '/DoctrineAnnotations.php';
/**
* The AnnotationDriver reads the mapping metadata from docblock annotations.
*
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @link www.doctrine-project.org
* @since 2.0
* @version $Revision$
* @author Benjamin Eberlei <kontakt@beberlei.de>
* @author Guilherme Blanco <guilhermeblanco@hotmail.com>
* @author Jonathan H. Wage <jonwage@gmail.com>
* @author Roman Borschel <roman@code-factory.org>
* @since 2.0
* @author Benjamin Eberlei <kontakt@beberlei.de>
* @author Guilherme Blanco <guilhermeblanco@hotmail.com>
* @author Jonathan H. Wage <jonwage@gmail.com>
* @author Roman Borschel <roman@code-factory.org>
*/
class AnnotationDriver implements Driver
{

9
lib/Doctrine/ORM/Mapping/Driver/DatabaseDriver.php
View File

@ -78,13 +78,6 @@ class DatabaseDriver implements Driver
$ids = array();
$fieldMappings = array();
foreach ($columns as $column) {
// Skip columns that are foreign keys
foreach ($foreignKeys as $foreignKey) {
if (in_array(strtolower($column->getName()), array_map('strtolower', $foreignKey->getColumns()))) {
continue(2);
}
}
$fieldMapping = array();
if (isset($indexes['primary']) && in_array($column->getName(), $indexes['primary']->getColumns())) {
$fieldMapping['id'] = true;
@ -100,7 +93,7 @@ class DatabaseDriver implements Driver
} else if ($column->getType() instanceof \Doctrine\DBAL\Types\IntegerType) {
$fieldMapping['unsigned'] = $column->getUnsigned();
}
$fieldMapping['notnull'] = $column->getNotNull();
$fieldMapping['nullable'] = $column->getNotNull() ? false : true;
if (isset($fieldMapping['id'])) {
$ids[] = $fieldMapping;

2
lib/Doctrine/ORM/Mapping/Driver/PHPDriver.php
View File

@ -1,7 +1,5 @@
<?php
/*
* $Id$
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR

102
lib/Doctrine/ORM/Mapping/Driver/XmlDriver.php
View File

@ -62,13 +62,17 @@ class XmlDriver extends AbstractFileDriver
}
// Evaluate <entity...> attributes
$table = array();
if (isset($xmlRoot['table'])) {
$metadata->table['name'] = (string)$xmlRoot['table'];
$table['name'] = (string)$xmlRoot['table'];
}
$metadata->setPrimaryTable($table);
/* not implemented specially anyway. use table = schema.table
if (isset($xmlRoot['schema'])) {
$metadata->table['schema'] = (string)$xmlRoot['schema'];
}
}*/
if (isset($xmlRoot['inheritance-type'])) {
$inheritanceType = (string)$xmlRoot['inheritance-type'];
@ -108,13 +112,13 @@ class XmlDriver extends AbstractFileDriver
} else {
$columns = $index['columns'];
}
$metadata->table['indexes'][$index['name']] = array(
'columns' => $columns
);
}
}
// Evaluate <unique-constraints..>
if (isset($xmlRoot->{'unique-constraints'})) {
foreach ($xmlRoot->{'unique-constraints'}->{'unique-constraint'} as $unique) {
@ -139,27 +143,27 @@ class XmlDriver extends AbstractFileDriver
'fieldName' => (string)$fieldMapping['name'],
'type' => (string)$fieldMapping['type']
);
if (isset($fieldMapping['column'])) {
$mapping['columnName'] = (string)$fieldMapping['column'];
}
if (isset($fieldMapping['length'])) {
$mapping['length'] = (int)$fieldMapping['length'];
}
if (isset($fieldMapping['precision'])) {
$mapping['precision'] = (int)$fieldMapping['precision'];
}
if (isset($fieldMapping['scale'])) {
$mapping['scale'] = (int)$fieldMapping['scale'];
}
if (isset($fieldMapping['unique'])) {
$mapping['unique'] = ((string)$fieldMapping['unique'] == "false") ? false : true;
}
if (isset($fieldMapping['options'])) {
$mapping['options'] = (array)$fieldMapping['options'];
}
@ -167,15 +171,15 @@ class XmlDriver extends AbstractFileDriver
if (isset($fieldMapping['nullable'])) {
$mapping['nullable'] = ((string)$fieldMapping['nullable'] == "false") ? false : true;
}
if (isset($fieldMapping['version']) && $fieldMapping['version']) {
$metadata->setVersionMapping($mapping);
}
if (isset($fieldMapping['column-definition'])) {
$mapping['columnDefinition'] = (string)$fieldMapping['column-definition'];
}
$metadata->mapField($mapping);
}
}
@ -187,11 +191,11 @@ class XmlDriver extends AbstractFileDriver
'fieldName' => (string)$idElement['name'],
'type' => (string)$idElement['type']
);
if (isset($idElement['column'])) {
$mapping['columnName'] = (string)$idElement['column'];
}
$metadata->mapField($mapping);
if (isset($idElement->generator)) {
@ -221,11 +225,11 @@ class XmlDriver extends AbstractFileDriver
'fieldName' => (string)$oneToOneElement['field'],
'targetEntity' => (string)$oneToOneElement['target-entity']
);
if (isset($oneToOneElement['fetch'])) {
$mapping['fetch'] = constant('Doctrine\ORM\Mapping\AssociationMapping::FETCH_' . (string)$oneToOneElement['fetch']);
}
if (isset($oneToOneElement['mapped-by'])) {
$mapping['mappedBy'] = (string)$oneToOneElement['mapped-by'];
} else {
@ -233,7 +237,7 @@ class XmlDriver extends AbstractFileDriver
$mapping['inversedBy'] = (string)$oneToOneElement['inversed-by'];
}
$joinColumns = array();
if (isset($oneToOneElement->{'join-column'})) {
$joinColumns[] = $this->_getJoinColumnMapping($oneToOneElement->{'join-column'});
} else if (isset($oneToOneElement->{'join-columns'})) {
@ -241,10 +245,10 @@ class XmlDriver extends AbstractFileDriver
$joinColumns[] = $this->_getJoinColumnMapping($joinColumnElement);
}
}
$mapping['joinColumns'] = $joinColumns;
}
if (isset($oneToOneElement->cascade)) {
$mapping['cascade'] = $this->_getCascadeMappings($oneToOneElement->cascade);
}
@ -252,7 +256,7 @@ class XmlDriver extends AbstractFileDriver
if (isset($oneToOneElement->{'orphan-removal'})) {
$mapping['orphanRemoval'] = (bool)$oneToOneElement->{'orphan-removal'};
}
$metadata->mapOneToOne($mapping);
}
}
@ -265,15 +269,15 @@ class XmlDriver extends AbstractFileDriver
'targetEntity' => (string)$oneToManyElement['target-entity'],
'mappedBy' => (string)$oneToManyElement['mapped-by']
);
if (isset($oneToManyElement['fetch'])) {
$mapping['fetch'] = constant('Doctrine\ORM\Mapping\AssociationMapping::FETCH_' . (string)$oneToManyElement['fetch']);
}
if (isset($oneToManyElement->cascade)) {
$mapping['cascade'] = $this->_getCascadeMappings($oneToManyElement->cascade);
}
if (isset($oneToManyElement->{'orphan-removal'})) {
$mapping['orphanRemoval'] = (bool)$oneToManyElement->{'orphan-removal'};
}
@ -285,11 +289,11 @@ class XmlDriver extends AbstractFileDriver
}
$mapping['orderBy'] = $orderBy;
}
$metadata->mapOneToMany($mapping);
}
}
// Evaluate <many-to-one ...> mappings
if (isset($xmlRoot->{'many-to-one'})) {
foreach ($xmlRoot->{'many-to-one'} as $manyToOneElement) {
@ -297,7 +301,7 @@ class XmlDriver extends AbstractFileDriver
'fieldName' => (string)$manyToOneElement['field'],
'targetEntity' => (string)$manyToOneElement['target-entity']
);
if (isset($manyToOneElement['fetch'])) {
$mapping['fetch'] = constant('Doctrine\ORM\Mapping\AssociationMapping::FETCH_' . (string)$manyToOneElement['fetch']);
}
@ -324,15 +328,15 @@ class XmlDriver extends AbstractFileDriver
if (isset($manyToOneElement->cascade)) {
$mapping['cascade'] = $this->_getCascadeMappings($manyToOneElement->cascade);
}
if (isset($manyToOneElement->{'orphan-removal'})) {
$mapping['orphanRemoval'] = (bool)$manyToOneElement->{'orphan-removal'};
}
$metadata->mapManyToOne($mapping);
}
}
// Evaluate <many-to-many ...> mappings
if (isset($xmlRoot->{'many-to-many'})) {
foreach ($xmlRoot->{'many-to-many'} as $manyToManyElement) {
@ -340,11 +344,11 @@ class XmlDriver extends AbstractFileDriver
'fieldName' => (string)$manyToManyElement['field'],
'targetEntity' => (string)$manyToManyElement['target-entity']
);
if (isset($manyToManyElement['fetch'])) {
$mapping['fetch'] = constant('Doctrine\ORM\Mapping\AssociationMapping::FETCH_' . (string)$manyToManyElement['fetch']);
}
if (isset($manyToManyElement['mapped-by'])) {
$mapping['mappedBy'] = (string)$manyToManyElement['mapped-by'];
} else if (isset($manyToManyElement->{'join-table'})) {
@ -360,22 +364,22 @@ class XmlDriver extends AbstractFileDriver
if (isset($joinTableElement['schema'])) {
$joinTable['schema'] = (string)$joinTableElement['schema'];
}
foreach ($joinTableElement->{'join-columns'}->{'join-column'} as $joinColumnElement) {
$joinTable['joinColumns'][] = $this->_getJoinColumnMapping($joinColumnElement);
}
foreach ($joinTableElement->{'inverse-join-columns'}->{'join-column'} as $joinColumnElement) {
$joinTable['inverseJoinColumns'][] = $this->_getJoinColumnMapping($joinColumnElement);
}
$mapping['joinTable'] = $joinTable;
}
if (isset($manyToManyElement->cascade)) {
$mapping['cascade'] = $this->_getCascadeMappings($manyToManyElement->cascade);
}
if (isset($manyToManyElement->{'orphan-removal'})) {
$mapping['orphanRemoval'] = (bool)$manyToManyElement->{'orphan-removal'};
}
@ -387,7 +391,7 @@ class XmlDriver extends AbstractFileDriver
}
$mapping['orderBy'] = $orderBy;
}
$metadata->mapManyToMany($mapping);
}
}
@ -403,7 +407,7 @@ class XmlDriver extends AbstractFileDriver
/**
* Constructs a joinColumn mapping array based on the information
* found in the given SimpleXMLElement.
*
*
* @param $joinColumnElement The XML element.
* @return array The mapping array.
*/
@ -413,19 +417,19 @@ class XmlDriver extends AbstractFileDriver
'name' => (string)$joinColumnElement['name'],
'referencedColumnName' => (string)$joinColumnElement['referenced-column-name']
);
if (isset($joinColumnElement['unique'])) {
$joinColumn['unique'] = ((string)$joinColumnElement['unique'] == "false") ? false : true;
}
if (isset($joinColumnElement['nullable'])) {
$joinColumn['nullable'] = ((string)$joinColumnElement['nullable'] == "false") ? false : true;
}
if (isset($joinColumnElement['on-delete'])) {
$joinColumn['onDelete'] = (string)$joinColumnElement['on-delete'];
}
if (isset($joinColumnElement['on-update'])) {
$joinColumn['onUpdate'] = (string)$joinColumnElement['on-update'];
}
@ -433,13 +437,13 @@ class XmlDriver extends AbstractFileDriver
if (isset($joinColumnElement['column-definition'])) {
$joinColumn['columnDefinition'] = (string)$joinColumnElement['column-definition'];
}
return $joinColumn;
}
/**
* Gathers a list of cascade options found in the given cascade element.
*
*
* @param $cascadeElement The cascade element.
* @return array The list of cascade options.
*/
@ -456,7 +460,7 @@ class XmlDriver extends AbstractFileDriver
}
return $cascades;
}
/**
* {@inheritdoc}
*/
@ -471,7 +475,7 @@ class XmlDriver extends AbstractFileDriver
$result[$entityName] = $entityElement;
}
} else if (isset($xmlElement->{'mapped-superclass'})) {
foreach ($xmlElement->{'mapped-superclass'} as $mapperSuperClass) {
foreach ($xmlElement->{'mapped-superclass'} as $mappedSuperClass) {
$className = (string)$mappedSuperClass['name'];
$result[$className] = $mappedSuperClass;
}

22
lib/Doctrine/ORM/Mapping/Driver/YamlDriver.php
View File

@ -1,7 +1,5 @@
<?php
/*
* $Id$
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
@ -27,14 +25,11 @@ use Doctrine\ORM\Mapping\ClassMetadataInfo,
/**
* The YamlDriver reads the mapping metadata from yaml schema files.
*
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @link www.doctrine-project.org
* @since 2.0
* @version $Revision$
* @author Benjamin Eberlei <kontakt@beberlei.de>
* @author Guilherme Blanco <guilhermeblanco@hotmail.com>
* @author Jonathan H. Wage <jonwage@gmail.com>
* @author Roman Borschel <roman@code-factory.org>
* @since 2.0
* @author Benjamin Eberlei <kontakt@beberlei.de>
* @author Guilherme Blanco <guilhermeblanco@hotmail.com>
* @author Jonathan H. Wage <jonwage@gmail.com>
* @author Roman Borschel <roman@code-factory.org>
*/
class YamlDriver extends AbstractFileDriver
{
@ -61,13 +56,16 @@ class YamlDriver extends AbstractFileDriver
}
// Evaluate root level properties
$table = array();
if (isset($element['table'])) {
$metadata->table['name'] = $element['table'];
$table['name'] = $element['table'];
}
$metadata->setPrimaryTable($table);
/* not implemented specially anyway. use table = schema.table
if (isset($element['schema'])) {
$metadata->table['schema'] = $element['schema'];
}
}*/
if (isset($element['inheritanceType'])) {
$metadata->setInheritanceType(constant('Doctrine\ORM\Mapping\ClassMetadata::INHERITANCE_TYPE_' . strtoupper($element['inheritanceType'])));

4
lib/Doctrine/ORM/ORMException.php
View File

@ -19,13 +19,15 @@
namespace Doctrine\ORM;
use Exception;
/**
* Base exception class for all ORM exceptions.
*
* @author Roman Borschel <roman@code-factory.org>
* @since 2.0
*/
class ORMException extends \Exception
class ORMException extends Exception
{
public static function missingMappingDriverImpl()
{

24
lib/Doctrine/ORM/OptimisticLockException.php
View File

@ -20,16 +20,34 @@
namespace Doctrine\ORM;
/**
* OptimisticLockException
* An OptimisticLockException is thrown when a version check on an object
* that uses optimistic locking through a version field fails.
*
* @author Roman Borschel <roman@code-factory.org>
* @since 2.0
*/
class OptimisticLockException extends ORMException
{
public static function lockFailed()
private $entity;
public function __construct($msg, $entity)
{
return new self("The optimistic lock failed.");
$this->entity = $entity;
}
/**
* Gets the entity that caused the exception.
*
* @return object
*/
public function getEntity()
{
return $this->entity;
}
public static function lockFailed($entity)
{
return new self("The optimistic lock on an entity failed.", $entity);
}
public static function lockFailedVersionMissmatch($expectedLockVersion, $actualLockVersion)

2
lib/Doctrine/ORM/Persisters/BasicEntityPersister.php
View File

@ -330,7 +330,7 @@ class BasicEntityPersister
$result = $this->_conn->executeUpdate($sql, $params, $types);
if ($this->_class->isVersioned && ! $result) {
throw OptimisticLockException::lockFailed();
throw OptimisticLockException::lockFailed($entity);
}
}

24
lib/Doctrine/ORM/Persisters/ManyToManyPersister.php
View File

@ -36,7 +36,7 @@ class ManyToManyPersister extends AbstractCollectionPersister
*
* @override
*/
protected function _getDeleteRowSql(PersistentCollection $coll)
protected function _getDeleteRowSQL(PersistentCollection $coll)
{
$mapping = $coll->getMapping();
$joinTable = $mapping->joinTable;
@ -51,7 +51,7 @@ class ManyToManyPersister extends AbstractCollectionPersister
* @internal Order of the parameters must be the same as the order of the columns in
* _getDeleteRowSql.
*/
protected function _getDeleteRowSqlParameters(PersistentCollection $coll, $element)
protected function _getDeleteRowSQLParameters(PersistentCollection $coll, $element)
{
return $this->_collectJoinTableColumnParameters($coll, $element);
}
@ -61,7 +61,7 @@ class ManyToManyPersister extends AbstractCollectionPersister
*
* @override
*/
protected function _getUpdateRowSql(PersistentCollection $coll)
protected function _getUpdateRowSQL(PersistentCollection $coll)
{}
/**
@ -71,7 +71,7 @@ class ManyToManyPersister extends AbstractCollectionPersister
* @internal Order of the parameters must be the same as the order of the columns in
* _getInsertRowSql.
*/
protected function _getInsertRowSql(PersistentCollection $coll)
protected function _getInsertRowSQL(PersistentCollection $coll)
{
$mapping = $coll->getMapping();
$joinTable = $mapping->joinTable;
@ -87,11 +87,11 @@ class ManyToManyPersister extends AbstractCollectionPersister
* @internal Order of the parameters must be the same as the order of the columns in
* _getInsertRowSql.
*/
protected function _getInsertRowSqlParameters(PersistentCollection $coll, $element)
protected function _getInsertRowSQLParameters(PersistentCollection $coll, $element)
{
return $this->_collectJoinTableColumnParameters($coll, $element);
}
/**
* Collects the parameters for inserting/deleting on the join table in the order
* of the join table columns as specified in ManyToManyMapping#joinTableColumns.
@ -105,15 +105,15 @@ class ManyToManyPersister extends AbstractCollectionPersister
$params = array();
$mapping = $coll->getMapping();
$isComposite = count($mapping->joinTableColumns) > 2;
$identifier1 = $this->_uow->getEntityIdentifier($coll->getOwner());
$identifier2 = $this->_uow->getEntityIdentifier($element);
if ($isComposite) {
$class1 = $this->_em->getClassMetadata(get_class($coll->getOwner()));
$class2 = $coll->getTypeClass();
}
foreach ($mapping->joinTableColumns as $joinTableColumn) {
if (isset($mapping->relationToSourceKeyColumns[$joinTableColumn])) {
if ($isComposite) {
@ -138,7 +138,7 @@ class ManyToManyPersister extends AbstractCollectionPersister
*
* @override
*/
protected function _getDeleteSql(PersistentCollection $coll)
protected function _getDeleteSQL(PersistentCollection $coll)
{
$mapping = $coll->getMapping();
$joinTable = $mapping->joinTable;
@ -157,7 +157,7 @@ class ManyToManyPersister extends AbstractCollectionPersister
* @internal Order of the parameters must be the same as the order of the columns in
* _getDeleteSql.
*/
protected function _getDeleteSqlParameters(PersistentCollection $coll)
protected function _getDeleteSQLParameters(PersistentCollection $coll)
{
$params = array();
$mapping = $coll->getMapping();
@ -170,7 +170,7 @@ class ManyToManyPersister extends AbstractCollectionPersister
} else {
$params[] = array_pop($identifier);
}
return $params;
}
}

26
lib/Doctrine/ORM/Persisters/OneToManyPersister.php
View File

@ -25,7 +25,7 @@ use Doctrine\ORM\PersistentCollection;
/**
* Persister for one-to-many collections.
*
*
* IMPORTANT:
* This persister is only used for uni-directional one-to-many mappings on a foreign key
* (which are not yet supported). So currently this persister is not used.
@ -44,7 +44,7 @@ class OneToManyPersister extends AbstractCollectionPersister
* @return string
* @override
*/
protected function _getDeleteRowSql(PersistentCollection $coll)
protected function _getDeleteRowSQL(PersistentCollection $coll)
{
$mapping = $coll->getMapping();
$targetClass = $this->_em->getClassMetadata($mapping->getTargetEntityName());
@ -67,36 +67,36 @@ class OneToManyPersister extends AbstractCollectionPersister
return array("UPDATE $table SET $setClause WHERE $whereClause", $this->_uow->getEntityIdentifier($element));
}
protected function _getInsertRowSql(PersistentCollection $coll)
protected function _getInsertRowSQL(PersistentCollection $coll)
{
return "UPDATE xxx SET foreign_key = yyy WHERE foreign_key = zzz";
}
/* Not used for OneToManyPersister */
protected function _getUpdateRowSql(PersistentCollection $coll)
protected function _getUpdateRowSQL(PersistentCollection $coll)
{
return;
}
/**
* Generates the SQL UPDATE that updates all the foreign keys to null.
*
* @param PersistentCollection $coll
*/
protected function _getDeleteSql(PersistentCollection $coll)
protected function _getDeleteSQL(PersistentCollection $coll)
{
}
/**
* Gets the SQL parameters for the corresponding SQL statement to delete
* the given collection.
*
* @param PersistentCollection $coll
*/
protected function _getDeleteSqlParameters(PersistentCollection $coll)
protected function _getDeleteSQLParameters(PersistentCollection $coll)
{}
/**
* Gets the SQL parameters for the corresponding SQL statement to insert the given
* element of the given collection into the database.
@ -104,9 +104,9 @@ class OneToManyPersister extends AbstractCollectionPersister
* @param PersistentCollection $coll
* @param mixed $element
*/
protected function _getInsertRowSqlParameters(PersistentCollection $coll, $element)
protected function _getInsertRowSQLParameters(PersistentCollection $coll, $element)
{}
/**
* Gets the SQL parameters for the corresponding SQL statement to delete the given
* element from the given collection.
@ -114,6 +114,6 @@ class OneToManyPersister extends AbstractCollectionPersister
* @param PersistentCollection $coll
* @param mixed $element
*/
protected function _getDeleteRowSqlParameters(PersistentCollection $coll, $element)
protected function _getDeleteRowSQLParameters(PersistentCollection $coll, $element)
{}
}

6
lib/Doctrine/ORM/Proxy/ProxyFactory.php
View File

@ -164,7 +164,11 @@ class ProxyFactory
}
if ($method->isPublic() && ! $method->isFinal() && ! $method->isStatic()) {
$methods .= PHP_EOL . ' public function ' . $method->getName() . '(';
$methods .= PHP_EOL . ' public function ';
if ($method->returnsReference()) {
$methods .= '&';
}
$methods .= $method->getName() . '(';
$firstParam = true;
$parameterString = $argumentString = '';

62
lib/Doctrine/ORM/Query/Parser.php
View File

@ -267,11 +267,11 @@ class Parser
{
$AST = $this->getAST();
if ($customWalkers = $this->_query->getHint(Query::HINT_CUSTOM_TREE_WALKERS)) {
if (($customWalkers = $this->_query->getHint(Query::HINT_CUSTOM_TREE_WALKERS)) !== false) {
$this->_customTreeWalkers = $customWalkers;
}
if ($customOutputWalker = $this->_query->getHint(Query::HINT_CUSTOM_OUTPUT_WALKER)) {
if (($customOutputWalker = $this->_query->getHint(Query::HINT_CUSTOM_OUTPUT_WALKER)) !== false) {
$this->_customOutputWalker = $customOutputWalker;
}
@ -1786,6 +1786,12 @@ class Parser
$conditionalTerms[] = $this->ConditionalTerm();
}
// Phase 1 AST optimization: Prevent AST\ConditionalExpression
// if only one AST\ConditionalTerm is defined
if (count($conditionalTerms) == 1) {
return $conditionalTerms[0];
}
return new AST\ConditionalExpression($conditionalTerms);
}
@ -1804,6 +1810,12 @@ class Parser
$conditionalFactors[] = $this->ConditionalFactor();
}
// Phase 1 AST optimization: Prevent AST\ConditionalTerm
// if only one AST\ConditionalFactor is defined
if (count($conditionalFactors) == 1) {
return $conditionalFactors[0];
}
return new AST\ConditionalTerm($conditionalFactors);
}
@ -1820,11 +1832,19 @@ class Parser
$this->match(Lexer::T_NOT);
$not = true;
}
$conditionalPrimary = $this->ConditionalPrimary();
$condFactor = new AST\ConditionalFactor($this->ConditionalPrimary());
$condFactor->not = $not;
// Phase 1 AST optimization: Prevent AST\ConditionalFactor
// if only one AST\ConditionalPrimary is defined
if ( ! $not) {
return $conditionalPrimary;
}
return $condFactor;
$conditionalFactor = new AST\ConditionalFactor($conditionalPrimary);
$conditionalFactor->not = $not;
return $conditionalFactor;
}
/**
@ -2104,6 +2124,12 @@ class Parser
$terms[] = $this->ArithmeticTerm();
}
// Phase 1 AST optimization: Prevent AST\SimpleArithmeticExpression
// if only one AST\ArithmeticTerm is defined
if (count($terms) == 1) {
return $terms[0];
}
return new AST\SimpleArithmeticExpression($terms);
}
@ -2124,6 +2150,12 @@ class Parser
$factors[] = $this->ArithmeticFactor();
}
// Phase 1 AST optimization: Prevent AST\ArithmeticTerm
// if only one AST\ArithmeticFactor is defined
if (count($factors) == 1) {
return $factors[0];
}
return new AST\ArithmeticTerm($factors);
}
@ -2134,14 +2166,22 @@ class Parser
*/
public function ArithmeticFactor()
{
$sign = null;
$sign = null;
if (($isPlus = $this->_lexer->isNextToken(Lexer::T_PLUS)) || $this->_lexer->isNextToken(Lexer::T_MINUS)) {
$this->match(($isPlus) ? Lexer::T_PLUS : Lexer::T_MINUS);
$sign = $isPlus;
}
if (($isPlus = $this->_lexer->isNextToken(Lexer::T_PLUS)) || $this->_lexer->isNextToken(Lexer::T_MINUS)) {
$this->match(($isPlus) ? Lexer::T_PLUS : Lexer::T_MINUS);
$sign = $isPlus;
}
$primary = $this->ArithmeticPrimary();
return new AST\ArithmeticFactor($this->ArithmeticPrimary(), $sign);
// Phase 1 AST optimization: Prevent AST\ArithmeticFactor
// if only one AST\ArithmeticPrimary is defined
if ($sign === null) {
return $primary;
}
return new AST\ArithmeticFactor($primary, $sign);
}
/**

191
lib/Doctrine/ORM/Query/SqlWalker.php
View File

@ -684,9 +684,7 @@ class SqlWalker implements TreeWalker
*/
public function walkHavingClause($havingClause)
{
return ' HAVING ' . implode(
' OR ', array_map(array($this, 'walkConditionalTerm'), $havingClause->conditionalExpression->conditionalTerms)
);
return ' HAVING ' . $this->walkConditionalExpression($havingClause->conditionalExpression);
}
/**
@ -794,10 +792,10 @@ class SqlWalker implements TreeWalker
}
// Handle WITH clause
if ($join->conditionalExpression !== null) {
$sql .= ' AND (' . implode(' OR ',
array_map(array($this, 'walkConditionalTerm'), $join->conditionalExpression->conditionalTerms)
). ')';
if (($condExpr = $join->conditionalExpression) !== null) {
// Phase 2 AST optimization: Skip processment of ConditionalExpression
// if only one ConditionalTerm is defined
$sql .= ' AND (' . $this->walkConditionalExpression($condExpr) . ')';
}
$discrSql = $this->_generateDiscriminatorColumnConditionSQL($joinedDqlAlias);
@ -806,7 +804,7 @@ class SqlWalker implements TreeWalker
$sql .= ' AND ' . $discrSql;
}
//FIXME: these should either be nested or all forced to be left joins (DDC-XXX)
// FIXME: these should either be nested or all forced to be left joins (DDC-XXX)
if ($targetClass->isInheritanceTypeJoined()) {
$sql .= $this->_generateClassTableInheritanceJoins($targetClass, $joinedDqlAlias);
}
@ -898,7 +896,12 @@ class SqlWalker implements TreeWalker
$columnAlias = $this->_platform->getSQLResultCasing($columnAlias);
$this->_rsm->addScalarResult($columnAlias, $resultAlias);
}
else if ($expr instanceof AST\SimpleArithmeticExpression) {
else if (
$expr instanceof AST\SimpleArithmeticExpression ||
$expr instanceof AST\ArithmeticTerm ||
$expr instanceof AST\ArithmeticFactor ||
$expr instanceof AST\ArithmeticPrimary
) {
if ( ! $selectExpression->fieldIdentificationVariable) {
$resultAlias = $this->_scalarResultCounter++;
} else {
@ -1230,20 +1233,27 @@ class SqlWalker implements TreeWalker
*/
public function walkWhereClause($whereClause)
{
$sql = ' WHERE ';
$condExpr = $whereClause->conditionalExpression;
$discrSql = $this->_generateDiscriminatorColumnConditionSql($this->_currentRootAlias);
$condSql = $this->walkConditionalExpression($whereClause->conditionalExpression);
$sql .= implode(
' OR ', array_map(array($this, 'walkConditionalTerm'), $condExpr->conditionalTerms)
);
return ' WHERE ' . (( ! $discrSql) ? $condSql : '(' . $condSql . ') AND ' . $discrSql);
}
$discrSql = $this->_generateDiscriminatorColumnConditionSQL($this->_currentRootAlias);
if ($discrSql) {
$sql .= ' AND ' . $discrSql;
}
return $sql;
/**
* Walk down a ConditionalExpression AST node, thereby generating the appropriate SQL.
*
* @param ConditionalExpression
* @return string The SQL.
*/
public function walkConditionalExpression($condExpr)
{
// Phase 2 AST optimization: Skip processment of ConditionalExpression
// if only one ConditionalTerm is defined
return ( ! ($condExpr instanceof AST\ConditionalExpression))
? $this->walkConditionalTerm($condExpr)
: implode(
' OR ', array_map(array($this, 'walkConditionalTerm'), $condExpr->conditionalTerms)
);
}
/**
@ -1254,9 +1264,13 @@ class SqlWalker implements TreeWalker
*/
public function walkConditionalTerm($condTerm)
{
return implode(
' AND ', array_map(array($this, 'walkConditionalFactor'), $condTerm->conditionalFactors)
);
// Phase 2 AST optimization: Skip processment of ConditionalTerm
// if only one ConditionalFactor is defined
return ( ! ($condTerm instanceof AST\ConditionalTerm))
? $this->walkConditionalFactor($condTerm)
: implode(
' AND ', array_map(array($this, 'walkConditionalFactor'), $condTerm->conditionalFactors)
);
}
/**
@ -1267,21 +1281,28 @@ class SqlWalker implements TreeWalker
*/
public function walkConditionalFactor($factor)
{
$sql = ($factor->not) ? 'NOT ' : '';
$primary = $factor->conditionalPrimary;
// Phase 2 AST optimization: Skip processment of ConditionalFactor
// if only one ConditionalPrimary is defined
return ( ! ($factor instanceof AST\ConditionalFactor))
? $this->walkConditionalPrimary($factor)
: ($factor->not ? 'NOT ' : '') . $this->walkConditionalPrimary($factor->conditionalPrimary);
}
/**
* Walks down a ConditionalPrimary AST node, thereby generating the appropriate SQL.
*
* @param ConditionalPrimary
* @return string The SQL.
*/
public function walkConditionalPrimary($primary)
{
if ($primary->isSimpleConditionalExpression()) {
$sql .= $primary->simpleConditionalExpression->dispatch($this);
return $primary->simpleConditionalExpression->dispatch($this);
} else if ($primary->isConditionalExpression()) {
$condExpr = $primary->conditionalExpression;
$sql .= '(' . implode(
' OR ', array_map(array($this, 'walkConditionalTerm'), $condExpr->conditionalTerms)
) . ')';
return '(' . $this->walkConditionalExpression($condExpr) . ')';
}
return $sql;
}
/**
@ -1621,6 +1642,21 @@ class SqlWalker implements TreeWalker
: $this->walkSubselect($arithmeticExpr->subselect);
}
/**
* Walks down an SimpleArithmeticExpression AST node, thereby generating the appropriate SQL.
*
* @param SimpleArithmeticExpression
* @return string The SQL.
*/
public function walkSimpleArithmeticExpression($simpleArithmeticExpr)
{
return ( ! ($simpleArithmeticExpr instanceof AST\SimpleArithmeticExpression))
? $this->walkArithmeticTerm($simpleArithmeticExpr)
: implode(
' ', array_map(array($this, 'walkArithmeticTerm'), $simpleArithmeticExpr->arithmeticTerms)
);
}
/**
* Walks down an ArithmeticTerm AST node, thereby generating the appropriate SQL.
*
@ -1629,11 +1665,55 @@ class SqlWalker implements TreeWalker
*/
public function walkArithmeticTerm($term)
{
if (is_string($term)) return $term;
if (is_string($term)) {
return $term;
}
return implode(
' ', array_map(array($this, 'walkArithmeticFactor'), $term->arithmeticFactors)
);
// Phase 2 AST optimization: Skip processment of ArithmeticTerm
// if only one ArithmeticFactor is defined
return ( ! ($term instanceof AST\ArithmeticTerm))
? $this->walkArithmeticFactor($term)
: implode(
' ', array_map(array($this, 'walkArithmeticFactor'), $term->arithmeticFactors)
);
}
/**
* Walks down an ArithmeticFactor that represents an AST node, thereby generating the appropriate SQL.
*
* @param mixed
* @return string The SQL.
*/
public function walkArithmeticFactor($factor)
{
if (is_string($factor)) {
return $factor;
}
// Phase 2 AST optimization: Skip processment of ArithmeticFactor
// if only one ArithmeticPrimary is defined
return ( ! ($factor instanceof AST\ArithmeticFactor))
? $this->walkArithmeticPrimary($factor)
: ($factor->isNegativeSigned() ? '-' : ($factor->isPositiveSigned() ? '+' : ''))
. $this->walkArithmeticPrimary($factor->arithmeticPrimary);
}
/**
* Walks down an ArithmeticPrimary that represents an AST node, thereby generating the appropriate SQL.
*
* @param mixed
* @return string The SQL.
*/
public function walkArithmeticPrimary($primary)
{
if ($primary instanceof AST\SimpleArithmeticExpression) {
return '(' . $this->walkSimpleArithmeticExpression($primary) . ')';
} else if ($primary instanceof AST\Node) {
return $primary->dispatch($this);
}
// We need to deal with IdentificationVariable here
return '';
}
/**
@ -1648,41 +1728,4 @@ class SqlWalker implements TreeWalker
? $this->_conn->quote($stringPrimary)
: $stringPrimary->dispatch($this);
}
/**
* Walks down an ArithmeticFactor that represents an AST node, thereby generating the appropriate SQL.
*
* @param mixed
* @return string The SQL.
*/
public function walkArithmeticFactor($factor)
{
if (is_string($factor)) return $factor;
$sql = ($factor->isNegativeSigned() ? '-' : ($factor->isPositiveSigned() ? '+' : ''));
$primary = $factor->arithmeticPrimary;
if ($primary instanceof AST\SimpleArithmeticExpression) {
$sql .= '(' . $this->walkSimpleArithmeticExpression($primary) . ')';
} else if ($primary instanceof AST\Node) {
$sql .= $primary->dispatch($this);
} else if (is_string($primary)) {
// We need to deal with IdentificationVariable here
}
return $sql;
}
/**
* Walks down an SimpleArithmeticExpression AST node, thereby generating the appropriate SQL.
*
* @param SimpleArithmeticExpression
* @return string The SQL.
*/
public function walkSimpleArithmeticExpression($simpleArithmeticExpr)
{
return implode(
' ', array_map(array($this, 'walkArithmeticTerm'), $simpleArithmeticExpr->arithmeticTerms)
);
}
}

16
lib/Doctrine/ORM/Query/TreeWalker.php
View File

@ -218,6 +218,14 @@ interface TreeWalker
*/
function walkWhereClause($whereClause);
/**
* Walks down a ConditionalExpression AST node, thereby generating the appropriate SQL.
*
* @param ConditionalExpression
* @return string The SQL.
*/
function walkConditionalExpression($condExpr);
/**
* Walks down a ConditionalTerm AST node, thereby generating the appropriate SQL.
*
@ -234,6 +242,14 @@ interface TreeWalker
*/
function walkConditionalFactor($factor);
/**
* Walks down a ConditionalPrimary AST node, thereby generating the appropriate SQL.
*
* @param ConditionalPrimary
* @return string The SQL.
*/
function walkConditionalPrimary($primary);
/**
* Walks down an ExistsExpression AST node, thereby generating the appropriate SQL.
*

16
lib/Doctrine/ORM/Query/TreeWalkerAdapter.php
View File

@ -252,6 +252,14 @@ abstract class TreeWalkerAdapter implements TreeWalker
*/
public function walkWhereClause($whereClause) {}
/**
* Walks down a ConditionalExpression AST node, thereby generating the appropriate SQL.
*
* @param ConditionalExpression
* @return string The SQL.
*/
public function walkConditionalExpression($condExpr) {}
/**
* Walks down a ConditionalTerm AST node, thereby generating the appropriate SQL.
*
@ -268,6 +276,14 @@ abstract class TreeWalkerAdapter implements TreeWalker
*/
public function walkConditionalFactor($factor) {}
/**
* Walks down a ConditionalPrimary AST node, thereby generating the appropriate SQL.
*
* @param ConditionalPrimary
* @return string The SQL.
*/
public function walkConditionalPrimary($primary) {}
/**
* Walks down an ExistsExpression AST node, thereby generating the appropriate SQL.
*

26
lib/Doctrine/ORM/Query/TreeWalkerChain.php
View File

@ -355,6 +355,19 @@ class TreeWalkerChain implements TreeWalker
}
}
/**
* Walks down a ConditionalExpression AST node, thereby generating the appropriate SQL.
*
* @param ConditionalExpression
* @return string The SQL.
*/
public function walkConditionalExpression($condExpr)
{
foreach ($this->_walkers as $walker) {
$walker->walkConditionalExpression($condExpr);
}
}
/**
* Walks down a ConditionalTerm AST node, thereby generating the appropriate SQL.
*
@ -381,6 +394,19 @@ class TreeWalkerChain implements TreeWalker
}
}
/**
* Walks down a ConditionalPrimary AST node, thereby generating the appropriate SQL.
*
* @param ConditionalPrimary
* @return string The SQL.
*/
public function walkConditionalPrimary($condPrimary)
{
foreach ($this->_walkers as $walker) {
$walker->walkConditionalPrimary($condPrimary);
}
}
/**
* Walks down an ExistsExpression AST node, thereby generating the appropriate SQL.
*

298
lib/Doctrine/ORM/QueryBuilder.php
View File

@ -1,7 +1,5 @@
<?php
/*
* $Id$
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
@ -27,30 +25,29 @@ use Doctrine\ORM\Query\Expr;
* This class is responsible for building DQL query strings via an object oriented
* PHP interface.
*
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @link www.doctrine-project.org
* @since 2.0
* @version $Revision$
* @author Guilherme Blanco <guilhermeblanco@hotmail.com>
* @author Jonathan Wage <jonwage@gmail.com>
* @author Roman Borschel <roman@code-factory.org>
* @since 2.0
* @author Guilherme Blanco <guilhermeblanco@hotmail.com>
* @author Jonathan Wage <jonwage@gmail.com>
* @author Roman Borschel <roman@code-factory.org>
*/
class QueryBuilder
{
/* The query types. */
const SELECT = 0;
const DELETE = 1;
const UPDATE = 2;
/** The builder states. */
const STATE_DIRTY = 0;
const STATE_CLEAN = 1;
/**
* @var EntityManager $em The EntityManager used by this QueryBuilder.
* @var EntityManager The EntityManager used by this QueryBuilder.
*/
private $_em;
/**
* @var array $dqlParts The array of DQL parts collected.
* @var array The array of DQL parts collected.
*/
private $_dqlParts = array(
'select' => array(),
@ -105,13 +102,17 @@ class QueryBuilder
/**
* Gets an ExpressionBuilder used for object-oriented construction of query expressions.
* Intended for convenient inline usage. Example:
* This producer method is intended for convenient inline usage. Example:
*
* [php]
* <code>
* $qb = $em->createQueryBuilder()
* ->select('u')
* ->from('User', 'u')
* ->where($qb->expr()->eq('u.id', 1));
* </code>
*
* For more complex expression construction, consider storing the expression
* builder object in a local variable.
*
* @return Expr
*/
@ -141,16 +142,9 @@ class QueryBuilder
}
/**
* Get the state of this query builder instance
* Get the state of this query builder instance.
*
* [php]
* if ($qb->getState() == QueryBuilder::STATE_DIRTY) {
* echo 'Query builder is dirty';
* } else {
* echo 'Query builder is clean';
* }
*
* @return integer
* @return integer Either QueryBuilder::STATE_DIRTY or QueryBuilder::STATE_CLEAN.
*/
public function getState()
{
@ -158,15 +152,16 @@ class QueryBuilder
}
/**
* Get the complete DQL string for this query builder instance
* Get the complete DQL string formed by the current specifications of this QueryBuilder.
*
* [php]
* <code>
* $qb = $em->createQueryBuilder()
* ->select('u')
* ->from('User', 'u')
* echo $qb->getDql(); // SELECT u FROM User u
* </code>
*
* @return string The DQL string
* @return string The DQL query string.
*/
public function getDQL()
{
@ -198,14 +193,15 @@ class QueryBuilder
}
/**
* Constructs a Query instance from the current configuration of the builder.
* Constructs a Query instance from the current specifications of the builder.
*
* [php]
* <code>
* $qb = $em->createQueryBuilder()
* ->select('u')
* ->from('User', 'u');
* $q = $qb->getQuery();
* $results = $q->execute();
* </code>
*
* @return Query
*/
@ -218,17 +214,19 @@ class QueryBuilder
}
/**
* Get the root alias for the query. This is the first entity alias involved
* in the construction of the query
* Gets the root alias of the query. This is the first entity alias involved
* in the construction of the query.
*
* [php]
* <code>
* $qb = $em->createQueryBuilder()
* ->select('u')
* ->from('User', 'u');
*
* echo $qb->getRootAlias(); // u
* </code>
*
* @return string $rootAlias
* @todo Rename/Refactor: getRootAliases(), there can be multiple roots!
*/
public function getRootAlias()
{
@ -236,14 +234,15 @@ class QueryBuilder
}
/**
* Sets a query parameter.
* Sets a query parameter for the query being constructed.
*
* [php]
* <code>
* $qb = $em->createQueryBuilder()
* ->select('u')
* ->from('User', 'u')
* ->where('u.id = :user_id')
* ->setParameter(':user_id', 1);
* </code>
*
* @param string|integer $key The parameter position or name.
* @param mixed $value The parameter value.
@ -256,9 +255,9 @@ class QueryBuilder
}
/**
* Sets a collection of query parameters.
* Sets a collection of query parameters for the query being constructed.
*
* [php]
* <code>
* $qb = $em->createQueryBuilder()
* ->select('u')
* ->from('User', 'u')
@ -267,8 +266,9 @@ class QueryBuilder
* ':user_id1' => 1,
* ':user_id2' => 2
* ));
* </code>
*
* @param array $params
* @param array $params The query parameters to set.
* @return QueryBuilder This QueryBuilder instance.
*/
public function setParameters(array $params)
@ -278,17 +278,17 @@ class QueryBuilder
}
/**
* Get all defined parameters
* Gets all defined query parameters for the query being constructed.
*
* @return array Defined parameters
* @return array The currently defined query parameters.
*/
public function getParameters($params = array())
public function getParameters()
{
return $this->_params;
}
/**
* Gets a query parameter.
* Gets a (previously set) query parameter of the query being constructed.
*
* @param mixed $key The key (index or name) of the bound parameter.
* @return mixed The value of the bound parameter.
@ -297,7 +297,7 @@ class QueryBuilder
{
return isset($this->_params[$key]) ? $this->_params[$key] : null;
}
/**
* Sets the position of the first result to retrieve (the "offset").
*
@ -309,10 +309,10 @@ class QueryBuilder
$this->_firstResult = $firstResult;
return $this;
}
/**
* Gets the position of the first result the query object was set to retrieve (the "offset").
* Returns NULL if {@link setFirstResult} was not applied to this query builder.
* Returns NULL if {@link setFirstResult} was not applied to this QueryBuilder.
*
* @return integer The position of the first result.
*/
@ -324,7 +324,7 @@ class QueryBuilder
/**
* Sets the maximum number of results to retrieve (the "limit").
*
* @param integer $maxResults
* @param integer $maxResults The maximum number of results to retrieve.
* @return QueryBuilder This QueryBuilder instance.
*/
public function setMaxResults($maxResults)
@ -345,7 +345,10 @@ class QueryBuilder
}
/**
* Add a single DQL query part to the array of parts
* Either appends to or replaces a single, generic query part.
*
* The available parts are: 'select', 'from', 'join', 'set', 'where',
* 'groupBy', 'having' and 'orderBy'.
*
* @param string $dqlPartName
* @param string $dqlPart
@ -368,15 +371,17 @@ class QueryBuilder
}
/**
* Set the SELECT statement
* Specifies an item that is to be returned in the query result.
* Replaces any previously specified selections, if any.
*
* [php]
* <code>
* $qb = $em->createQueryBuilder()
* ->select('u', 'p')
* ->from('User', 'u')
* ->leftJoin('u.Phonenumbers', 'p');
* </code>
*
* @param mixed $select String SELECT statement or SELECT Expr instance
* @param mixed $select The selection expressions.
* @return QueryBuilder This QueryBuilder instance.
*/
public function select($select = null)
@ -393,16 +398,17 @@ class QueryBuilder
}
/**
* Add to the SELECT statement
* Adds an item that is to be returned in the query result.
*
* [php]
* <code>
* $qb = $em->createQueryBuilder()
* ->select('u')
* ->addSelect('p')
* ->from('User', 'u')
* ->leftJoin('u.Phonenumbers', 'p');
* </code>
*
* @param mixed $select String SELECT statement or SELECT Expr instance
* @param mixed $select The selection expression.
* @return QueryBuilder This QueryBuilder instance.
*/
public function addSelect($select = null)
@ -419,16 +425,18 @@ class QueryBuilder
}
/**
* Construct a DQL DELETE query
* Turns the query being built into a bulk delete query that ranges over
* a certain entity type.
*
* [php]
* <code>
* $qb = $em->createQueryBuilder()
* ->delete('User', 'u')
* ->where('u.id = :user_id');
* ->setParameter(':user_id', 1);
* </code>
*
* @param string $delete The model to delete
* @param string $alias The alias of the model
* @param string $delete The class/type whose instances are subject to the deletion.
* @param string $alias The class/type alias used in the constructed query.
* @return QueryBuilder This QueryBuilder instance.
*/
public function delete($delete = null, $alias = null)
@ -443,16 +451,18 @@ class QueryBuilder
}
/**
* Construct a DQL UPDATE query
* Turns the query being built into a bulk update query that ranges over
* a certain entity type.
*
* [php]
* <code>
* $qb = $em->createQueryBuilder()
* ->update('User', 'u')
* ->set('u.password', md5('password'))
* ->where('u.id = ?');
* </code>
*
* @param string $update The model to update
* @param string $alias The alias of the model
* @param string $update The class/type whose instances are subject to the update.
* @param string $alias The class/type alias used in the constructed query.
* @return QueryBuilder This QueryBuilder instance.
*/
public function update($update = null, $alias = null)
@ -467,12 +477,14 @@ class QueryBuilder
}
/**
* Specify the FROM part when constructing a SELECT DQL query
* Create and add a query root corresponding to the entity identified by the given alias,
* forming a cartesian product with any existing query roots.
*
* [php]
* <code>
* $qb = $em->createQueryBuilder()
* ->select('u')
* ->from('User', 'u')
* </code>
*
* @param string $from The class name.
* @param string $alias The alias of the class.
@ -482,20 +494,25 @@ class QueryBuilder
{
return $this->add('from', new Expr\From($from, $alias), true);
}
/**
* Add a INNER JOIN to an associated class.
* Creates and adds a join over an entity association to the query.
*
* [php]
* The entities in the joined association will be fetched as part of the query
* result if the alias used for the joined association is placed in the select
* expressions.
*
* <code>
* $qb = $em->createQueryBuilder()
* ->select('u')
* ->from('User', 'u')
* ->innerJoin('u.Phonenumbers', 'p', Expr\Join::WITH, 'p.is_primary = 1');
* ->join('u.Phonenumbers', 'p', Expr\Join::WITH, 'p.is_primary = 1');
* </code>
*
* @param string $join The relationship to join
* @param string $alias The alias of the join
* @param string $conditionType The condition type constant. Either ON or WITH.
* @param string $condition The condition for the join
* @param string $join The relationship to join
* @param string $alias The alias of the join
* @param string $conditionType The condition type constant. Either ON or WITH.
* @param string $condition The condition for the join
* @return QueryBuilder This QueryBuilder instance.
*/
public function join($join, $alias, $conditionType = null, $condition = null)
@ -504,7 +521,11 @@ class QueryBuilder
}
/**
* Add an INNER JOIN to an associated class.
* Creates and adds a join over an entity association to the query.
*
* The entities in the joined association will be fetched as part of the query
* result if the alias used for the joined association is placed in the select
* expressions.
*
* [php]
* $qb = $em->createQueryBuilder()
@ -512,10 +533,10 @@ class QueryBuilder
* ->from('User', 'u')
* ->innerJoin('u.Phonenumbers', 'p', Expr\Join::WITH, 'p.is_primary = 1');
*
* @param string $join The relationship to join
* @param string $alias The alias of the join
* @param string $conditionType The condition type constant. Either ON or WITH.
* @param string $condition The condition for the join
* @param string $join The relationship to join
* @param string $alias The alias of the join
* @param string $conditionType The condition type constant. Either ON or WITH.
* @param string $condition The condition for the join
* @return QueryBuilder This QueryBuilder instance.
*/
public function innerJoin($join, $alias, $conditionType = null, $condition = null)
@ -526,19 +547,24 @@ class QueryBuilder
}
/**
* Add a LEFT JOIN
* Creates and adds a left join over an entity association to the query.
*
* [php]
* The entities in the joined association will be fetched as part of the query
* result if the alias used for the joined association is placed in the select
* expressions.
*
* <code>
* $qb = $em->createQueryBuilder()
* ->select('u')
* ->from('User', 'u')
* ->leftJoin('u.Phonenumbers', 'p', Expr\Join::WITH, 'p.is_primary = 1');
* </code>
*
* @param string $join The relationship to join
* @param string $alias The alias of the join
* @param string $conditionType The condition type constant. Either ON or WITH.
* @param string $condition The condition for the join
* @return QueryBuilder $qb
* @param string $join The relationship to join
* @param string $alias The alias of the join
* @param string $conditionType The condition type constant. Either ON or WITH.
* @param string $condition The condition for the join
* @return QueryBuilder This QueryBuilder instance.
*/
public function leftJoin($join, $alias, $conditionType = null, $condition = null)
{
@ -548,17 +574,18 @@ class QueryBuilder
}
/**
* Add a SET statement for a DQL UPDATE query
* Sets a new value for a field in a bulk update query.
*
* [php]
* <code>
* $qb = $em->createQueryBuilder()
* ->update('User', 'u')
* ->set('u.password', md5('password'))
* ->where('u.id = ?');
* </code>
*
* @param string $key The key/field to set
* @param string $value The value, expression, placeholder, etc. to use in the SET
* @return QueryBuilder $qb
* @param string $key The key/field to set.
* @param string $value The value, expression, placeholder, etc.
* @return QueryBuilder This QueryBuilder instance.
*/
public function set($key, $value)
{
@ -566,9 +593,10 @@ class QueryBuilder
}
/**
* Set and override any existing WHERE statements
* Specifies one or more restrictions to the query result.
* Replaces any previously specified restrictions, if any.
*
* [php]
* <code>
* $qb = $em->createQueryBuilder()
* ->select('u')
* ->from('User', 'u')
@ -584,9 +612,10 @@ class QueryBuilder
* $qb->update('User', 'u')
* ->set('u.password', md5('password'))
* ->where($or);
* </code>
*
* @param mixed $predicates The predicates.
* @return QueryBuilder
* @param mixed $predicates The restriction predicates.
* @return QueryBuilder This QueryBuilder instance.
*/
public function where($predicates)
{
@ -598,17 +627,19 @@ class QueryBuilder
}
/**
* Add a new WHERE statement with an AND
* Adds one or more restrictions to the query results, forming a logical
* conjunction with any previously specified restrictions.
*
* [php]
* <code>
* $qb = $em->createQueryBuilder()
* ->select('u')
* ->from('User', 'u')
* ->where('u.username LIKE ?')
* ->andWhere('u.is_active = 1');
* </code>
*
* @param mixed $where The WHERE statement
* @return QueryBuilder $qb
* @param mixed $where The query restrictions.
* @return QueryBuilder This QueryBuilder instance.
* @see where()
*/
public function andWhere($where)
@ -627,14 +658,16 @@ class QueryBuilder
}
/**
* Add a new WHERE statement with an OR
* Adds one or more restrictions to the query results, forming a logical
* disjunction with any previously specified restrictions.
*
* [php]
* <code>
* $qb = $em->createQueryBuilder()
* ->select('u')
* ->from('User', 'u')
* ->where('u.id = 1')
* ->orWhere('u.id = 2');
* </code>
*
* @param mixed $where The WHERE statement
* @return QueryBuilder $qb
@ -656,16 +689,18 @@ class QueryBuilder
}
/**
* Set the GROUP BY clause
* Specifies a grouping over the results of the query.
* Replaces any previously specified groupings, if any.
*
* [php]
* <code>
* $qb = $em->createQueryBuilder()
* ->select('u')
* ->from('User', 'u')
* ->groupBy('u.id');
* </code>
*
* @param string $groupBy The GROUP BY clause
* @return QueryBuilder $qb
* @param string $groupBy The grouping expression.
* @return QueryBuilder This QueryBuilder instance.
*/
public function groupBy($groupBy)
{
@ -674,17 +709,18 @@ class QueryBuilder
/**
* Add to the existing GROUP BY clause
* Adds a grouping expression to the query.
*
* [php]
* <code>
* $qb = $em->createQueryBuilder()
* ->select('u')
* ->from('User', 'u')
* ->groupBy('u.last_login');
* ->addGroupBy('u.created_at')
* ->groupBy('u.lastLogin');
* ->addGroupBy('u.createdAt')
* </code>
*
* @param string $groupBy The GROUP BY clause
* @return QueryBuilder $qb
* @param string $groupBy The grouping expression.
* @return QueryBuilder This QueryBuilder instance.
*/
public function addGroupBy($groupBy)
{
@ -692,10 +728,11 @@ class QueryBuilder
}
/**
* Set the HAVING clause
* Specifies a restriction over the groups of the query.
* Replaces any previous having restrictions, if any.
*
* @param mixed $having
* @return QueryBuilder $qb
* @param mixed $having The restriction over the groups.
* @return QueryBuilder This QueryBuilder instance.
*/
public function having($having)
{
@ -707,10 +744,11 @@ class QueryBuilder
}
/**
* Add to the existing HAVING clause with an AND
* Adds a restriction over the groups of the query, forming a logical
* conjunction with any existing having restrictions.
*
* @param mixed $having
* @return QueryBuilder $qb
* @param mixed $having The restriction to append.
* @return QueryBuilder This QueryBuilder instance.
*/
public function andHaving($having)
{
@ -728,10 +766,11 @@ class QueryBuilder
}
/**
* Add to the existing HAVING clause with an OR
* Adds a restriction over the groups of the query, forming a logical
* disjunction with any existing having restrictions.
*
* @param mixed $having
* @return QueryBuilder $qb
* @param mixed $having The restriction to add.
* @return QueryBuilder This QueryBuilder instance.
*/
public function orHaving($having)
{
@ -749,11 +788,12 @@ class QueryBuilder
}
/**
* Set the ORDER BY clause
* Specifies an ordering for the query results.
* Replaces any previously specified orderings, if any.
*
* @param string $sort What to sort on
* @param string $order Optional: The order to sort the results.
* @return QueryBuilder $qb
* @param string $sort The ordering expression.
* @param string $order The ordering direction.
* @return QueryBuilder This QueryBuilder instance.
*/
public function orderBy($sort, $order = null)
{
@ -762,11 +802,11 @@ class QueryBuilder
}
/**
* Add to the existing ORDER BY clause
* Adds an ordering to the query results.
*
* @param string $sort What to sort on
* @param string $order Optional: The order to sort the results.
* @return QueryBuilder $qb
* @param string $sort The ordering expression.
* @param string $order The ordering direction.
* @return QueryBuilder This QueryBuilder instance.
*/
public function addOrderBy($sort, $order = null)
{
@ -774,10 +814,11 @@ class QueryBuilder
}
/**
* Get a DQL part or parts by the part name
* Get a query part by its name.
*
* @param string $queryPartName
* @return mixed $queryPart
* @todo Rename: getQueryPart (or remove?)
*/
public function getDQLPart($queryPartName)
{
@ -785,9 +826,10 @@ class QueryBuilder
}
/**
* Get the full DQL parts array
* Get all query parts.
*
* @return array $dqlParts
* @todo Rename: getQueryParts (or remove?)
*/
public function getDQLParts()
{
@ -836,6 +878,12 @@ class QueryBuilder
. (isset($options['post']) ? $options['post'] : '');
}
/**
* Gets a string representation of this QueryBuilder which corresponds to
* the final DQL query being constructed.
*
* @return string The string representation of this QueryBuilder.
*/
public function __toString()
{
return $this->getDQL();

2
lib/Doctrine/ORM/Tools/Console/Command/ConvertDoctrine1SchemaCommand.php
View File

@ -136,7 +136,7 @@ EOT
$converter = new ConvertDoctrine1Schema($fromPaths);
$metadata = $converter->getMetadata();
if ($metadatas) {
if ($metadata) {
$output->write(PHP_EOL);
foreach ($metadata as $class) {

51
lib/Doctrine/ORM/Tools/Console/Command/ValidateSchemaCommand.php
View File

@ -44,35 +44,46 @@ class ValidateSchemaCommand extends Console\Command\Command
*/
protected function configure()
{
$this->setName('orm:validate-schema')
->setDescription('Validate that the current metadata schema is valid.');
$this
->setName('orm:validate-schema')
->setDescription('Validate that the mapping files.')
->setHelp(<<<EOT
'Validate that the mapping files are correct and in sync with the database.'
EOT
);
}
/**
* @param InputInterface $input
* @param OutputInterface $output
* @see Console\Command\Command
*/
protected function execute(Console\Input\InputInterface $input, Console\Output\OutputInterface $output)
{
$emHelper = $this->getHelper('em');
$em = $this->getHelper('em')->getEntityManager();
/* @var $em \Doctrine\ORM\EntityManager */
$em = $emHelper->getEntityManager();
$validator = new \Doctrine\ORM\Tools\SchemaValidator($em);
$errors = $validator->validateMapping();
$metadatas = $em->getMetadataFactory()->getAllMetadata();
if ( ! empty($metadatas)) {
// Create SchemaTool
$tool = new \Doctrine\ORM\Tools\SchemaTool($em);
$updateSql = $tool->getUpdateSchemaSql($metadatas, false);
if (count($updateSql) == 0) {
$output->write("[Database] OK - Metadata schema exactly matches the database schema.");
} else {
$output->write("[Database] FAIL - There are differences between metadata and database schema.");
$exit = 0;
if ($errors) {
foreach ($errors AS $className => $errorMessages) {
$output->write("<error>[Mapping] FAIL - The entity-class '" . $className . "' mapping is invalid:</error>\n");
foreach ($errorMessages AS $errorMessage) {
$output->write('* ' . $errorMessage . "\n");
}
$output->write("\n");
}
$exit += 1;
} else {
$output->write("No metadata mappings found");
$output->write('<info>[Mapping] OK - The mapping files are correct.</info>' . "\n");
}
if (!$validator->schemaInSyncWithMetadata()) {
$output->write('<error>[Database] FAIL - The database schema is not in sync with the current mapping file.</error>' . "\n");
$exit += 2;
} else {
$output->write('<info>[Database] OK - The database schema is in sync with the mapping files.</info>' . "\n");
}
exit($exit);
}
}

203
lib/Doctrine/ORM/Tools/SchemaValidator.php Normal file
View File

@ -0,0 +1,203 @@
<?php
/*
* $Id$
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* This software consists of voluntary contributions made by many individuals
* and is licensed under the LGPL. For more information, see
* <http://www.doctrine-project.org>.
*/
namespace Doctrine\ORM\Tools;
use Doctrine\ORM\EntityManager;
use Doctrine\ORM\Mapping\ManyToManyMapping;
use Doctrine\ORM\Mapping\OneToOneMapping;
/**
* Performs strict validation of the mapping schema
*
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @link www.doctrine-project.com
* @since 1.0
* @version $Revision$
* @author Benjamin Eberlei <kontakt@beberlei.de>
* @author Guilherme Blanco <guilhermeblanco@hotmail.com>
* @author Jonathan Wage <jonwage@gmail.com>
* @author Roman Borschel <roman@code-factory.org>
*/
class SchemaValidator
{
/**
* @var EntityManager
*/
private $em;
/**
* @param EntityManager $em
*/
public function __construct(EntityManager $em)
{
$this->em = $em;
}
/**
* Checks the internal consistency of mapping files.
*
* There are several checks that can't be done at runtime or are to expensive, which can be verified
* with this command. For example:
*
* 1. Check if a relation with "mappedBy" is actually connected to that specified field.
* 2. Check if "mappedBy" and "inversedBy" are consistent to each other.
* 3. Check if "referencedColumnName" attributes are really pointing to primary key columns.
*
* @return array
*/
public function validateMapping()
{
$errors = array();
$cmf = $this->em->getMetadataFactory();
$classes = $cmf->getAllMetadata();
foreach ($classes AS $class) {
/* @var $class ClassMetadata */
foreach ($class->associationMappings AS $fieldName => $assoc) {
$ce = array();
if (!$cmf->hasMetadataFor($assoc->targetEntityName)) {
$ce[] = "The target entity '" . $assoc->targetEntityName . "' specified on " . $class->name . '#' . $fieldName . ' is unknown.';
}
if ($assoc->mappedBy && $assoc->inversedBy) {
$ce[] = "The association " . $class . "#" . $fieldName . " cannot be defined as both inverse and owning.";
}
$targetMetadata = $cmf->getMetadataFor($assoc->targetEntityName);
/* @var $assoc AssociationMapping */
if ($assoc->mappedBy) {
if ($targetMetadata->hasField($assoc->mappedBy)) {
$ce[] = "The association " . $class->name . "#" . $fieldName . " refers to the owning side ".
"field " . $assoc->targetEntityName . "#" . $assoc->mappedBy . " which is not defined as association.";
}
if (!$targetMetadata->hasAssociation($assoc->mappedBy)) {
$ce[] = "The association " . $class->name . "#" . $fieldName . " refers to the owning side ".
"field " . $assoc->targetEntityName . "#" . $assoc->mappedBy . " which does not exist.";
}
if ($targetMetadata->associationMappings[$assoc->mappedBy]->inversedBy == null) {
$ce[] = "The field " . $class->name . "#" . $fieldName . " is on the inverse side of a ".
"bi-directional relationship, but the specified mappedBy association on the target-entity ".
$assoc->targetEntityName . "#" . $assoc->mappedBy . " does not contain the required ".
"'inversedBy' attribute.";
} else if ($targetMetadata->associationMappings[$assoc->mappedBy]->inversedBy != $fieldName) {
$ce[] = "The mappings " . $class->name . "#" . $fieldName . " and " .
$assoc->targetEntityName . "#" . $assoc->mappedBy . " are ".
"incosistent with each other.";
}
}
if ($assoc->inversedBy) {
if ($targetMetadata->hasField($assoc->inversedBy)) {
$ce[] = "The association " . $class->name . "#" . $fieldName . " refers to the inverse side ".
"field " . $assoc->targetEntityName . "#" . $assoc->inversedBy . " which is not defined as association.";
}
if (!$targetMetadata->hasAssociation($assoc->inversedBy)) {
$ce[] = "The association " . $class->name . "#" . $fieldName . " refers to the inverse side ".
"field " . $assoc->targetEntityName . "#" . $assoc->inversedBy . " which does not exist.";
}
if (isset($targetMetadata->associationMappings[$assoc->mappedBy]) &&
$targetMetadata->associationMappings[$assoc->mappedBy]->mappedBy == null) {
$ce[] = "The field " . $class->name . "#" . $fieldName . " is on the inverse side of a ".
"bi-directional relationship, but the specified mappedBy association on the target-entity ".
$assoc->targetEntityName . "#" . $assoc->mappedBy . " does not contain the required ".
"'inversedBy' attribute.";
} else if ($targetMetadata->associationMappings[$assoc->inversedBy]->mappedBy != $fieldName) {
$ce[] = "The mappings " . $class->name . "#" . $fieldName . " and " .
$assoc->targetEntityName . "#" . $assoc->inversedBy . " are ".
"incosistent with each other.";
}
}
if ($assoc->isOwningSide) {
if ($assoc instanceof ManyToManyMapping) {
foreach ($assoc->joinTable['joinColumns'] AS $joinColumn) {
if (!isset($class->fieldNames[$joinColumn['referencedColumnName']])) {
$ce[] = "The referenced column name '" . $joinColumn['referencedColumnName'] . "' does not " .
"have a corresponding field with this column name on the class '" . $class->name . "'.";
break;
}
$fieldName = $class->fieldNames[$joinColumn['referencedColumnName']];
if (!in_array($fieldName, $class->identifier)) {
$ce[] = "The referenced column name '" . $joinColumn['referencedColumnName'] . "' " .
"has to be a primary key column.";
}
}
foreach ($assoc->joinTable['inverseJoinColumns'] AS $inverseJoinColumn) {
$targetClass = $cmf->getMetadataFor($assoc->targetEntityName);
if (!isset($targetClass->fieldNames[$inverseJoinColumn['referencedColumnName']])) {
$ce[] = "The inverse referenced column name '" . $inverseJoinColumn['referencedColumnName'] . "' does not " .
"have a corresponding field with this column name on the class '" . $targetClass->name . "'.";
break;
}
$fieldName = $targetClass->fieldNames[$inverseJoinColumn['referencedColumnName']];
if (!in_array($fieldName, $targetClass->identifier)) {
$ce[] = "The referenced column name '" . $inverseJoinColumn['referencedColumnName'] . "' " .
"has to be a primary key column.";
}
}
} else if ($assoc instanceof OneToOneMapping) {
foreach ($assoc->joinColumns AS $joinColumn) {
$targetClass = $cmf->getMetadataFor($assoc->targetEntityName);
if (!isset($targetClass->fieldNames[$joinColumn['referencedColumnName']])) {
$ce[] = "The referenced column name '" . $joinColumn['referencedColumnName'] . "' does not " .
"have a corresponding field with this column name on the class '" . $targetClass->name . "'.";
break;
}
$fieldName = $targetClass->fieldNames[$joinColumn['referencedColumnName']];
if (!in_array($fieldName, $targetClass->identifier)) {
$ce[] = "The referenced column name '" . $joinColumn['referencedColumnName'] . "' " .
"has to be a primary key column.";
}
}
}
} else {
}
if ($ce) {
$errors[$class->name] = $ce;
}
}
}
return $errors;
}
/**
* Check if the Database Schema is in sync with the current metadata state.
*
* @return bool
*/
public function schemaInSyncWithMetadata()
{
$schemaTool = new SchemaTool($this->em);
$allMetadata = $this->em->getMetadataFactory()->getAllMetadata();
return (count($schemaTool->getUpdateSchemaSql($allMetadata, false)) == 0);
}
}

30
lib/Doctrine/ORM/UnitOfWork.php
View File

@ -19,7 +19,8 @@
namespace Doctrine\ORM;
use Doctrine\Common\Collections\ArrayCollection,
use Exception,
Doctrine\Common\Collections\ArrayCollection,
Doctrine\Common\Collections\Collection,
Doctrine\Common\NotifyPropertyChanged,
Doctrine\Common\PropertyChangedListener,
@ -280,13 +281,13 @@ class UnitOfWork implements PropertyChangedListener
$conn = $this->_em->getConnection();
$conn->beginTransaction();
try {
try {
if ($this->_entityInsertions) {
foreach ($commitOrder as $class) {
$this->_executeInserts($class);
}
}
if ($this->_entityUpdates) {
foreach ($commitOrder as $class) {
$this->_executeUpdates($class);
@ -317,10 +318,9 @@ class UnitOfWork implements PropertyChangedListener
}
$conn->commit();
} catch (\Exception $e) {
$conn->setRollbackOnly();
$conn->rollback();
} catch (Exception $e) {
$this->_em->close();
$conn->rollback();
throw $e;
}
@ -485,7 +485,7 @@ class UnitOfWork implements PropertyChangedListener
}
}
}
// Look for changes in associations of the entity
foreach ($class->associationMappings as $assoc) {
$val = $class->reflFields[$assoc->sourceFieldName]->getValue($entity);
@ -1288,6 +1288,10 @@ class UnitOfWork implements PropertyChangedListener
*
* @param object $entity
* @return object The managed copy of the entity.
* @throws OptimisticLockException If the entity uses optimistic locking through a version
* attribute and the version check against the managed copy fails.
*
* @todo Require active transaction!? OptimisticLockException may result in undefined state!?
*/
public function merge($entity)
{
@ -1314,7 +1318,7 @@ class UnitOfWork implements PropertyChangedListener
throw new \InvalidArgumentException('New entity detected during merge.'
. ' Persist the new entity before merging.');
}
// MANAGED entities are ignored by the merge operation
if ($this->getEntityState($entity, self::STATE_DETACHED) == self::STATE_MANAGED) {
$managedCopy = $entity;
@ -1476,7 +1480,7 @@ class UnitOfWork implements PropertyChangedListener
$class = $this->_em->getClassMetadata(get_class($entity));
if ($this->getEntityState($entity) == self::STATE_MANAGED) {
$this->getEntityPersister($class->name)->refresh(
array_combine($class->getIdentifierColumnNames(), $this->_entityIdentifiers[$oid]),
array_combine($class->getIdentifierFieldNames(), $this->_entityIdentifiers[$oid]),
$entity
);
} else {
@ -2084,9 +2088,15 @@ class UnitOfWork implements PropertyChangedListener
$oid = spl_object_hash($entity);
$class = $this->_em->getClassMetadata(get_class($entity));
$isAssocField = isset($class->associationMappings[$propertyName]);
if ( ! $isAssocField && ! isset($class->fieldMappings[$propertyName])) {
return; // ignore non-persistent fields
}
$this->_entityChangeSets[$oid][$propertyName] = array($oldValue, $newValue);
if (isset($class->associationMappings[$propertyName])) {
if ($isAssocField) {
$assoc = $class->associationMappings[$propertyName];
if ($assoc->isOneToOne() && $assoc->isOwningSide) {
$this->_entityUpdates[$oid] = $entity;

338
lib/api/allitems-frame.html
View File

@ -1,338 +0,0 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang="en">
<head>
<meta name="generator" content="PHPDoctor 2RC4 (http://phpdoctor.sourceforge.net/)">
<meta name="when" content="Wed, 14 Apr 2010 15:12:03 +0000">
<link rel="stylesheet" type="text/css" href="stylesheet.css">
<link rel="start" href="overview-summary.html">
<title>All Items (Doctrine)</title>
</head>
<body id="frame">
<h1>All Items</h1>
<h2>Classes</h2>
<ul>
<li><a href="doctrine/common/classloader.html" target="main">ClassLoader</a></li>
<li><a href="doctrine/common/commonexception.html" target="main">CommonException</a></li>
<li><a href="doctrine/common/eventargs.html" target="main">EventArgs</a></li>
<li><a href="doctrine/common/eventmanager.html" target="main">EventManager</a></li>
<li><em><a href="doctrine/common/eventsubscriber.html" target="main">EventSubscriber</a></em></li>
<li><a href="doctrine/common/lexer.html" target="main">Lexer</a></li>
<li><em><a href="doctrine/common/notifypropertychanged.html" target="main">NotifyPropertyChanged</a></em></li>
<li><em><a href="doctrine/common/propertychangedlistener.html" target="main">PropertyChangedListener</a></em></li>
<li><a href="doctrine/common/version.html" target="main">Version</a></li>
<li><a href="doctrine/common/annotations/annotation.html" target="main">Annotation</a></li>
<li><a href="doctrine/common/annotations/annotationexception.html" target="main">AnnotationException</a></li>
<li><a href="doctrine/common/annotations/annotationreader.html" target="main">AnnotationReader</a></li>
<li><a href="doctrine/common/annotations/lexer.html" target="main">Lexer</a></li>
<li><a href="doctrine/common/annotations/parser.html" target="main">Parser</a></li>
<li><a href="doctrine/common/cache/abstractcache.html" target="main">AbstractCache</a></li>
<li><a href="doctrine/common/cache/apccache.html" target="main">ApcCache</a></li>
<li><a href="doctrine/common/cache/arraycache.html" target="main">ArrayCache</a></li>
<li><em><a href="doctrine/common/cache/cache.html" target="main">Cache</a></em></li>
<li><a href="doctrine/common/cache/memcachecache.html" target="main">MemcacheCache</a></li>
<li><a href="doctrine/common/cache/xcachecache.html" target="main">XcacheCache</a></li>
<li><a href="doctrine/common/collections/arraycollection.html" target="main">ArrayCollection</a></li>
<li><em><a href="doctrine/common/collections/collection.html" target="main">Collection</a></em></li>
<li><a href="doctrine/common/util/debug.html" target="main">Debug</a></li>
<li><a href="doctrine/common/util/inflector.html" target="main">Inflector</a></li>
<li><a href="doctrine/dbal/configuration.html" target="main">Configuration</a></li>
<li><a href="doctrine/dbal/connection.html" target="main">Connection</a></li>
<li><a href="doctrine/dbal/connectionexception.html" target="main">ConnectionException</a></li>
<li><a href="doctrine/dbal/dbalexception.html" target="main">DBALException</a></li>
<li><em><a href="doctrine/dbal/driver.html" target="main">Driver</a></em></li>
<li><a href="doctrine/dbal/drivermanager.html" target="main">DriverManager</a></li>
<li><a href="doctrine/dbal/events.html" target="main">Events</a></li>
<li><a href="doctrine/dbal/statement.html" target="main">Statement</a></li>
<li><em><a href="doctrine/dbal/driver/connection.html" target="main">Connection</a></em></li>
<li><a href="doctrine/dbal/driver/pdoconnection.html" target="main">PDOConnection</a></li>
<li><a href="doctrine/dbal/driver/pdostatement.html" target="main">PDOStatement</a></li>
<li><em><a href="doctrine/dbal/driver/statement.html" target="main">Statement</a></em></li>
<li><a href="doctrine/dbal/driver/oci8/driver.html" target="main">Driver</a></li>
<li><a href="doctrine/dbal/driver/oci8/oci8connection.html" target="main">OCI8Connection</a></li>
<li><a href="doctrine/dbal/driver/oci8/oci8exception.html" target="main">OCI8Exception</a></li>
<li><a href="doctrine/dbal/driver/oci8/oci8statement.html" target="main">OCI8Statement</a></li>
<li><a href="doctrine/dbal/driver/pdomssql/connection.html" target="main">Connection</a></li>
<li><a href="doctrine/dbal/driver/pdomssql/driver.html" target="main">Driver</a></li>
<li><a href="doctrine/dbal/driver/pdomysql/driver.html" target="main">Driver</a></li>
<li><a href="doctrine/dbal/driver/pdooracle/driver.html" target="main">Driver</a></li>
<li><a href="doctrine/dbal/driver/pdopgsql/driver.html" target="main">Driver</a></li>
<li><a href="doctrine/dbal/driver/pdosqlite/driver.html" target="main">Driver</a></li>
<li><a href="doctrine/dbal/event/connectioneventargs.html" target="main">ConnectionEventArgs</a></li>
<li><a href="doctrine/dbal/event/listeners/mysqlsessioninit.html" target="main">MysqlSessionInit</a></li>
<li><a href="doctrine/dbal/event/listeners/oraclesessioninit.html" target="main">OracleSessionInit</a></li>
<li><a href="doctrine/dbal/logging/debugstack.html" target="main">DebugStack</a></li>
<li><a href="doctrine/dbal/logging/echosqllogger.html" target="main">EchoSQLLogger</a></li>
<li><em><a href="doctrine/dbal/logging/sqllogger.html" target="main">SQLLogger</a></em></li>
<li><a href="doctrine/dbal/platforms/abstractplatform.html" target="main">AbstractPlatform</a></li>
<li><a href="doctrine/dbal/platforms/mssqlplatform.html" target="main">MsSqlPlatform</a></li>
<li><a href="doctrine/dbal/platforms/mysqlplatform.html" target="main">MySqlPlatform</a></li>
<li><a href="doctrine/dbal/platforms/oracleplatform.html" target="main">OraclePlatform</a></li>
<li><a href="doctrine/dbal/platforms/postgresqlplatform.html" target="main">PostgreSqlPlatform</a></li>
<li><a href="doctrine/dbal/platforms/sqliteplatform.html" target="main">SqlitePlatform</a></li>
<li><a href="doctrine/dbal/schema/abstractasset.html" target="main">AbstractAsset</a></li>
<li><a href="doctrine/dbal/schema/abstractschemamanager.html" target="main">AbstractSchemaManager</a></li>
<li><a href="doctrine/dbal/schema/column.html" target="main">Column</a></li>
<li><a href="doctrine/dbal/schema/columndiff.html" target="main">ColumnDiff</a></li>
<li><a href="doctrine/dbal/schema/comparator.html" target="main">Comparator</a></li>
<li><em><a href="doctrine/dbal/schema/constraint.html" target="main">Constraint</a></em></li>
<li><a href="doctrine/dbal/schema/foreignkeyconstraint.html" target="main">ForeignKeyConstraint</a></li>
<li><a href="doctrine/dbal/schema/index.html" target="main">Index</a></li>
<li><a href="doctrine/dbal/schema/mssqlschemamanager.html" target="main">MsSqlSchemaManager</a></li>
<li><a href="doctrine/dbal/schema/mysqlschemamanager.html" target="main">MySqlSchemaManager</a></li>
<li><a href="doctrine/dbal/schema/oracleschemamanager.html" target="main">OracleSchemaManager</a></li>
<li><a href="doctrine/dbal/schema/postgresqlschemamanager.html" target="main">PostgreSqlSchemaManager</a></li>
<li><a href="doctrine/dbal/schema/schema.html" target="main">Schema</a></li>
<li><a href="doctrine/dbal/schema/schemaconfig.html" target="main">SchemaConfig</a></li>
<li><a href="doctrine/dbal/schema/schemadiff.html" target="main">SchemaDiff</a></li>
<li><a href="doctrine/dbal/schema/schemaexception.html" target="main">SchemaException</a></li>
<li><a href="doctrine/dbal/schema/sequence.html" target="main">Sequence</a></li>
<li><a href="doctrine/dbal/schema/sqliteschemamanager.html" target="main">SqliteSchemaManager</a></li>
<li><a href="doctrine/dbal/schema/table.html" target="main">Table</a></li>
<li><a href="doctrine/dbal/schema/tablediff.html" target="main">TableDiff</a></li>
<li><a href="doctrine/dbal/schema/view.html" target="main">View</a></li>
<li><a href="doctrine/dbal/schema/visitor/createschemasqlcollector.html" target="main">CreateSchemaSqlCollector</a></li>
<li><a href="doctrine/dbal/schema/visitor/dropschemasqlcollector.html" target="main">DropSchemaSqlCollector</a></li>
<li><a href="doctrine/dbal/schema/visitor/fixschema.html" target="main">FixSchema</a></li>
<li><em><a href="doctrine/dbal/schema/visitor/visitor.html" target="main">Visitor</a></em></li>
<li><a href="doctrine/dbal/tools/console/command/importcommand.html" target="main">ImportCommand</a></li>
<li><a href="doctrine/dbal/tools/console/command/runsqlcommand.html" target="main">RunSqlCommand</a></li>
<li><a href="doctrine/dbal/tools/console/helper/connectionhelper.html" target="main">ConnectionHelper</a></li>
<li><a href="doctrine/dbal/types/arraytype.html" target="main">ArrayType</a></li>
<li><a href="doctrine/dbal/types/biginttype.html" target="main">BigIntType</a></li>
<li><a href="doctrine/dbal/types/booleantype.html" target="main">BooleanType</a></li>
<li><a href="doctrine/dbal/types/datetimetype.html" target="main">DateTimeType</a></li>
<li><a href="doctrine/dbal/types/datetype.html" target="main">DateType</a></li>
<li><a href="doctrine/dbal/types/decimaltype.html" target="main">DecimalType</a></li>
<li><a href="doctrine/dbal/types/integertype.html" target="main">IntegerType</a></li>
<li><a href="doctrine/dbal/types/objecttype.html" target="main">ObjectType</a></li>
<li><a href="doctrine/dbal/types/smallinttype.html" target="main">SmallIntType</a></li>
<li><a href="doctrine/dbal/types/stringtype.html" target="main">StringType</a></li>
<li><a href="doctrine/dbal/types/texttype.html" target="main">TextType</a></li>
<li><a href="doctrine/dbal/types/timetype.html" target="main">TimeType</a></li>
<li><a href="doctrine/dbal/types/type.html" target="main">Type</a></li>
<li><a href="doctrine/orm/abstractquery.html" target="main">AbstractQuery</a></li>
<li><a href="doctrine/orm/configuration.html" target="main">Configuration</a></li>
<li><a href="doctrine/orm/entitymanager.html" target="main">EntityManager</a></li>
<li><a href="doctrine/orm/entitynotfoundexception.html" target="main">EntityNotFoundException</a></li>
<li><a href="doctrine/orm/entityrepository.html" target="main">EntityRepository</a></li>
<li><a href="doctrine/orm/events.html" target="main">Events</a></li>
<li><a href="doctrine/orm/nativequery.html" target="main">NativeQuery</a></li>
<li><a href="doctrine/orm/noresultexception.html" target="main">NoResultException</a></li>
<li><a href="doctrine/orm/nonuniqueresultexception.html" target="main">NonUniqueResultException</a></li>
<li><a href="doctrine/orm/ormexception.html" target="main">ORMException</a></li>
<li><a href="doctrine/orm/optimisticlockexception.html" target="main">OptimisticLockException</a></li>
<li><a href="doctrine/orm/persistentcollection.html" target="main">PersistentCollection</a></li>
<li><a href="doctrine/orm/query.html" target="main">Query</a></li>
<li><a href="doctrine/orm/querybuilder.html" target="main">QueryBuilder</a></li>
<li><a href="doctrine/orm/unitofwork.html" target="main">UnitOfWork</a></li>
<li><a href="doctrine/orm/event/lifecycleeventargs.html" target="main">LifecycleEventArgs</a></li>
<li><a href="doctrine/orm/event/loadclassmetadataeventargs.html" target="main">LoadClassMetadataEventArgs</a></li>
<li><a href="doctrine/orm/event/onflusheventargs.html" target="main">OnFlushEventArgs</a></li>
<li><a href="doctrine/orm/event/preupdateeventargs.html" target="main">PreUpdateEventArgs</a></li>
<li><a href="doctrine/orm/id/abstractidgenerator.html" target="main">AbstractIdGenerator</a></li>
<li><a href="doctrine/orm/id/assignedgenerator.html" target="main">AssignedGenerator</a></li>
<li><a href="doctrine/orm/id/identitygenerator.html" target="main">IdentityGenerator</a></li>
<li><a href="doctrine/orm/id/sequencegenerator.html" target="main">SequenceGenerator</a></li>
<li><a href="doctrine/orm/id/sequenceidentitygenerator.html" target="main">SequenceIdentityGenerator</a></li>
<li><a href="doctrine/orm/id/tablegenerator.html" target="main">TableGenerator</a></li>
<li><a href="doctrine/orm/internal/commitordercalculator.html" target="main">CommitOrderCalculator</a></li>
<li><a href="doctrine/orm/internal/hydration/abstracthydrator.html" target="main">AbstractHydrator</a></li>
<li><a href="doctrine/orm/internal/hydration/arrayhydrator.html" target="main">ArrayHydrator</a></li>
<li><a href="doctrine/orm/internal/hydration/hydrationexception.html" target="main">HydrationException</a></li>
<li><a href="doctrine/orm/internal/hydration/iterableresult.html" target="main">IterableResult</a></li>
<li><a href="doctrine/orm/internal/hydration/objecthydrator.html" target="main">ObjectHydrator</a></li>
<li><a href="doctrine/orm/internal/hydration/scalarhydrator.html" target="main">ScalarHydrator</a></li>
<li><a href="doctrine/orm/internal/hydration/singlescalarhydrator.html" target="main">SingleScalarHydrator</a></li>
<li><a href="doctrine/orm/mapping/associationmapping.html" target="main">AssociationMapping</a></li>
<li><a href="doctrine/orm/mapping/changetrackingpolicy.html" target="main">ChangeTrackingPolicy</a></li>
<li><a href="doctrine/orm/mapping/classmetadata.html" target="main">ClassMetadata</a></li>
<li><a href="doctrine/orm/mapping/classmetadatafactory.html" target="main">ClassMetadataFactory</a></li>
<li><a href="doctrine/orm/mapping/classmetadatainfo.html" target="main">ClassMetadataInfo</a></li>
<li><a href="doctrine/orm/mapping/column.html" target="main">Column</a></li>
<li><a href="doctrine/orm/mapping/discriminatorcolumn.html" target="main">DiscriminatorColumn</a></li>
<li><a href="doctrine/orm/mapping/discriminatormap.html" target="main">DiscriminatorMap</a></li>
<li><a href="doctrine/orm/mapping/elementcollection.html" target="main">ElementCollection</a></li>
<li><a href="doctrine/orm/mapping/entity.html" target="main">Entity</a></li>
<li><a href="doctrine/orm/mapping/generatedvalue.html" target="main">GeneratedValue</a></li>
<li><a href="doctrine/orm/mapping/haslifecyclecallbacks.html" target="main">HasLifecycleCallbacks</a></li>
<li><a href="doctrine/orm/mapping/id.html" target="main">Id</a></li>
<li><a href="doctrine/orm/mapping/index.html" target="main">Index</a></li>
<li><a href="doctrine/orm/mapping/inheritancetype.html" target="main">InheritanceType</a></li>
<li><a href="doctrine/orm/mapping/joincolumn.html" target="main">JoinColumn</a></li>
<li><a href="doctrine/orm/mapping/joincolumns.html" target="main">JoinColumns</a></li>
<li><a href="doctrine/orm/mapping/jointable.html" target="main">JoinTable</a></li>
<li><a href="doctrine/orm/mapping/manytomany.html" target="main">ManyToMany</a></li>
<li><a href="doctrine/orm/mapping/manytomanymapping.html" target="main">ManyToManyMapping</a></li>
<li><a href="doctrine/orm/mapping/manytoone.html" target="main">ManyToOne</a></li>
<li><a href="doctrine/orm/mapping/mappedsuperclass.html" target="main">MappedSuperclass</a></li>
<li><a href="doctrine/orm/mapping/mappingexception.html" target="main">MappingException</a></li>
<li><a href="doctrine/orm/mapping/onetomany.html" target="main">OneToMany</a></li>
<li><a href="doctrine/orm/mapping/onetomanymapping.html" target="main">OneToManyMapping</a></li>
<li><a href="doctrine/orm/mapping/onetoone.html" target="main">OneToOne</a></li>
<li><a href="doctrine/orm/mapping/onetoonemapping.html" target="main">OneToOneMapping</a></li>
<li><a href="doctrine/orm/mapping/orderby.html" target="main">OrderBy</a></li>
<li><a href="doctrine/orm/mapping/postload.html" target="main">PostLoad</a></li>
<li><a href="doctrine/orm/mapping/postpersist.html" target="main">PostPersist</a></li>
<li><a href="doctrine/orm/mapping/postremove.html" target="main">PostRemove</a></li>
<li><a href="doctrine/orm/mapping/postupdate.html" target="main">PostUpdate</a></li>
<li><a href="doctrine/orm/mapping/prepersist.html" target="main">PrePersist</a></li>
<li><a href="doctrine/orm/mapping/preremove.html" target="main">PreRemove</a></li>
<li><a href="doctrine/orm/mapping/preupdate.html" target="main">PreUpdate</a></li>
<li><a href="doctrine/orm/mapping/sequencegenerator.html" target="main">SequenceGenerator</a></li>
<li><a href="doctrine/orm/mapping/table.html" target="main">Table</a></li>
<li><a href="doctrine/orm/mapping/uniqueconstraint.html" target="main">UniqueConstraint</a></li>
<li><a href="doctrine/orm/mapping/version.html" target="main">Version</a></li>
<li><a href="doctrine/orm/mapping/driver/abstractfiledriver.html" target="main">AbstractFileDriver</a></li>
<li><a href="doctrine/orm/mapping/driver/annotationdriver.html" target="main">AnnotationDriver</a></li>
<li><a href="doctrine/orm/mapping/driver/databasedriver.html" target="main">DatabaseDriver</a></li>
<li><em><a href="doctrine/orm/mapping/driver/driver.html" target="main">Driver</a></em></li>
<li><a href="doctrine/orm/mapping/driver/driverchain.html" target="main">DriverChain</a></li>
<li><a href="doctrine/orm/mapping/driver/phpdriver.html" target="main">PhpDriver</a></li>
<li><a href="doctrine/orm/mapping/driver/xmldriver.html" target="main">XmlDriver</a></li>
<li><a href="doctrine/orm/mapping/driver/yamldriver.html" target="main">YamlDriver</a></li>
<li><a href="doctrine/orm/persisters/abstractcollectionpersister.html" target="main">AbstractCollectionPersister</a></li>
<li><a href="doctrine/orm/persisters/abstractentityinheritancepersister.html" target="main">AbstractEntityInheritancePersister</a></li>
<li><a href="doctrine/orm/persisters/elementcollectionpersister.html" target="main">ElementCollectionPersister</a></li>
<li><a href="doctrine/orm/persisters/joinedsubclasspersister.html" target="main">JoinedSubclassPersister</a></li>
<li><a href="doctrine/orm/persisters/manytomanypersister.html" target="main">ManyToManyPersister</a></li>
<li><a href="doctrine/orm/persisters/onetomanypersister.html" target="main">OneToManyPersister</a></li>
<li><a href="doctrine/orm/persisters/singletablepersister.html" target="main">SingleTablePersister</a></li>
<li><a href="doctrine/orm/persisters/standardentitypersister.html" target="main">StandardEntityPersister</a></li>
<li><a href="doctrine/orm/persisters/unionsubclasspersister.html" target="main">UnionSubclassPersister</a></li>
<li><em><a href="doctrine/orm/proxy/proxy.html" target="main">Proxy</a></em></li>
<li><a href="doctrine/orm/proxy/proxyexception.html" target="main">ProxyException</a></li>
<li><a href="doctrine/orm/proxy/proxyfactory.html" target="main">ProxyFactory</a></li>
<li><a href="doctrine/orm/query/expr.html" target="main">Expr</a></li>
<li><a href="doctrine/orm/query/lexer.html" target="main">Lexer</a></li>
<li><a href="doctrine/orm/query/parser.html" target="main">Parser</a></li>
<li><a href="doctrine/orm/query/parserresult.html" target="main">ParserResult</a></li>
<li><a href="doctrine/orm/query/printer.html" target="main">Printer</a></li>
<li><a href="doctrine/orm/query/queryexception.html" target="main">QueryException</a></li>
<li><a href="doctrine/orm/query/resultsetmapping.html" target="main">ResultSetMapping</a></li>
<li><a href="doctrine/orm/query/sqlwalker.html" target="main">SqlWalker</a></li>
<li><em><a href="doctrine/orm/query/treewalker.html" target="main">TreeWalker</a></em></li>
<li><a href="doctrine/orm/query/treewalkeradapter.html" target="main">TreeWalkerAdapter</a></li>
<li><a href="doctrine/orm/query/treewalkerchain.html" target="main">TreeWalkerChain</a></li>
<li><a href="doctrine/orm/query/ast/astexception.html" target="main">ASTException</a></li>
<li><a href="doctrine/orm/query/ast/aggregateexpression.html" target="main">AggregateExpression</a></li>
<li><a href="doctrine/orm/query/ast/arithmeticexpression.html" target="main">ArithmeticExpression</a></li>
<li><a href="doctrine/orm/query/ast/arithmeticfactor.html" target="main">ArithmeticFactor</a></li>
<li><a href="doctrine/orm/query/ast/arithmeticterm.html" target="main">ArithmeticTerm</a></li>
<li><a href="doctrine/orm/query/ast/betweenexpression.html" target="main">BetweenExpression</a></li>
<li><a href="doctrine/orm/query/ast/collectionmemberexpression.html" target="main">CollectionMemberExpression</a></li>
<li><a href="doctrine/orm/query/ast/comparisonexpression.html" target="main">ComparisonExpression</a></li>
<li><a href="doctrine/orm/query/ast/conditionalexpression.html" target="main">ConditionalExpression</a></li>
<li><a href="doctrine/orm/query/ast/conditionalfactor.html" target="main">ConditionalFactor</a></li>
<li><a href="doctrine/orm/query/ast/conditionalprimary.html" target="main">ConditionalPrimary</a></li>
<li><a href="doctrine/orm/query/ast/conditionalterm.html" target="main">ConditionalTerm</a></li>
<li><a href="doctrine/orm/query/ast/deleteclause.html" target="main">DeleteClause</a></li>
<li><a href="doctrine/orm/query/ast/deletestatement.html" target="main">DeleteStatement</a></li>
<li><a href="doctrine/orm/query/ast/emptycollectioncomparisonexpression.html" target="main">EmptyCollectionComparisonExpression</a></li>
<li><a href="doctrine/orm/query/ast/existsexpression.html" target="main">ExistsExpression</a></li>
<li><a href="doctrine/orm/query/ast/fromclause.html" target="main">FromClause</a></li>
<li><a href="doctrine/orm/query/ast/groupbyclause.html" target="main">GroupByClause</a></li>
<li><a href="doctrine/orm/query/ast/havingclause.html" target="main">HavingClause</a></li>
<li><a href="doctrine/orm/query/ast/identificationvariabledeclaration.html" target="main">IdentificationVariableDeclaration</a></li>
<li><a href="doctrine/orm/query/ast/inexpression.html" target="main">InExpression</a></li>
<li><a href="doctrine/orm/query/ast/indexby.html" target="main">IndexBy</a></li>
<li><a href="doctrine/orm/query/ast/inputparameter.html" target="main">InputParameter</a></li>
<li><a href="doctrine/orm/query/ast/join.html" target="main">Join</a></li>
<li><a href="doctrine/orm/query/ast/joinassociationpathexpression.html" target="main">JoinAssociationPathExpression</a></li>
<li><a href="doctrine/orm/query/ast/joinvariabledeclaration.html" target="main">JoinVariableDeclaration</a></li>
<li><a href="doctrine/orm/query/ast/likeexpression.html" target="main">LikeExpression</a></li>
<li><a href="doctrine/orm/query/ast/literal.html" target="main">Literal</a></li>
<li><a href="doctrine/orm/query/ast/node.html" target="main">Node</a></li>
<li><a href="doctrine/orm/query/ast/nullcomparisonexpression.html" target="main">NullComparisonExpression</a></li>
<li><a href="doctrine/orm/query/ast/orderbyclause.html" target="main">OrderByClause</a></li>
<li><a href="doctrine/orm/query/ast/orderbyitem.html" target="main">OrderByItem</a></li>
<li><a href="doctrine/orm/query/ast/partialobjectexpression.html" target="main">PartialObjectExpression</a></li>
<li><a href="doctrine/orm/query/ast/pathexpression.html" target="main">PathExpression</a></li>
<li><a href="doctrine/orm/query/ast/quantifiedexpression.html" target="main">QuantifiedExpression</a></li>
<li><a href="doctrine/orm/query/ast/rangevariabledeclaration.html" target="main">RangeVariableDeclaration</a></li>
<li><a href="doctrine/orm/query/ast/selectclause.html" target="main">SelectClause</a></li>
<li><a href="doctrine/orm/query/ast/selectexpression.html" target="main">SelectExpression</a></li>
<li><a href="doctrine/orm/query/ast/selectstatement.html" target="main">SelectStatement</a></li>
<li><a href="doctrine/orm/query/ast/simplearithmeticexpression.html" target="main">SimpleArithmeticExpression</a></li>
<li><a href="doctrine/orm/query/ast/simpleselectclause.html" target="main">SimpleSelectClause</a></li>
<li><a href="doctrine/orm/query/ast/simpleselectexpression.html" target="main">SimpleSelectExpression</a></li>
<li><a href="doctrine/orm/query/ast/subselect.html" target="main">Subselect</a></li>
<li><a href="doctrine/orm/query/ast/subselectfromclause.html" target="main">SubselectFromClause</a></li>
<li><a href="doctrine/orm/query/ast/updateclause.html" target="main">UpdateClause</a></li>
<li><a href="doctrine/orm/query/ast/updateitem.html" target="main">UpdateItem</a></li>
<li><a href="doctrine/orm/query/ast/updatestatement.html" target="main">UpdateStatement</a></li>
<li><a href="doctrine/orm/query/ast/whereclause.html" target="main">WhereClause</a></li>
<li><a href="doctrine/orm/query/ast/functions/absfunction.html" target="main">AbsFunction</a></li>
<li><a href="doctrine/orm/query/ast/functions/concatfunction.html" target="main">ConcatFunction</a></li>
<li><a href="doctrine/orm/query/ast/functions/currentdatefunction.html" target="main">CurrentDateFunction</a></li>
<li><a href="doctrine/orm/query/ast/functions/currenttimefunction.html" target="main">CurrentTimeFunction</a></li>
<li><a href="doctrine/orm/query/ast/functions/currenttimestampfunction.html" target="main">CurrentTimestampFunction</a></li>
<li><a href="doctrine/orm/query/ast/functions/functionnode.html" target="main">FunctionNode</a></li>
<li><a href="doctrine/orm/query/ast/functions/lengthfunction.html" target="main">LengthFunction</a></li>
<li><a href="doctrine/orm/query/ast/functions/locatefunction.html" target="main">LocateFunction</a></li>
<li><a href="doctrine/orm/query/ast/functions/lowerfunction.html" target="main">LowerFunction</a></li>
<li><a href="doctrine/orm/query/ast/functions/modfunction.html" target="main">ModFunction</a></li>
<li><a href="doctrine/orm/query/ast/functions/sizefunction.html" target="main">SizeFunction</a></li>
<li><a href="doctrine/orm/query/ast/functions/sqrtfunction.html" target="main">SqrtFunction</a></li>
<li><a href="doctrine/orm/query/ast/functions/substringfunction.html" target="main">SubstringFunction</a></li>
<li><a href="doctrine/orm/query/ast/functions/trimfunction.html" target="main">TrimFunction</a></li>
<li><a href="doctrine/orm/query/ast/functions/upperfunction.html" target="main">UpperFunction</a></li>
<li><a href="doctrine/orm/query/exec/abstractsqlexecutor.html" target="main">AbstractSqlExecutor</a></li>
<li><a href="doctrine/orm/query/exec/multitabledeleteexecutor.html" target="main">MultiTableDeleteExecutor</a></li>
<li><a href="doctrine/orm/query/exec/multitableupdateexecutor.html" target="main">MultiTableUpdateExecutor</a></li>
<li><a href="doctrine/orm/query/exec/singleselectexecutor.html" target="main">SingleSelectExecutor</a></li>
<li><a href="doctrine/orm/query/exec/singletabledeleteupdateexecutor.html" target="main">SingleTableDeleteUpdateExecutor</a></li>
<li><a href="doctrine/orm/query/expr/andx.html" target="main">Andx</a></li>
<li><a href="doctrine/orm/query/expr/base.html" target="main">Base</a></li>
<li><a href="doctrine/orm/query/expr/comparison.html" target="main">Comparison</a></li>
<li><a href="doctrine/orm/query/expr/from.html" target="main">From</a></li>
<li><a href="doctrine/orm/query/expr/func.html" target="main">Func</a></li>
<li><a href="doctrine/orm/query/expr/groupby.html" target="main">GroupBy</a></li>
<li><a href="doctrine/orm/query/expr/join.html" target="main">Join</a></li>
<li><a href="doctrine/orm/query/expr/literal.html" target="main">Literal</a></li>
<li><a href="doctrine/orm/query/expr/math.html" target="main">Math</a></li>
<li><a href="doctrine/orm/query/expr/orderby.html" target="main">OrderBy</a></li>
<li><a href="doctrine/orm/query/expr/orx.html" target="main">Orx</a></li>
<li><a href="doctrine/orm/query/expr/select.html" target="main">Select</a></li>
<li><a href="doctrine/orm/tools/classmetadatareader.html" target="main">ClassMetadataReader</a></li>
<li><a href="doctrine/orm/tools/convertdoctrine1schema.html" target="main">ConvertDoctrine1Schema</a></li>
<li><a href="doctrine/orm/tools/entitygenerator.html" target="main">EntityGenerator</a></li>
<li><a href="doctrine/orm/tools/schematool.html" target="main">SchemaTool</a></li>
<li><a href="doctrine/orm/tools/toolevents.html" target="main">ToolEvents</a></li>
<li><a href="doctrine/orm/tools/toolsexception.html" target="main">ToolsException</a></li>
<li><a href="doctrine/orm/tools/console/metadatafilter.html" target="main">MetadataFilter</a></li>
<li><a href="doctrine/orm/tools/console/command/convertdoctrine1schemacommand.html" target="main">ConvertDoctrine1SchemaCommand</a></li>
<li><a href="doctrine/orm/tools/console/command/convertmappingcommand.html" target="main">ConvertMappingCommand</a></li>
<li><a href="doctrine/orm/tools/console/command/ensureproductionsettingscommand.html" target="main">EnsureProductionSettingsCommand</a></li>
<li><a href="doctrine/orm/tools/console/command/generateentitiescommand.html" target="main">GenerateEntitiesCommand</a></li>
<li><a href="doctrine/orm/tools/console/command/generateproxiescommand.html" target="main">GenerateProxiesCommand</a></li>
<li><a href="doctrine/orm/tools/console/command/generaterepositoriescommand.html" target="main">GenerateRepositoriesCommand</a></li>
<li><a href="doctrine/orm/tools/console/command/rundqlcommand.html" target="main">RunDqlCommand</a></li>
<li><a href="doctrine/orm/tools/console/command/clearcache/metadatacommand.html" target="main">MetadataCommand</a></li>
<li><a href="doctrine/orm/tools/console/command/clearcache/querycommand.html" target="main">QueryCommand</a></li>
<li><a href="doctrine/orm/tools/console/command/clearcache/resultcommand.html" target="main">ResultCommand</a></li>
<li><a href="doctrine/orm/tools/console/command/schematool/abstractcommand.html" target="main">AbstractCommand</a></li>
<li><a href="doctrine/orm/tools/console/command/schematool/createcommand.html" target="main">CreateCommand</a></li>
<li><a href="doctrine/orm/tools/console/command/schematool/dropcommand.html" target="main">DropCommand</a></li>
<li><a href="doctrine/orm/tools/console/command/schematool/updatecommand.html" target="main">UpdateCommand</a></li>
<li><a href="doctrine/orm/tools/console/helper/entitymanagerhelper.html" target="main">EntityManagerHelper</a></li>
<li><a href="doctrine/orm/tools/event/generateschemaeventargs.html" target="main">GenerateSchemaEventArgs</a></li>
<li><a href="doctrine/orm/tools/event/generateschematableeventargs.html" target="main">GenerateSchemaTableEventArgs</a></li>
<li><a href="doctrine/orm/tools/export/classmetadataexporter.html" target="main">ClassMetadataExporter</a></li>
<li><a href="doctrine/orm/tools/export/exportexception.html" target="main">ExportException</a></li>
<li><a href="doctrine/orm/tools/export/driver/abstractexporter.html" target="main">AbstractExporter</a></li>
<li><a href="doctrine/orm/tools/export/driver/annotationexporter.html" target="main">AnnotationExporter</a></li>
<li><a href="doctrine/orm/tools/export/driver/phpexporter.html" target="main">PhpExporter</a></li>
<li><a href="doctrine/orm/tools/export/driver/xmlexporter.html" target="main">XmlExporter</a></li>
<li><a href="doctrine/orm/tools/export/driver/yamlexporter.html" target="main">YamlExporter</a></li>
</ul>
</body>
</html>

64
lib/api/deprecated-list.html
View File

@ -1,64 +0,0 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang="en">
<head>
<meta name="generator" content="PHPDoctor 2RC4 (http://phpdoctor.sourceforge.net/)">
<meta name="when" content="Wed, 14 Apr 2010 15:12:06 +0000">
<link rel="stylesheet" type="text/css" href="stylesheet.css">
<link rel="start" href="overview-summary.html">
<title>Deprecated (Doctrine)</title>
</head>
<body id="overview" onload="parent.document.title=document.title;">
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="overview-summary.html">Overview</a></li>
<li>Namespace</li><li>Class</li><li><a href="overview-tree.html">Tree</a></li>
<li class="active">Deprecated</li>
<li><a href="index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="index.html" target="_top">Frames</a>
<a href="deprecated-list.html" target="_top">No frames</a>
</div>
<h1>Deprecated API</h1><hr>
<h2>Contents</h2>
<ul>
<li><a href="#deprecated_method">Deprecated Methods</a></li></ul>
<table id="deprecated_method" class="detail">
<tr><th colspan="2" class="title">Deprecated Methods</th></tr>
<tr>
<td class="name"><a href="doctrine/orm/mapping/classmetadatainfo.html#setTableName()">Doctrine\ORM\Mapping\ClassMetadataInfo\setTableName</a></td>
<td class="description">Sets the name of the primary table the class is mapped to.</td>
</tr>
</table>
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="overview-summary.html">Overview</a></li>
<li>Namespace</li><li>Class</li><li><a href="overview-tree.html">Tree</a></li>
<li class="active">Deprecated</li>
<li><a href="index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="index.html" target="_top">Frames</a>
<a href="deprecated-list.html" target="_top">No frames</a>
</div>
<hr>
<p id="footer">This document was generated by <a href="http://peej.github.com/phpdoctor/">PHPDoctor: The PHP Documentation Creator</a></p>
</body>
</html>

131
lib/api/doctrine/common/annotations/annotation.html
View File

@ -1,131 +0,0 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang="en">
<head>
<meta name="generator" content="PHPDoctor 2RC4 (http://phpdoctor.sourceforge.net/)">
<meta name="when" content="Wed, 14 Apr 2010 15:12:03 +0000">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css">
<link rel="start" href="../../../overview-summary.html">
<title>Annotation (Doctrine)</title>
</head>
<body id="definition" onload="parent.document.title=document.title;">
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="../../../doctrine/common/annotations/package-summary.html">Namespace</a></li>
<li class="active">Class</li>
<li><a href="../../../doctrine/common/annotations/package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../../index.html" target="_top">Frames</a>
<a href="../../../doctrine/common/annotations/annotation.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>
<div class="qualifiedName">Doctrine\Common\Annotations\Annotation</div>
<div class="location">/Doctrine/Common/Annotations/Annotation.php at line 35</div>
<h1>Class Annotation</h1>
<pre class="tree"><strong>Annotation</strong><br /></pre>
<hr>
<p class="signature">public class <strong>Annotation</strong></p>
<div class="comment" id="overview_description"><p>Annotations class</p></div>
<dl>
<dt>License:</dt>
<dd>http://www.opensource.org/licenses/lgpl-license.php LGPL</dd>
<dt>See Also:</dt>
<dd><code>www.doctrine-project.org</code></dd>
<dt>Since:</dt>
<dd>2.0</dd>
<dt>Version:</dt>
<dd>$Revision: 3938 $</dd>
<dt>Author:</dt>
<dd>Guilherme Blanco <guilhermeblanco@hotmail.com></dd>
<dd>Jonathan Wage <jonwage@gmail.com></dd>
<dd>Roman Borschel <roman@code-factory.org></dd>
</dl>
<hr>
<table id="summary_field">
<tr><th colspan="2">Field Summary</th></tr>
<tr>
<td class="type"> string</td>
<td class="description"><p class="name"><a href="#value">$value</a></p><p class="description">Value property. </p></td>
</tr>
</table>
<table id="summary_constr">
<tr><th colspan="2">Constructor Summary</th></tr>
<tr>
<td class="description"><p class="name"><a href="#Annotation()">Annotation</a>(array data)</p><p class="description">Constructor</p></td>
</tr>
</table>
<h2 id="detail_field">Field Detail</h2>
<div class="location">/Doctrine/Common/Annotations/Annotation.php at line 42</div>
<h3 id="value">value</h3>
<code class="signature">public string <strong>$value</strong></code>
<div class="details">
<p>Value property. Common among all derived classes.</p></div>
<hr>
<h2 id="detail_constr">Constructor Detail</h2>
<div class="location">/Doctrine/Common/Annotations/Annotation.php at line 49</div>
<h3 id="Annotation()">Annotation</h3>
<code class="signature">public <strong>Annotation</strong>(array data)</code>
<div class="details">
<p>Constructor</p><dl>
<dt>Parameters:</dt>
<dd>data - Key-value for properties to be defined in this class</dd>
</dl>
</div>
<hr>
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="../../../doctrine/common/annotations/package-summary.html">Namespace</a></li>
<li class="active">Class</li>
<li><a href="../../../doctrine/common/annotations/package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../../index.html" target="_top">Frames</a>
<a href="../../../doctrine/common/annotations/annotation.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>
<p id="footer">This document was generated by <a href="http://peej.github.com/phpdoctor/">PHPDoctor: The PHP Documentation Creator</a></p>
</body>
</html>

126
lib/api/doctrine/common/annotations/annotationexception.html
View File

@ -1,126 +0,0 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang="en">
<head>
<meta name="generator" content="PHPDoctor 2RC4 (http://phpdoctor.sourceforge.net/)">
<meta name="when" content="Wed, 14 Apr 2010 15:12:03 +0000">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css">
<link rel="start" href="../../../overview-summary.html">
<title>AnnotationException (Doctrine)</title>
</head>
<body id="definition" onload="parent.document.title=document.title;">
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="../../../doctrine/common/annotations/package-summary.html">Namespace</a></li>
<li class="active">Class</li>
<li><a href="../../../doctrine/common/annotations/package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../../index.html" target="_top">Frames</a>
<a href="../../../doctrine/common/annotations/annotationexception.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>
<div class="qualifiedName">Doctrine\Common\Annotations\AnnotationException</div>
<div class="location">/Doctrine/Common/Annotations/AnnotationException.php at line 35</div>
<h1>Class AnnotationException</h1>
<pre class="tree">Class:AnnotationException - Superclass: Doctrine
Doctrine<br>&lfloor;&nbsp;<strong>AnnotationException</strong><br /></pre>
<hr>
<p class="signature">public class <strong>AnnotationException</strong><br>extends Doctrine
</p>
<div class="comment" id="overview_description"><p>Description of AnnotationException</p></div>
<dl>
<dt>License:</dt>
<dd>http://www.opensource.org/licenses/lgpl-license.php LGPL</dd>
<dt>See Also:</dt>
<dd><code>www.doctrine-project.org</code></dd>
<dt>Since:</dt>
<dd>2.0</dd>
<dt>Version:</dt>
<dd>$Revision: 3938 $</dd>
<dt>Author:</dt>
<dd>Guilherme Blanco <guilhermeblanco@hotmail.com></dd>
<dd>Jonathan Wage <jonwage@gmail.com></dd>
<dd>Roman Borschel <roman@code-factory.org></dd>
</dl>
<hr>
<table id="summary_method">
<tr><th colspan="2">Method Summary</th></tr>
<tr>
<td class="type">static void</td>
<td class="description"><p class="name"><a href="#semanticalError()">semanticalError</a>(mixed message)</p></td>
</tr>
<tr>
<td class="type">static void</td>
<td class="description"><p class="name"><a href="#syntaxError()">syntaxError</a>(mixed message)</p></td>
</tr>
</table>
<h2 id="detail_method">Method Detail</h2>
<div class="location">/Doctrine/Common/Annotations/AnnotationException.php at line 43</div>
<h3 id="semanticalError()">semanticalError</h3>
<code class="signature">public static void <strong>semanticalError</strong>(mixed message)</code>
<div class="details">
</div>
<hr>
<div class="location">/Doctrine/Common/Annotations/AnnotationException.php at line 37</div>
<h3 id="syntaxError()">syntaxError</h3>
<code class="signature">public static void <strong>syntaxError</strong>(mixed message)</code>
<div class="details">
</div>
<hr>
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="../../../doctrine/common/annotations/package-summary.html">Namespace</a></li>
<li class="active">Class</li>
<li><a href="../../../doctrine/common/annotations/package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../../index.html" target="_top">Frames</a>
<a href="../../../doctrine/common/annotations/annotationexception.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>
<p id="footer">This document was generated by <a href="http://peej.github.com/phpdoctor/">PHPDoctor: The PHP Documentation Creator</a></p>
</body>
</html>

260
lib/api/doctrine/common/annotations/annotationreader.html
View File

@ -1,260 +0,0 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang="en">
<head>
<meta name="generator" content="PHPDoctor 2RC4 (http://phpdoctor.sourceforge.net/)">
<meta name="when" content="Wed, 14 Apr 2010 15:12:03 +0000">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css">
<link rel="start" href="../../../overview-summary.html">
<title>AnnotationReader (Doctrine)</title>
</head>
<body id="definition" onload="parent.document.title=document.title;">
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="../../../doctrine/common/annotations/package-summary.html">Namespace</a></li>
<li class="active">Class</li>
<li><a href="../../../doctrine/common/annotations/package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../../index.html" target="_top">Frames</a>
<a href="../../../doctrine/common/annotations/annotationreader.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>
<div class="qualifiedName">Doctrine\Common\Annotations\AnnotationReader</div>
<div class="location">/Doctrine/Common/Annotations/AnnotationReader.php at line 41</div>
<h1>Class AnnotationReader</h1>
<pre class="tree"><strong>AnnotationReader</strong><br /></pre>
<hr>
<p class="signature">public class <strong>AnnotationReader</strong></p>
<div class="comment" id="overview_description"><p>A reader for docblock annotations.</p></div>
<dl>
<dt>License:</dt>
<dd>http://www.opensource.org/licenses/lgpl-license.php LGPL</dd>
<dt>See Also:</dt>
<dd><code>www.doctrine-project.org</code></dd>
<dt>Since:</dt>
<dd>2.0</dd>
<dt>Version:</dt>
<dd>$Revision: 3938 $</dd>
<dt>Author:</dt>
<dd>Benjamin Eberlei <kontakt@beberlei.de></dd>
<dd>Guilherme Blanco <guilhermeblanco@hotmail.com></dd>
<dd>Jonathan Wage <jonwage@gmail.com></dd>
<dd>Roman Borschel <roman@code-factory.org></dd>
</dl>
<hr>
<table id="summary_constr">
<tr><th colspan="2">Constructor Summary</th></tr>
<tr>
<td class="description"><p class="name"><a href="#AnnotationReader()">AnnotationReader</a>(<a href="../../../doctrine/common/cache/cache.html">Cache</a> cache)</p><p class="description">Constructor. </p></td>
</tr>
</table>
<table id="summary_method">
<tr><th colspan="2">Method Summary</th></tr>
<tr>
<td class="type"> The</td>
<td class="description"><p class="name"><a href="#getClassAnnotation()">getClassAnnotation</a>(mixed class, string annotation, $class )</p><p class="description">Gets a class annotation.</p></td>
</tr>
<tr>
<td class="type"> array</td>
<td class="description"><p class="name"><a href="#getClassAnnotations()">getClassAnnotations</a>(string|ReflectionClass class)</p><p class="description">Gets the annotations applied to a class.</p></td>
</tr>
<tr>
<td class="type"> The</td>
<td class="description"><p class="name"><a href="#getMethodAnnotation()">getMethodAnnotation</a>(ReflectionMethod method, string annotation)</p><p class="description">Gets a method annotation.</p></td>
</tr>
<tr>
<td class="type"> array</td>
<td class="description"><p class="name"><a href="#getMethodAnnotations()">getMethodAnnotations</a>(mixed method, string|ReflectionClass class, string|ReflectionMethod property)</p><p class="description">Gets the annotations applied to a method.</p></td>
</tr>
<tr>
<td class="type"> The</td>
<td class="description"><p class="name"><a href="#getPropertyAnnotation()">getPropertyAnnotation</a>(ReflectionProperty property, string annotation)</p><p class="description">Gets a property annotation.</p></td>
</tr>
<tr>
<td class="type"> array</td>
<td class="description"><p class="name"><a href="#getPropertyAnnotations()">getPropertyAnnotations</a>(string|ReflectionProperty property, string|ReflectionClass class)</p><p class="description">Gets the annotations applied to a property.</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#setAnnotationNamespaceAlias()">setAnnotationNamespaceAlias</a>(mixed namespace, mixed alias, $alias )</p><p class="description">Sets an alias for an annotation namespace.</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#setDefaultAnnotationNamespace()">setDefaultAnnotationNamespace</a>(string defaultNamespace)</p><p class="description">Sets the default namespace that the AnnotationReader should assume for annotations
with not fully qualified names.</p></td>
</tr>
</table>
<h2 id="detail_constr">Constructor Detail</h2>
<div class="location">/Doctrine/Common/Annotations/AnnotationReader.php at line 71</div>
<h3 id="AnnotationReader()">AnnotationReader</h3>
<code class="signature">public <strong>AnnotationReader</strong>(<a href="../../../doctrine/common/cache/cache.html">Cache</a> cache)</code>
<div class="details">
<p>Constructor. Initializes a new AnnotationReader that uses the given
Cache provider.</p><dl>
<dt>Parameters:</dt>
<dd>cache - The cache provider to use. If none is provided, ArrayCache is used.</dd>
</dl>
</div>
<hr>
<h2 id="detail_method">Method Detail</h2>
<div class="location">/Doctrine/Common/Annotations/AnnotationReader.php at line 128</div>
<h3 id="getClassAnnotation()">getClassAnnotation</h3>
<code class="signature">public The <strong>getClassAnnotation</strong>(mixed class, string annotation, $class )</code>
<div class="details">
<p>Gets a class annotation.</p><dl>
<dt>Parameters:</dt>
<dd></dd>
<dd>annotation - The name of the annotation.</dd>
<dt>Returns:</dt>
<dd>Annotation or NULL, if the requested annotation does not exist.</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/Common/Annotations/AnnotationReader.php at line 106</div>
<h3 id="getClassAnnotations()">getClassAnnotations</h3>
<code class="signature">public array <strong>getClassAnnotations</strong>(string|ReflectionClass class)</code>
<div class="details">
<p>Gets the annotations applied to a class.</p><dl>
<dt>Parameters:</dt>
<dd>class - The name or ReflectionClass of the class from which the class annotations should be read.</dd>
<dt>Returns:</dt>
<dd>An array of Annotations.</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/Common/Annotations/AnnotationReader.php at line 202</div>
<h3 id="getMethodAnnotation()">getMethodAnnotation</h3>
<code class="signature">public The <strong>getMethodAnnotation</strong>(ReflectionMethod method, string annotation)</code>
<div class="details">
<p>Gets a method annotation.</p><dl>
<dt>Parameters:</dt>
<dd></dd>
<dd>annotation - The name of the annotation.</dd>
<dt>Returns:</dt>
<dd>Annotation or NULL, if the requested annotation does not exist.</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/Common/Annotations/AnnotationReader.php at line 179</div>
<h3 id="getMethodAnnotations()">getMethodAnnotations</h3>
<code class="signature">public array <strong>getMethodAnnotations</strong>(mixed method, string|ReflectionClass class, string|ReflectionMethod property)</code>
<div class="details">
<p>Gets the annotations applied to a method.</p><dl>
<dt>Parameters:</dt>
<dd>class - The name or ReflectionClass of the class that owns the method.</dd>
<dd>property - The name or ReflectionMethod of the method from which the annotations should be read.</dd>
<dt>Returns:</dt>
<dd>An array of Annotations.</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/Common/Annotations/AnnotationReader.php at line 165</div>
<h3 id="getPropertyAnnotation()">getPropertyAnnotation</h3>
<code class="signature">public The <strong>getPropertyAnnotation</strong>(ReflectionProperty property, string annotation)</code>
<div class="details">
<p>Gets a property annotation.</p><dl>
<dt>Parameters:</dt>
<dd></dd>
<dd>annotation - The name of the annotation.</dd>
<dt>Returns:</dt>
<dd>Annotation or NULL, if the requested annotation does not exist.</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/Common/Annotations/AnnotationReader.php at line 142</div>
<h3 id="getPropertyAnnotations()">getPropertyAnnotations</h3>
<code class="signature">public array <strong>getPropertyAnnotations</strong>(string|ReflectionProperty property, string|ReflectionClass class)</code>
<div class="details">
<p>Gets the annotations applied to a property.</p><dl>
<dt>Parameters:</dt>
<dd>class - The name or ReflectionClass of the class that owns the property.</dd>
<dd>property - The name or ReflectionProperty of the property from which the annotations should be read.</dd>
<dt>Returns:</dt>
<dd>An array of Annotations.</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/Common/Annotations/AnnotationReader.php at line 94</div>
<h3 id="setAnnotationNamespaceAlias()">setAnnotationNamespaceAlias</h3>
<code class="signature">public void <strong>setAnnotationNamespaceAlias</strong>(mixed namespace, mixed alias, $alias )</code>
<div class="details">
<p>Sets an alias for an annotation namespace.</p></div>
<hr>
<div class="location">/Doctrine/Common/Annotations/AnnotationReader.php at line 83</div>
<h3 id="setDefaultAnnotationNamespace()">setDefaultAnnotationNamespace</h3>
<code class="signature">public void <strong>setDefaultAnnotationNamespace</strong>(string defaultNamespace)</code>
<div class="details">
<p>Sets the default namespace that the AnnotationReader should assume for annotations
with not fully qualified names.</p></div>
<hr>
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="../../../doctrine/common/annotations/package-summary.html">Namespace</a></li>
<li class="active">Class</li>
<li><a href="../../../doctrine/common/annotations/package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../../index.html" target="_top">Frames</a>
<a href="../../../doctrine/common/annotations/annotationreader.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>
<p id="footer">This document was generated by <a href="http://peej.github.com/phpdoctor/">PHPDoctor: The PHP Documentation Creator</a></p>
</body>
</html>

317
lib/api/doctrine/common/annotations/lexer.html
View File

@ -1,317 +0,0 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang="en">
<head>
<meta name="generator" content="PHPDoctor 2RC4 (http://phpdoctor.sourceforge.net/)">
<meta name="when" content="Wed, 14 Apr 2010 15:12:03 +0000">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css">
<link rel="start" href="../../../overview-summary.html">
<title>Lexer (Doctrine)</title>
</head>
<body id="definition" onload="parent.document.title=document.title;">
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="../../../doctrine/common/annotations/package-summary.html">Namespace</a></li>
<li class="active">Class</li>
<li><a href="../../../doctrine/common/annotations/package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../../index.html" target="_top">Frames</a>
<a href="../../../doctrine/common/annotations/lexer.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>
<div class="qualifiedName">Doctrine\Common\Annotations\Lexer</div>
<div class="location">/Doctrine/Common/Annotations/Lexer.php at line 35</div>
<h1>Class Lexer</h1>
<pre class="tree">Class:Lexer - Superclass: Doctrine
Doctrine<br>&lfloor;&nbsp;<strong>Lexer</strong><br /></pre>
<hr>
<p class="signature">public class <strong>Lexer</strong><br>extends Doctrine
</p>
<div class="comment" id="overview_description"><p>Simple lexer for docblock annotations.</p></div>
<dl>
<dt>License:</dt>
<dd>http://www.opensource.org/licenses/lgpl-license.php LGPL</dd>
<dt>See Also:</dt>
<dd><code>www.doctrine-project.org</code></dd>
<dt>Since:</dt>
<dd>2.0</dd>
<dt>Version:</dt>
<dd>$Revision: 3938 $</dd>
<dt>Author:</dt>
<dd>Guilherme Blanco <guilhermeblanco@hotmail.com></dd>
<dd>Jonathan Wage <jonwage@gmail.com></dd>
<dd>Roman Borschel <roman@code-factory.org></dd>
</dl>
<hr>
<table id="summary_field">
<tr><th colspan="2">Field Summary</th></tr>
<tr>
<td class="type">final int</td>
<td class="description"><p class="name"><a href="#T_AT">T_AT</a></p></td>
</tr>
<tr>
<td class="type">final int</td>
<td class="description"><p class="name"><a href="#T_CLOSE_CURLY_BRACES">T_CLOSE_CURLY_BRACES</a></p></td>
</tr>
<tr>
<td class="type">final int</td>
<td class="description"><p class="name"><a href="#T_CLOSE_PARENTHESIS">T_CLOSE_PARENTHESIS</a></p></td>
</tr>
<tr>
<td class="type">final int</td>
<td class="description"><p class="name"><a href="#T_COMMA">T_COMMA</a></p></td>
</tr>
<tr>
<td class="type">final int</td>
<td class="description"><p class="name"><a href="#T_EQUALS">T_EQUALS</a></p></td>
</tr>
<tr>
<td class="type">final int</td>
<td class="description"><p class="name"><a href="#T_FALSE">T_FALSE</a></p></td>
</tr>
<tr>
<td class="type">final int</td>
<td class="description"><p class="name"><a href="#T_FLOAT">T_FLOAT</a></p></td>
</tr>
<tr>
<td class="type">final int</td>
<td class="description"><p class="name"><a href="#T_IDENTIFIER">T_IDENTIFIER</a></p></td>
</tr>
<tr>
<td class="type">final int</td>
<td class="description"><p class="name"><a href="#T_INTEGER">T_INTEGER</a></p></td>
</tr>
<tr>
<td class="type">final int</td>
<td class="description"><p class="name"><a href="#T_NAMESPACE_SEPARATOR">T_NAMESPACE_SEPARATOR</a></p></td>
</tr>
<tr>
<td class="type">final int</td>
<td class="description"><p class="name"><a href="#T_NONE">T_NONE</a></p></td>
</tr>
<tr>
<td class="type">final int</td>
<td class="description"><p class="name"><a href="#T_OPEN_CURLY_BRACES">T_OPEN_CURLY_BRACES</a></p></td>
</tr>
<tr>
<td class="type">final int</td>
<td class="description"><p class="name"><a href="#T_OPEN_PARENTHESIS">T_OPEN_PARENTHESIS</a></p></td>
</tr>
<tr>
<td class="type">final int</td>
<td class="description"><p class="name"><a href="#T_STRING">T_STRING</a></p></td>
</tr>
<tr>
<td class="type">final int</td>
<td class="description"><p class="name"><a href="#T_TRUE">T_TRUE</a></p></td>
</tr>
</table>
<table id="summary_method">
<tr><th colspan="2">Method Summary</th></tr>
<tr>
<td class="type">protected void</td>
<td class="description"><p class="name"><a href="#getCatchablePatterns()">getCatchablePatterns</a>()</p><p class="description"></p></td>
</tr>
<tr>
<td class="type">protected void</td>
<td class="description"><p class="name"><a href="#getNonCatchablePatterns()">getNonCatchablePatterns</a>()</p><p class="description"></p></td>
</tr>
</table>
<h2 id="detail_field">Field Detail</h2>
<div class="location">/Doctrine/Common/Annotations/Lexer.php at line 43</div>
<h3 id="T_AT">T_AT</h3>
<code class="signature">public final int <strong>T_AT</strong> = 101</code>
<div class="details">
</div>
<hr>
<div class="location">/Doctrine/Common/Annotations/Lexer.php at line 44</div>
<h3 id="T_CLOSE_CURLY_BRACES">T_CLOSE_CURLY_BRACES</h3>
<code class="signature">public final int <strong>T_CLOSE_CURLY_BRACES</strong> = 102</code>
<div class="details">
</div>
<hr>
<div class="location">/Doctrine/Common/Annotations/Lexer.php at line 45</div>
<h3 id="T_CLOSE_PARENTHESIS">T_CLOSE_PARENTHESIS</h3>
<code class="signature">public final int <strong>T_CLOSE_PARENTHESIS</strong> = 103</code>
<div class="details">
</div>
<hr>
<div class="location">/Doctrine/Common/Annotations/Lexer.php at line 46</div>
<h3 id="T_COMMA">T_COMMA</h3>
<code class="signature">public final int <strong>T_COMMA</strong> = 104</code>
<div class="details">
</div>
<hr>
<div class="location">/Doctrine/Common/Annotations/Lexer.php at line 47</div>
<h3 id="T_EQUALS">T_EQUALS</h3>
<code class="signature">public final int <strong>T_EQUALS</strong> = 105</code>
<div class="details">
</div>
<hr>
<div class="location">/Doctrine/Common/Annotations/Lexer.php at line 48</div>
<h3 id="T_FALSE">T_FALSE</h3>
<code class="signature">public final int <strong>T_FALSE</strong> = 106</code>
<div class="details">
</div>
<hr>
<div class="location">/Doctrine/Common/Annotations/Lexer.php at line 41</div>
<h3 id="T_FLOAT">T_FLOAT</h3>
<code class="signature">public final int <strong>T_FLOAT</strong> = 5</code>
<div class="details">
</div>
<hr>
<div class="location">/Doctrine/Common/Annotations/Lexer.php at line 38</div>
<h3 id="T_IDENTIFIER">T_IDENTIFIER</h3>
<code class="signature">public final int <strong>T_IDENTIFIER</strong> = 2</code>
<div class="details">
</div>
<hr>
<div class="location">/Doctrine/Common/Annotations/Lexer.php at line 39</div>
<h3 id="T_INTEGER">T_INTEGER</h3>
<code class="signature">public final int <strong>T_INTEGER</strong> = 3</code>
<div class="details">
</div>
<hr>
<div class="location">/Doctrine/Common/Annotations/Lexer.php at line 49</div>
<h3 id="T_NAMESPACE_SEPARATOR">T_NAMESPACE_SEPARATOR</h3>
<code class="signature">public final int <strong>T_NAMESPACE_SEPARATOR</strong> = 107</code>
<div class="details">
</div>
<hr>
<div class="location">/Doctrine/Common/Annotations/Lexer.php at line 37</div>
<h3 id="T_NONE">T_NONE</h3>
<code class="signature">public final int <strong>T_NONE</strong> = 1</code>
<div class="details">
</div>
<hr>
<div class="location">/Doctrine/Common/Annotations/Lexer.php at line 50</div>
<h3 id="T_OPEN_CURLY_BRACES">T_OPEN_CURLY_BRACES</h3>
<code class="signature">public final int <strong>T_OPEN_CURLY_BRACES</strong> = 108</code>
<div class="details">
</div>
<hr>
<div class="location">/Doctrine/Common/Annotations/Lexer.php at line 51</div>
<h3 id="T_OPEN_PARENTHESIS">T_OPEN_PARENTHESIS</h3>
<code class="signature">public final int <strong>T_OPEN_PARENTHESIS</strong> = 109</code>
<div class="details">
</div>
<hr>
<div class="location">/Doctrine/Common/Annotations/Lexer.php at line 40</div>
<h3 id="T_STRING">T_STRING</h3>
<code class="signature">public final int <strong>T_STRING</strong> = 4</code>
<div class="details">
</div>
<hr>
<div class="location">/Doctrine/Common/Annotations/Lexer.php at line 52</div>
<h3 id="T_TRUE">T_TRUE</h3>
<code class="signature">public final int <strong>T_TRUE</strong> = 110</code>
<div class="details">
</div>
<hr>
<h2 id="detail_method">Method Detail</h2>
<div class="location">/Doctrine/Common/Annotations/Lexer.php at line 57</div>
<h3 id="getCatchablePatterns()">getCatchablePatterns</h3>
<code class="signature">protected void <strong>getCatchablePatterns</strong>()</code>
<div class="details">
<p></p><dl>
<dt>Inheritdoc.</dt>
</dl>
</div>
<hr>
<div class="location">/Doctrine/Common/Annotations/Lexer.php at line 69</div>
<h3 id="getNonCatchablePatterns()">getNonCatchablePatterns</h3>
<code class="signature">protected void <strong>getNonCatchablePatterns</strong>()</code>
<div class="details">
<p></p><dl>
<dt>Inheritdoc.</dt>
</dl>
</div>
<hr>
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="../../../doctrine/common/annotations/package-summary.html">Namespace</a></li>
<li class="active">Class</li>
<li><a href="../../../doctrine/common/annotations/package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../../index.html" target="_top">Frames</a>
<a href="../../../doctrine/common/annotations/lexer.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>
<p id="footer">This document was generated by <a href="http://peej.github.com/phpdoctor/">PHPDoctor: The PHP Documentation Creator</a></p>
</body>
</html>

30
lib/api/doctrine/common/annotations/package-frame.html
View File

@ -1,30 +0,0 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang="en">
<head>
<meta name="generator" content="PHPDoctor 2RC4 (http://phpdoctor.sourceforge.net/)">
<meta name="when" content="Wed, 14 Apr 2010 15:12:03 +0000">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css">
<link rel="start" href="../../../overview-summary.html">
<title>Doctrine\Common\Annotations (Doctrine)</title>
</head>
<body id="frame">
<h1><a href="package-summary.html" target="main">Doctrine\Common\Annotations</a></h1>
<h2>Classes</h2>
<ul>
<li><a href="../../../doctrine/common/annotations/annotation.html" target="main">Annotation</a></li>
<li><a href="../../../doctrine/common/annotations/annotationexception.html" target="main">AnnotationException</a></li>
<li><a href="../../../doctrine/common/annotations/annotationreader.html" target="main">AnnotationReader</a></li>
<li><a href="../../../doctrine/common/annotations/lexer.html" target="main">Lexer</a></li>
<li><a href="../../../doctrine/common/annotations/parser.html" target="main">Parser</a></li>
</ul>
</body>
</html>

69
lib/api/doctrine/common/annotations/package-functions.html
View File

@ -1,69 +0,0 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang="en">
<head>
<meta name="generator" content="PHPDoctor 2RC4 (http://phpdoctor.sourceforge.net/)">
<meta name="when" content="Wed, 14 Apr 2010 15:12:06 +0000">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css">
<link rel="start" href="../../../overview-summary.html">
<title>Functions (Doctrine)</title>
</head>
<body id="definition" onload="parent.document.title=document.title;">
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="../../../doctrine/common/annotations/package-summary.html">Package</a></li>
<li class="active">Function</li>
<li><a href="../../../overview-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../../index.html" target="_top">Frames</a>
<a href="../../../doctrine/common/annotations/package-functions.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_function">Function</a>
Detail: <a href="#detail_function">Function</a>
</div>
<hr>
<h1>Functions</h1>
<hr>
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="../../../doctrine/common/annotations/package-summary.html">Package</a></li>
<li class="active">Function</li>
<li><a href="../../../overview-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../../index.html" target="_top">Frames</a>
<a href="../../../doctrine/common/annotations/package-functions.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_function">Function</a>
Detail: <a href="#detail_function">Function</a>
</div>
<hr>
<p id="footer">This document was generated by <a href="http://peej.github.com/phpdoctor/">PHPDoctor: The PHP Documentation Creator</a></p>
</body>
</html>

69
lib/api/doctrine/common/annotations/package-globals.html
View File

@ -1,69 +0,0 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang="en">
<head>
<meta name="generator" content="PHPDoctor 2RC4 (http://phpdoctor.sourceforge.net/)">
<meta name="when" content="Wed, 14 Apr 2010 15:12:06 +0000">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css">
<link rel="start" href="../../../overview-summary.html">
<title>Globals (Doctrine)</title>
</head>
<body id="definition" onload="parent.document.title=document.title;">
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="../../../doctrine/common/annotations/package-summary.html">Package</a></li>
<li class="active">Global</li>
<li><a href="../../../overview-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../../index.html" target="_top">Frames</a>
<a href="../../../doctrine/common/annotations/package-globals.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_global">Global</a>
Detail: <a href="#detail_global">Global</a>
</div>
<hr>
<h1>Globals</h1>
<hr>
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="../../../doctrine/common/annotations/package-summary.html">Package</a></li>
<li class="active">Global</li>
<li><a href="../../../overview-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../../index.html" target="_top">Frames</a>
<a href="../../../doctrine/common/annotations/package-globals.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_global">Global</a>
Detail: <a href="#detail_global">Global</a>
</div>
<hr>
<p id="footer">This document was generated by <a href="http://peej.github.com/phpdoctor/">PHPDoctor: The PHP Documentation Creator</a></p>
</body>
</html>

68
lib/api/doctrine/common/annotations/package-summary.html
View File

@ -1,68 +0,0 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang="en">
<head>
<meta name="generator" content="PHPDoctor 2RC4 (http://phpdoctor.sourceforge.net/)">
<meta name="when" content="Wed, 14 Apr 2010 15:12:03 +0000">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css">
<link rel="start" href="../../../overview-summary.html">
<title>Doctrine\Common\Annotations (Doctrine)</title>
</head>
<body id="tree" onload="parent.document.title=document.title;">
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../../overview-summary.html">Overview</a></li>
<li class="active">Namespace</li>
<li>Class</li><li><a href="../../../doctrine/common/annotations/package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../../index.html" target="_top">Frames</a>
<a href="../../../doctrine/common/annotations/package-summary.html" target="_top">No frames</a>
</div>
<hr>
<h1>Namespace Doctrine\Common\Annotations</h1>
<table class="title">
<tr><th colspan="2" class="title">Class Summary</th></tr>
<tr><td class="name"><a href="../../../doctrine/common/annotations/annotation.html">Annotation</a></td><td class="description">Annotations class</td></tr>
<tr><td class="name"><a href="../../../doctrine/common/annotations/annotationexception.html">AnnotationException</a></td><td class="description">Description of AnnotationException</td></tr>
<tr><td class="name"><a href="../../../doctrine/common/annotations/annotationreader.html">AnnotationReader</a></td><td class="description">A reader for docblock annotations.</td></tr>
<tr><td class="name"><a href="../../../doctrine/common/annotations/lexer.html">Lexer</a></td><td class="description">Simple lexer for docblock annotations.</td></tr>
<tr><td class="name"><a href="../../../doctrine/common/annotations/parser.html">Parser</a></td><td class="description">A simple parser for docblock annotations.</td></tr>
</table>
<hr>
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../../overview-summary.html">Overview</a></li>
<li class="active">Namespace</li>
<li>Class</li><li><a href="../../../doctrine/common/annotations/package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../../index.html" target="_top">Frames</a>
<a href="../../../doctrine/common/annotations/package-summary.html" target="_top">No frames</a>
</div>
<hr>
<p id="footer">This document was generated by <a href="http://peej.github.com/phpdoctor/">PHPDoctor: The PHP Documentation Creator</a></p>
</body>
</html>

58
lib/api/doctrine/common/annotations/package-tree.html
View File

@ -1,58 +0,0 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang="en">
<head>
<meta name="generator" content="PHPDoctor 2RC4 (http://phpdoctor.sourceforge.net/)">
<meta name="when" content="Wed, 14 Apr 2010 15:12:03 +0000">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css">
<link rel="start" href="../../../overview-summary.html">
<title>Doctrine\Common\Annotations (Doctrine)</title>
</head>
<body id="tree" onload="parent.document.title=document.title;">
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="../../../doctrine/common/annotations/package-summary.html">Namespace</a></li>
<li>Class</li><li class="active">Tree</li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../../index.html" target="_top">Frames</a>
<a href="../../../doctrine/common/annotations/package-tree.html" target="_top">No frames</a>
</div>
<h1>Class Hierarchy for Package Doctrine\Common\Annotations</h1><ul>
<li><a href="../../../doctrine/common/annotations/annotation.html">Doctrine\Common\Annotations\Annotation</a></li>
<li><a href="../../../doctrine/common/annotations/annotationreader.html">Doctrine\Common\Annotations\AnnotationReader</a></li>
<li><a href="../../../doctrine/common/annotations/parser.html">Doctrine\Common\Annotations\Parser</a></li>
</ul>
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="../../../doctrine/common/annotations/package-summary.html">Namespace</a></li>
<li>Class</li><li class="active">Tree</li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../../index.html" target="_top">Frames</a>
<a href="../../../doctrine/common/annotations/package-tree.html" target="_top">No frames</a>
</div>
<hr>
<p id="footer">This document was generated by <a href="http://peej.github.com/phpdoctor/">PHPDoctor: The PHP Documentation Creator</a></p>
</body>
</html>

296
lib/api/doctrine/common/annotations/parser.html
View File

@ -1,296 +0,0 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang="en">
<head>
<meta name="generator" content="PHPDoctor 2RC4 (http://phpdoctor.sourceforge.net/)">
<meta name="when" content="Wed, 14 Apr 2010 15:12:03 +0000">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css">
<link rel="start" href="../../../overview-summary.html">
<title>Parser (Doctrine)</title>
</head>
<body id="definition" onload="parent.document.title=document.title;">
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="../../../doctrine/common/annotations/package-summary.html">Namespace</a></li>
<li class="active">Class</li>
<li><a href="../../../doctrine/common/annotations/package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../../index.html" target="_top">Frames</a>
<a href="../../../doctrine/common/annotations/parser.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>
<div class="qualifiedName">Doctrine\Common\Annotations\Parser</div>
<div class="location">/Doctrine/Common/Annotations/Parser.php at line 36</div>
<h1>Class Parser</h1>
<pre class="tree"><strong>Parser</strong><br /></pre>
<hr>
<p class="signature">public class <strong>Parser</strong></p>
<div class="comment" id="overview_description"><p>A simple parser for docblock annotations.</p></div>
<dl>
<dt>License:</dt>
<dd>http://www.opensource.org/licenses/lgpl-license.php LGPL</dd>
<dt>See Also:</dt>
<dd><code>www.doctrine-project.org</code></dd>
<dt>Since:</dt>
<dd>2.0</dd>
<dt>Version:</dt>
<dd>$Revision: 3938 $</dd>
<dt>Author:</dt>
<dd>Guilherme Blanco <guilhermeblanco@hotmail.com></dd>
<dd>Jonathan Wage <jonwage@gmail.com></dd>
<dd>Roman Borschel <roman@code-factory.org></dd>
<dd>Benjamin Eberlei <kontakt@beberlei.de></dd>
</dl>
<hr>
<table id="summary_constr">
<tr><th colspan="2">Constructor Summary</th></tr>
<tr>
<td class="description"><p class="name"><a href="#Parser()">Parser</a>()</p><p class="description">Constructs a new AnnotationParser.</p></td>
</tr>
</table>
<table id="summary_method">
<tr><th colspan="2">Method Summary</th></tr>
<tr>
<td class="type"> mixed</td>
<td class="description"><p class="name"><a href="#Annotation()">Annotation</a>()</p><p class="description">Annotation ::= "@" AnnotationName ["(" [Values] ")"]
AnnotationName ::= QualifiedName | SimpleName | AliasedName
QualifiedName ::= NameSpacePart "\" {NameSpacePart "\"}* SimpleName
AliasedName ::= Alias ":" SimpleName
NameSpacePart ::= identifier
SimpleName ::= identifier
Alias ::= identifier</p></td>
</tr>
<tr>
<td class="type"> array</td>
<td class="description"><p class="name"><a href="#Annotations()">Annotations</a>()</p><p class="description">Annotations ::= Annotation {[ "*" ]* [Annotation]}</p></td>
</tr>
<tr>
<td class="type"> array</td>
<td class="description"><p class="name"><a href="#ArrayEntry()">ArrayEntry</a>()</p><p class="description">ArrayEntry ::= Value | KeyValuePair
KeyValuePair ::= Key "=" PlainValue
Key ::= string | integer</p></td>
</tr>
<tr>
<td class="type"> array</td>
<td class="description"><p class="name"><a href="#Arrayx()">Arrayx</a>()</p><p class="description">Array ::= "{" ArrayEntry {"," ArrayEntry}* "}"</p></td>
</tr>
<tr>
<td class="type"> array</td>
<td class="description"><p class="name"><a href="#FieldAssignment()">FieldAssignment</a>()</p><p class="description">FieldAssignment ::= FieldName "=" PlainValue
FieldName ::= identifier</p></td>
</tr>
<tr>
<td class="type"> mixed</td>
<td class="description"><p class="name"><a href="#PlainValue()">PlainValue</a>()</p><p class="description">PlainValue ::= integer | string | float | boolean | Array | Annotation</p></td>
</tr>
<tr>
<td class="type"> mixed</td>
<td class="description"><p class="name"><a href="#Value()">Value</a>()</p><p class="description">Value ::= PlainValue | FieldAssignment</p></td>
</tr>
<tr>
<td class="type"> array</td>
<td class="description"><p class="name"><a href="#Values()">Values</a>()</p><p class="description">Values ::= Array | Value {"," Value}</p></td>
</tr>
<tr>
<td class="type"> bool</td>
<td class="description"><p class="name"><a href="#match()">match</a>(int|string token)</p><p class="description">Attempts to match the given token with the current lookahead token.
</p></td>
</tr>
<tr>
<td class="type"> array</td>
<td class="description"><p class="name"><a href="#parse()">parse</a>(string docBlockString, string context)</p><p class="description">Parses the given docblock string for annotations.</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#setAnnotationNamespaceAlias()">setAnnotationNamespaceAlias</a>(mixed namespace, mixed alias, $alias )</p><p class="description">Sets an alias for an annotation namespace.</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#setDefaultAnnotationNamespace()">setDefaultAnnotationNamespace</a>(mixed defaultNamespace, $defaultNamespace )</p><p class="description">Sets the default namespace that is assumed for an annotation that does not
define a namespace prefix.</p></td>
</tr>
</table>
<h2 id="detail_constr">Constructor Detail</h2>
<div class="location">/Doctrine/Common/Annotations/Parser.php at line 85</div>
<h3 id="Parser()">Parser</h3>
<code class="signature">public <strong>Parser</strong>()</code>
<div class="details">
<p>Constructs a new AnnotationParser.</p></div>
<hr>
<h2 id="detail_method">Method Detail</h2>
<div class="location">/Doctrine/Common/Annotations/Parser.php at line 224</div>
<h3 id="Annotation()">Annotation</h3>
<code class="signature">public mixed <strong>Annotation</strong>()</code>
<div class="details">
<p>Annotation ::= "@" AnnotationName ["(" [Values] ")"]
AnnotationName ::= QualifiedName | SimpleName | AliasedName
QualifiedName ::= NameSpacePart "\" {NameSpacePart "\"}* SimpleName
AliasedName ::= Alias ":" SimpleName
NameSpacePart ::= identifier
SimpleName ::= identifier
Alias ::= identifier</p><dl>
<dt>Returns:</dt>
<dd>False if it is not a valid Annotation; instance of Annotation subclass otherwise.</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/Common/Annotations/Parser.php at line 189</div>
<h3 id="Annotations()">Annotations</h3>
<code class="signature">public array <strong>Annotations</strong>()</code>
<div class="details">
<p>Annotations ::= Annotation {[ "*" ]* [Annotation]}</p></div>
<hr>
<div class="location">/Doctrine/Common/Annotations/Parser.php at line 431</div>
<h3 id="ArrayEntry()">ArrayEntry</h3>
<code class="signature">public array <strong>ArrayEntry</strong>()</code>
<div class="details">
<p>ArrayEntry ::= Value | KeyValuePair
KeyValuePair ::= Key "=" PlainValue
Key ::= string | integer</p></div>
<hr>
<div class="location">/Doctrine/Common/Annotations/Parser.php at line 398</div>
<h3 id="Arrayx()">Arrayx</h3>
<code class="signature">public array <strong>Arrayx</strong>()</code>
<div class="details">
<p>Array ::= "{" ArrayEntry {"," ArrayEntry}* "}"</p></div>
<hr>
<div class="location">/Doctrine/Common/Annotations/Parser.php at line 384</div>
<h3 id="FieldAssignment()">FieldAssignment</h3>
<code class="signature">public array <strong>FieldAssignment</strong>()</code>
<div class="details">
<p>FieldAssignment ::= FieldName "=" PlainValue
FieldName ::= identifier</p></div>
<hr>
<div class="location">/Doctrine/Common/Annotations/Parser.php at line 342</div>
<h3 id="PlainValue()">PlainValue</h3>
<code class="signature">public mixed <strong>PlainValue</strong>()</code>
<div class="details">
<p>PlainValue ::= integer | string | float | boolean | Array | Annotation</p></div>
<hr>
<div class="location">/Doctrine/Common/Annotations/Parser.php at line 326</div>
<h3 id="Value()">Value</h3>
<code class="signature">public mixed <strong>Value</strong>()</code>
<div class="details">
<p>Value ::= PlainValue | FieldAssignment</p></div>
<hr>
<div class="location">/Doctrine/Common/Annotations/Parser.php at line 284</div>
<h3 id="Values()">Values</h3>
<code class="signature">public array <strong>Values</strong>()</code>
<div class="details">
<p>Values ::= Array | Value {"," Value}</p></div>
<hr>
<div class="location">/Doctrine/Common/Annotations/Parser.php at line 147</div>
<h3 id="match()">match</h3>
<code class="signature">public bool <strong>match</strong>(int|string token)</code>
<div class="details">
<p>Attempts to match the given token with the current lookahead token.
If they match, updates the lookahead token; otherwise raises a syntax error.</p><dl>
<dt>Parameters:</dt>
<dd>token - type or value</dd>
<dt>Returns:</dt>
<dd>True if tokens match; false otherwise.</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/Common/Annotations/Parser.php at line 119</div>
<h3 id="parse()">parse</h3>
<code class="signature">public array <strong>parse</strong>(string docBlockString, string context)</code>
<div class="details">
<p>Parses the given docblock string for annotations.</p><dl>
<dt>Returns:</dt>
<dd>Array of Annotations. If no annotations are found, an empty array is returned.</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/Common/Annotations/Parser.php at line 107</div>
<h3 id="setAnnotationNamespaceAlias()">setAnnotationNamespaceAlias</h3>
<code class="signature">public void <strong>setAnnotationNamespaceAlias</strong>(mixed namespace, mixed alias, $alias )</code>
<div class="details">
<p>Sets an alias for an annotation namespace.</p></div>
<hr>
<div class="location">/Doctrine/Common/Annotations/Parser.php at line 96</div>
<h3 id="setDefaultAnnotationNamespace()">setDefaultAnnotationNamespace</h3>
<code class="signature">public void <strong>setDefaultAnnotationNamespace</strong>(mixed defaultNamespace, $defaultNamespace )</code>
<div class="details">
<p>Sets the default namespace that is assumed for an annotation that does not
define a namespace prefix.</p></div>
<hr>
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="../../../doctrine/common/annotations/package-summary.html">Namespace</a></li>
<li class="active">Class</li>
<li><a href="../../../doctrine/common/annotations/package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../../index.html" target="_top">Frames</a>
<a href="../../../doctrine/common/annotations/parser.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>
<p id="footer">This document was generated by <a href="http://peej.github.com/phpdoctor/">PHPDoctor: The PHP Documentation Creator</a></p>
</body>
</html>

239
lib/api/doctrine/common/cache/abstractcache.html vendored
View File

@ -1,239 +0,0 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang="en">
<head>
<meta name="generator" content="PHPDoctor 2RC4 (http://phpdoctor.sourceforge.net/)">
<meta name="when" content="Wed, 14 Apr 2010 15:12:03 +0000">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css">
<link rel="start" href="../../../overview-summary.html">
<title>AbstractCache (Doctrine)</title>
</head>
<body id="definition" onload="parent.document.title=document.title;">
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="../../../doctrine/common/cache/package-summary.html">Namespace</a></li>
<li class="active">Class</li>
<li><a href="../../../doctrine/common/cache/package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../../index.html" target="_top">Frames</a>
<a href="../../../doctrine/common/cache/abstractcache.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>
<div class="qualifiedName">Doctrine\Common\Cache\AbstractCache</div>
<div class="location">/Doctrine/Common/Cache/AbstractCache.php at line 35</div>
<h1>Class AbstractCache</h1>
<pre class="tree"><strong>AbstractCache</strong><br /></pre>
<hr>
<p class="signature">public abstract class <strong>AbstractCache</strong></p>
<div class="comment" id="overview_description"><p>Base class for cache driver implementations.</p></div>
<dl>
<dt>License:</dt>
<dd>http://www.opensource.org/licenses/lgpl-license.php LGPL</dd>
<dt>See Also:</dt>
<dd><code>www.doctrine-project.org</code></dd>
<dt>Since:</dt>
<dd>2.0</dd>
<dt>Version:</dt>
<dd>$Revision: 3938 $</dd>
<dt>Author:</dt>
<dd>Guilherme Blanco <guilhermeblanco@hotmail.com></dd>
<dd>Jonathan Wage <jonwage@gmail.com></dd>
<dd>Roman Borschel <roman@code-factory.org></dd>
</dl>
<hr>
<table id="summary_method">
<tr><th colspan="2">Method Summary</th></tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#contains()">contains</a>(mixed id)</p><p class="description">{@inheritdoc}</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#delete()">delete</a>(mixed id)</p><p class="description">{@inheritdoc}</p></td>
</tr>
<tr>
<td class="type"> array</td>
<td class="description"><p class="name"><a href="#deleteAll()">deleteAll</a>()</p><p class="description">Delete all cache entries.</p></td>
</tr>
<tr>
<td class="type"> array</td>
<td class="description"><p class="name"><a href="#deleteByPrefix()">deleteByPrefix</a>(string prefix)</p><p class="description">Delete cache entries where the id has the passed prefix</p></td>
</tr>
<tr>
<td class="type"> array</td>
<td class="description"><p class="name"><a href="#deleteByRegex()">deleteByRegex</a>(string regex)</p><p class="description">Delete cache entries where the id matches a PHP regular expressions</p></td>
</tr>
<tr>
<td class="type"> array</td>
<td class="description"><p class="name"><a href="#deleteBySuffix()">deleteBySuffix</a>(string suffix)</p><p class="description">Delete cache entries where the id has the passed suffix</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#fetch()">fetch</a>(mixed id)</p><p class="description">{@inheritdoc}</p></td>
</tr>
<tr>
<td class="type">abstract array</td>
<td class="description"><p class="name"><a href="#getIds()">getIds</a>()</p><p class="description">Get an array of all the cache ids stored</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#save()">save</a>(mixed id, mixed data, mixed lifeTime)</p><p class="description">{@inheritdoc}</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#setNamespace()">setNamespace</a>(string namespace)</p><p class="description">Set the namespace to prefix all cache ids with.</p></td>
</tr>
</table>
<h2 id="detail_method">Method Detail</h2>
<div class="location">/Doctrine/Common/Cache/AbstractCache.php at line 65</div>
<h3 id="contains()">contains</h3>
<code class="signature">public void <strong>contains</strong>(mixed id)</code>
<div class="details">
<p></p></div>
<hr>
<div class="location">/Doctrine/Common/Cache/AbstractCache.php at line 82</div>
<h3 id="delete()">delete</h3>
<code class="signature">public void <strong>delete</strong>(mixed id)</code>
<div class="details">
<p></p></div>
<hr>
<div class="location">/Doctrine/Common/Cache/AbstractCache.php at line 98</div>
<h3 id="deleteAll()">deleteAll</h3>
<code class="signature">public array <strong>deleteAll</strong>()</code>
<div class="details">
<p>Delete all cache entries.</p><dl>
<dt>Returns:</dt>
<dd>$deleted Array of the deleted cache ids</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/Common/Cache/AbstractCache.php at line 132</div>
<h3 id="deleteByPrefix()">deleteByPrefix</h3>
<code class="signature">public array <strong>deleteByPrefix</strong>(string prefix)</code>
<div class="details">
<p>Delete cache entries where the id has the passed prefix</p><dl>
<dt>Returns:</dt>
<dd>$deleted Array of the deleted cache ids</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/Common/Cache/AbstractCache.php at line 113</div>
<h3 id="deleteByRegex()">deleteByRegex</h3>
<code class="signature">public array <strong>deleteByRegex</strong>(string regex)</code>
<div class="details">
<p>Delete cache entries where the id matches a PHP regular expressions</p><dl>
<dt>Returns:</dt>
<dd>$deleted Array of the deleted cache ids</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/Common/Cache/AbstractCache.php at line 151</div>
<h3 id="deleteBySuffix()">deleteBySuffix</h3>
<code class="signature">public array <strong>deleteBySuffix</strong>(string suffix)</code>
<div class="details">
<p>Delete cache entries where the id has the passed suffix</p><dl>
<dt>Returns:</dt>
<dd>$deleted Array of the deleted cache ids</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/Common/Cache/AbstractCache.php at line 57</div>
<h3 id="fetch()">fetch</h3>
<code class="signature">public void <strong>fetch</strong>(mixed id)</code>
<div class="details">
<p></p></div>
<hr>
<div class="location">/Doctrine/Common/Cache/AbstractCache.php at line 218</div>
<h3 id="getIds()">getIds</h3>
<code class="signature">public abstract array <strong>getIds</strong>()</code>
<div class="details">
<p>Get an array of all the cache ids stored</p><dl>
<dt>Returns:</dt>
<dd>$ids</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/Common/Cache/AbstractCache.php at line 73</div>
<h3 id="save()">save</h3>
<code class="signature">public void <strong>save</strong>(mixed id, mixed data, mixed lifeTime)</code>
<div class="details">
<p></p></div>
<hr>
<div class="location">/Doctrine/Common/Cache/AbstractCache.php at line 49</div>
<h3 id="setNamespace()">setNamespace</h3>
<code class="signature">public void <strong>setNamespace</strong>(string namespace)</code>
<div class="details">
<p>Set the namespace to prefix all cache ids with.</p></div>
<hr>
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="../../../doctrine/common/cache/package-summary.html">Namespace</a></li>
<li class="active">Class</li>
<li><a href="../../../doctrine/common/cache/package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../../index.html" target="_top">Frames</a>
<a href="../../../doctrine/common/cache/abstractcache.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>
<p id="footer">This document was generated by <a href="http://peej.github.com/phpdoctor/">PHPDoctor: The PHP Documentation Creator</a></p>
</body>
</html>

126
lib/api/doctrine/common/cache/apccache.html vendored
View File

@ -1,126 +0,0 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang="en">
<head>
<meta name="generator" content="PHPDoctor 2RC4 (http://phpdoctor.sourceforge.net/)">
<meta name="when" content="Wed, 14 Apr 2010 15:12:03 +0000">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css">
<link rel="start" href="../../../overview-summary.html">
<title>ApcCache (Doctrine)</title>
</head>
<body id="definition" onload="parent.document.title=document.title;">
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="../../../doctrine/common/cache/package-summary.html">Namespace</a></li>
<li class="active">Class</li>
<li><a href="../../../doctrine/common/cache/package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../../index.html" target="_top">Frames</a>
<a href="../../../doctrine/common/cache/apccache.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>
<div class="qualifiedName">Doctrine\Common\Cache\ApcCache</div>
<div class="location">/Doctrine/Common/Cache/ApcCache.php at line 38</div>
<h1>Class ApcCache</h1>
<pre class="tree">Class:ApcCache - Superclass: AbstractCache
<a href="../../../doctrine/common/cache/abstractcache.html">AbstractCache</a><br> &lfloor;&nbsp;<strong>ApcCache</strong><br /></pre>
<hr>
<p class="signature">public class <strong>ApcCache</strong><br>extends <a href="../../../doctrine/common/cache/abstractcache.html">AbstractCache</a>
</p>
<div class="comment" id="overview_description"><p>APC cache driver.</p></div>
<dl>
<dt>License:</dt>
<dd>http://www.opensource.org/licenses/lgpl-license.php LGPL</dd>
<dt>See Also:</dt>
<dd><code>www.doctrine-project.org</code></dd>
<dt>Since:</dt>
<dd>2.0</dd>
<dt>Version:</dt>
<dd>$Revision$</dd>
<dt>Author:</dt>
<dd>Benjamin Eberlei <kontakt@beberlei.de></dd>
<dd>Guilherme Blanco <guilhermeblanco@hotmail.com></dd>
<dd>Jonathan Wage <jonwage@gmail.com></dd>
<dd>Roman Borschel <roman@code-factory.org></dd>
<dd>David Abdemoulaie <dave@hobodave.com></dd>
<dt>Todo:</dt>
<dd>Rename: APCCache</dd>
</dl>
<hr>
<table id="summary_method">
<tr><th colspan="2">Method Summary</th></tr>
<tr>
<td class="type"> array</td>
<td class="description"><p class="name"><a href="#getIds()">getIds</a>()</p><p class="description">{@inheritdoc}</p></td>
</tr>
</table>
<table class="inherit">
<tr><th colspan="2">Methods inherited from Doctrine\Common\Cache\AbstractCache</th></tr>
<tr><td><a href="../../../doctrine/common/cache/abstractcache.html#contains()">contains</a>, <a href="../../../doctrine/common/cache/abstractcache.html#delete()">delete</a>, <a href="../../../doctrine/common/cache/abstractcache.html#deleteAll()">deleteAll</a>, <a href="../../../doctrine/common/cache/abstractcache.html#deleteByPrefix()">deleteByPrefix</a>, <a href="../../../doctrine/common/cache/abstractcache.html#deleteByRegex()">deleteByRegex</a>, <a href="../../../doctrine/common/cache/abstractcache.html#deleteBySuffix()">deleteBySuffix</a>, <a href="../../../doctrine/common/cache/abstractcache.html#fetch()">fetch</a>, <a href="../../../doctrine/common/cache/abstractcache.html#getIds()">getIds</a>, <a href="../../../doctrine/common/cache/abstractcache.html#save()">save</a>, <a href="../../../doctrine/common/cache/abstractcache.html#setNamespace()">setNamespace</a></td></tr></table>
<h2 id="detail_method">Method Detail</h2>
<div class="location">/Doctrine/Common/Cache/ApcCache.php at line 43</div>
<h3 id="getIds()">getIds</h3>
<code class="signature">public array <strong>getIds</strong>()</code>
<div class="details">
<p></p><dl>
<dt>Returns:</dt>
<dd>$ids</dd>
</dl>
</div>
<hr>
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="../../../doctrine/common/cache/package-summary.html">Namespace</a></li>
<li class="active">Class</li>
<li><a href="../../../doctrine/common/cache/package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../../index.html" target="_top">Frames</a>
<a href="../../../doctrine/common/cache/apccache.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>
<p id="footer">This document was generated by <a href="http://peej.github.com/phpdoctor/">PHPDoctor: The PHP Documentation Creator</a></p>
</body>
</html>

124
lib/api/doctrine/common/cache/arraycache.html vendored
View File

@ -1,124 +0,0 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang="en">
<head>
<meta name="generator" content="PHPDoctor 2RC4 (http://phpdoctor.sourceforge.net/)">
<meta name="when" content="Wed, 14 Apr 2010 15:12:03 +0000">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css">
<link rel="start" href="../../../overview-summary.html">
<title>ArrayCache (Doctrine)</title>
</head>
<body id="definition" onload="parent.document.title=document.title;">
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="../../../doctrine/common/cache/package-summary.html">Namespace</a></li>
<li class="active">Class</li>
<li><a href="../../../doctrine/common/cache/package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../../index.html" target="_top">Frames</a>
<a href="../../../doctrine/common/cache/arraycache.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>
<div class="qualifiedName">Doctrine\Common\Cache\ArrayCache</div>
<div class="location">/Doctrine/Common/Cache/ArrayCache.php at line 37</div>
<h1>Class ArrayCache</h1>
<pre class="tree">Class:ArrayCache - Superclass: AbstractCache
<a href="../../../doctrine/common/cache/abstractcache.html">AbstractCache</a><br> &lfloor;&nbsp;<strong>ArrayCache</strong><br /></pre>
<hr>
<p class="signature">public class <strong>ArrayCache</strong><br>extends <a href="../../../doctrine/common/cache/abstractcache.html">AbstractCache</a>
</p>
<div class="comment" id="overview_description"><p>Array cache driver.</p></div>
<dl>
<dt>License:</dt>
<dd>http://www.opensource.org/licenses/lgpl-license.php LGPL</dd>
<dt>See Also:</dt>
<dd><code>www.doctrine-project.org</code></dd>
<dt>Since:</dt>
<dd>2.0</dd>
<dt>Version:</dt>
<dd>$Revision: 3938 $</dd>
<dt>Author:</dt>
<dd>Benjamin Eberlei <kontakt@beberlei.de></dd>
<dd>Guilherme Blanco <guilhermeblanco@hotmail.com></dd>
<dd>Jonathan Wage <jonwage@gmail.com></dd>
<dd>Roman Borschel <roman@code-factory.org></dd>
<dd>David Abdemoulaie <dave@hobodave.com></dd>
</dl>
<hr>
<table id="summary_method">
<tr><th colspan="2">Method Summary</th></tr>
<tr>
<td class="type"> array</td>
<td class="description"><p class="name"><a href="#getIds()">getIds</a>()</p><p class="description">{@inheritdoc}</p></td>
</tr>
</table>
<table class="inherit">
<tr><th colspan="2">Methods inherited from Doctrine\Common\Cache\AbstractCache</th></tr>
<tr><td><a href="../../../doctrine/common/cache/abstractcache.html#contains()">contains</a>, <a href="../../../doctrine/common/cache/abstractcache.html#delete()">delete</a>, <a href="../../../doctrine/common/cache/abstractcache.html#deleteAll()">deleteAll</a>, <a href="../../../doctrine/common/cache/abstractcache.html#deleteByPrefix()">deleteByPrefix</a>, <a href="../../../doctrine/common/cache/abstractcache.html#deleteByRegex()">deleteByRegex</a>, <a href="../../../doctrine/common/cache/abstractcache.html#deleteBySuffix()">deleteBySuffix</a>, <a href="../../../doctrine/common/cache/abstractcache.html#fetch()">fetch</a>, <a href="../../../doctrine/common/cache/abstractcache.html#getIds()">getIds</a>, <a href="../../../doctrine/common/cache/abstractcache.html#save()">save</a>, <a href="../../../doctrine/common/cache/abstractcache.html#setNamespace()">setNamespace</a></td></tr></table>
<h2 id="detail_method">Method Detail</h2>
<div class="location">/Doctrine/Common/Cache/ArrayCache.php at line 47</div>
<h3 id="getIds()">getIds</h3>
<code class="signature">public array <strong>getIds</strong>()</code>
<div class="details">
<p></p><dl>
<dt>Returns:</dt>
<dd>$ids</dd>
</dl>
</div>
<hr>
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="../../../doctrine/common/cache/package-summary.html">Namespace</a></li>
<li class="active">Class</li>
<li><a href="../../../doctrine/common/cache/package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../../index.html" target="_top">Frames</a>
<a href="../../../doctrine/common/cache/arraycache.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>
<p id="footer">This document was generated by <a href="http://peej.github.com/phpdoctor/">PHPDoctor: The PHP Documentation Creator</a></p>
</body>
</html>

174
lib/api/doctrine/common/cache/cache.html vendored
View File

@ -1,174 +0,0 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang="en">
<head>
<meta name="generator" content="PHPDoctor 2RC4 (http://phpdoctor.sourceforge.net/)">
<meta name="when" content="Wed, 14 Apr 2010 15:12:03 +0000">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css">
<link rel="start" href="../../../overview-summary.html">
<title>Cache (Doctrine)</title>
</head>
<body id="definition" onload="parent.document.title=document.title;">
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="../../../doctrine/common/cache/package-summary.html">Namespace</a></li>
<li class="active">Class</li>
<li><a href="../../../doctrine/common/cache/package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../../index.html" target="_top">Frames</a>
<a href="../../../doctrine/common/cache/cache.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>
<div class="qualifiedName">Doctrine\Common\Cache\Cache</div>
<div class="location">/Doctrine/Common/Cache/Cache.php at line 36</div>
<h1>Interface Cache</h1>
<pre class="tree"><strong>Cache</strong><br /></pre>
<hr>
<p class="signature">public interface <strong>Cache</strong></p>
<div class="comment" id="overview_description"><p>Interface for cache drivers.</p></div>
<dl>
<dt>License:</dt>
<dd>http://www.opensource.org/licenses/lgpl-license.php LGPL</dd>
<dt>See Also:</dt>
<dd><code>www.doctrine-project.org</code></dd>
<dt>Since:</dt>
<dd>2.0</dd>
<dt>Version:</dt>
<dd>$Revision: 3938 $</dd>
<dt>Author:</dt>
<dd>Benjamin Eberlei <kontakt@beberlei.de></dd>
<dd>Guilherme Blanco <guilhermeblanco@hotmail.com></dd>
<dd>Jonathan Wage <jonwage@gmail.com></dd>
<dd>Roman Borschel <roman@code-factory.org></dd>
</dl>
<hr>
<table id="summary_method">
<tr><th colspan="2">Method Summary</th></tr>
<tr>
<td class="type"> boolean</td>
<td class="description"><p class="name"><a href="#contains()">contains</a>(string id)</p><p class="description">Test if an entry exists in the cache.</p></td>
</tr>
<tr>
<td class="type"> boolean</td>
<td class="description"><p class="name"><a href="#delete()">delete</a>(string id)</p><p class="description">Deletes a cache entry.</p></td>
</tr>
<tr>
<td class="type"> string</td>
<td class="description"><p class="name"><a href="#fetch()">fetch</a>(string id)</p><p class="description">Fetches an entry from the cache.</p></td>
</tr>
<tr>
<td class="type"> boolean</td>
<td class="description"><p class="name"><a href="#save()">save</a>(string id, string data, int lifeTime)</p><p class="description">Puts data into the cache.</p></td>
</tr>
</table>
<h2 id="detail_method">Method Detail</h2>
<div class="location">/Doctrine/Common/Cache/Cache.php at line 52</div>
<h3 id="contains()">contains</h3>
<code class="signature">public boolean <strong>contains</strong>(string id)</code>
<div class="details">
<p>Test if an entry exists in the cache.</p><dl>
<dt>Parameters:</dt>
<dd>id - cache id The cache id of the entry to check for.</dd>
<dt>Returns:</dt>
<dd>TRUE if a cache entry exists for the given cache id, FALSE otherwise.</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/Common/Cache/Cache.php at line 70</div>
<h3 id="delete()">delete</h3>
<code class="signature">public boolean <strong>delete</strong>(string id)</code>
<div class="details">
<p>Deletes a cache entry.</p><dl>
<dt>Parameters:</dt>
<dd>id - cache id</dd>
<dt>Returns:</dt>
<dd>TRUE if the cache entry was successfully deleted, FALSE otherwise.</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/Common/Cache/Cache.php at line 44</div>
<h3 id="fetch()">fetch</h3>
<code class="signature">public string <strong>fetch</strong>(string id)</code>
<div class="details">
<p>Fetches an entry from the cache.</p><dl>
<dt>Parameters:</dt>
<dd>id - cache id The id of the cache entry to fetch.</dd>
<dt>Returns:</dt>
<dd>The cached data or FALSE, if no cache entry exists for the given id.</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/Common/Cache/Cache.php at line 62</div>
<h3 id="save()">save</h3>
<code class="signature">public boolean <strong>save</strong>(string id, string data, int lifeTime)</code>
<div class="details">
<p>Puts data into the cache.</p><dl>
<dt>Parameters:</dt>
<dd>id - The cache id.</dd>
<dd>data - The cache entry/data.</dd>
<dd>lifeTime - The lifetime. If != 0, sets a specific lifetime for this cache entry (0 => infinite lifeTime).</dd>
<dt>Returns:</dt>
<dd>TRUE if the entry was successfully stored in the cache, FALSE otherwise.</dd>
</dl>
</div>
<hr>
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="../../../doctrine/common/cache/package-summary.html">Namespace</a></li>
<li class="active">Class</li>
<li><a href="../../../doctrine/common/cache/package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../../index.html" target="_top">Frames</a>
<a href="../../../doctrine/common/cache/cache.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>
<p id="footer">This document was generated by <a href="http://peej.github.com/phpdoctor/">PHPDoctor: The PHP Documentation Creator</a></p>
</body>
</html>

148
lib/api/doctrine/common/cache/memcachecache.html vendored
View File

@ -1,148 +0,0 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang="en">
<head>
<meta name="generator" content="PHPDoctor 2RC4 (http://phpdoctor.sourceforge.net/)">
<meta name="when" content="Wed, 14 Apr 2010 15:12:03 +0000">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css">
<link rel="start" href="../../../overview-summary.html">
<title>MemcacheCache (Doctrine)</title>
</head>
<body id="definition" onload="parent.document.title=document.title;">
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="../../../doctrine/common/cache/package-summary.html">Namespace</a></li>
<li class="active">Class</li>
<li><a href="../../../doctrine/common/cache/package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../../index.html" target="_top">Frames</a>
<a href="../../../doctrine/common/cache/memcachecache.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>
<div class="qualifiedName">Doctrine\Common\Cache\MemcacheCache</div>
<div class="location">/Doctrine/Common/Cache/MemcacheCache.php at line 39</div>
<h1>Class MemcacheCache</h1>
<pre class="tree">Class:MemcacheCache - Superclass: AbstractCache
<a href="../../../doctrine/common/cache/abstractcache.html">AbstractCache</a><br> &lfloor;&nbsp;<strong>MemcacheCache</strong><br /></pre>
<hr>
<p class="signature">public class <strong>MemcacheCache</strong><br>extends <a href="../../../doctrine/common/cache/abstractcache.html">AbstractCache</a>
</p>
<div class="comment" id="overview_description"><p>Memcache cache driver.</p></div>
<dl>
<dt>License:</dt>
<dd>http://www.opensource.org/licenses/lgpl-license.php LGPL</dd>
<dt>See Also:</dt>
<dd><code>www.doctrine-project.org</code></dd>
<dt>Since:</dt>
<dd>2.0</dd>
<dt>Version:</dt>
<dd>$Revision: 3938 $</dd>
<dt>Author:</dt>
<dd>Benjamin Eberlei <kontakt@beberlei.de></dd>
<dd>Guilherme Blanco <guilhermeblanco@hotmail.com></dd>
<dd>Jonathan Wage <jonwage@gmail.com></dd>
<dd>Roman Borschel <roman@code-factory.org></dd>
<dd>David Abdemoulaie <dave@hobodave.com></dd>
</dl>
<hr>
<table id="summary_method">
<tr><th colspan="2">Method Summary</th></tr>
<tr>
<td class="type"> array</td>
<td class="description"><p class="name"><a href="#getIds()">getIds</a>()</p><p class="description">{@inheritdoc}</p></td>
</tr>
<tr>
<td class="type"> Memcache</td>
<td class="description"><p class="name"><a href="#getMemcache()">getMemcache</a>()</p><p class="description">Gets the memcache instance used by the cache.</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#setMemcache()">setMemcache</a>(Memcache memcache)</p><p class="description">Sets the memcache instance to use.</p></td>
</tr>
</table>
<table class="inherit">
<tr><th colspan="2">Methods inherited from Doctrine\Common\Cache\AbstractCache</th></tr>
<tr><td><a href="../../../doctrine/common/cache/abstractcache.html#contains()">contains</a>, <a href="../../../doctrine/common/cache/abstractcache.html#delete()">delete</a>, <a href="../../../doctrine/common/cache/abstractcache.html#deleteAll()">deleteAll</a>, <a href="../../../doctrine/common/cache/abstractcache.html#deleteByPrefix()">deleteByPrefix</a>, <a href="../../../doctrine/common/cache/abstractcache.html#deleteByRegex()">deleteByRegex</a>, <a href="../../../doctrine/common/cache/abstractcache.html#deleteBySuffix()">deleteBySuffix</a>, <a href="../../../doctrine/common/cache/abstractcache.html#fetch()">fetch</a>, <a href="../../../doctrine/common/cache/abstractcache.html#getIds()">getIds</a>, <a href="../../../doctrine/common/cache/abstractcache.html#save()">save</a>, <a href="../../../doctrine/common/cache/abstractcache.html#setNamespace()">setNamespace</a></td></tr></table>
<h2 id="detail_method">Method Detail</h2>
<div class="location">/Doctrine/Common/Cache/MemcacheCache.php at line 69</div>
<h3 id="getIds()">getIds</h3>
<code class="signature">public array <strong>getIds</strong>()</code>
<div class="details">
<p></p><dl>
<dt>Returns:</dt>
<dd>$ids</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/Common/Cache/MemcacheCache.php at line 61</div>
<h3 id="getMemcache()">getMemcache</h3>
<code class="signature">public Memcache <strong>getMemcache</strong>()</code>
<div class="details">
<p>Gets the memcache instance used by the cache.</p></div>
<hr>
<div class="location">/Doctrine/Common/Cache/MemcacheCache.php at line 51</div>
<h3 id="setMemcache()">setMemcache</h3>
<code class="signature">public void <strong>setMemcache</strong>(Memcache memcache)</code>
<div class="details">
<p>Sets the memcache instance to use.</p></div>
<hr>
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="../../../doctrine/common/cache/package-summary.html">Namespace</a></li>
<li class="active">Class</li>
<li><a href="../../../doctrine/common/cache/package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../../index.html" target="_top">Frames</a>
<a href="../../../doctrine/common/cache/memcachecache.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>
<p id="footer">This document was generated by <a href="http://peej.github.com/phpdoctor/">PHPDoctor: The PHP Documentation Creator</a></p>
</body>
</html>

35
lib/api/doctrine/common/cache/package-frame.html vendored
View File

@ -1,35 +0,0 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang="en">
<head>
<meta name="generator" content="PHPDoctor 2RC4 (http://phpdoctor.sourceforge.net/)">
<meta name="when" content="Wed, 14 Apr 2010 15:12:03 +0000">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css">
<link rel="start" href="../../../overview-summary.html">
<title>Doctrine\Common\Cache (Doctrine)</title>
</head>
<body id="frame">
<h1><a href="package-summary.html" target="main">Doctrine\Common\Cache</a></h1>
<h2>Classes</h2>
<ul>
<li><a href="../../../doctrine/common/cache/abstractcache.html" target="main">AbstractCache</a></li>
<li><a href="../../../doctrine/common/cache/apccache.html" target="main">ApcCache</a></li>
<li><a href="../../../doctrine/common/cache/arraycache.html" target="main">ArrayCache</a></li>
<li><a href="../../../doctrine/common/cache/memcachecache.html" target="main">MemcacheCache</a></li>
<li><a href="../../../doctrine/common/cache/xcachecache.html" target="main">XcacheCache</a></li>
</ul>
<h2>Interfaces</h2>
<ul>
<li><a href="../../../doctrine/common/cache/cache.html" target="main">Cache</a></li>
</ul>
</body>
</html>

69
lib/api/doctrine/common/cache/package-functions.html vendored
View File

@ -1,69 +0,0 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang="en">
<head>
<meta name="generator" content="PHPDoctor 2RC4 (http://phpdoctor.sourceforge.net/)">
<meta name="when" content="Wed, 14 Apr 2010 15:12:06 +0000">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css">
<link rel="start" href="../../../overview-summary.html">
<title>Functions (Doctrine)</title>
</head>
<body id="definition" onload="parent.document.title=document.title;">
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="../../../doctrine/common/cache/package-summary.html">Package</a></li>
<li class="active">Function</li>
<li><a href="../../../overview-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../../index.html" target="_top">Frames</a>
<a href="../../../doctrine/common/cache/package-functions.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_function">Function</a>
Detail: <a href="#detail_function">Function</a>
</div>
<hr>
<h1>Functions</h1>
<hr>
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="../../../doctrine/common/cache/package-summary.html">Package</a></li>
<li class="active">Function</li>
<li><a href="../../../overview-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../../index.html" target="_top">Frames</a>
<a href="../../../doctrine/common/cache/package-functions.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_function">Function</a>
Detail: <a href="#detail_function">Function</a>
</div>
<hr>
<p id="footer">This document was generated by <a href="http://peej.github.com/phpdoctor/">PHPDoctor: The PHP Documentation Creator</a></p>
</body>
</html>

69
lib/api/doctrine/common/cache/package-globals.html vendored
View File

@ -1,69 +0,0 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang="en">
<head>
<meta name="generator" content="PHPDoctor 2RC4 (http://phpdoctor.sourceforge.net/)">
<meta name="when" content="Wed, 14 Apr 2010 15:12:06 +0000">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css">
<link rel="start" href="../../../overview-summary.html">
<title>Globals (Doctrine)</title>
</head>
<body id="definition" onload="parent.document.title=document.title;">
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="../../../doctrine/common/cache/package-summary.html">Package</a></li>
<li class="active">Global</li>
<li><a href="../../../overview-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../../index.html" target="_top">Frames</a>
<a href="../../../doctrine/common/cache/package-globals.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_global">Global</a>
Detail: <a href="#detail_global">Global</a>
</div>
<hr>
<h1>Globals</h1>
<hr>
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="../../../doctrine/common/cache/package-summary.html">Package</a></li>
<li class="active">Global</li>
<li><a href="../../../overview-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../../index.html" target="_top">Frames</a>
<a href="../../../doctrine/common/cache/package-globals.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_global">Global</a>
Detail: <a href="#detail_global">Global</a>
</div>
<hr>
<p id="footer">This document was generated by <a href="http://peej.github.com/phpdoctor/">PHPDoctor: The PHP Documentation Creator</a></p>
</body>
</html>

73
lib/api/doctrine/common/cache/package-summary.html vendored
View File

@ -1,73 +0,0 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang="en">
<head>
<meta name="generator" content="PHPDoctor 2RC4 (http://phpdoctor.sourceforge.net/)">
<meta name="when" content="Wed, 14 Apr 2010 15:12:03 +0000">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css">
<link rel="start" href="../../../overview-summary.html">
<title>Doctrine\Common\Cache (Doctrine)</title>
</head>
<body id="tree" onload="parent.document.title=document.title;">
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../../overview-summary.html">Overview</a></li>
<li class="active">Namespace</li>
<li>Class</li><li><a href="../../../doctrine/common/cache/package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../../index.html" target="_top">Frames</a>
<a href="../../../doctrine/common/cache/package-summary.html" target="_top">No frames</a>
</div>
<hr>
<h1>Namespace Doctrine\Common\Cache</h1>
<table class="title">
<tr><th colspan="2" class="title">Class Summary</th></tr>
<tr><td class="name"><a href="../../../doctrine/common/cache/abstractcache.html">AbstractCache</a></td><td class="description">Base class for cache driver implementations.</td></tr>
<tr><td class="name"><a href="../../../doctrine/common/cache/apccache.html">ApcCache</a></td><td class="description">APC cache driver.</td></tr>
<tr><td class="name"><a href="../../../doctrine/common/cache/arraycache.html">ArrayCache</a></td><td class="description">Array cache driver.</td></tr>
<tr><td class="name"><a href="../../../doctrine/common/cache/memcachecache.html">MemcacheCache</a></td><td class="description">Memcache cache driver.</td></tr>
<tr><td class="name"><a href="../../../doctrine/common/cache/xcachecache.html">XcacheCache</a></td><td class="description">Xcache cache driver.</td></tr>
</table>
<table class="title">
<tr><th colspan="2" class="title">Interface Summary</th></tr>
<tr><td class="name"><a href="../../../doctrine/common/cache/cache.html">Cache</a></td><td class="description">Interface for cache drivers.</td></tr>
</table>
<hr>
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../../overview-summary.html">Overview</a></li>
<li class="active">Namespace</li>
<li>Class</li><li><a href="../../../doctrine/common/cache/package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../../index.html" target="_top">Frames</a>
<a href="../../../doctrine/common/cache/package-summary.html" target="_top">No frames</a>
</div>
<hr>
<p id="footer">This document was generated by <a href="http://peej.github.com/phpdoctor/">PHPDoctor: The PHP Documentation Creator</a></p>
</body>
</html>

62
lib/api/doctrine/common/cache/package-tree.html vendored
View File

@ -1,62 +0,0 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang="en">
<head>
<meta name="generator" content="PHPDoctor 2RC4 (http://phpdoctor.sourceforge.net/)">
<meta name="when" content="Wed, 14 Apr 2010 15:12:03 +0000">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css">
<link rel="start" href="../../../overview-summary.html">
<title>Doctrine\Common\Cache (Doctrine)</title>
</head>
<body id="tree" onload="parent.document.title=document.title;">
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="../../../doctrine/common/cache/package-summary.html">Namespace</a></li>
<li>Class</li><li class="active">Tree</li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../../index.html" target="_top">Frames</a>
<a href="../../../doctrine/common/cache/package-tree.html" target="_top">No frames</a>
</div>
<h1>Class Hierarchy for Package Doctrine\Common\Cache</h1><ul>
<li><a href="../../../doctrine/common/cache/abstractcache.html">Doctrine\Common\Cache\AbstractCache</a><ul>
<li><a href="../../../doctrine/common/cache/apccache.html">Doctrine\Common\Cache\ApcCache</a></li>
<li><a href="../../../doctrine/common/cache/arraycache.html">Doctrine\Common\Cache\ArrayCache</a></li>
<li><a href="../../../doctrine/common/cache/memcachecache.html">Doctrine\Common\Cache\MemcacheCache</a></li>
<li><a href="../../../doctrine/common/cache/xcachecache.html">Doctrine\Common\Cache\XcacheCache</a></li>
</ul>
</li>
</ul>
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="../../../doctrine/common/cache/package-summary.html">Namespace</a></li>
<li>Class</li><li class="active">Tree</li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../../index.html" target="_top">Frames</a>
<a href="../../../doctrine/common/cache/package-tree.html" target="_top">No frames</a>
</div>
<hr>
<p id="footer">This document was generated by <a href="http://peej.github.com/phpdoctor/">PHPDoctor: The PHP Documentation Creator</a></p>
</body>
</html>

124
lib/api/doctrine/common/cache/xcachecache.html vendored
View File

@ -1,124 +0,0 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang="en">
<head>
<meta name="generator" content="PHPDoctor 2RC4 (http://phpdoctor.sourceforge.net/)">
<meta name="when" content="Wed, 14 Apr 2010 15:12:03 +0000">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css">
<link rel="start" href="../../../overview-summary.html">
<title>XcacheCache (Doctrine)</title>
</head>
<body id="definition" onload="parent.document.title=document.title;">
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="../../../doctrine/common/cache/package-summary.html">Namespace</a></li>
<li class="active">Class</li>
<li><a href="../../../doctrine/common/cache/package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../../index.html" target="_top">Frames</a>
<a href="../../../doctrine/common/cache/xcachecache.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>
<div class="qualifiedName">Doctrine\Common\Cache\XcacheCache</div>
<div class="location">/Doctrine/Common/Cache/XcacheCache.php at line 37</div>
<h1>Class XcacheCache</h1>
<pre class="tree">Class:XcacheCache - Superclass: AbstractCache
<a href="../../../doctrine/common/cache/abstractcache.html">AbstractCache</a><br> &lfloor;&nbsp;<strong>XcacheCache</strong><br /></pre>
<hr>
<p class="signature">public class <strong>XcacheCache</strong><br>extends <a href="../../../doctrine/common/cache/abstractcache.html">AbstractCache</a>
</p>
<div class="comment" id="overview_description"><p>Xcache cache driver.</p></div>
<dl>
<dt>License:</dt>
<dd>http://www.opensource.org/licenses/lgpl-license.php LGPL</dd>
<dt>See Also:</dt>
<dd><code>www.doctrine-project.org</code></dd>
<dt>Since:</dt>
<dd>2.0</dd>
<dt>Version:</dt>
<dd>$Revision: 3938 $</dd>
<dt>Author:</dt>
<dd>Benjamin Eberlei <kontakt@beberlei.de></dd>
<dd>Guilherme Blanco <guilhermeblanco@hotmail.com></dd>
<dd>Jonathan Wage <jonwage@gmail.com></dd>
<dd>Roman Borschel <roman@code-factory.org></dd>
<dd>David Abdemoulaie <dave@hobodave.com></dd>
</dl>
<hr>
<table id="summary_method">
<tr><th colspan="2">Method Summary</th></tr>
<tr>
<td class="type"> array</td>
<td class="description"><p class="name"><a href="#getIds()">getIds</a>()</p><p class="description">{@inheritdoc}</p></td>
</tr>
</table>
<table class="inherit">
<tr><th colspan="2">Methods inherited from Doctrine\Common\Cache\AbstractCache</th></tr>
<tr><td><a href="../../../doctrine/common/cache/abstractcache.html#contains()">contains</a>, <a href="../../../doctrine/common/cache/abstractcache.html#delete()">delete</a>, <a href="../../../doctrine/common/cache/abstractcache.html#deleteAll()">deleteAll</a>, <a href="../../../doctrine/common/cache/abstractcache.html#deleteByPrefix()">deleteByPrefix</a>, <a href="../../../doctrine/common/cache/abstractcache.html#deleteByRegex()">deleteByRegex</a>, <a href="../../../doctrine/common/cache/abstractcache.html#deleteBySuffix()">deleteBySuffix</a>, <a href="../../../doctrine/common/cache/abstractcache.html#fetch()">fetch</a>, <a href="../../../doctrine/common/cache/abstractcache.html#getIds()">getIds</a>, <a href="../../../doctrine/common/cache/abstractcache.html#save()">save</a>, <a href="../../../doctrine/common/cache/abstractcache.html#setNamespace()">setNamespace</a></td></tr></table>
<h2 id="detail_method">Method Detail</h2>
<div class="location">/Doctrine/Common/Cache/XcacheCache.php at line 42</div>
<h3 id="getIds()">getIds</h3>
<code class="signature">public array <strong>getIds</strong>()</code>
<div class="details">
<p></p><dl>
<dt>Returns:</dt>
<dd>$ids</dd>
</dl>
</div>
<hr>
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="../../../doctrine/common/cache/package-summary.html">Namespace</a></li>
<li class="active">Class</li>
<li><a href="../../../doctrine/common/cache/package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../../index.html" target="_top">Frames</a>
<a href="../../../doctrine/common/cache/xcachecache.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>
<p id="footer">This document was generated by <a href="http://peej.github.com/phpdoctor/">PHPDoctor: The PHP Documentation Creator</a></p>
</body>
</html>

235
lib/api/doctrine/common/classloader.html
View File

@ -1,235 +0,0 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang="en">
<head>
<meta name="generator" content="PHPDoctor 2RC4 (http://phpdoctor.sourceforge.net/)">
<meta name="when" content="Wed, 14 Apr 2010 15:12:03 +0000">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css">
<link rel="start" href="../../overview-summary.html">
<title>ClassLoader (Doctrine)</title>
</head>
<body id="definition" onload="parent.document.title=document.title;">
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="../../doctrine/common/package-summary.html">Namespace</a></li>
<li class="active">Class</li>
<li><a href="../../doctrine/common/package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../index.html" target="_top">Frames</a>
<a href="../../doctrine/common/classloader.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>
<div class="qualifiedName">Doctrine\Common\ClassLoader</div>
<div class="location">/Doctrine/Common/ClassLoader.php at line 36</div>
<h1>Class ClassLoader</h1>
<pre class="tree"><strong>ClassLoader</strong><br /></pre>
<hr>
<p class="signature">public class <strong>ClassLoader</strong></p>
<div class="comment" id="overview_description"><p>A <tt>ClassLoader</tt> is an autoloader for class files that can be
installed on the SPL autoload stack. It is a class loader that loads only classes
of a specific namespace or all namespaces and is suitable for working together
with other autoloaders in the SPL autoload stack.</p><p>If no include path is configured through <code><a href="../../doctrine/common/classloader.html#setIncludePath()">setIncludePath</a></code>, a ClassLoader
relies on the PHP include_path.</p></div>
<dl>
<dt>Author:</dt>
<dd>Roman Borschel <roman@code-factory.org></dd>
<dt>Since:</dt>
<dd>2.0</dd>
</dl>
<hr>
<table id="summary_constr">
<tr><th colspan="2">Constructor Summary</th></tr>
<tr>
<td class="description"><p class="name"><a href="#ClassLoader()">ClassLoader</a>(string ns, mixed includePath)</p><p class="description">Creates a new ClassLoader that loads classes of the
specified namespace.</p></td>
</tr>
</table>
<table id="summary_method">
<tr><th colspan="2">Method Summary</th></tr>
<tr>
<td class="type"> string</td>
<td class="description"><p class="name"><a href="#getFileExtension()">getFileExtension</a>()</p><p class="description">Gets the file extension of class files in the namespace of this class loader.</p></td>
</tr>
<tr>
<td class="type"> string</td>
<td class="description"><p class="name"><a href="#getIncludePath()">getIncludePath</a>()</p><p class="description">Gets the base include path for all class files in the namespace of this class loader.</p></td>
</tr>
<tr>
<td class="type"> string</td>
<td class="description"><p class="name"><a href="#getNamespaceSeparator()">getNamespaceSeparator</a>()</p><p class="description">Gets the namespace separator used by classes in the namespace of this class loader.</p></td>
</tr>
<tr>
<td class="type"> boolean</td>
<td class="description"><p class="name"><a href="#loadClass()">loadClass</a>(mixed className, string classname)</p><p class="description">Loads the given class or interface.</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#register()">register</a>()</p><p class="description">Installs this class loader on the SPL autoload stack.</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#setFileExtension()">setFileExtension</a>(string fileExtension)</p><p class="description">Sets the file extension of class files in the namespace of this class loader.</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#setIncludePath()">setIncludePath</a>(string includePath)</p><p class="description">Sets the base include path for all class files in the namespace of this class loader.</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#setNamespaceSeparator()">setNamespaceSeparator</a>(string sep)</p><p class="description">Sets the namespace separator used by classes in the namespace of this class loader.</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#unregister()">unregister</a>()</p><p class="description">Uninstalls this class loader on the SPL autoload stack.</p></td>
</tr>
</table>
<h2 id="detail_constr">Constructor Detail</h2>
<div class="location">/Doctrine/Common/ClassLoader.php at line 49</div>
<h3 id="ClassLoader()">ClassLoader</h3>
<code class="signature">public <strong>ClassLoader</strong>(string ns, mixed includePath)</code>
<div class="details">
<p>Creates a new <tt>ClassLoader</tt> that loads classes of the
specified namespace.</p><dl>
<dt>Parameters:</dt>
<dd>ns - The namespace to use.</dd>
</dl>
</div>
<hr>
<h2 id="detail_method">Method Detail</h2>
<div class="location">/Doctrine/Common/ClassLoader.php at line 110</div>
<h3 id="getFileExtension()">getFileExtension</h3>
<code class="signature">public string <strong>getFileExtension</strong>()</code>
<div class="details">
<p>Gets the file extension of class files in the namespace of this class loader.</p></div>
<hr>
<div class="location">/Doctrine/Common/ClassLoader.php at line 90</div>
<h3 id="getIncludePath()">getIncludePath</h3>
<code class="signature">public string <strong>getIncludePath</strong>()</code>
<div class="details">
<p>Gets the base include path for all class files in the namespace of this class loader.</p></div>
<hr>
<div class="location">/Doctrine/Common/ClassLoader.php at line 70</div>
<h3 id="getNamespaceSeparator()">getNamespaceSeparator</h3>
<code class="signature">public string <strong>getNamespaceSeparator</strong>()</code>
<div class="details">
<p>Gets the namespace separator used by classes in the namespace of this class loader.</p></div>
<hr>
<div class="location">/Doctrine/Common/ClassLoader.php at line 137</div>
<h3 id="loadClass()">loadClass</h3>
<code class="signature">public boolean <strong>loadClass</strong>(mixed className, string classname)</code>
<div class="details">
<p>Loads the given class or interface.</p><dl>
<dt>Parameters:</dt>
<dd>classname - The name of the class to load.</dd>
<dt>Returns:</dt>
<dd>TRUE if the class has been successfully loaded, FALSE otherwise.</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/Common/ClassLoader.php at line 118</div>
<h3 id="register()">register</h3>
<code class="signature">public void <strong>register</strong>()</code>
<div class="details">
<p>Installs this class loader on the SPL autoload stack.</p></div>
<hr>
<div class="location">/Doctrine/Common/ClassLoader.php at line 100</div>
<h3 id="setFileExtension()">setFileExtension</h3>
<code class="signature">public void <strong>setFileExtension</strong>(string fileExtension)</code>
<div class="details">
<p>Sets the file extension of class files in the namespace of this class loader.</p></div>
<hr>
<div class="location">/Doctrine/Common/ClassLoader.php at line 80</div>
<h3 id="setIncludePath()">setIncludePath</h3>
<code class="signature">public void <strong>setIncludePath</strong>(string includePath)</code>
<div class="details">
<p>Sets the base include path for all class files in the namespace of this class loader.</p></div>
<hr>
<div class="location">/Doctrine/Common/ClassLoader.php at line 60</div>
<h3 id="setNamespaceSeparator()">setNamespaceSeparator</h3>
<code class="signature">public void <strong>setNamespaceSeparator</strong>(string sep)</code>
<div class="details">
<p>Sets the namespace separator used by classes in the namespace of this class loader.</p><dl>
<dt>Parameters:</dt>
<dd>sep - The separator to use.</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/Common/ClassLoader.php at line 126</div>
<h3 id="unregister()">unregister</h3>
<code class="signature">public void <strong>unregister</strong>()</code>
<div class="details">
<p>Uninstalls this class loader on the SPL autoload stack.</p></div>
<hr>
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="../../doctrine/common/package-summary.html">Namespace</a></li>
<li class="active">Class</li>
<li><a href="../../doctrine/common/package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../index.html" target="_top">Frames</a>
<a href="../../doctrine/common/classloader.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>
<p id="footer">This document was generated by <a href="http://peej.github.com/phpdoctor/">PHPDoctor: The PHP Documentation Creator</a></p>
</body>
</html>

567
lib/api/doctrine/common/collections/arraycollection.html
View File

@ -1,567 +0,0 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang="en">
<head>
<meta name="generator" content="PHPDoctor 2RC4 (http://phpdoctor.sourceforge.net/)">
<meta name="when" content="Wed, 14 Apr 2010 15:12:03 +0000">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css">
<link rel="start" href="../../../overview-summary.html">
<title>ArrayCollection (Doctrine)</title>
</head>
<body id="definition" onload="parent.document.title=document.title;">
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="../../../doctrine/common/collections/package-summary.html">Namespace</a></li>
<li class="active">Class</li>
<li><a href="../../../doctrine/common/collections/package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../../index.html" target="_top">Frames</a>
<a href="../../../doctrine/common/collections/arraycollection.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>
<div class="qualifiedName">Doctrine\Common\Collections\ArrayCollection</div>
<div class="location">/Doctrine/Common/Collections/ArrayCollection.php at line 38</div>
<h1>Class ArrayCollection</h1>
<pre class="tree"><strong>ArrayCollection</strong><br /></pre>
<hr>
<p class="signature">public class <strong>ArrayCollection</strong></p>
<div class="comment" id="overview_description"><p>An ArrayCollection is a Collection implementation that uses a regular PHP array
internally.</p></div>
<dl>
<dt>License:</dt>
<dd>http://www.opensource.org/licenses/lgpl-license.php LGPL</dd>
<dt>See Also:</dt>
<dd><code>www.doctrine-project.org</code></dd>
<dt>Since:</dt>
<dd>2.0</dd>
<dt>Version:</dt>
<dd>$Revision: 3938 $</dd>
<dt>Author:</dt>
<dd>Guilherme Blanco <guilhermeblanco@hotmail.com></dd>
<dd>Jonathan Wage <jonwage@gmail.com></dd>
<dd>Roman Borschel <roman@code-factory.org></dd>
</dl>
<hr>
<table id="summary_constr">
<tr><th colspan="2">Constructor Summary</th></tr>
<tr>
<td class="description"><p class="name"><a href="#ArrayCollection()">ArrayCollection</a>(array elements)</p><p class="description">Initializes a new ArrayCollection.</p></td>
</tr>
</table>
<table id="summary_method">
<tr><th colspan="2">Method Summary</th></tr>
<tr>
<td class="type"> boolean</td>
<td class="description"><p class="name"><a href="#add()">add</a>(mixed value)</p><p class="description">Adds an element to the collection.</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#clear()">clear</a>()</p><p class="description">Clears the collection.</p></td>
</tr>
<tr>
<td class="type"> boolean</td>
<td class="description"><p class="name"><a href="#contains()">contains</a>(mixed element)</p><p class="description">Checks whether the given element is contained in the collection.
</p></td>
</tr>
<tr>
<td class="type"> boolean</td>
<td class="description"><p class="name"><a href="#containsKey()">containsKey</a>(mixed key)</p><p class="description">Checks whether the collection contains a specific key/index.</p></td>
</tr>
<tr>
<td class="type"> integer</td>
<td class="description"><p class="name"><a href="#count()">count</a>()</p><p class="description">Returns the number of elements in the collection.
</p></td>
</tr>
<tr>
<td class="type"> mixed</td>
<td class="description"><p class="name"><a href="#current()">current</a>()</p><p class="description">Gets the element of the collection at the current internal iterator position.</p></td>
</tr>
<tr>
<td class="type"> boolean</td>
<td class="description"><p class="name"><a href="#exists()">exists</a>(Closure p)</p><p class="description">Tests for the existance of an element that satisfies the given predicate.</p></td>
</tr>
<tr>
<td class="type"> <a href="../../../doctrine/common/collections/collection.html">Collection</a></td>
<td class="description"><p class="name"><a href="#filter()">filter</a>(Closure p)</p><p class="description">Returns all the elements of this collection that satisfy the predicate p.
</p></td>
</tr>
<tr>
<td class="type"> mixed</td>
<td class="description"><p class="name"><a href="#first()">first</a>()</p><p class="description">Sets the internal iterator to the first element in the collection and
returns this element.</p></td>
</tr>
<tr>
<td class="type"> boolean</td>
<td class="description"><p class="name"><a href="#forAll()">forAll</a>(Closure p)</p><p class="description">Applies the given predicate p to all elements of this collection,
returning true, if the predicate yields true for all elements.</p></td>
</tr>
<tr>
<td class="type"> mixed</td>
<td class="description"><p class="name"><a href="#get()">get</a>(mixed key)</p><p class="description">Gets the element with the given key/index.</p></td>
</tr>
<tr>
<td class="type"> ArrayIterator</td>
<td class="description"><p class="name"><a href="#getIterator()">getIterator</a>()</p><p class="description">Gets an iterator for iterating over the elements in the collection.</p></td>
</tr>
<tr>
<td class="type"> array</td>
<td class="description"><p class="name"><a href="#getKeys()">getKeys</a>()</p><p class="description">Gets all keys/indexes of the collection elements.</p></td>
</tr>
<tr>
<td class="type"> array</td>
<td class="description"><p class="name"><a href="#getValues()">getValues</a>()</p><p class="description">Gets all elements.</p></td>
</tr>
<tr>
<td class="type"> mixed</td>
<td class="description"><p class="name"><a href="#indexOf()">indexOf</a>(mixed element)</p><p class="description">Searches for a given element and, if found, returns the corresponding key/index
of that element. </p></td>
</tr>
<tr>
<td class="type"> boolean</td>
<td class="description"><p class="name"><a href="#isEmpty()">isEmpty</a>()</p><p class="description">Checks whether the collection is empty.
</p></td>
</tr>
<tr>
<td class="type"> mixed</td>
<td class="description"><p class="name"><a href="#key()">key</a>()</p><p class="description">Gets the current key/index at the current internal iterator position.</p></td>
</tr>
<tr>
<td class="type"> mixed</td>
<td class="description"><p class="name"><a href="#last()">last</a>()</p><p class="description">Sets the internal iterator to the last element in the collection and
returns this element.</p></td>
</tr>
<tr>
<td class="type"> <a href="../../../doctrine/common/collections/collection.html">Collection</a></td>
<td class="description"><p class="name"><a href="#map()">map</a>(Closure func)</p><p class="description">Applies the given function to each element in the collection and returns
a new collection with the elements returned by the function.</p></td>
</tr>
<tr>
<td class="type"> mixed</td>
<td class="description"><p class="name"><a href="#next()">next</a>()</p><p class="description">Moves the internal iterator position to the next element.</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#offsetExists()">offsetExists</a>(mixed offset)</p><p class="description">ArrayAccess implementation of offsetExists()</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#offsetGet()">offsetGet</a>(mixed offset)</p><p class="description">ArrayAccess implementation of offsetGet()</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#offsetSet()">offsetSet</a>(mixed offset, mixed value)</p><p class="description">ArrayAccess implementation of offsetGet()</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#offsetUnset()">offsetUnset</a>(mixed offset)</p><p class="description">ArrayAccess implementation of offsetUnset()</p></td>
</tr>
<tr>
<td class="type"> array</td>
<td class="description"><p class="name"><a href="#partition()">partition</a>(Closure p)</p><p class="description">Partitions this collection in two collections according to a predicate.
</p></td>
</tr>
<tr>
<td class="type"> mixed</td>
<td class="description"><p class="name"><a href="#remove()">remove</a>(mixed key)</p><p class="description">Removes an element with a specific key/index from the collection.</p></td>
</tr>
<tr>
<td class="type"> boolean</td>
<td class="description"><p class="name"><a href="#removeElement()">removeElement</a>(mixed element)</p><p class="description">Removes the specified element from the collection, if it is found.</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#set()">set</a>(mixed key, mixed value)</p><p class="description">Adds/sets an element in the collection at the index / with the specified key.
</p></td>
</tr>
<tr>
<td class="type"> array</td>
<td class="description"><p class="name"><a href="#toArray()">toArray</a>()</p><p class="description">Gets the PHP array representation of this collection.</p></td>
</tr>
</table>
<h2 id="detail_constr">Constructor Detail</h2>
<div class="location">/Doctrine/Common/Collections/ArrayCollection.php at line 53</div>
<h3 id="ArrayCollection()">ArrayCollection</h3>
<code class="signature">public <strong>ArrayCollection</strong>(array elements)</code>
<div class="details">
<p>Initializes a new ArrayCollection.</p></div>
<hr>
<h2 id="detail_method">Method Detail</h2>
<div class="location">/Doctrine/Common/Collections/ArrayCollection.php at line 321</div>
<h3 id="add()">add</h3>
<code class="signature">public boolean <strong>add</strong>(mixed value)</code>
<div class="details">
<p>Adds an element to the collection.</p><dl>
<dt>Returns:</dt>
<dd>Always TRUE.</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/Common/Collections/ArrayCollection.php at line 426</div>
<h3 id="clear()">clear</h3>
<code class="signature">public void <strong>clear</strong>()</code>
<div class="details">
<p>Clears the collection.</p></div>
<hr>
<div class="location">/Doctrine/Common/Collections/ArrayCollection.php at line 223</div>
<h3 id="contains()">contains</h3>
<code class="signature">public boolean <strong>contains</strong>(mixed element)</code>
<div class="details">
<p>Checks whether the given element is contained in the collection.
Only element values are compared, not keys. The comparison of two elements
is strict, that means not only the value but also the type must match.
For objects this means reference equality.</p><dl>
<dt>Returns:</dt>
<dd>TRUE if the given element is contained in the collection, FALSE otherwise.</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/Common/Collections/ArrayCollection.php at line 208</div>
<h3 id="containsKey()">containsKey</h3>
<code class="signature">public boolean <strong>containsKey</strong>(mixed key)</code>
<div class="details">
<p>Checks whether the collection contains a specific key/index.</p><dl>
<dt>Parameters:</dt>
<dd>key - The key to check for.</dd>
<dt>Returns:</dt>
<dd>TRUE if the given key/index exists, FALSE otherwise.</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/Common/Collections/ArrayCollection.php at line 296</div>
<h3 id="count()">count</h3>
<code class="signature">public integer <strong>count</strong>()</code>
<div class="details">
<p>Returns the number of elements in the collection.</p><p>Implementation of the Countable interface.</p><dl>
<dt>Returns:</dt>
<dd>The number of elements in the collection.</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/Common/Collections/ArrayCollection.php at line 115</div>
<h3 id="current()">current</h3>
<code class="signature">public mixed <strong>current</strong>()</code>
<div class="details">
<p>Gets the element of the collection at the current internal iterator position.</p></div>
<hr>
<div class="location">/Doctrine/Common/Collections/ArrayCollection.php at line 234</div>
<h3 id="exists()">exists</h3>
<code class="signature">public boolean <strong>exists</strong>(Closure p)</code>
<div class="details">
<p>Tests for the existance of an element that satisfies the given predicate.</p><dl>
<dt>Parameters:</dt>
<dd>p - The predicate.</dd>
<dt>Returns:</dt>
<dd>TRUE if the predicate is TRUE for at least one element, FALSE otherwise.</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/Common/Collections/ArrayCollection.php at line 368</div>
<h3 id="filter()">filter</h3>
<code class="signature">public <a href="../../../doctrine/common/collections/collection.html">Collection</a> <strong>filter</strong>(Closure p)</code>
<div class="details">
<p>Returns all the elements of this collection that satisfy the predicate p.
The order of the elements is preserved.</p><dl>
<dt>Parameters:</dt>
<dd>p - The predicate used for filtering.</dd>
<dt>Returns:</dt>
<dd>A collection with the results of the filter operation.</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/Common/Collections/ArrayCollection.php at line 74</div>
<h3 id="first()">first</h3>
<code class="signature">public mixed <strong>first</strong>()</code>
<div class="details">
<p>Sets the internal iterator to the first element in the collection and
returns this element.</p></div>
<hr>
<div class="location">/Doctrine/Common/Collections/ArrayCollection.php at line 380</div>
<h3 id="forAll()">forAll</h3>
<code class="signature">public boolean <strong>forAll</strong>(Closure p)</code>
<div class="details">
<p>Applies the given predicate p to all elements of this collection,
returning true, if the predicate yields true for all elements.</p><dl>
<dt>Parameters:</dt>
<dd>p - The predicate.</dd>
<dt>Returns:</dt>
<dd>TRUE, if the predicate yields TRUE for all elements, FALSE otherwise.</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/Common/Collections/ArrayCollection.php at line 261</div>
<h3 id="get()">get</h3>
<code class="signature">public mixed <strong>get</strong>(mixed key)</code>
<div class="details">
<p>Gets the element with the given key/index.</p><dl>
<dt>Parameters:</dt>
<dd>key - The key.</dd>
<dt>Returns:</dt>
<dd>The element or NULL, if no element exists for the given key.</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/Common/Collections/ArrayCollection.php at line 344</div>
<h3 id="getIterator()">getIterator</h3>
<code class="signature">public ArrayIterator <strong>getIterator</strong>()</code>
<div class="details">
<p>Gets an iterator for iterating over the elements in the collection.</p></div>
<hr>
<div class="location">/Doctrine/Common/Collections/ArrayCollection.php at line 274</div>
<h3 id="getKeys()">getKeys</h3>
<code class="signature">public array <strong>getKeys</strong>()</code>
<div class="details">
<p>Gets all keys/indexes of the collection elements.</p></div>
<hr>
<div class="location">/Doctrine/Common/Collections/ArrayCollection.php at line 284</div>
<h3 id="getValues()">getValues</h3>
<code class="signature">public array <strong>getValues</strong>()</code>
<div class="details">
<p>Gets all elements.</p></div>
<hr>
<div class="location">/Doctrine/Common/Collections/ArrayCollection.php at line 250</div>
<h3 id="indexOf()">indexOf</h3>
<code class="signature">public mixed <strong>indexOf</strong>(mixed element)</code>
<div class="details">
<p>Searches for a given element and, if found, returns the corresponding key/index
of that element. The comparison of two elements is strict, that means not
only the value but also the type must match.
For objects this means reference equality.</p><dl>
<dt>Parameters:</dt>
<dd>element - The element to search for.</dd>
<dt>Returns:</dt>
<dd>The key/index of the element or FALSE if the element was not found.</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/Common/Collections/ArrayCollection.php at line 334</div>
<h3 id="isEmpty()">isEmpty</h3>
<code class="signature">public boolean <strong>isEmpty</strong>()</code>
<div class="details">
<p>Checks whether the collection is empty.</p><p>Note: This is preferrable over count() == 0.</p><dl>
<dt>Returns:</dt>
<dd>TRUE if the collection is empty, FALSE otherwise.</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/Common/Collections/ArrayCollection.php at line 95</div>
<h3 id="key()">key</h3>
<code class="signature">public mixed <strong>key</strong>()</code>
<div class="details">
<p>Gets the current key/index at the current internal iterator position.</p></div>
<hr>
<div class="location">/Doctrine/Common/Collections/ArrayCollection.php at line 85</div>
<h3 id="last()">last</h3>
<code class="signature">public mixed <strong>last</strong>()</code>
<div class="details">
<p>Sets the internal iterator to the last element in the collection and
returns this element.</p></div>
<hr>
<div class="location">/Doctrine/Common/Collections/ArrayCollection.php at line 356</div>
<h3 id="map()">map</h3>
<code class="signature">public <a href="../../../doctrine/common/collections/collection.html">Collection</a> <strong>map</strong>(Closure func)</code>
<div class="details">
<p>Applies the given function to each element in the collection and returns
a new collection with the elements returned by the function.</p></div>
<hr>
<div class="location">/Doctrine/Common/Collections/ArrayCollection.php at line 105</div>
<h3 id="next()">next</h3>
<code class="signature">public mixed <strong>next</strong>()</code>
<div class="details">
<p>Moves the internal iterator position to the next element.</p></div>
<hr>
<div class="location">/Doctrine/Common/Collections/ArrayCollection.php at line 163</div>
<h3 id="offsetExists()">offsetExists</h3>
<code class="signature">public void <strong>offsetExists</strong>(mixed offset)</code>
<div class="details">
<p>ArrayAccess implementation of offsetExists()</p><dl>
<dt>See Also:</dt>
<dd>containsKey()</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/Common/Collections/ArrayCollection.php at line 173</div>
<h3 id="offsetGet()">offsetGet</h3>
<code class="signature">public void <strong>offsetGet</strong>(mixed offset)</code>
<div class="details">
<p>ArrayAccess implementation of offsetGet()</p><dl>
<dt>See Also:</dt>
<dd>get()</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/Common/Collections/ArrayCollection.php at line 184</div>
<h3 id="offsetSet()">offsetSet</h3>
<code class="signature">public void <strong>offsetSet</strong>(mixed offset, mixed value)</code>
<div class="details">
<p>ArrayAccess implementation of offsetGet()</p><dl>
<dt>See Also:</dt>
<dd>add()</dd>
<dd>set()</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/Common/Collections/ArrayCollection.php at line 197</div>
<h3 id="offsetUnset()">offsetUnset</h3>
<code class="signature">public void <strong>offsetUnset</strong>(mixed offset)</code>
<div class="details">
<p>ArrayAccess implementation of offsetUnset()</p><dl>
<dt>See Also:</dt>
<dd>remove()</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/Common/Collections/ArrayCollection.php at line 400</div>
<h3 id="partition()">partition</h3>
<code class="signature">public array <strong>partition</strong>(Closure p)</code>
<div class="details">
<p>Partitions this collection in two collections according to a predicate.
Keys are preserved in the resulting collections.</p><dl>
<dt>Parameters:</dt>
<dd>p - The predicate on which to partition.</dd>
<dt>Returns:</dt>
<dd>An array with two elements. The first element contains the collection of elements where the predicate returned TRUE, the second element contains the collection of elements where the predicate returned FALSE.</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/Common/Collections/ArrayCollection.php at line 126</div>
<h3 id="remove()">remove</h3>
<code class="signature">public mixed <strong>remove</strong>(mixed key)</code>
<div class="details">
<p>Removes an element with a specific key/index from the collection.</p></div>
<hr>
<div class="location">/Doctrine/Common/Collections/ArrayCollection.php at line 144</div>
<h3 id="removeElement()">removeElement</h3>
<code class="signature">public boolean <strong>removeElement</strong>(mixed element)</code>
<div class="details">
<p>Removes the specified element from the collection, if it is found.</p></div>
<hr>
<div class="location">/Doctrine/Common/Collections/ArrayCollection.php at line 310</div>
<h3 id="set()">set</h3>
<code class="signature">public void <strong>set</strong>(mixed key, mixed value)</code>
<div class="details">
<p>Adds/sets an element in the collection at the index / with the specified key.</p><p>When the collection is a Map this is like put(key,value)/add(key,value).
When the collection is a List this is like add(position,value).</p></div>
<hr>
<div class="location">/Doctrine/Common/Collections/ArrayCollection.php at line 63</div>
<h3 id="toArray()">toArray</h3>
<code class="signature">public array <strong>toArray</strong>()</code>
<div class="details">
<p>Gets the PHP array representation of this collection.</p><dl>
<dt>Returns:</dt>
<dd>The PHP array representation of this collection.</dd>
</dl>
</div>
<hr>
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="../../../doctrine/common/collections/package-summary.html">Namespace</a></li>
<li class="active">Class</li>
<li><a href="../../../doctrine/common/collections/package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../../index.html" target="_top">Frames</a>
<a href="../../../doctrine/common/collections/arraycollection.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>
<p id="footer">This document was generated by <a href="http://peej.github.com/phpdoctor/">PHPDoctor: The PHP Documentation Creator</a></p>
</body>
</html>

485
lib/api/doctrine/common/collections/collection.html
View File

@ -1,485 +0,0 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang="en">
<head>
<meta name="generator" content="PHPDoctor 2RC4 (http://phpdoctor.sourceforge.net/)">
<meta name="when" content="Wed, 14 Apr 2010 15:12:03 +0000">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css">
<link rel="start" href="../../../overview-summary.html">
<title>Collection (Doctrine)</title>
</head>
<body id="definition" onload="parent.document.title=document.title;">
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="../../../doctrine/common/collections/package-summary.html">Namespace</a></li>
<li class="active">Class</li>
<li><a href="../../../doctrine/common/collections/package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../../index.html" target="_top">Frames</a>
<a href="../../../doctrine/common/collections/collection.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>
<div class="qualifiedName">Doctrine\Common\Collections\Collection</div>
<div class="location">/Doctrine/Common/Collections/Collection.php at line 51</div>
<h1>Interface Collection</h1>
<pre class="tree">Class:Collection - Superclass: Countable
Countable<br>&lfloor;&nbsp;<strong>Collection</strong><br /></pre>
<hr>
<p class="signature">public interface <strong>Collection</strong><br>extends Countable
</p>
<div class="comment" id="overview_description"><p>The missing (SPL) Collection/Array/OrderedMap interface.</p><p>A Collection resembles the nature of a regular PHP array. That is,
it is essentially an <b>ordered map</b> that can also be used
like a list.</p><p>A Collection has an internal iterator just like a PHP array. In addition,
a Collection can be iterated with external iterators, which is preferrable.
To use an external iterator simply use the foreach language construct to
iterate over the collection (which calls <code>getIterator()</code> internally) or
explicitly retrieve an iterator though <code>getIterator()</code> which can then be
used to iterate over the collection.
You can not rely on the internal iterator of the collection being at a certain
position unless you explicitly positioned it before. Prefer iteration with
external iterators.</p></div>
<dl>
<dt>License:</dt>
<dd>http://www.opensource.org/licenses/lgpl-license.php LGPL</dd>
<dt>See Also:</dt>
<dd><code>www.doctrine-project.org</code></dd>
<dt>Since:</dt>
<dd>2.0</dd>
<dt>Version:</dt>
<dd>$Revision: 3938 $</dd>
<dt>Author:</dt>
<dd>Guilherme Blanco <guilhermeblanco@hotmail.com></dd>
<dd>Jonathan Wage <jonwage@gmail.com></dd>
<dd>Roman Borschel <roman@code-factory.org></dd>
</dl>
<hr>
<table id="summary_method">
<tr><th colspan="2">Method Summary</th></tr>
<tr>
<td class="type"> boolean</td>
<td class="description"><p class="name"><a href="#add()">add</a>(mixed element)</p><p class="description">Adds an element at the end of the collection.</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#clear()">clear</a>()</p><p class="description">Clears the collection, removing all elements.</p></td>
</tr>
<tr>
<td class="type"> boolean</td>
<td class="description"><p class="name"><a href="#contains()">contains</a>(mixed element)</p><p class="description">Checks whether an element is contained in the collection.
</p></td>
</tr>
<tr>
<td class="type"> boolean</td>
<td class="description"><p class="name"><a href="#containsKey()">containsKey</a>(string|integer key)</p><p class="description">Checks whether the collection contains an element with the specified key/index.</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#current()">current</a>()</p><p class="description">Gets the element of the collection at the current iterator position.</p></td>
</tr>
<tr>
<td class="type"> boolean</td>
<td class="description"><p class="name"><a href="#exists()">exists</a>(Closure p)</p><p class="description">Tests for the existence of an element that satisfies the given predicate.</p></td>
</tr>
<tr>
<td class="type"> <a href="../../../doctrine/common/collections/collection.html">Collection</a></td>
<td class="description"><p class="name"><a href="#filter()">filter</a>(Closure p)</p><p class="description">Returns all the elements of this collection that satisfy the predicate p.
</p></td>
</tr>
<tr>
<td class="type"> mixed</td>
<td class="description"><p class="name"><a href="#first()">first</a>()</p><p class="description">Sets the internal iterator to the first element in the collection and
returns this element.</p></td>
</tr>
<tr>
<td class="type"> boolean</td>
<td class="description"><p class="name"><a href="#forAll()">forAll</a>(Closure p)</p><p class="description">Applies the given predicate p to all elements of this collection,
returning true, if the predicate yields true for all elements.</p></td>
</tr>
<tr>
<td class="type"> mixed</td>
<td class="description"><p class="name"><a href="#get()">get</a>(string|integer key)</p><p class="description">Gets the element at the specified key/index.</p></td>
</tr>
<tr>
<td class="type"> array</td>
<td class="description"><p class="name"><a href="#getKeys()">getKeys</a>()</p><p class="description">Gets all keys/indices of the collection.</p></td>
</tr>
<tr>
<td class="type"> array</td>
<td class="description"><p class="name"><a href="#getValues()">getValues</a>()</p><p class="description">Gets all values of the collection.</p></td>
</tr>
<tr>
<td class="type"> mixed</td>
<td class="description"><p class="name"><a href="#indexOf()">indexOf</a>(mixed element)</p><p class="description">Gets the index/key of a given element. </p></td>
</tr>
<tr>
<td class="type"> boolean</td>
<td class="description"><p class="name"><a href="#isEmpty()">isEmpty</a>()</p><p class="description">Checks whether the collection is empty (contains no elements).</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#key()">key</a>()</p><p class="description">Gets the key/index of the element at the current iterator position.</p></td>
</tr>
<tr>
<td class="type"> mixed</td>
<td class="description"><p class="name"><a href="#last()">last</a>()</p><p class="description">Sets the internal iterator to the last element in the collection and
returns this element.</p></td>
</tr>
<tr>
<td class="type"> <a href="../../../doctrine/common/collections/collection.html">Collection</a></td>
<td class="description"><p class="name"><a href="#map()">map</a>(Closure func)</p><p class="description">Applies the given function to each element in the collection and returns
a new collection with the elements returned by the function.</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#next()">next</a>()</p><p class="description">Moves the internal iterator position to the next element.</p></td>
</tr>
<tr>
<td class="type"> array</td>
<td class="description"><p class="name"><a href="#partition()">partition</a>(Closure p)</p><p class="description">Partitions this collection in two collections according to a predicate.
</p></td>
</tr>
<tr>
<td class="type"> mixed</td>
<td class="description"><p class="name"><a href="#remove()">remove</a>(string|integer key)</p><p class="description">Removes the element at the specified index from the collection.</p></td>
</tr>
<tr>
<td class="type"> mixed</td>
<td class="description"><p class="name"><a href="#removeElement()">removeElement</a>(mixed element)</p><p class="description">Removes an element from the collection.</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#set()">set</a>(string|integer key, mixed value)</p><p class="description">Sets an element in the collection at the specified key/index.</p></td>
</tr>
<tr>
<td class="type"> array</td>
<td class="description"><p class="name"><a href="#toArray()">toArray</a>()</p><p class="description">Gets a native PHP array representation of the collection.</p></td>
</tr>
</table>
<h2 id="detail_method">Method Detail</h2>
<div class="location">/Doctrine/Common/Collections/Collection.php at line 59</div>
<h3 id="add()">add</h3>
<code class="signature">public boolean <strong>add</strong>(mixed element)</code>
<div class="details">
<p>Adds an element at the end of the collection.</p><dl>
<dt>Parameters:</dt>
<dd>element - The element to add.</dd>
<dt>Returns:</dt>
<dd>Always TRUE.</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/Common/Collections/Collection.php at line 64</div>
<h3 id="clear()">clear</h3>
<code class="signature">public void <strong>clear</strong>()</code>
<div class="details">
<p>Clears the collection, removing all elements.</p></div>
<hr>
<div class="location">/Doctrine/Common/Collections/Collection.php at line 73</div>
<h3 id="contains()">contains</h3>
<code class="signature">public boolean <strong>contains</strong>(mixed element)</code>
<div class="details">
<p>Checks whether an element is contained in the collection.
This is an O(n) operation, where n is the size of the collection.</p><dl>
<dt>Parameters:</dt>
<dd>element - The element to search for.</dd>
<dt>Returns:</dt>
<dd>TRUE if the collection contains the element, FALSE otherwise.</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/Common/Collections/Collection.php at line 105</div>
<h3 id="containsKey()">containsKey</h3>
<code class="signature">public boolean <strong>containsKey</strong>(string|integer key)</code>
<div class="details">
<p>Checks whether the collection contains an element with the specified key/index.</p><dl>
<dt>Parameters:</dt>
<dd>key - The key/index to check for.</dd>
<dt>Returns:</dt>
<dd>TRUE if the collection contains an element with the specified key/index, FALSE otherwise.</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/Common/Collections/Collection.php at line 172</div>
<h3 id="current()">current</h3>
<code class="signature">public void <strong>current</strong>()</code>
<div class="details">
<p>Gets the element of the collection at the current iterator position.</p></div>
<hr>
<div class="location">/Doctrine/Common/Collections/Collection.php at line 186</div>
<h3 id="exists()">exists</h3>
<code class="signature">public boolean <strong>exists</strong>(Closure p)</code>
<div class="details">
<p>Tests for the existence of an element that satisfies the given predicate.</p><dl>
<dt>Parameters:</dt>
<dd>p - The predicate.</dd>
<dt>Returns:</dt>
<dd>TRUE if the predicate is TRUE for at least one element, FALSE otherwise.</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/Common/Collections/Collection.php at line 195</div>
<h3 id="filter()">filter</h3>
<code class="signature">public <a href="../../../doctrine/common/collections/collection.html">Collection</a> <strong>filter</strong>(Closure p)</code>
<div class="details">
<p>Returns all the elements of this collection that satisfy the predicate p.
The order of the elements is preserved.</p><dl>
<dt>Parameters:</dt>
<dd>p - The predicate used for filtering.</dd>
<dt>Returns:</dt>
<dd>A collection with the results of the filter operation.</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/Common/Collections/Collection.php at line 152</div>
<h3 id="first()">first</h3>
<code class="signature">public mixed <strong>first</strong>()</code>
<div class="details">
<p>Sets the internal iterator to the first element in the collection and
returns this element.</p></div>
<hr>
<div class="location">/Doctrine/Common/Collections/Collection.php at line 204</div>
<h3 id="forAll()">forAll</h3>
<code class="signature">public boolean <strong>forAll</strong>(Closure p)</code>
<div class="details">
<p>Applies the given predicate p to all elements of this collection,
returning true, if the predicate yields true for all elements.</p><dl>
<dt>Parameters:</dt>
<dd>p - The predicate.</dd>
<dt>Returns:</dt>
<dd>TRUE, if the predicate yields TRUE for all elements, FALSE otherwise.</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/Common/Collections/Collection.php at line 113</div>
<h3 id="get()">get</h3>
<code class="signature">public mixed <strong>get</strong>(string|integer key)</code>
<div class="details">
<p>Gets the element at the specified key/index.</p><dl>
<dt>Parameters:</dt>
<dd>key - The key/index of the element to retrieve.</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/Common/Collections/Collection.php at line 121</div>
<h3 id="getKeys()">getKeys</h3>
<code class="signature">public array <strong>getKeys</strong>()</code>
<div class="details">
<p>Gets all keys/indices of the collection.</p><dl>
<dt>Returns:</dt>
<dd>The keys/indices of the collection, in the order of the corresponding elements in the collection.</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/Common/Collections/Collection.php at line 129</div>
<h3 id="getValues()">getValues</h3>
<code class="signature">public array <strong>getValues</strong>()</code>
<div class="details">
<p>Gets all values of the collection.</p><dl>
<dt>Returns:</dt>
<dd>The values of all elements in the collection, in the order they appear in the collection.</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/Common/Collections/Collection.php at line 234</div>
<h3 id="indexOf()">indexOf</h3>
<code class="signature">public mixed <strong>indexOf</strong>(mixed element)</code>
<div class="details">
<p>Gets the index/key of a given element. The comparison of two elements is strict,
that means not only the value but also the type must match.
For objects this means reference equality.</p><dl>
<dt>Parameters:</dt>
<dd>element - The element to search for.</dd>
<dt>Returns:</dt>
<dd>The key/index of the element or FALSE if the element was not found.</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/Common/Collections/Collection.php at line 80</div>
<h3 id="isEmpty()">isEmpty</h3>
<code class="signature">public boolean <strong>isEmpty</strong>()</code>
<div class="details">
<p>Checks whether the collection is empty (contains no elements).</p><dl>
<dt>Returns:</dt>
<dd>TRUE if the collection is empty, FALSE otherwise.</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/Common/Collections/Collection.php at line 166</div>
<h3 id="key()">key</h3>
<code class="signature">public void <strong>key</strong>()</code>
<div class="details">
<p>Gets the key/index of the element at the current iterator position.</p></div>
<hr>
<div class="location">/Doctrine/Common/Collections/Collection.php at line 160</div>
<h3 id="last()">last</h3>
<code class="signature">public mixed <strong>last</strong>()</code>
<div class="details">
<p>Sets the internal iterator to the last element in the collection and
returns this element.</p></div>
<hr>
<div class="location">/Doctrine/Common/Collections/Collection.php at line 213</div>
<h3 id="map()">map</h3>
<code class="signature">public <a href="../../../doctrine/common/collections/collection.html">Collection</a> <strong>map</strong>(Closure func)</code>
<div class="details">
<p>Applies the given function to each element in the collection and returns
a new collection with the elements returned by the function.</p></div>
<hr>
<div class="location">/Doctrine/Common/Collections/Collection.php at line 178</div>
<h3 id="next()">next</h3>
<code class="signature">public void <strong>next</strong>()</code>
<div class="details">
<p>Moves the internal iterator position to the next element.</p></div>
<hr>
<div class="location">/Doctrine/Common/Collections/Collection.php at line 224</div>
<h3 id="partition()">partition</h3>
<code class="signature">public array <strong>partition</strong>(Closure p)</code>
<div class="details">
<p>Partitions this collection in two collections according to a predicate.
Keys are preserved in the resulting collections.</p><dl>
<dt>Parameters:</dt>
<dd>p - The predicate on which to partition.</dd>
<dt>Returns:</dt>
<dd>An array with two elements. The first element contains the collection of elements where the predicate returned TRUE, the second element contains the collection of elements where the predicate returned FALSE.</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/Common/Collections/Collection.php at line 88</div>
<h3 id="remove()">remove</h3>
<code class="signature">public mixed <strong>remove</strong>(string|integer key)</code>
<div class="details">
<p>Removes the element at the specified index from the collection.</p><dl>
<dt>Parameters:</dt>
<dd>key - The kex/index of the element to remove.</dd>
<dt>Returns:</dt>
<dd>The removed element or NULL, if the collection did not contain the element.</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/Common/Collections/Collection.php at line 96</div>
<h3 id="removeElement()">removeElement</h3>
<code class="signature">public mixed <strong>removeElement</strong>(mixed element)</code>
<div class="details">
<p>Removes an element from the collection.</p><dl>
<dt>Parameters:</dt>
<dd>element - The element to remove.</dd>
<dt>Returns:</dt>
<dd>The removed element or NULL, if the collection did not contain the element.</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/Common/Collections/Collection.php at line 137</div>
<h3 id="set()">set</h3>
<code class="signature">public void <strong>set</strong>(string|integer key, mixed value)</code>
<div class="details">
<p>Sets an element in the collection at the specified key/index.</p><dl>
<dt>Parameters:</dt>
<dd>key - The key/index of the element to set.</dd>
<dd>value - The element to set.</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/Common/Collections/Collection.php at line 144</div>
<h3 id="toArray()">toArray</h3>
<code class="signature">public array <strong>toArray</strong>()</code>
<div class="details">
<p>Gets a native PHP array representation of the collection.</p></div>
<hr>
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="../../../doctrine/common/collections/package-summary.html">Namespace</a></li>
<li class="active">Class</li>
<li><a href="../../../doctrine/common/collections/package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../../index.html" target="_top">Frames</a>
<a href="../../../doctrine/common/collections/collection.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>
<p id="footer">This document was generated by <a href="http://peej.github.com/phpdoctor/">PHPDoctor: The PHP Documentation Creator</a></p>
</body>
</html>

31
lib/api/doctrine/common/collections/package-frame.html
View File

@ -1,31 +0,0 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang="en">
<head>
<meta name="generator" content="PHPDoctor 2RC4 (http://phpdoctor.sourceforge.net/)">
<meta name="when" content="Wed, 14 Apr 2010 15:12:03 +0000">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css">
<link rel="start" href="../../../overview-summary.html">
<title>Doctrine\Common\Collections (Doctrine)</title>
</head>
<body id="frame">
<h1><a href="package-summary.html" target="main">Doctrine\Common\Collections</a></h1>
<h2>Classes</h2>
<ul>
<li><a href="../../../doctrine/common/collections/arraycollection.html" target="main">ArrayCollection</a></li>
</ul>
<h2>Interfaces</h2>
<ul>
<li><a href="../../../doctrine/common/collections/collection.html" target="main">Collection</a></li>
</ul>
</body>
</html>

69
lib/api/doctrine/common/collections/package-functions.html
View File

@ -1,69 +0,0 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang="en">
<head>
<meta name="generator" content="PHPDoctor 2RC4 (http://phpdoctor.sourceforge.net/)">
<meta name="when" content="Wed, 14 Apr 2010 15:12:06 +0000">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css">
<link rel="start" href="../../../overview-summary.html">
<title>Functions (Doctrine)</title>
</head>
<body id="definition" onload="parent.document.title=document.title;">
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="../../../doctrine/common/collections/package-summary.html">Package</a></li>
<li class="active">Function</li>
<li><a href="../../../overview-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../../index.html" target="_top">Frames</a>
<a href="../../../doctrine/common/collections/package-functions.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_function">Function</a>
Detail: <a href="#detail_function">Function</a>
</div>
<hr>
<h1>Functions</h1>
<hr>
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="../../../doctrine/common/collections/package-summary.html">Package</a></li>
<li class="active">Function</li>
<li><a href="../../../overview-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../../index.html" target="_top">Frames</a>
<a href="../../../doctrine/common/collections/package-functions.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_function">Function</a>
Detail: <a href="#detail_function">Function</a>
</div>
<hr>
<p id="footer">This document was generated by <a href="http://peej.github.com/phpdoctor/">PHPDoctor: The PHP Documentation Creator</a></p>
</body>
</html>

69
lib/api/doctrine/common/collections/package-globals.html
View File

@ -1,69 +0,0 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang="en">
<head>
<meta name="generator" content="PHPDoctor 2RC4 (http://phpdoctor.sourceforge.net/)">
<meta name="when" content="Wed, 14 Apr 2010 15:12:06 +0000">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css">
<link rel="start" href="../../../overview-summary.html">
<title>Globals (Doctrine)</title>
</head>
<body id="definition" onload="parent.document.title=document.title;">
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="../../../doctrine/common/collections/package-summary.html">Package</a></li>
<li class="active">Global</li>
<li><a href="../../../overview-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../../index.html" target="_top">Frames</a>
<a href="../../../doctrine/common/collections/package-globals.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_global">Global</a>
Detail: <a href="#detail_global">Global</a>
</div>
<hr>
<h1>Globals</h1>
<hr>
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="../../../doctrine/common/collections/package-summary.html">Package</a></li>
<li class="active">Global</li>
<li><a href="../../../overview-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../../index.html" target="_top">Frames</a>
<a href="../../../doctrine/common/collections/package-globals.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_global">Global</a>
Detail: <a href="#detail_global">Global</a>
</div>
<hr>
<p id="footer">This document was generated by <a href="http://peej.github.com/phpdoctor/">PHPDoctor: The PHP Documentation Creator</a></p>
</body>
</html>

71
lib/api/doctrine/common/collections/package-summary.html
View File

@ -1,71 +0,0 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang="en">
<head>
<meta name="generator" content="PHPDoctor 2RC4 (http://phpdoctor.sourceforge.net/)">
<meta name="when" content="Wed, 14 Apr 2010 15:12:03 +0000">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css">
<link rel="start" href="../../../overview-summary.html">
<title>Doctrine\Common\Collections (Doctrine)</title>
</head>
<body id="tree" onload="parent.document.title=document.title;">
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../../overview-summary.html">Overview</a></li>
<li class="active">Namespace</li>
<li>Class</li><li><a href="../../../doctrine/common/collections/package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../../index.html" target="_top">Frames</a>
<a href="../../../doctrine/common/collections/package-summary.html" target="_top">No frames</a>
</div>
<hr>
<h1>Namespace Doctrine\Common\Collections</h1>
<table class="title">
<tr><th colspan="2" class="title">Class Summary</th></tr>
<tr><td class="name"><a href="../../../doctrine/common/collections/arraycollection.html">ArrayCollection</a></td><td class="description">An ArrayCollection is a Collection implementation that uses a regular PHP array
internally.</td></tr>
</table>
<table class="title">
<tr><th colspan="2" class="title">Interface Summary</th></tr>
<tr><td class="name"><a href="../../../doctrine/common/collections/collection.html">Collection</a></td><td class="description">The missing (SPL) Collection/Array/OrderedMap interface.
</td></tr>
</table>
<hr>
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../../overview-summary.html">Overview</a></li>
<li class="active">Namespace</li>
<li>Class</li><li><a href="../../../doctrine/common/collections/package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../../index.html" target="_top">Frames</a>
<a href="../../../doctrine/common/collections/package-summary.html" target="_top">No frames</a>
</div>
<hr>
<p id="footer">This document was generated by <a href="http://peej.github.com/phpdoctor/">PHPDoctor: The PHP Documentation Creator</a></p>
</body>
</html>

56
lib/api/doctrine/common/collections/package-tree.html
View File

@ -1,56 +0,0 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang="en">
<head>
<meta name="generator" content="PHPDoctor 2RC4 (http://phpdoctor.sourceforge.net/)">
<meta name="when" content="Wed, 14 Apr 2010 15:12:03 +0000">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css">
<link rel="start" href="../../../overview-summary.html">
<title>Doctrine\Common\Collections (Doctrine)</title>
</head>
<body id="tree" onload="parent.document.title=document.title;">
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="../../../doctrine/common/collections/package-summary.html">Namespace</a></li>
<li>Class</li><li class="active">Tree</li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../../index.html" target="_top">Frames</a>
<a href="../../../doctrine/common/collections/package-tree.html" target="_top">No frames</a>
</div>
<h1>Class Hierarchy for Package Doctrine\Common\Collections</h1><ul>
<li><a href="../../../doctrine/common/collections/arraycollection.html">Doctrine\Common\Collections\ArrayCollection</a></li>
</ul>
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="../../../doctrine/common/collections/package-summary.html">Namespace</a></li>
<li>Class</li><li class="active">Tree</li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../../index.html" target="_top">Frames</a>
<a href="../../../doctrine/common/collections/package-tree.html" target="_top">No frames</a>
</div>
<hr>
<p id="footer">This document was generated by <a href="http://peej.github.com/phpdoctor/">PHPDoctor: The PHP Documentation Creator</a></p>
</body>
</html>

87
lib/api/doctrine/common/commonexception.html
View File

@ -1,87 +0,0 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang="en">
<head>
<meta name="generator" content="PHPDoctor 2RC4 (http://phpdoctor.sourceforge.net/)">
<meta name="when" content="Wed, 14 Apr 2010 15:12:03 +0000">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css">
<link rel="start" href="../../overview-summary.html">
<title>CommonException (Doctrine)</title>
</head>
<body id="definition" onload="parent.document.title=document.title;">
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="../../doctrine/common/package-summary.html">Namespace</a></li>
<li class="active">Class</li>
<li><a href="../../doctrine/common/package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../index.html" target="_top">Frames</a>
<a href="../../doctrine/common/commonexception.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>
<div class="qualifiedName">Doctrine\Common\CommonException</div>
<div class="location">/Doctrine/Common/CommonException.php at line 10</div>
<h1>Class CommonException</h1>
<pre class="tree">Class:CommonException - Superclass: Exception
Exception<br>&lfloor;&nbsp;<strong>CommonException</strong><br /></pre>
<hr>
<p class="signature">public class <strong>CommonException</strong><br>extends Exception
</p>
<div class="comment" id="overview_description"><p>Base exception class for package Doctrine\Common</p></div>
<dl>
<dt>Author:</dt>
<dd>heinrich /</dd>
</dl>
<hr>
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="../../doctrine/common/package-summary.html">Namespace</a></li>
<li class="active">Class</li>
<li><a href="../../doctrine/common/package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../index.html" target="_top">Frames</a>
<a href="../../doctrine/common/commonexception.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>
<p id="footer">This document was generated by <a href="http://peej.github.com/phpdoctor/">PHPDoctor: The PHP Documentation Creator</a></p>
</body>
</html>

122
lib/api/doctrine/common/eventargs.html
View File

@ -1,122 +0,0 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang="en">
<head>
<meta name="generator" content="PHPDoctor 2RC4 (http://phpdoctor.sourceforge.net/)">
<meta name="when" content="Wed, 14 Apr 2010 15:12:03 +0000">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css">
<link rel="start" href="../../overview-summary.html">
<title>EventArgs (Doctrine)</title>
</head>
<body id="definition" onload="parent.document.title=document.title;">
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="../../doctrine/common/package-summary.html">Namespace</a></li>
<li class="active">Class</li>
<li><a href="../../doctrine/common/package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../index.html" target="_top">Frames</a>
<a href="../../doctrine/common/eventargs.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>
<div class="qualifiedName">Doctrine\Common\EventArgs</div>
<div class="location">/Doctrine/Common/EventArgs.php at line 39</div>
<h1>Class EventArgs</h1>
<pre class="tree"><strong>EventArgs</strong><br /></pre>
<hr>
<p class="signature">public class <strong>EventArgs</strong></p>
<div class="comment" id="overview_description"><p>EventArgs is the base class for classes containing event data.</p><p>This class contains no event data. It is used by events that do not pass state
information to an event handler when an event is raised. The single empty EventArgs
instance can be obtained through <code><a href="../../doctrine/common/eventargs.html#getEmptyInstance()">getEmptyInstance</a></code>.</p></div>
<dl>
<dt>License:</dt>
<dd>http://www.opensource.org/licenses/lgpl-license.php LGPL</dd>
<dt>See Also:</dt>
<dd><code>www.doctrine-project.org</code></dd>
<dt>Since:</dt>
<dd>2.0</dd>
<dt>Version:</dt>
<dd>$Revision: 3938 $</dd>
<dt>Author:</dt>
<dd>Guilherme Blanco <guilhermeblanco@hotmail.com></dd>
<dd>Jonathan Wage <jonwage@gmail.com></dd>
<dd>Roman Borschel <roman@code-factory.org></dd>
</dl>
<hr>
<table id="summary_method">
<tr><th colspan="2">Method Summary</th></tr>
<tr>
<td class="type">static <a href="../../doctrine/common/eventargs.html">EventArgs</a></td>
<td class="description"><p class="name"><a href="#getEmptyInstance()">getEmptyInstance</a>()</p><p class="description">Gets the single, empty and immutable EventArgs instance.
</p></td>
</tr>
</table>
<h2 id="detail_method">Method Detail</h2>
<div class="location">/Doctrine/Common/EventArgs.php at line 61</div>
<h3 id="getEmptyInstance()">getEmptyInstance</h3>
<code class="signature">public static <a href="../../doctrine/common/eventargs.html">EventArgs</a> <strong>getEmptyInstance</strong>()</code>
<div class="details">
<p>Gets the single, empty and immutable EventArgs instance.</p><p>This instance will be used when events are dispatched without any parameter,
like this: EventManager::dispatchEvent('eventname');</p><p>The benefit from this is that only one empty instance is instantiated and shared
(otherwise there would be instances for every dispatched in the abovementioned form)</p><dl>
<dt>See Also:</dt>
<dd>EventManager::dispatchEvent</dd>
<dt>See Also:</dt>
<dd><code><a href="http://msdn.microsoft.com/en-us/library/system.eventargs.aspx">http://msdn.microsoft.com/en-us/library/system.eventargs.aspx</a></code></dd>
</dl>
</div>
<hr>
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="../../doctrine/common/package-summary.html">Namespace</a></li>
<li class="active">Class</li>
<li><a href="../../doctrine/common/package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../index.html" target="_top">Frames</a>
<a href="../../doctrine/common/eventargs.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>
<p id="footer">This document was generated by <a href="http://peej.github.com/phpdoctor/">PHPDoctor: The PHP Documentation Creator</a></p>
</body>
</html>

198
lib/api/doctrine/common/eventmanager.html
View File

@ -1,198 +0,0 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang="en">
<head>
<meta name="generator" content="PHPDoctor 2RC4 (http://phpdoctor.sourceforge.net/)">
<meta name="when" content="Wed, 14 Apr 2010 15:12:03 +0000">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css">
<link rel="start" href="../../overview-summary.html">
<title>EventManager (Doctrine)</title>
</head>
<body id="definition" onload="parent.document.title=document.title;">
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="../../doctrine/common/package-summary.html">Namespace</a></li>
<li class="active">Class</li>
<li><a href="../../doctrine/common/package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../index.html" target="_top">Frames</a>
<a href="../../doctrine/common/eventmanager.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>
<div class="qualifiedName">Doctrine\Common\EventManager</div>
<div class="location">/Doctrine/Common/EventManager.php at line 39</div>
<h1>Class EventManager</h1>
<pre class="tree"><strong>EventManager</strong><br /></pre>
<hr>
<p class="signature">public class <strong>EventManager</strong></p>
<div class="comment" id="overview_description"><p>The EventManager is the central point of Doctrine's event listener system.
Listeners are registered on the manager and events are dispatched through the
manager.</p></div>
<dl>
<dt>License:</dt>
<dd>http://www.opensource.org/licenses/lgpl-license.php LGPL</dd>
<dt>See Also:</dt>
<dd><code>www.doctrine-project.org</code></dd>
<dt>Since:</dt>
<dd>2.0</dd>
<dt>Version:</dt>
<dd>$Revision: 3938 $</dd>
<dt>Author:</dt>
<dd>Guilherme Blanco <guilhermeblanco@hotmail.com></dd>
<dd>Jonathan Wage <jonwage@gmail.com></dd>
<dd>Roman Borschel <roman@code-factory.org></dd>
</dl>
<hr>
<table id="summary_method">
<tr><th colspan="2">Method Summary</th></tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#addEventListener()">addEventListener</a>(string|array events, object listener)</p><p class="description">Adds an event listener that listens on the specified events.</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#addEventSubscriber()">addEventSubscriber</a>(Doctrine\Common\EventSubscriber subscriber)</p><p class="description">Adds an EventSubscriber. </p></td>
</tr>
<tr>
<td class="type"> boolean</td>
<td class="description"><p class="name"><a href="#dispatchEvent()">dispatchEvent</a>(string eventName, <a href="../../doctrine/common/eventargs.html">EventArgs</a> eventArgs)</p><p class="description">Dispatches an event to all registered listeners.</p></td>
</tr>
<tr>
<td class="type"> array</td>
<td class="description"><p class="name"><a href="#getListeners()">getListeners</a>(string event)</p><p class="description">Gets the listeners of a specific event or all listeners.</p></td>
</tr>
<tr>
<td class="type"> boolean</td>
<td class="description"><p class="name"><a href="#hasListeners()">hasListeners</a>(string event)</p><p class="description">Checks whether an event has any registered listeners.</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#removeEventListener()">removeEventListener</a>(string|array events, object listener)</p><p class="description">Removes an event listener from the specified events.</p></td>
</tr>
</table>
<h2 id="detail_method">Method Detail</h2>
<div class="location">/Doctrine/Common/EventManager.php at line 97</div>
<h3 id="addEventListener()">addEventListener</h3>
<code class="signature">public void <strong>addEventListener</strong>(string|array events, object listener)</code>
<div class="details">
<p>Adds an event listener that listens on the specified events.</p><dl>
<dt>Parameters:</dt>
<dd>events - The event(s) to listen on.</dd>
<dd>listener - The listener object.</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/Common/EventManager.php at line 134</div>
<h3 id="addEventSubscriber()">addEventSubscriber</h3>
<code class="signature">public void <strong>addEventSubscriber</strong>(Doctrine\Common\EventSubscriber subscriber)</code>
<div class="details">
<p>Adds an EventSubscriber. The subscriber is asked for all the events he is
interested in and added as a listener for these events.</p><dl>
<dt>Parameters:</dt>
<dd>subscriber - The subscriber.</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/Common/EventManager.php at line 58</div>
<h3 id="dispatchEvent()">dispatchEvent</h3>
<code class="signature">public boolean <strong>dispatchEvent</strong>(string eventName, <a href="../../doctrine/common/eventargs.html">EventArgs</a> eventArgs)</code>
<div class="details">
<p>Dispatches an event to all registered listeners.</p><dl>
<dt>Parameters:</dt>
<dd>eventName - The name of the event to dispatch. The name of the event is the name of the method that is invoked on listeners.</dd>
<dd>eventArgs - The event arguments to pass to the event handlers/listeners. If not supplied, the single empty EventArgs instance is used.</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/Common/EventManager.php at line 75</div>
<h3 id="getListeners()">getListeners</h3>
<code class="signature">public array <strong>getListeners</strong>(string event)</code>
<div class="details">
<p>Gets the listeners of a specific event or all listeners.</p><dl>
<dt>Parameters:</dt>
<dd>event - The name of the event.</dd>
<dt>Returns:</dt>
<dd>The event listeners for the specified event, or all event listeners.</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/Common/EventManager.php at line 86</div>
<h3 id="hasListeners()">hasListeners</h3>
<code class="signature">public boolean <strong>hasListeners</strong>(string event)</code>
<div class="details">
<p>Checks whether an event has any registered listeners.</p><dl>
<dt>Returns:</dt>
<dd>TRUE if the specified event has any listeners, FALSE otherwise.</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/Common/EventManager.php at line 115</div>
<h3 id="removeEventListener()">removeEventListener</h3>
<code class="signature">public void <strong>removeEventListener</strong>(string|array events, object listener)</code>
<div class="details">
<p>Removes an event listener from the specified events.</p></div>
<hr>
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="../../doctrine/common/package-summary.html">Namespace</a></li>
<li class="active">Class</li>
<li><a href="../../doctrine/common/package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../index.html" target="_top">Frames</a>
<a href="../../doctrine/common/eventmanager.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>
<p id="footer">This document was generated by <a href="http://peej.github.com/phpdoctor/">PHPDoctor: The PHP Documentation Creator</a></p>
</body>
</html>

112
lib/api/doctrine/common/eventsubscriber.html
View File

@ -1,112 +0,0 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang="en">
<head>
<meta name="generator" content="PHPDoctor 2RC4 (http://phpdoctor.sourceforge.net/)">
<meta name="when" content="Wed, 14 Apr 2010 15:12:03 +0000">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css">
<link rel="start" href="../../overview-summary.html">
<title>EventSubscriber (Doctrine)</title>
</head>
<body id="definition" onload="parent.document.title=document.title;">
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="../../doctrine/common/package-summary.html">Namespace</a></li>
<li class="active">Class</li>
<li><a href="../../doctrine/common/package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../index.html" target="_top">Frames</a>
<a href="../../doctrine/common/eventsubscriber.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>
<div class="qualifiedName">Doctrine\Common\EventSubscriber</div>
<div class="location">/Doctrine/Common/EventSubscriber.php at line 37</div>
<h1>Interface EventSubscriber</h1>
<pre class="tree"><strong>EventSubscriber</strong><br /></pre>
<hr>
<p class="signature">public interface <strong>EventSubscriber</strong></p>
<div class="comment" id="overview_description"><p>An EventSubscriber knows himself what events he is interested in.
If an EventSubscriber is added to an EventManager, the manager invokes
<code><a href="../../doctrine/common/eventsubscriber.html#getSubscribedEvents()">getSubscribedEvents</a></code> and registers the subscriber as a listener for all
returned events.</p></div>
<dl>
<dt>License:</dt>
<dd>http://www.opensource.org/licenses/lgpl-license.php LGPL</dd>
<dt>See Also:</dt>
<dd><code>www.doctrine-project.org</code></dd>
<dt>Since:</dt>
<dd>2.0</dd>
<dt>Author:</dt>
<dd>Guilherme Blanco <guilhermeblanco@hotmail.com></dd>
<dd>Jonathan Wage <jonwage@gmail.com></dd>
<dd>Roman Borschel <roman@code-factory.org></dd>
</dl>
<hr>
<table id="summary_method">
<tr><th colspan="2">Method Summary</th></tr>
<tr>
<td class="type"> array</td>
<td class="description"><p class="name"><a href="#getSubscribedEvents()">getSubscribedEvents</a>()</p><p class="description">Returns an array of events this subscriber wants to listen to.</p></td>
</tr>
</table>
<h2 id="detail_method">Method Detail</h2>
<div class="location">/Doctrine/Common/EventSubscriber.php at line 44</div>
<h3 id="getSubscribedEvents()">getSubscribedEvents</h3>
<code class="signature">public array <strong>getSubscribedEvents</strong>()</code>
<div class="details">
<p>Returns an array of events this subscriber wants to listen to.</p></div>
<hr>
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="../../doctrine/common/package-summary.html">Namespace</a></li>
<li class="active">Class</li>
<li><a href="../../doctrine/common/package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../index.html" target="_top">Frames</a>
<a href="../../doctrine/common/eventsubscriber.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>
<p id="footer">This document was generated by <a href="http://peej.github.com/phpdoctor/">PHPDoctor: The PHP Documentation Creator</a></p>
</body>
</html>

313
lib/api/doctrine/common/lexer.html
View File

@ -1,313 +0,0 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang="en">
<head>
<meta name="generator" content="PHPDoctor 2RC4 (http://phpdoctor.sourceforge.net/)">
<meta name="when" content="Wed, 14 Apr 2010 15:12:03 +0000">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css">
<link rel="start" href="../../overview-summary.html">
<title>Lexer (Doctrine)</title>
</head>
<body id="definition" onload="parent.document.title=document.title;">
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="../../doctrine/common/package-summary.html">Namespace</a></li>
<li class="active">Class</li>
<li><a href="../../doctrine/common/package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../index.html" target="_top">Frames</a>
<a href="../../doctrine/common/lexer.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>
<div class="qualifiedName">Doctrine\Common\Lexer</div>
<div class="location">/Doctrine/Common/Lexer.php at line 35</div>
<h1>Class Lexer</h1>
<pre class="tree"><strong>Lexer</strong><br /></pre>
<hr>
<p class="signature">public abstract class <strong>Lexer</strong></p>
<div class="comment" id="overview_description"><p>Simple generic lexical scanner.</p></div>
<dl>
<dt>License:</dt>
<dd>http://www.opensource.org/licenses/lgpl-license.php LGPL</dd>
<dt>See Also:</dt>
<dd><code>www.doctrine-project.org</code></dd>
<dt>Since:</dt>
<dd>2.0</dd>
<dt>Version:</dt>
<dd>$Revision: 3938 $</dd>
<dt>Author:</dt>
<dd>Guilherme Blanco <guilhermeblanco@hotmail.com></dd>
<dd>Jonathan Wage <jonwage@gmail.com></dd>
<dd>Roman Borschel <roman@code-factory.org></dd>
</dl>
<hr>
<table id="summary_field">
<tr><th colspan="2">Field Summary</th></tr>
<tr>
<td class="type"> array The next token in the query string.</td>
<td class="description"><p class="name"><a href="#lookahead">$lookahead</a></p><p class="description"></p></td>
</tr>
<tr>
<td class="type"> array The last matched/seen token.</td>
<td class="description"><p class="name"><a href="#token">$token</a></p><p class="description"></p></td>
</tr>
</table>
<table id="summary_method">
<tr><th colspan="2">Method Summary</th></tr>
<tr>
<td class="type">protected abstract array</td>
<td class="description"><p class="name"><a href="#getCatchablePatterns()">getCatchablePatterns</a>()</p><p class="description">Lexical catchable patterns</p></td>
</tr>
<tr>
<td class="type"> string</td>
<td class="description"><p class="name"><a href="#getLiteral()">getLiteral</a>(integer token)</p><p class="description">Gets the literal for a given token.</p></td>
</tr>
<tr>
<td class="type">protected abstract array</td>
<td class="description"><p class="name"><a href="#getNonCatchablePatterns()">getNonCatchablePatterns</a>()</p><p class="description">Lexical non-catchable patterns</p></td>
</tr>
<tr>
<td class="type"> array|null</td>
<td class="description"><p class="name"><a href="#glimpse()">glimpse</a>()</p><p class="description">Peeks at the next token, returns it and immediately resets the peek.</p></td>
</tr>
<tr>
<td class="type"> boolean</td>
<td class="description"><p class="name"><a href="#isA()">isA</a>(mixed value, integer token)</p><p class="description">Checks if given value is identical to the given token</p></td>
</tr>
<tr>
<td class="type"> boolean</td>
<td class="description"><p class="name"><a href="#isNextToken()">isNextToken</a>(integer|string token)</p><p class="description">Checks whether a given token matches the current lookahead.</p></td>
</tr>
<tr>
<td class="type"> array|null</td>
<td class="description"><p class="name"><a href="#moveNext()">moveNext</a>()</p><p class="description">Moves to the next token in the input string.
</p></td>
</tr>
<tr>
<td class="type"> array</td>
<td class="description"><p class="name"><a href="#peek()">peek</a>()</p><p class="description">Moves the lookahead token forward.</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#reset()">reset</a>()</p><p class="description">Resets the scanner</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#resetPeek()">resetPeek</a>()</p><p class="description">Resets the peek pointer to 0</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#resetPosition()">resetPosition</a>(integer position)</p><p class="description">Resets the lexer position on the input to the given position</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#setInput()">setInput</a>(string input)</p><p class="description">Inputs data to be tokenized</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#skipUntil()">skipUntil</a>(mixed type, $type The)</p><p class="description">Tells the lexer to skip input tokens until it sees a token with the given value.</p></td>
</tr>
</table>
<h2 id="detail_field">Field Detail</h2>
<div class="location">/Doctrine/Common/Lexer.php at line 55</div>
<h3 id="lookahead">lookahead</h3>
<code class="signature">public array The next token in the query string. <strong>$lookahead</strong></code>
<div class="details">
<p></p></div>
<hr>
<div class="location">/Doctrine/Common/Lexer.php at line 60</div>
<h3 id="token">token</h3>
<code class="signature">public array The last matched/seen token. <strong>$token</strong></code>
<div class="details">
<p></p></div>
<hr>
<h2 id="detail_method">Method Detail</h2>
<div class="location">/Doctrine/Common/Lexer.php at line 242</div>
<h3 id="getCatchablePatterns()">getCatchablePatterns</h3>
<code class="signature">protected abstract array <strong>getCatchablePatterns</strong>()</code>
<div class="details">
<p>Lexical catchable patterns</p></div>
<hr>
<div class="location">/Doctrine/Common/Lexer.php at line 222</div>
<h3 id="getLiteral()">getLiteral</h3>
<code class="signature">public string <strong>getLiteral</strong>(integer token)</code>
<div class="details">
<p>Gets the literal for a given token.</p></div>
<hr>
<div class="location">/Doctrine/Common/Lexer.php at line 249</div>
<h3 id="getNonCatchablePatterns()">getNonCatchablePatterns</h3>
<code class="signature">protected abstract array <strong>getNonCatchablePatterns</strong>()</code>
<div class="details">
<p>Lexical non-catchable patterns</p></div>
<hr>
<div class="location">/Doctrine/Common/Lexer.php at line 180</div>
<h3 id="glimpse()">glimpse</h3>
<code class="signature">public array|null <strong>glimpse</strong>()</code>
<div class="details">
<p>Peeks at the next token, returns it and immediately resets the peek.</p><dl>
<dt>Returns:</dt>
<dd>The next token or NULL if there are no more tokens ahead.</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/Common/Lexer.php at line 156</div>
<h3 id="isA()">isA</h3>
<code class="signature">public boolean <strong>isA</strong>(mixed value, integer token)</code>
<div class="details">
<p>Checks if given value is identical to the given token</p></div>
<hr>
<div class="location">/Doctrine/Common/Lexer.php at line 111</div>
<h3 id="isNextToken()">isNextToken</h3>
<code class="signature">public boolean <strong>isNextToken</strong>(integer|string token)</code>
<div class="details">
<p>Checks whether a given token matches the current lookahead.</p></div>
<hr>
<div class="location">/Doctrine/Common/Lexer.php at line 127</div>
<h3 id="moveNext()">moveNext</h3>
<code class="signature">public array|null <strong>moveNext</strong>()</code>
<div class="details">
<p>Moves to the next token in the input string.</p><p>A token is an associative array containing three items:
- 'value' : the string value of the token in the input string
- 'type' : the type of the token (identifier, numeric, string, input
parameter, none)
- 'position' : the position of the token in the input string</p><dl>
<dt>Returns:</dt>
<dd>the next token; null if there is no more tokens left</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/Common/Lexer.php at line 166</div>
<h3 id="peek()">peek</h3>
<code class="signature">public array <strong>peek</strong>()</code>
<div class="details">
<p>Moves the lookahead token forward.</p><dl>
<dt>Returns:</dt>
<dd>| null The next token or NULL if there are no more tokens ahead.</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/Common/Lexer.php at line 78</div>
<h3 id="reset()">reset</h3>
<code class="signature">public void <strong>reset</strong>()</code>
<div class="details">
<p>Resets the scanner</p></div>
<hr>
<div class="location">/Doctrine/Common/Lexer.php at line 90</div>
<h3 id="resetPeek()">resetPeek</h3>
<code class="signature">public void <strong>resetPeek</strong>()</code>
<div class="details">
<p>Resets the peek pointer to 0</p></div>
<hr>
<div class="location">/Doctrine/Common/Lexer.php at line 100</div>
<h3 id="resetPosition()">resetPosition</h3>
<code class="signature">public void <strong>resetPosition</strong>(integer position)</code>
<div class="details">
<p>Resets the lexer position on the input to the given position</p><dl>
<dt>Parameters:</dt>
<dd>position - Position to place the lexical scanner</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/Common/Lexer.php at line 67</div>
<h3 id="setInput()">setInput</h3>
<code class="signature">public void <strong>setInput</strong>(string input)</code>
<div class="details">
<p>Inputs data to be tokenized</p><dl>
<dt>Parameters:</dt>
<dd>input - input to be tokenized</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/Common/Lexer.php at line 142</div>
<h3 id="skipUntil()">skipUntil</h3>
<code class="signature">public void <strong>skipUntil</strong>(mixed type, $type The)</code>
<div class="details">
<p>Tells the lexer to skip input tokens until it sees a token with the given value.</p><dl>
<dt>Parameters:</dt>
<dd>The - token type to skip until.</dd>
</dl>
</div>
<hr>
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="../../doctrine/common/package-summary.html">Namespace</a></li>
<li class="active">Class</li>
<li><a href="../../doctrine/common/package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../index.html" target="_top">Frames</a>
<a href="../../doctrine/common/lexer.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>
<p id="footer">This document was generated by <a href="http://peej.github.com/phpdoctor/">PHPDoctor: The PHP Documentation Creator</a></p>
</body>
</html>

112
lib/api/doctrine/common/notifypropertychanged.html
View File

@ -1,112 +0,0 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang="en">
<head>
<meta name="generator" content="PHPDoctor 2RC4 (http://phpdoctor.sourceforge.net/)">
<meta name="when" content="Wed, 14 Apr 2010 15:12:03 +0000">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css">
<link rel="start" href="../../overview-summary.html">
<title>NotifyPropertyChanged (Doctrine)</title>
</head>
<body id="definition" onload="parent.document.title=document.title;">
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="../../doctrine/common/package-summary.html">Namespace</a></li>
<li class="active">Class</li>
<li><a href="../../doctrine/common/package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../index.html" target="_top">Frames</a>
<a href="../../doctrine/common/notifypropertychanged.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>
<div class="qualifiedName">Doctrine\Common\NotifyPropertyChanged</div>
<div class="location">/Doctrine/Common/NotifyPropertyChanged.php at line 36</div>
<h1>Interface NotifyPropertyChanged</h1>
<pre class="tree"><strong>NotifyPropertyChanged</strong><br /></pre>
<hr>
<p class="signature">public interface <strong>NotifyPropertyChanged</strong></p>
<div class="comment" id="overview_description"><p>Contract for classes that provide the service of notifying listeners of
changes to their properties.</p></div>
<dl>
<dt>License:</dt>
<dd>http://www.opensource.org/licenses/lgpl-license.php LGPL</dd>
<dt>See Also:</dt>
<dd><code>www.doctrine-project.org</code></dd>
<dt>Since:</dt>
<dd>2.0</dd>
<dt>Version:</dt>
<dd>$Revision: 3938 $</dd>
<dt>Author:</dt>
<dd>Guilherme Blanco <guilhermeblanco@hotmail.com></dd>
<dd>Jonathan Wage <jonwage@gmail.com></dd>
<dd>Roman Borschel <roman@code-factory.org></dd>
</dl>
<hr>
<table id="summary_method">
<tr><th colspan="2">Method Summary</th></tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#addPropertyChangedListener()">addPropertyChangedListener</a>(<a href="../../doctrine/common/propertychangedlistener.html">PropertyChangedListener</a> listener)</p><p class="description">Adds a listener that wants to be notified about property changes.</p></td>
</tr>
</table>
<h2 id="detail_method">Method Detail</h2>
<div class="location">/Doctrine/Common/NotifyPropertyChanged.php at line 43</div>
<h3 id="addPropertyChangedListener()">addPropertyChangedListener</h3>
<code class="signature">public void <strong>addPropertyChangedListener</strong>(<a href="../../doctrine/common/propertychangedlistener.html">PropertyChangedListener</a> listener)</code>
<div class="details">
<p>Adds a listener that wants to be notified about property changes.</p></div>
<hr>
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="../../doctrine/common/package-summary.html">Namespace</a></li>
<li class="active">Class</li>
<li><a href="../../doctrine/common/package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../index.html" target="_top">Frames</a>
<a href="../../doctrine/common/notifypropertychanged.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>
<p id="footer">This document was generated by <a href="http://peej.github.com/phpdoctor/">PHPDoctor: The PHP Documentation Creator</a></p>
</body>
</html>

42
lib/api/doctrine/common/package-frame.html
View File

@ -1,42 +0,0 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang="en">
<head>
<meta name="generator" content="PHPDoctor 2RC4 (http://phpdoctor.sourceforge.net/)">
<meta name="when" content="Wed, 14 Apr 2010 15:12:03 +0000">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css">
<link rel="start" href="../../overview-summary.html">
<title>Doctrine\Common (Doctrine)</title>
</head>
<body id="frame">
<h1><a href="package-summary.html" target="main">Doctrine\Common</a></h1>
<h2>Classes</h2>
<ul>
<li><a href="../../doctrine/common/classloader.html" target="main">ClassLoader</a></li>
<li><a href="../../doctrine/common/eventargs.html" target="main">EventArgs</a></li>
<li><a href="../../doctrine/common/eventmanager.html" target="main">EventManager</a></li>
<li><a href="../../doctrine/common/lexer.html" target="main">Lexer</a></li>
<li><a href="../../doctrine/common/version.html" target="main">Version</a></li>
</ul>
<h2>Interfaces</h2>
<ul>
<li><a href="../../doctrine/common/eventsubscriber.html" target="main">EventSubscriber</a></li>
<li><a href="../../doctrine/common/notifypropertychanged.html" target="main">NotifyPropertyChanged</a></li>
<li><a href="../../doctrine/common/propertychangedlistener.html" target="main">PropertyChangedListener</a></li>
</ul>
<h2>Exceptions</h2>
<ul>
<li><a href="../../doctrine/common/commonexception.html" target="main">CommonException</a></li>
</ul>
</body>
</html>

69
lib/api/doctrine/common/package-functions.html
View File

@ -1,69 +0,0 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang="en">
<head>
<meta name="generator" content="PHPDoctor 2RC4 (http://phpdoctor.sourceforge.net/)">
<meta name="when" content="Wed, 14 Apr 2010 15:12:06 +0000">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css">
<link rel="start" href="../../overview-summary.html">
<title>Functions (Doctrine)</title>
</head>
<body id="definition" onload="parent.document.title=document.title;">
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="../../doctrine/common/package-summary.html">Package</a></li>
<li class="active">Function</li>
<li><a href="../../overview-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../index.html" target="_top">Frames</a>
<a href="../../doctrine/common/package-functions.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_function">Function</a>
Detail: <a href="#detail_function">Function</a>
</div>
<hr>
<h1>Functions</h1>
<hr>
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="../../doctrine/common/package-summary.html">Package</a></li>
<li class="active">Function</li>
<li><a href="../../overview-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../index.html" target="_top">Frames</a>
<a href="../../doctrine/common/package-functions.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_function">Function</a>
Detail: <a href="#detail_function">Function</a>
</div>
<hr>
<p id="footer">This document was generated by <a href="http://peej.github.com/phpdoctor/">PHPDoctor: The PHP Documentation Creator</a></p>
</body>
</html>

69
lib/api/doctrine/common/package-globals.html
View File

@ -1,69 +0,0 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang="en">
<head>
<meta name="generator" content="PHPDoctor 2RC4 (http://phpdoctor.sourceforge.net/)">
<meta name="when" content="Wed, 14 Apr 2010 15:12:06 +0000">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css">
<link rel="start" href="../../overview-summary.html">
<title>Globals (Doctrine)</title>
</head>
<body id="definition" onload="parent.document.title=document.title;">
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="../../doctrine/common/package-summary.html">Package</a></li>
<li class="active">Global</li>
<li><a href="../../overview-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../index.html" target="_top">Frames</a>
<a href="../../doctrine/common/package-globals.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_global">Global</a>
Detail: <a href="#detail_global">Global</a>
</div>
<hr>
<h1>Globals</h1>
<hr>
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="../../doctrine/common/package-summary.html">Package</a></li>
<li class="active">Global</li>
<li><a href="../../overview-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../index.html" target="_top">Frames</a>
<a href="../../doctrine/common/package-globals.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_global">Global</a>
Detail: <a href="#detail_global">Global</a>
</div>
<hr>
<p id="footer">This document was generated by <a href="http://peej.github.com/phpdoctor/">PHPDoctor: The PHP Documentation Creator</a></p>
</body>
</html>

86
lib/api/doctrine/common/package-summary.html
View File

@ -1,86 +0,0 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang="en">
<head>
<meta name="generator" content="PHPDoctor 2RC4 (http://phpdoctor.sourceforge.net/)">
<meta name="when" content="Wed, 14 Apr 2010 15:12:03 +0000">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css">
<link rel="start" href="../../overview-summary.html">
<title>Doctrine\Common (Doctrine)</title>
</head>
<body id="package" onload="parent.document.title=document.title;">
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../overview-summary.html">Overview</a></li>
<li class="active">Namespace</li>
<li>Class</li><li><a href="../../doctrine/common/package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../index.html" target="_top">Frames</a>
<a href="../../doctrine/common/package-summary.html" target="_top">No frames</a>
</div>
<hr>
<h1>Namespace Doctrine\Common</h1>
<table class="title">
<tr><th colspan="2" class="title">Class Summary</th></tr>
<tr><td class="name"><a href="../../doctrine/common/classloader.html">ClassLoader</a></td><td class="description">A ClassLoader is an autoloader for class files that can be
installed on the SPL autoload stack. </td></tr>
<tr><td class="name"><a href="../../doctrine/common/eventargs.html">EventArgs</a></td><td class="description">EventArgs is the base class for classes containing event data.
</td></tr>
<tr><td class="name"><a href="../../doctrine/common/eventmanager.html">EventManager</a></td><td class="description">The EventManager is the central point of Doctrine's event listener system.
</td></tr>
<tr><td class="name"><a href="../../doctrine/common/lexer.html">Lexer</a></td><td class="description">Simple generic lexical scanner.</td></tr>
<tr><td class="name"><a href="../../doctrine/common/version.html">Version</a></td><td class="description">Class to store and retrieve the version of Doctrine</td></tr>
</table>
<table class="title">
<tr><th colspan="2" class="title">Interface Summary</th></tr>
<tr><td class="name"><a href="../../doctrine/common/eventsubscriber.html">EventSubscriber</a></td><td class="description">An EventSubscriber knows himself what events he is interested in.
</td></tr>
<tr><td class="name"><a href="../../doctrine/common/notifypropertychanged.html">NotifyPropertyChanged</a></td><td class="description">Contract for classes that provide the service of notifying listeners of
changes to their properties.</td></tr>
<tr><td class="name"><a href="../../doctrine/common/propertychangedlistener.html">PropertyChangedListener</a></td><td class="description">Contract for classes that are potential listeners of a NotifyPropertyChanged
implementor.</td></tr>
</table>
<table class="title">
<tr><th colspan="2" class="title">Exception Summary</th></tr>
<tr><td class="name"><a href="../../doctrine/common/commonexception.html">CommonException</a></td><td class="description">Base exception class for package Doctrine\Common</td></tr>
</table>
<hr>
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../overview-summary.html">Overview</a></li>
<li class="active">Namespace</li>
<li>Class</li><li><a href="../../doctrine/common/package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../index.html" target="_top">Frames</a>
<a href="../../doctrine/common/package-summary.html" target="_top">No frames</a>
</div>
<hr>
<p id="footer">This document was generated by <a href="http://peej.github.com/phpdoctor/">PHPDoctor: The PHP Documentation Creator</a></p>
</body>
</html>

60
lib/api/doctrine/common/package-tree.html
View File

@ -1,60 +0,0 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang="en">
<head>
<meta name="generator" content="PHPDoctor 2RC4 (http://phpdoctor.sourceforge.net/)">
<meta name="when" content="Wed, 14 Apr 2010 15:12:03 +0000">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css">
<link rel="start" href="../../overview-summary.html">
<title>Doctrine\Common (Doctrine)</title>
</head>
<body id="tree" onload="parent.document.title=document.title;">
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="../../doctrine/common/package-summary.html">Namespace</a></li>
<li>Class</li><li class="active">Tree</li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../index.html" target="_top">Frames</a>
<a href="../../doctrine/common/package-tree.html" target="_top">No frames</a>
</div>
<h1>Class Hierarchy for Package Doctrine\Common</h1><ul>
<li><a href="../../doctrine/common/classloader.html">Doctrine\Common\ClassLoader</a></li>
<li><a href="../../doctrine/common/eventargs.html">Doctrine\Common\EventArgs</a></li>
<li><a href="../../doctrine/common/eventmanager.html">Doctrine\Common\EventManager</a></li>
<li><a href="../../doctrine/common/lexer.html">Doctrine\Common\Lexer</a></li>
<li><a href="../../doctrine/common/version.html">Doctrine\Common\Version</a></li>
</ul>
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="../../doctrine/common/package-summary.html">Namespace</a></li>
<li>Class</li><li class="active">Tree</li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../index.html" target="_top">Frames</a>
<a href="../../doctrine/common/package-tree.html" target="_top">No frames</a>
</div>
<hr>
<p id="footer">This document was generated by <a href="http://peej.github.com/phpdoctor/">PHPDoctor: The PHP Documentation Creator</a></p>
</body>
</html>

119
lib/api/doctrine/common/propertychangedlistener.html
View File

@ -1,119 +0,0 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang="en">
<head>
<meta name="generator" content="PHPDoctor 2RC4 (http://phpdoctor.sourceforge.net/)">
<meta name="when" content="Wed, 14 Apr 2010 15:12:03 +0000">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css">
<link rel="start" href="../../overview-summary.html">
<title>PropertyChangedListener (Doctrine)</title>
</head>
<body id="definition" onload="parent.document.title=document.title;">
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="../../doctrine/common/package-summary.html">Namespace</a></li>
<li class="active">Class</li>
<li><a href="../../doctrine/common/package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../index.html" target="_top">Frames</a>
<a href="../../doctrine/common/propertychangedlistener.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>
<div class="qualifiedName">Doctrine\Common\PropertyChangedListener</div>
<div class="location">/Doctrine/Common/PropertyChangedListener.php at line 36</div>
<h1>Interface PropertyChangedListener</h1>
<pre class="tree"><strong>PropertyChangedListener</strong><br /></pre>
<hr>
<p class="signature">public interface <strong>PropertyChangedListener</strong></p>
<div class="comment" id="overview_description"><p>Contract for classes that are potential listeners of a <tt>NotifyPropertyChanged</tt>
implementor.</p></div>
<dl>
<dt>License:</dt>
<dd>http://www.opensource.org/licenses/lgpl-license.php LGPL</dd>
<dt>See Also:</dt>
<dd><code>www.doctrine-project.org</code></dd>
<dt>Since:</dt>
<dd>2.0</dd>
<dt>Version:</dt>
<dd>$Revision: 3938 $</dd>
<dt>Author:</dt>
<dd>Guilherme Blanco <guilhermeblanco@hotmail.com></dd>
<dd>Jonathan Wage <jonwage@gmail.com></dd>
<dd>Roman Borschel <roman@code-factory.org></dd>
</dl>
<hr>
<table id="summary_method">
<tr><th colspan="2">Method Summary</th></tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#propertyChanged()">propertyChanged</a>(object sender, string propertyName, mixed oldValue, mixed newValue)</p><p class="description">Notifies the listener of a property change.</p></td>
</tr>
</table>
<h2 id="detail_method">Method Detail</h2>
<div class="location">/Doctrine/Common/PropertyChangedListener.php at line 46</div>
<h3 id="propertyChanged()">propertyChanged</h3>
<code class="signature">public void <strong>propertyChanged</strong>(object sender, string propertyName, mixed oldValue, mixed newValue)</code>
<div class="details">
<p>Notifies the listener of a property change.</p><dl>
<dt>Parameters:</dt>
<dd>sender - The object on which the property changed.</dd>
<dd>propertyName - The name of the property that changed.</dd>
<dd>oldValue - The old value of the property that changed.</dd>
<dd>newValue - The new value of the property that changed.</dd>
</dl>
</div>
<hr>
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="../../doctrine/common/package-summary.html">Namespace</a></li>
<li class="active">Class</li>
<li><a href="../../doctrine/common/package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../index.html" target="_top">Frames</a>
<a href="../../doctrine/common/propertychangedlistener.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>
<p id="footer">This document was generated by <a href="http://peej.github.com/phpdoctor/">PHPDoctor: The PHP Documentation Creator</a></p>
</body>
</html>

147
lib/api/doctrine/common/util/debug.html
View File

@ -1,147 +0,0 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang="en">
<head>
<meta name="generator" content="PHPDoctor 2RC4 (http://phpdoctor.sourceforge.net/)">
<meta name="when" content="Wed, 14 Apr 2010 15:12:03 +0000">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css">
<link rel="start" href="../../../overview-summary.html">
<title>Debug (Doctrine)</title>
</head>
<body id="definition" onload="parent.document.title=document.title;">
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="../../../doctrine/common/util/package-summary.html">Namespace</a></li>
<li class="active">Class</li>
<li><a href="../../../doctrine/common/util/package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../../index.html" target="_top">Frames</a>
<a href="../../../doctrine/common/util/debug.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>
<div class="qualifiedName">Doctrine\Common\Util\Debug</div>
<div class="location">/Doctrine/Common/Util/Debug.php at line 36</div>
<h1>Class Debug</h1>
<pre class="tree"><strong>Debug</strong><br /></pre>
<hr>
<p class="signature">public final class <strong>Debug</strong></p>
<div class="comment" id="overview_description"><p>Static class containing most used debug methods.</p></div>
<dl>
<dt>License:</dt>
<dd>http://www.opensource.org/licenses/lgpl-license.php LGPL</dd>
<dt>See Also:</dt>
<dd><code>www.doctrine-project.org</code></dd>
<dt>Since:</dt>
<dd>2.0</dd>
<dt>Version:</dt>
<dd>$Revision: 3938 $</dd>
<dt>Author:</dt>
<dd>Guilherme Blanco <guilhermeblanco@hotmail.com></dd>
<dd>Jonathan Wage <jonwage@gmail.com></dd>
<dd>Roman Borschel <roman@code-factory.org></dd>
<dd>Giorgio Sironi <piccoloprincipeazzurro@gmail.com></dd>
</dl>
<hr>
<table id="summary_constr">
<tr><th colspan="2">Constructor Summary</th></tr>
<tr>
<td class="description"><p class="name"><a href="#Debug()">Debug</a>()</p><p class="description">Private constructor (prevents from instantiation)</p></td>
</tr>
</table>
<table id="summary_method">
<tr><th colspan="2">Method Summary</th></tr>
<tr>
<td class="type">static void</td>
<td class="description"><p class="name"><a href="#dump()">dump</a>(mixed var, integer maxDepth)</p><p class="description">Prints a dump of the public, protected and private properties of $var.</p></td>
</tr>
<tr>
<td class="type">static void</td>
<td class="description"><p class="name"><a href="#export()">export</a>(mixed var, mixed maxDepth)</p></td>
</tr>
</table>
<h2 id="detail_constr">Constructor Detail</h2>
<div class="location">/Doctrine/Common/Util/Debug.php at line 42</div>
<h3 id="Debug()">Debug</h3>
<code class="signature">public <strong>Debug</strong>()</code>
<div class="details">
<p>Private constructor (prevents from instantiation)</p></div>
<hr>
<h2 id="detail_method">Method Detail</h2>
<div class="location">/Doctrine/Common/Util/Debug.php at line 52</div>
<h3 id="dump()">dump</h3>
<code class="signature">public static void <strong>dump</strong>(mixed var, integer maxDepth)</code>
<div class="details">
<p>Prints a dump of the public, protected and private properties of $var.</p><dl>
<dt>See Also:</dt>
<dd><code><a href="http://xdebug.org/">http://xdebug.org/</a></code></dd>
<dt>Parameters:</dt>
<dd></dd>
<dd>maxDepth - Maximum nesting level for object properties</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/Common/Util/Debug.php at line 72</div>
<h3 id="export()">export</h3>
<code class="signature">public static void <strong>export</strong>(mixed var, mixed maxDepth)</code>
<div class="details">
</div>
<hr>
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="../../../doctrine/common/util/package-summary.html">Namespace</a></li>
<li class="active">Class</li>
<li><a href="../../../doctrine/common/util/package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../../index.html" target="_top">Frames</a>
<a href="../../../doctrine/common/util/debug.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>
<p id="footer">This document was generated by <a href="http://peej.github.com/phpdoctor/">PHPDoctor: The PHP Documentation Creator</a></p>
</body>
</html>

152
lib/api/doctrine/common/util/inflector.html
View File

@ -1,152 +0,0 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang="en">
<head>
<meta name="generator" content="PHPDoctor 2RC4 (http://phpdoctor.sourceforge.net/)">
<meta name="when" content="Wed, 14 Apr 2010 15:12:03 +0000">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css">
<link rel="start" href="../../../overview-summary.html">
<title>Inflector (Doctrine)</title>
</head>
<body id="definition" onload="parent.document.title=document.title;">
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="../../../doctrine/common/util/package-summary.html">Namespace</a></li>
<li class="active">Class</li>
<li><a href="../../../doctrine/common/util/package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../../index.html" target="_top">Frames</a>
<a href="../../../doctrine/common/util/inflector.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>
<div class="qualifiedName">Doctrine\Common\Util\Inflector</div>
<div class="location">/Doctrine/Common/Util/Inflector.php at line 38</div>
<h1>Class Inflector</h1>
<pre class="tree"><strong>Inflector</strong><br /></pre>
<hr>
<p class="signature">public class <strong>Inflector</strong></p>
<div class="comment" id="overview_description"><p>Doctrine inflector has static methods for inflecting text</p><p>The methods in these classes are from several different sources collected
across several different php projects and several different authors. The
original author names and emails are not known</p></div>
<dl>
<dt>License:</dt>
<dd>http://www.opensource.org/licenses/lgpl-license.php LGPL</dd>
<dt>See Also:</dt>
<dd><code>www.doctrine-project.org</code></dd>
<dt>Since:</dt>
<dd>1.0</dd>
<dt>Version:</dt>
<dd>$Revision: 3189 $</dd>
<dt>Author:</dt>
<dd>Konsta Vesterinen <kvesteri@cc.hut.fi></dd>
<dd>Jonathan H. Wage <jonwage@gmail.com></dd>
</dl>
<hr>
<table id="summary_method">
<tr><th colspan="2">Method Summary</th></tr>
<tr>
<td class="type">static string</td>
<td class="description"><p class="name"><a href="#camelize()">camelize</a>(string word)</p><p class="description">Camelize a word. </p></td>
</tr>
<tr>
<td class="type">static string</td>
<td class="description"><p class="name"><a href="#classify()">classify</a>(string word)</p><p class="description">Convert a word in to the format for a Doctrine class name. </p></td>
</tr>
<tr>
<td class="type">static string</td>
<td class="description"><p class="name"><a href="#tableize()">tableize</a>(string word)</p><p class="description">Convert word in to the format for a Doctrine table name. </p></td>
</tr>
</table>
<h2 id="detail_method">Method Detail</h2>
<div class="location">/Doctrine/Common/Util/Inflector.php at line 68</div>
<h3 id="camelize()">camelize</h3>
<code class="signature">public static string <strong>camelize</strong>(string word)</code>
<div class="details">
<p>Camelize a word. This uses the classify() method and turns the first character to lowercase</p><dl>
<dt>Returns:</dt>
<dd>$word</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/Common/Util/Inflector.php at line 57</div>
<h3 id="classify()">classify</h3>
<code class="signature">public static string <strong>classify</strong>(string word)</code>
<div class="details">
<p>Convert a word in to the format for a Doctrine class name. Converts 'table_name' to 'TableName'</p><dl>
<dt>Parameters:</dt>
<dd>word - Word to classify</dd>
<dt>Returns:</dt>
<dd>$word Classified word</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/Common/Util/Inflector.php at line 46</div>
<h3 id="tableize()">tableize</h3>
<code class="signature">public static string <strong>tableize</strong>(string word)</code>
<div class="details">
<p>Convert word in to the format for a Doctrine table name. Converts 'ModelName' to 'model_name'</p><dl>
<dt>Parameters:</dt>
<dd>word - Word to tableize</dd>
<dt>Returns:</dt>
<dd>$word Tableized word</dd>
</dl>
</div>
<hr>
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="../../../doctrine/common/util/package-summary.html">Namespace</a></li>
<li class="active">Class</li>
<li><a href="../../../doctrine/common/util/package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../../index.html" target="_top">Frames</a>
<a href="../../../doctrine/common/util/inflector.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>
<p id="footer">This document was generated by <a href="http://peej.github.com/phpdoctor/">PHPDoctor: The PHP Documentation Creator</a></p>
</body>
</html>

27
lib/api/doctrine/common/util/package-frame.html
View File

@ -1,27 +0,0 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang="en">
<head>
<meta name="generator" content="PHPDoctor 2RC4 (http://phpdoctor.sourceforge.net/)">
<meta name="when" content="Wed, 14 Apr 2010 15:12:03 +0000">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css">
<link rel="start" href="../../../overview-summary.html">
<title>Doctrine\Common\Util (Doctrine)</title>
</head>
<body id="frame">
<h1><a href="package-summary.html" target="main">Doctrine\Common\Util</a></h1>
<h2>Classes</h2>
<ul>
<li><a href="../../../doctrine/common/util/debug.html" target="main">Debug</a></li>
<li><a href="../../../doctrine/common/util/inflector.html" target="main">Inflector</a></li>
</ul>
</body>
</html>

69
lib/api/doctrine/common/util/package-functions.html
View File

@ -1,69 +0,0 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang="en">
<head>
<meta name="generator" content="PHPDoctor 2RC4 (http://phpdoctor.sourceforge.net/)">
<meta name="when" content="Wed, 14 Apr 2010 15:12:06 +0000">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css">
<link rel="start" href="../../../overview-summary.html">
<title>Functions (Doctrine)</title>
</head>
<body id="definition" onload="parent.document.title=document.title;">
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="../../../doctrine/common/util/package-summary.html">Package</a></li>
<li class="active">Function</li>
<li><a href="../../../overview-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../../index.html" target="_top">Frames</a>
<a href="../../../doctrine/common/util/package-functions.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_function">Function</a>
Detail: <a href="#detail_function">Function</a>
</div>
<hr>
<h1>Functions</h1>
<hr>
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="../../../doctrine/common/util/package-summary.html">Package</a></li>
<li class="active">Function</li>
<li><a href="../../../overview-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../../index.html" target="_top">Frames</a>
<a href="../../../doctrine/common/util/package-functions.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_function">Function</a>
Detail: <a href="#detail_function">Function</a>
</div>
<hr>
<p id="footer">This document was generated by <a href="http://peej.github.com/phpdoctor/">PHPDoctor: The PHP Documentation Creator</a></p>
</body>
</html>

69
lib/api/doctrine/common/util/package-globals.html
View File

@ -1,69 +0,0 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang="en">
<head>
<meta name="generator" content="PHPDoctor 2RC4 (http://phpdoctor.sourceforge.net/)">
<meta name="when" content="Wed, 14 Apr 2010 15:12:06 +0000">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css">
<link rel="start" href="../../../overview-summary.html">
<title>Globals (Doctrine)</title>
</head>
<body id="definition" onload="parent.document.title=document.title;">
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="../../../doctrine/common/util/package-summary.html">Package</a></li>
<li class="active">Global</li>
<li><a href="../../../overview-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../../index.html" target="_top">Frames</a>
<a href="../../../doctrine/common/util/package-globals.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_global">Global</a>
Detail: <a href="#detail_global">Global</a>
</div>
<hr>
<h1>Globals</h1>
<hr>
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="../../../doctrine/common/util/package-summary.html">Package</a></li>
<li class="active">Global</li>
<li><a href="../../../overview-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../../index.html" target="_top">Frames</a>
<a href="../../../doctrine/common/util/package-globals.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_global">Global</a>
Detail: <a href="#detail_global">Global</a>
</div>
<hr>
<p id="footer">This document was generated by <a href="http://peej.github.com/phpdoctor/">PHPDoctor: The PHP Documentation Creator</a></p>
</body>
</html>

66
lib/api/doctrine/common/util/package-summary.html
View File

@ -1,66 +0,0 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang="en">
<head>
<meta name="generator" content="PHPDoctor 2RC4 (http://phpdoctor.sourceforge.net/)">
<meta name="when" content="Wed, 14 Apr 2010 15:12:03 +0000">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css">
<link rel="start" href="../../../overview-summary.html">
<title>Doctrine\Common\Util (Doctrine)</title>
</head>
<body id="tree" onload="parent.document.title=document.title;">
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../../overview-summary.html">Overview</a></li>
<li class="active">Namespace</li>
<li>Class</li><li><a href="../../../doctrine/common/util/package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../../index.html" target="_top">Frames</a>
<a href="../../../doctrine/common/util/package-summary.html" target="_top">No frames</a>
</div>
<hr>
<h1>Namespace Doctrine\Common\Util</h1>
<table class="title">
<tr><th colspan="2" class="title">Class Summary</th></tr>
<tr><td class="name"><a href="../../../doctrine/common/util/debug.html">Debug</a></td><td class="description">Static class containing most used debug methods.</td></tr>
<tr><td class="name"><a href="../../../doctrine/common/util/inflector.html">Inflector</a></td><td class="description">Doctrine inflector has static methods for inflecting textThe methods in these classes are from several different sources collected
across several different php projects and several different authors. </td></tr>
</table>
<hr>
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../../overview-summary.html">Overview</a></li>
<li class="active">Namespace</li>
<li>Class</li><li><a href="../../../doctrine/common/util/package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../../index.html" target="_top">Frames</a>
<a href="../../../doctrine/common/util/package-summary.html" target="_top">No frames</a>
</div>
<hr>
<p id="footer">This document was generated by <a href="http://peej.github.com/phpdoctor/">PHPDoctor: The PHP Documentation Creator</a></p>
</body>
</html>

57
lib/api/doctrine/common/util/package-tree.html
View File

@ -1,57 +0,0 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang="en">
<head>
<meta name="generator" content="PHPDoctor 2RC4 (http://phpdoctor.sourceforge.net/)">
<meta name="when" content="Wed, 14 Apr 2010 15:12:03 +0000">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css">
<link rel="start" href="../../../overview-summary.html">
<title>Doctrine\Common\Util (Doctrine)</title>
</head>
<body id="tree" onload="parent.document.title=document.title;">
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="../../../doctrine/common/util/package-summary.html">Namespace</a></li>
<li>Class</li><li class="active">Tree</li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../../index.html" target="_top">Frames</a>
<a href="../../../doctrine/common/util/package-tree.html" target="_top">No frames</a>
</div>
<h1>Class Hierarchy for Package Doctrine\Common\Util</h1><ul>
<li><a href="../../../doctrine/common/util/debug.html">Doctrine\Common\Util\Debug</a></li>
<li><a href="../../../doctrine/common/util/inflector.html">Doctrine\Common\Util\Inflector</a></li>
</ul>
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="../../../doctrine/common/util/package-summary.html">Namespace</a></li>
<li>Class</li><li class="active">Tree</li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../../index.html" target="_top">Frames</a>
<a href="../../../doctrine/common/util/package-tree.html" target="_top">No frames</a>
</div>
<hr>
<p id="footer">This document was generated by <a href="http://peej.github.com/phpdoctor/">PHPDoctor: The PHP Documentation Creator</a></p>
</body>
</html>

135
lib/api/doctrine/common/version.html
View File

@ -1,135 +0,0 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang="en">
<head>
<meta name="generator" content="PHPDoctor 2RC4 (http://phpdoctor.sourceforge.net/)">
<meta name="when" content="Wed, 14 Apr 2010 15:12:03 +0000">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css">
<link rel="start" href="../../overview-summary.html">
<title>Version (Doctrine)</title>
</head>
<body id="definition" onload="parent.document.title=document.title;">
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="../../doctrine/common/package-summary.html">Namespace</a></li>
<li class="active">Class</li>
<li><a href="../../doctrine/common/package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../index.html" target="_top">Frames</a>
<a href="../../doctrine/common/version.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>
<div class="qualifiedName">Doctrine\Common\Version</div>
<div class="location">/Doctrine/Common/Version.php at line 36</div>
<h1>Class Version</h1>
<pre class="tree"><strong>Version</strong><br /></pre>
<hr>
<p class="signature">public class <strong>Version</strong></p>
<div class="comment" id="overview_description"><p>Class to store and retrieve the version of Doctrine</p></div>
<dl>
<dt>License:</dt>
<dd>http://www.opensource.org/licenses/lgpl-license.php LGPL</dd>
<dt>See Also:</dt>
<dd><code>www.doctrine-project.org</code></dd>
<dt>Since:</dt>
<dd>2.0</dd>
<dt>Version:</dt>
<dd>$Revision$</dd>
<dt>Author:</dt>
<dd>Benjamin Eberlei <kontakt@beberlei.de></dd>
<dd>Guilherme Blanco <guilhermeblanco@hotmail.com></dd>
<dd>Jonathan Wage <jonwage@gmail.com></dd>
<dd>Roman Borschel <roman@code-factory.org></dd>
</dl>
<hr>
<table id="summary_field">
<tr><th colspan="2">Field Summary</th></tr>
<tr>
<td class="type">final str</td>
<td class="description"><p class="name"><a href="#VERSION">VERSION</a></p><p class="description">Current Doctrine Version</p></td>
</tr>
</table>
<table id="summary_method">
<tr><th colspan="2">Method Summary</th></tr>
<tr>
<td class="type">static int</td>
<td class="description"><p class="name"><a href="#compare()">compare</a>(string version)</p><p class="description">Compares a Doctrine version with the current one.</p></td>
</tr>
</table>
<h2 id="detail_field">Field Detail</h2>
<div class="location">/Doctrine/Common/Version.php at line 41</div>
<h3 id="VERSION">VERSION</h3>
<code class="signature">public final str <strong>VERSION</strong> = '2.0-DEV'</code>
<div class="details">
<p>Current Doctrine Version</p></div>
<hr>
<h2 id="detail_method">Method Detail</h2>
<div class="location">/Doctrine/Common/Version.php at line 50</div>
<h3 id="compare()">compare</h3>
<code class="signature">public static int <strong>compare</strong>(string version)</code>
<div class="details">
<p>Compares a Doctrine version with the current one.</p><dl>
<dt>Parameters:</dt>
<dd>version - Doctrine version to compare.</dd>
<dt>Returns:</dt>
<dd>Returns -1 if older, 0 if it is the same, 1 if version passed as argument is newer.</dd>
</dl>
</div>
<hr>
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="../../doctrine/common/package-summary.html">Namespace</a></li>
<li class="active">Class</li>
<li><a href="../../doctrine/common/package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../index.html" target="_top">Frames</a>
<a href="../../doctrine/common/version.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>
<p id="footer">This document was generated by <a href="http://peej.github.com/phpdoctor/">PHPDoctor: The PHP Documentation Creator</a></p>
</body>
</html>

160
lib/api/doctrine/dbal/configuration.html
View File

@ -1,160 +0,0 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang="en">
<head>
<meta name="generator" content="PHPDoctor 2RC4 (http://phpdoctor.sourceforge.net/)">
<meta name="when" content="Wed, 14 Apr 2010 15:12:03 +0000">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css">
<link rel="start" href="../../overview-summary.html">
<title>Configuration (Doctrine)</title>
</head>
<body id="definition" onload="parent.document.title=document.title;">
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="../../doctrine/dbal/package-summary.html">Namespace</a></li>
<li class="active">Class</li>
<li><a href="../../doctrine/dbal/package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../index.html" target="_top">Frames</a>
<a href="../../doctrine/dbal/configuration.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>
<div class="qualifiedName">Doctrine\DBAL\Configuration</div>
<div class="location">/Doctrine/DBAL/Configuration.php at line 39</div>
<h1>Class Configuration</h1>
<pre class="tree"><strong>Configuration</strong><br /></pre>
<hr>
<p class="signature">public class <strong>Configuration</strong></p>
<div class="comment" id="overview_description"><p>Configuration container for the Doctrine DBAL.</p></div>
<dl>
<dt>License:</dt>
<dd>http://www.opensource.org/licenses/lgpl-license.php LGPL</dd>
<dt>See Also:</dt>
<dd><code>www.doctrine-project.org</code></dd>
<dt>Since:</dt>
<dd>2.0</dd>
<dt>Version:</dt>
<dd>$Revision: 3938 $</dd>
<dt>Author:</dt>
<dd>Guilherme Blanco <guilhermeblanco@hotmail.com></dd>
<dd>Jonathan Wage <jonwage@gmail.com></dd>
<dd>Roman Borschel <roman@code-factory.org></dd>
<dt>Internal:</dt>
<dd>When adding a new configuration option just write a getter/setter pair and add the option to the _attributes array with a proper default value.</dd>
</dl>
<hr>
<table id="summary_field">
<tr><th colspan="2">Field Summary</th></tr>
<tr>
<td class="type">protected array</td>
<td class="description"><p class="name"><a href="#_attributes">$_attributes</a></p><p class="description">The attributes that are contained in the configuration.
</p></td>
</tr>
</table>
<table id="summary_constr">
<tr><th colspan="2">Constructor Summary</th></tr>
<tr>
<td class="description"><p class="name"><a href="#Configuration()">Configuration</a>()</p><p class="description">Creates a new DBAL configuration instance.</p></td>
</tr>
</table>
<table id="summary_method">
<tr><th colspan="2">Method Summary</th></tr>
<tr>
<td class="type"> <a href="../../doctrine/dbal/logging/sqllogger.html">SQLLogger</a></td>
<td class="description"><p class="name"><a href="#getSQLLogger()">getSQLLogger</a>()</p><p class="description">Gets the SQL logger that is used.</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#setSQLLogger()">setSQLLogger</a>(<a href="../../doctrine/dbal/logging/sqllogger.html">SQLLogger</a> logger)</p><p class="description">Sets the SQL logger to use. </p></td>
</tr>
</table>
<h2 id="detail_field">Field Detail</h2>
<div class="location">/Doctrine/DBAL/Configuration.php at line 47</div>
<h3 id="_attributes">_attributes</h3>
<code class="signature">protected array <strong>$_attributes</strong> = array()</code>
<div class="details">
<p>The attributes that are contained in the configuration.
Values are default values.</p></div>
<hr>
<h2 id="detail_constr">Constructor Detail</h2>
<div class="location">/Doctrine/DBAL/Configuration.php at line 52</div>
<h3 id="Configuration()">Configuration</h3>
<code class="signature">public <strong>Configuration</strong>()</code>
<div class="details">
<p>Creates a new DBAL configuration instance.</p></div>
<hr>
<h2 id="detail_method">Method Detail</h2>
<div class="location">/Doctrine/DBAL/Configuration.php at line 74</div>
<h3 id="getSQLLogger()">getSQLLogger</h3>
<code class="signature">public <a href="../../doctrine/dbal/logging/sqllogger.html">SQLLogger</a> <strong>getSQLLogger</strong>()</code>
<div class="details">
<p>Gets the SQL logger that is used.</p></div>
<hr>
<div class="location">/Doctrine/DBAL/Configuration.php at line 64</div>
<h3 id="setSQLLogger()">setSQLLogger</h3>
<code class="signature">public void <strong>setSQLLogger</strong>(<a href="../../doctrine/dbal/logging/sqllogger.html">SQLLogger</a> logger)</code>
<div class="details">
<p>Sets the SQL logger to use. Defaults to NULL which means SQL logging is disabled.</p></div>
<hr>
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="../../doctrine/dbal/package-summary.html">Namespace</a></li>
<li class="active">Class</li>
<li><a href="../../doctrine/dbal/package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../index.html" target="_top">Frames</a>
<a href="../../doctrine/dbal/configuration.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>
<p id="footer">This document was generated by <a href="http://peej.github.com/phpdoctor/">PHPDoctor: The PHP Documentation Creator</a></p>
</body>
</html>

996
lib/api/doctrine/dbal/connection.html
View File

@ -1,996 +0,0 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang="en">
<head>
<meta name="generator" content="PHPDoctor 2RC4 (http://phpdoctor.sourceforge.net/)">
<meta name="when" content="Wed, 14 Apr 2010 15:12:03 +0000">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css">
<link rel="start" href="../../overview-summary.html">
<title>Connection (Doctrine)</title>
</head>
<body id="definition" onload="parent.document.title=document.title;">
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="../../doctrine/dbal/package-summary.html">Namespace</a></li>
<li class="active">Class</li>
<li><a href="../../doctrine/dbal/package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../index.html" target="_top">Frames</a>
<a href="../../doctrine/dbal/connection.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>
<div class="qualifiedName">Doctrine\DBAL\Connection</div>
<div class="location">/Doctrine/DBAL/Connection.php at line 45</div>
<h1>Class Connection</h1>
<pre class="tree"><strong>Connection</strong><br /></pre>
<hr>
<p class="signature">public class <strong>Connection</strong></p>
<div class="comment" id="overview_description"><p>A wrapper around a Doctrine\DBAL\Driver\Connection that adds features like
events, transaction isolation levels, configuration, emulated transaction nesting,
lazy connecting and more.</p></div>
<dl>
<dt>License:</dt>
<dd>http://www.opensource.org/licenses/lgpl-license.php LGPL</dd>
<dt>See Also:</dt>
<dd><code>www.doctrine-project.org</code></dd>
<dt>Since:</dt>
<dd>2.0</dd>
<dt>Version:</dt>
<dd>$Revision: 3938 $</dd>
<dt>Author:</dt>
<dd>Guilherme Blanco <guilhermeblanco@hotmail.com></dd>
<dd>Jonathan Wage <jonwage@gmail.com></dd>
<dd>Roman Borschel <roman@code-factory.org></dd>
<dd>Konsta Vesterinen <kvesteri@cc.hut.fi></dd>
<dd>Lukas Smith <smith@pooteeweet.org> (MDB2 library)</dd>
</dl>
<hr>
<table id="summary_field">
<tr><th colspan="2">Field Summary</th></tr>
<tr>
<td class="type">final int</td>
<td class="description"><p class="name"><a href="#TRANSACTION_READ_COMMITTED">TRANSACTION_READ_COMMITTED</a></p><p class="description">Constant for transaction isolation level READ COMMITTED.</p></td>
</tr>
<tr>
<td class="type">final int</td>
<td class="description"><p class="name"><a href="#TRANSACTION_READ_UNCOMMITTED">TRANSACTION_READ_UNCOMMITTED</a></p><p class="description">Constant for transaction isolation level READ UNCOMMITTED.</p></td>
</tr>
<tr>
<td class="type">final int</td>
<td class="description"><p class="name"><a href="#TRANSACTION_REPEATABLE_READ">TRANSACTION_REPEATABLE_READ</a></p><p class="description">Constant for transaction isolation level REPEATABLE READ.</p></td>
</tr>
<tr>
<td class="type">final int</td>
<td class="description"><p class="name"><a href="#TRANSACTION_SERIALIZABLE">TRANSACTION_SERIALIZABLE</a></p><p class="description">Constant for transaction isolation level SERIALIZABLE.</p></td>
</tr>
<tr>
<td class="type">protected Doctrine\DBAL\Configuration</td>
<td class="description"><p class="name"><a href="#_config">$_config</a></p><p class="description"></p></td>
</tr>
<tr>
<td class="type">protected Doctrine\DBAL\Driver\Connection</td>
<td class="description"><p class="name"><a href="#_conn">$_conn</a></p><p class="description">The wrapped driver connection.</p></td>
</tr>
<tr>
<td class="type">protected Doctrine\DBAL\Driver</td>
<td class="description"><p class="name"><a href="#_driver">$_driver</a></p><p class="description">The used DBAL driver.</p></td>
</tr>
<tr>
<td class="type">protected Doctrine\Common\EventManager</td>
<td class="description"><p class="name"><a href="#_eventManager">$_eventManager</a></p><p class="description"></p></td>
</tr>
<tr>
<td class="type">protected Doctrine\DBAL\Platforms\AbstractPlatform</td>
<td class="description"><p class="name"><a href="#_platform">$_platform</a></p><p class="description">The DatabasePlatform object that provides information about the
database platform used by the connection.</p></td>
</tr>
<tr>
<td class="type">protected Doctrine\DBAL\Schema\SchemaManager</td>
<td class="description"><p class="name"><a href="#_schemaManager">$_schemaManager</a></p><p class="description">The schema manager.</p></td>
</tr>
</table>
<table id="summary_constr">
<tr><th colspan="2">Constructor Summary</th></tr>
<tr>
<td class="description"><p class="name"><a href="#Connection()">Connection</a>(array params, <a href="../../doctrine/dbal/driver.html">Driver</a> driver, <a href="../../doctrine/dbal/configuration.html">Configuration</a> config, <a href="../../doctrine/common/eventmanager.html">EventManager</a> eventManager)</p><p class="description">Initializes a new instance of the Connection class.</p></td>
</tr>
</table>
<table id="summary_method">
<tr><th colspan="2">Method Summary</th></tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#beginTransaction()">beginTransaction</a>()</p><p class="description">Starts a transaction by suspending auto-commit mode.</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#close()">close</a>()</p><p class="description">Closes the connection.</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#commit()">commit</a>()</p><p class="description">Commits the current transaction.</p></td>
</tr>
<tr>
<td class="type"> boolean</td>
<td class="description"><p class="name"><a href="#connect()">connect</a>()</p><p class="description">Establishes the connection with the database.</p></td>
</tr>
<tr>
<td class="type"> mixed</td>
<td class="description"><p class="name"><a href="#convertToDatabaseValue()">convertToDatabaseValue</a>(mixed value, string type)</p><p class="description">Converts a given value to its database representation according to the conversion
rules of a specific DBAL mapping type.</p></td>
</tr>
<tr>
<td class="type"> mixed</td>
<td class="description"><p class="name"><a href="#convertToPHPValue()">convertToPHPValue</a>(mixed value, string type)</p><p class="description">Converts a given value to its PHP representation according to the conversion
rules of a specific DBAL mapping type.</p></td>
</tr>
<tr>
<td class="type"> integer</td>
<td class="description"><p class="name"><a href="#delete()">delete</a>(mixed tableName, array identifier, string table)</p><p class="description">Executes an SQL DELETE statement on a table.</p></td>
</tr>
<tr>
<td class="type"> integer</td>
<td class="description"><p class="name"><a href="#errorCode()">errorCode</a>()</p><p class="description">Fetch the SQLSTATE associated with the last database operation.</p></td>
</tr>
<tr>
<td class="type"> array</td>
<td class="description"><p class="name"><a href="#errorInfo()">errorInfo</a>()</p><p class="description">Fetch extended error information associated with the last database operation.</p></td>
</tr>
<tr>
<td class="type"> integer</td>
<td class="description"><p class="name"><a href="#exec()">exec</a>(string statement)</p><p class="description">Execute an SQL statement and return the number of affected rows.</p></td>
</tr>
<tr>
<td class="type"> Doctrine\DBAL\Driver\Statement</td>
<td class="description"><p class="name"><a href="#executeQuery()">executeQuery</a>(string query, array params)</p><p class="description">Executes an, optionally parameterized, SQL query.
</p></td>
</tr>
<tr>
<td class="type"> integer</td>
<td class="description"><p class="name"><a href="#executeUpdate()">executeUpdate</a>(string query, array params, array types)</p><p class="description">Executes an SQL INSERT/UPDATE/DELETE query with the given parameters
and returns the number of affected rows.
</p></td>
</tr>
<tr>
<td class="type"> array</td>
<td class="description"><p class="name"><a href="#fetchAll()">fetchAll</a>(string sql, array params)</p><p class="description">Prepares and executes an SQL query and returns the result as an associative array.</p></td>
</tr>
<tr>
<td class="type"> array</td>
<td class="description"><p class="name"><a href="#fetchArray()">fetchArray</a>(string statement, array params)</p><p class="description">Prepares and executes an SQL query and returns the first row of the result
as a numerically indexed array.</p></td>
</tr>
<tr>
<td class="type"> mixed</td>
<td class="description"><p class="name"><a href="#fetchColumn()">fetchColumn</a>(string statement, array params, int colnum)</p><p class="description">Prepares and executes an SQL query and returns the value of a single column
of the first row of the result.</p></td>
</tr>
<tr>
<td class="type"> array</td>
<td class="description"><p class="name"><a href="#fetchRow()">fetchRow</a>(string statement, array params)</p><p class="description">Prepares and executes an SQL query and returns the first row of the result
as an associative array.</p></td>
</tr>
<tr>
<td class="type"> Doctrine\DBAL\Configuration</td>
<td class="description"><p class="name"><a href="#getConfiguration()">getConfiguration</a>()</p><p class="description">Gets the Configuration used by the Connection.</p></td>
</tr>
<tr>
<td class="type"> string</td>
<td class="description"><p class="name"><a href="#getDatabase()">getDatabase</a>()</p><p class="description">Gets the name of the database this Connection is connected to.</p></td>
</tr>
<tr>
<td class="type"> Doctrine\DBAL\Platforms\AbstractPlatform</td>
<td class="description"><p class="name"><a href="#getDatabasePlatform()">getDatabasePlatform</a>()</p><p class="description">Gets the DatabasePlatform for the connection.</p></td>
</tr>
<tr>
<td class="type"> Doctrine\DBAL\Driver</td>
<td class="description"><p class="name"><a href="#getDriver()">getDriver</a>()</p><p class="description">Gets the DBAL driver instance.</p></td>
</tr>
<tr>
<td class="type"> Doctrine\Common\EventManager</td>
<td class="description"><p class="name"><a href="#getEventManager()">getEventManager</a>()</p><p class="description">Gets the EventManager used by the Connection.</p></td>
</tr>
<tr>
<td class="type"> string</td>
<td class="description"><p class="name"><a href="#getHost()">getHost</a>()</p><p class="description">Gets the hostname of the currently connected database.</p></td>
</tr>
<tr>
<td class="type"> array</td>
<td class="description"><p class="name"><a href="#getParams()">getParams</a>()</p><p class="description">Gets the parameters used during instantiation.</p></td>
</tr>
<tr>
<td class="type"> string</td>
<td class="description"><p class="name"><a href="#getPassword()">getPassword</a>()</p><p class="description">Gets the password used by this connection.</p></td>
</tr>
<tr>
<td class="type"> mixed</td>
<td class="description"><p class="name"><a href="#getPort()">getPort</a>()</p><p class="description">Gets the port of the currently connected database.</p></td>
</tr>
<tr>
<td class="type"> boolean</td>
<td class="description"><p class="name"><a href="#getRollbackOnly()">getRollbackOnly</a>()</p><p class="description">Check whether the current transaction is marked for rollback only.</p></td>
</tr>
<tr>
<td class="type"> Doctrine\DBAL\Schema\SchemaManager</td>
<td class="description"><p class="name"><a href="#getSchemaManager()">getSchemaManager</a>()</p><p class="description">Gets the SchemaManager that can be used to inspect or change the
database schema through the connection.</p></td>
</tr>
<tr>
<td class="type"> integer</td>
<td class="description"><p class="name"><a href="#getTransactionIsolation()">getTransactionIsolation</a>()</p><p class="description">Gets the currently active transaction isolation level.</p></td>
</tr>
<tr>
<td class="type"> integer</td>
<td class="description"><p class="name"><a href="#getTransactionNestingLevel()">getTransactionNestingLevel</a>()</p><p class="description">Returns the current transaction nesting level.</p></td>
</tr>
<tr>
<td class="type"> string</td>
<td class="description"><p class="name"><a href="#getUsername()">getUsername</a>()</p><p class="description">Gets the username used by this connection.</p></td>
</tr>
<tr>
<td class="type"> Doctrine\DBAL\Driver\Connection</td>
<td class="description"><p class="name"><a href="#getWrappedConnection()">getWrappedConnection</a>()</p><p class="description">Gets the wrapped driver connection.</p></td>
</tr>
<tr>
<td class="type"> integer</td>
<td class="description"><p class="name"><a href="#insert()">insert</a>(mixed tableName, array data, string table)</p><p class="description">Inserts a table row with specified data.</p></td>
</tr>
<tr>
<td class="type"> boolean</td>
<td class="description"><p class="name"><a href="#isConnected()">isConnected</a>()</p><p class="description">Whether an actual connection to the database is established.</p></td>
</tr>
<tr>
<td class="type"> boolean</td>
<td class="description"><p class="name"><a href="#isTransactionActive()">isTransactionActive</a>()</p><p class="description">Checks whether a transaction is currently active.</p></td>
</tr>
<tr>
<td class="type"> string</td>
<td class="description"><p class="name"><a href="#lastInsertId()">lastInsertId</a>(string seqName)</p><p class="description">Returns the ID of the last inserted row, or the last value from a sequence object,
depending on the underlying driver.
</p></td>
</tr>
<tr>
<td class="type"> Doctrine\DBAL\Driver\Statement</td>
<td class="description"><p class="name"><a href="#prepare()">prepare</a>(string statement)</p><p class="description">Prepares an SQL statement.</p></td>
</tr>
<tr>
<td class="type"> mixed</td>
<td class="description"><p class="name"><a href="#project()">project</a>(string query, array params, mixed function, Closure mapper)</p><p class="description">Executes an, optionally parameterized, SQL query and returns the result,
applying a given projection/transformation function on each row of the result.</p></td>
</tr>
<tr>
<td class="type"> Doctrine\DBAL\Driver\Statement</td>
<td class="description"><p class="name"><a href="#query()">query</a>(string statement, integer fetchType)</p><p class="description">Executes an SQL statement, returning a result set as a Statement object.</p></td>
</tr>
<tr>
<td class="type"> string</td>
<td class="description"><p class="name"><a href="#quote()">quote</a>(mixed input, string type)</p><p class="description">Quotes a given input parameter.</p></td>
</tr>
<tr>
<td class="type"> string</td>
<td class="description"><p class="name"><a href="#quoteIdentifier()">quoteIdentifier</a>(string str)</p><p class="description">Quote a string so it can be safely used as a table or column name, even if
it is a reserved name.
</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#rollback()">rollback</a>()</p><p class="description">Cancel any database changes done during the current transaction.
</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#setCharset()">setCharset</a>(string charset)</p><p class="description">Sets the given charset on the current connection.</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#setRollbackOnly()">setRollbackOnly</a>()</p><p class="description">Marks the current transaction so that the only possible
outcome for the transaction to be rolled back.</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#setTransactionIsolation()">setTransactionIsolation</a>(integer level)</p><p class="description">Sets the transaction isolation level.</p></td>
</tr>
<tr>
<td class="type"> integer</td>
<td class="description"><p class="name"><a href="#update()">update</a>(mixed tableName, mixed data, array identifier, string table)</p><p class="description">Executes an SQL UPDATE statement on a table.</p></td>
</tr>
</table>
<h2 id="detail_field">Field Detail</h2>
<div class="location">/Doctrine/DBAL/Connection.php at line 55</div>
<h3 id="TRANSACTION_READ_COMMITTED">TRANSACTION_READ_COMMITTED</h3>
<code class="signature">public final int <strong>TRANSACTION_READ_COMMITTED</strong> = 2</code>
<div class="details">
<p>Constant for transaction isolation level READ COMMITTED.</p></div>
<hr>
<div class="location">/Doctrine/DBAL/Connection.php at line 50</div>
<h3 id="TRANSACTION_READ_UNCOMMITTED">TRANSACTION_READ_UNCOMMITTED</h3>
<code class="signature">public final int <strong>TRANSACTION_READ_UNCOMMITTED</strong> = 1</code>
<div class="details">
<p>Constant for transaction isolation level READ UNCOMMITTED.</p></div>
<hr>
<div class="location">/Doctrine/DBAL/Connection.php at line 60</div>
<h3 id="TRANSACTION_REPEATABLE_READ">TRANSACTION_REPEATABLE_READ</h3>
<code class="signature">public final int <strong>TRANSACTION_REPEATABLE_READ</strong> = 3</code>
<div class="details">
<p>Constant for transaction isolation level REPEATABLE READ.</p></div>
<hr>
<div class="location">/Doctrine/DBAL/Connection.php at line 65</div>
<h3 id="TRANSACTION_SERIALIZABLE">TRANSACTION_SERIALIZABLE</h3>
<code class="signature">public final int <strong>TRANSACTION_SERIALIZABLE</strong> = 4</code>
<div class="details">
<p>Constant for transaction isolation level SERIALIZABLE.</p></div>
<hr>
<div class="location">/Doctrine/DBAL/Connection.php at line 77</div>
<h3 id="_config">_config</h3>
<code class="signature">protected Doctrine\DBAL\Configuration <strong>$_config</strong></code>
<div class="details">
<p></p></div>
<hr>
<div class="location">/Doctrine/DBAL/Connection.php at line 72</div>
<h3 id="_conn">_conn</h3>
<code class="signature">protected Doctrine\DBAL\Driver\Connection <strong>$_conn</strong></code>
<div class="details">
<p>The wrapped driver connection.</p></div>
<hr>
<div class="location">/Doctrine/DBAL/Connection.php at line 132</div>
<h3 id="_driver">_driver</h3>
<code class="signature">protected Doctrine\DBAL\Driver <strong>$_driver</strong></code>
<div class="details">
<p>The used DBAL driver.</p></div>
<hr>
<div class="location">/Doctrine/DBAL/Connection.php at line 82</div>
<h3 id="_eventManager">_eventManager</h3>
<code class="signature">protected Doctrine\Common\EventManager <strong>$_eventManager</strong></code>
<div class="details">
<p></p></div>
<hr>
<div class="location">/Doctrine/DBAL/Connection.php at line 118</div>
<h3 id="_platform">_platform</h3>
<code class="signature">protected Doctrine\DBAL\Platforms\AbstractPlatform <strong>$_platform</strong></code>
<div class="details">
<p>The DatabasePlatform object that provides information about the
database platform used by the connection.</p></div>
<hr>
<div class="location">/Doctrine/DBAL/Connection.php at line 125</div>
<h3 id="_schemaManager">_schemaManager</h3>
<code class="signature">protected Doctrine\DBAL\Schema\SchemaManager <strong>$_schemaManager</strong></code>
<div class="details">
<p>The schema manager.</p></div>
<hr>
<h2 id="detail_constr">Constructor Detail</h2>
<div class="location">/Doctrine/DBAL/Connection.php at line 149</div>
<h3 id="Connection()">Connection</h3>
<code class="signature">public <strong>Connection</strong>(array params, <a href="../../doctrine/dbal/driver.html">Driver</a> driver, <a href="../../doctrine/dbal/configuration.html">Configuration</a> config, <a href="../../doctrine/common/eventmanager.html">EventManager</a> eventManager)</code>
<div class="details">
<p>Initializes a new instance of the Connection class.</p><dl>
<dt>Parameters:</dt>
<dd>params - The connection parameters.</dd>
<dd></dd>
<dd></dd>
<dd></dd>
</dl>
</div>
<hr>
<h2 id="detail_method">Method Detail</h2>
<div class="location">/Doctrine/DBAL/Connection.php at line 716</div>
<h3 id="beginTransaction()">beginTransaction</h3>
<code class="signature">public void <strong>beginTransaction</strong>()</code>
<div class="details">
<p>Starts a transaction by suspending auto-commit mode.</p></div>
<hr>
<div class="location">/Doctrine/DBAL/Connection.php at line 396</div>
<h3 id="close()">close</h3>
<code class="signature">public void <strong>close</strong>()</code>
<div class="details">
<p>Closes the connection.</p></div>
<hr>
<div class="location">/Doctrine/DBAL/Connection.php at line 734</div>
<h3 id="commit()">commit</h3>
<code class="signature">public void <strong>commit</strong>()</code>
<div class="details">
<p>Commits the current transaction.</p><dl>
<dt>Throws:</dt>
<dd><a href="../../doctrine/dbal/connectionexception.html">If the commit failed due to no active transaction or because the transaction was marked for rollback only.</a></dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/DBAL/Connection.php at line 287</div>
<h3 id="connect()">connect</h3>
<code class="signature">public boolean <strong>connect</strong>()</code>
<div class="details">
<p>Establishes the connection with the database.</p><dl>
<dt>Returns:</dt>
<dd>TRUE if the connection was successfully established, FALSE if the connection is already open.</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/DBAL/Connection.php at line 841</div>
<h3 id="convertToDatabaseValue()">convertToDatabaseValue</h3>
<code class="signature">public mixed <strong>convertToDatabaseValue</strong>(mixed value, string type)</code>
<div class="details">
<p>Converts a given value to its database representation according to the conversion
rules of a specific DBAL mapping type.</p><dl>
<dt>Parameters:</dt>
<dd>value - The value to convert.</dd>
<dd>type - The name of the DBAL mapping type.</dd>
<dt>Returns:</dt>
<dd>The converted value.</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/DBAL/Connection.php at line 854</div>
<h3 id="convertToPHPValue()">convertToPHPValue</h3>
<code class="signature">public mixed <strong>convertToPHPValue</strong>(mixed value, string type)</code>
<div class="details">
<p>Converts a given value to its PHP representation according to the conversion
rules of a specific DBAL mapping type.</p><dl>
<dt>Parameters:</dt>
<dd>value - The value to convert.</dd>
<dd>type - The name of the DBAL mapping type.</dd>
<dt>Returns:</dt>
<dd>The converted type.</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/DBAL/Connection.php at line 376</div>
<h3 id="delete()">delete</h3>
<code class="signature">public integer <strong>delete</strong>(mixed tableName, array identifier, string table)</code>
<div class="details">
<p>Executes an SQL DELETE statement on a table.</p><dl>
<dt>Parameters:</dt>
<dd>table - The name of the table on which to delete.</dd>
<dd>identifier - The deletion criteria. An associateve array containing column-value pairs.</dd>
<dt>Returns:</dt>
<dd>The number of affected rows.</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/DBAL/Connection.php at line 677</div>
<h3 id="errorCode()">errorCode</h3>
<code class="signature">public integer <strong>errorCode</strong>()</code>
<div class="details">
<p>Fetch the SQLSTATE associated with the last database operation.</p><dl>
<dt>Returns:</dt>
<dd>The last error code.</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/DBAL/Connection.php at line 688</div>
<h3 id="errorInfo()">errorInfo</h3>
<code class="signature">public array <strong>errorInfo</strong>()</code>
<div class="details">
<p>Fetch extended error information associated with the last database operation.</p><dl>
<dt>Returns:</dt>
<dd>The last error information.</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/DBAL/Connection.php at line 656</div>
<h3 id="exec()">exec</h3>
<code class="signature">public integer <strong>exec</strong>(string statement)</code>
<div class="details">
<p>Execute an SQL statement and return the number of affected rows.</p><dl>
<dt>Returns:</dt>
<dd>The number of affected rows.</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/DBAL/Connection.php at line 554</div>
<h3 id="executeQuery()">executeQuery</h3>
<code class="signature">public Doctrine\DBAL\Driver\Statement <strong>executeQuery</strong>(string query, array params)</code>
<div class="details">
<p>Executes an, optionally parameterized, SQL query.</p><p>If the query is parameterized, a prepared statement is used.
If an SQLLogger is configured, the execution is logged.</p><dl>
<dt>Parameters:</dt>
<dd>query - The SQL query to execute.</dd>
<dd>params - The parameters to bind to the query, if any.</dd>
<dt>Returns:</dt>
<dd>The executed statement.</dd>
<dt>Internal:</dt>
<dd>PERF: Directly prepares a driver statement, not a wrapper.</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/DBAL/Connection.php at line 626</div>
<h3 id="executeUpdate()">executeUpdate</h3>
<code class="signature">public integer <strong>executeUpdate</strong>(string query, array params, array types)</code>
<div class="details">
<p>Executes an SQL INSERT/UPDATE/DELETE query with the given parameters
and returns the number of affected rows.</p><p>This method supports PDO binding types as well as DBAL mapping types.</p><dl>
<dt>Parameters:</dt>
<dd>query - The SQL query.</dd>
<dd>params - The query parameters.</dd>
<dd>types - The parameter types.</dd>
<dt>Returns:</dt>
<dd>The number of affected rows.</dd>
<dt>Internal:</dt>
<dd>PERF: Directly prepares a driver statement, not a wrapper.</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/DBAL/Connection.php at line 525</div>
<h3 id="fetchAll()">fetchAll</h3>
<code class="signature">public array <strong>fetchAll</strong>(string sql, array params)</code>
<div class="details">
<p>Prepares and executes an SQL query and returns the result as an associative array.</p><dl>
<dt>Parameters:</dt>
<dd>sql - The SQL query.</dd>
<dd>params - The query parameters.</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/DBAL/Connection.php at line 330</div>
<h3 id="fetchArray()">fetchArray</h3>
<code class="signature">public array <strong>fetchArray</strong>(string statement, array params)</code>
<div class="details">
<p>Prepares and executes an SQL query and returns the first row of the result
as a numerically indexed array.</p><dl>
<dt>Parameters:</dt>
<dd>statement - sql query to be executed</dd>
<dd>params - prepared statement params</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/DBAL/Connection.php at line 344</div>
<h3 id="fetchColumn()">fetchColumn</h3>
<code class="signature">public mixed <strong>fetchColumn</strong>(string statement, array params, int colnum)</code>
<div class="details">
<p>Prepares and executes an SQL query and returns the value of a single column
of the first row of the result.</p><dl>
<dt>Parameters:</dt>
<dd>statement - sql query to be executed</dd>
<dd>params - prepared statement params</dd>
<dd>colnum - 0-indexed column number to retrieve</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/DBAL/Connection.php at line 317</div>
<h3 id="fetchRow()">fetchRow</h3>
<code class="signature">public array <strong>fetchRow</strong>(string statement, array params)</code>
<div class="details">
<p>Prepares and executes an SQL query and returns the first row of the result
as an associative array.</p><dl>
<dt>Parameters:</dt>
<dd>statement - The SQL query.</dd>
<dd>params - The query parameters.</dd>
<dt>Todo:</dt>
<dd>Rename: fetchAssoc</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/DBAL/Connection.php at line 256</div>
<h3 id="getConfiguration()">getConfiguration</h3>
<code class="signature">public Doctrine\DBAL\Configuration <strong>getConfiguration</strong>()</code>
<div class="details">
<p>Gets the Configuration used by the Connection.</p></div>
<hr>
<div class="location">/Doctrine/DBAL/Connection.php at line 196</div>
<h3 id="getDatabase()">getDatabase</h3>
<code class="signature">public string <strong>getDatabase</strong>()</code>
<div class="details">
<p>Gets the name of the database this Connection is connected to.</p><dl>
<dt>Returns:</dt>
<dd>$database</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/DBAL/Connection.php at line 276</div>
<h3 id="getDatabasePlatform()">getDatabasePlatform</h3>
<code class="signature">public Doctrine\DBAL\Platforms\AbstractPlatform <strong>getDatabasePlatform</strong>()</code>
<div class="details">
<p>Gets the DatabasePlatform for the connection.</p></div>
<hr>
<div class="location">/Doctrine/DBAL/Connection.php at line 246</div>
<h3 id="getDriver()">getDriver</h3>
<code class="signature">public Doctrine\DBAL\Driver <strong>getDriver</strong>()</code>
<div class="details">
<p>Gets the DBAL driver instance.</p></div>
<hr>
<div class="location">/Doctrine/DBAL/Connection.php at line 266</div>
<h3 id="getEventManager()">getEventManager</h3>
<code class="signature">public Doctrine\Common\EventManager <strong>getEventManager</strong>()</code>
<div class="details">
<p>Gets the EventManager used by the Connection.</p></div>
<hr>
<div class="location">/Doctrine/DBAL/Connection.php at line 206</div>
<h3 id="getHost()">getHost</h3>
<code class="signature">public string <strong>getHost</strong>()</code>
<div class="details">
<p>Gets the hostname of the currently connected database.</p></div>
<hr>
<div class="location">/Doctrine/DBAL/Connection.php at line 186</div>
<h3 id="getParams()">getParams</h3>
<code class="signature">public array <strong>getParams</strong>()</code>
<div class="details">
<p>Gets the parameters used during instantiation.</p><dl>
<dt>Returns:</dt>
<dd>$params</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/DBAL/Connection.php at line 236</div>
<h3 id="getPassword()">getPassword</h3>
<code class="signature">public string <strong>getPassword</strong>()</code>
<div class="details">
<p>Gets the password used by this connection.</p></div>
<hr>
<div class="location">/Doctrine/DBAL/Connection.php at line 216</div>
<h3 id="getPort()">getPort</h3>
<code class="signature">public mixed <strong>getPort</strong>()</code>
<div class="details">
<p>Gets the port of the currently connected database.</p></div>
<hr>
<div class="location">/Doctrine/DBAL/Connection.php at line 825</div>
<h3 id="getRollbackOnly()">getRollbackOnly</h3>
<code class="signature">public boolean <strong>getRollbackOnly</strong>()</code>
<div class="details">
<p>Check whether the current transaction is marked for rollback only.</p><dl>
<dt>Throws:</dt>
<dd><a href="../../doctrine/dbal/connectionexception.html">If no transaction is active.</a></dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/DBAL/Connection.php at line 796</div>
<h3 id="getSchemaManager()">getSchemaManager</h3>
<code class="signature">public Doctrine\DBAL\Schema\SchemaManager <strong>getSchemaManager</strong>()</code>
<div class="details">
<p>Gets the SchemaManager that can be used to inspect or change the
database schema through the connection.</p></div>
<hr>
<div class="location">/Doctrine/DBAL/Connection.php at line 420</div>
<h3 id="getTransactionIsolation()">getTransactionIsolation</h3>
<code class="signature">public integer <strong>getTransactionIsolation</strong>()</code>
<div class="details">
<p>Gets the currently active transaction isolation level.</p><dl>
<dt>Returns:</dt>
<dd>The current transaction isolation level.</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/DBAL/Connection.php at line 667</div>
<h3 id="getTransactionNestingLevel()">getTransactionNestingLevel</h3>
<code class="signature">public integer <strong>getTransactionNestingLevel</strong>()</code>
<div class="details">
<p>Returns the current transaction nesting level.</p><dl>
<dt>Returns:</dt>
<dd>The nesting level. A value of 0 means there's no active transaction.</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/DBAL/Connection.php at line 226</div>
<h3 id="getUsername()">getUsername</h3>
<code class="signature">public string <strong>getUsername</strong>()</code>
<div class="details">
<p>Gets the username used by this connection.</p></div>
<hr>
<div class="location">/Doctrine/DBAL/Connection.php at line 783</div>
<h3 id="getWrappedConnection()">getWrappedConnection</h3>
<code class="signature">public Doctrine\DBAL\Driver\Connection <strong>getWrappedConnection</strong>()</code>
<div class="details">
<p>Gets the wrapped driver connection.</p></div>
<hr>
<div class="location">/Doctrine/DBAL/Connection.php at line 456</div>
<h3 id="insert()">insert</h3>
<code class="signature">public integer <strong>insert</strong>(mixed tableName, array data, string table)</code>
<div class="details">
<p>Inserts a table row with specified data.</p><dl>
<dt>Parameters:</dt>
<dd>table - The name of the table to insert data into.</dd>
<dd>data - An associative array containing column-value pairs.</dd>
<dt>Returns:</dt>
<dd>The number of affected rows.</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/DBAL/Connection.php at line 354</div>
<h3 id="isConnected()">isConnected</h3>
<code class="signature">public boolean <strong>isConnected</strong>()</code>
<div class="details">
<p>Whether an actual connection to the database is established.</p></div>
<hr>
<div class="location">/Doctrine/DBAL/Connection.php at line 364</div>
<h3 id="isTransactionActive()">isTransactionActive</h3>
<code class="signature">public boolean <strong>isTransactionActive</strong>()</code>
<div class="details">
<p>Checks whether a transaction is currently active.</p><dl>
<dt>Returns:</dt>
<dd>TRUE if a transaction is currently active, FALSE otherwise.</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/DBAL/Connection.php at line 705</div>
<h3 id="lastInsertId()">lastInsertId</h3>
<code class="signature">public string <strong>lastInsertId</strong>(string seqName)</code>
<div class="details">
<p>Returns the ID of the last inserted row, or the last value from a sequence object,
depending on the underlying driver.</p><p>Note: This method may not return a meaningful or consistent result across different drivers,
because the underlying database may not even support the notion of AUTO_INCREMENT/IDENTITY
columns or sequences.</p><dl>
<dt>Parameters:</dt>
<dd>seqName - Name of the sequence object from which the ID should be returned.</dd>
<dt>Returns:</dt>
<dd>A string representation of the last inserted ID.</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/DBAL/Connection.php at line 536</div>
<h3 id="prepare()">prepare</h3>
<code class="signature">public Doctrine\DBAL\Driver\Statement <strong>prepare</strong>(string statement)</code>
<div class="details">
<p>Prepares an SQL statement.</p><dl>
<dt>Parameters:</dt>
<dd>statement - The SQL statement to prepare.</dd>
<dt>Returns:</dt>
<dd>The prepared statement.</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/DBAL/Connection.php at line 588</div>
<h3 id="project()">project</h3>
<code class="signature">public mixed <strong>project</strong>(string query, array params, mixed function, Closure mapper)</code>
<div class="details">
<p>Executes an, optionally parameterized, SQL query and returns the result,
applying a given projection/transformation function on each row of the result.</p><dl>
<dt>Parameters:</dt>
<dd>query - The SQL query to execute.</dd>
<dd>params - The parameters, if any.</dd>
<dd>mapper - The transformation function that is applied on each row. The function receives a single paramater, an array, that represents a row of the result set.</dd>
<dt>Returns:</dt>
<dd>The projected result of the query.</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/DBAL/Connection.php at line 609</div>
<h3 id="query()">query</h3>
<code class="signature">public Doctrine\DBAL\Driver\Statement <strong>query</strong>(string statement, integer fetchType)</code>
<div class="details">
<p>Executes an SQL statement, returning a result set as a Statement object.</p></div>
<hr>
<div class="location">/Doctrine/DBAL/Connection.php at line 511</div>
<h3 id="quote()">quote</h3>
<code class="signature">public string <strong>quote</strong>(mixed input, string type)</code>
<div class="details">
<p>Quotes a given input parameter.</p><dl>
<dt>Parameters:</dt>
<dd>input - Parameter to be quoted.</dd>
<dd>type - Type of the parameter.</dd>
<dt>Returns:</dt>
<dd>The quoted parameter.</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/DBAL/Connection.php at line 499</div>
<h3 id="quoteIdentifier()">quoteIdentifier</h3>
<code class="signature">public string <strong>quoteIdentifier</strong>(string str)</code>
<div class="details">
<p>Quote a string so it can be safely used as a table or column name, even if
it is a reserved name.</p><p>Delimiting style depends on the underlying database platform that is being used.</p><p>NOTE: Just because you CAN use quoted identifiers does not mean
you SHOULD use them. In general, they end up causing way more
problems than they solve.</p><dl>
<dt>Parameters:</dt>
<dd>str - The name to be quoted.</dd>
<dt>Returns:</dt>
<dd>The quoted name.</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/DBAL/Connection.php at line 760</div>
<h3 id="rollback()">rollback</h3>
<code class="signature">public void <strong>rollback</strong>()</code>
<div class="details">
<p>Cancel any database changes done during the current transaction.</p><p>this method can be listened with onPreTransactionRollback and onTransactionRollback
eventlistener methods</p><dl>
<dt>Throws:</dt>
<dd><a href="../../doctrine/dbal/connectionexception.html">If the rollback operation failed.</a></dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/DBAL/Connection.php at line 481</div>
<h3 id="setCharset()">setCharset</h3>
<code class="signature">public void <strong>setCharset</strong>(string charset)</code>
<div class="details">
<p>Sets the given charset on the current connection.</p><dl>
<dt>Parameters:</dt>
<dd>charset - The charset to set.</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/DBAL/Connection.php at line 811</div>
<h3 id="setRollbackOnly()">setRollbackOnly</h3>
<code class="signature">public void <strong>setRollbackOnly</strong>()</code>
<div class="details">
<p>Marks the current transaction so that the only possible
outcome for the transaction to be rolled back.</p><dl>
<dt>Throws:</dt>
<dd><a href="../../doctrine/dbal/connectionexception.html">If no transaction is active.</a></dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/DBAL/Connection.php at line 408</div>
<h3 id="setTransactionIsolation()">setTransactionIsolation</h3>
<code class="signature">public void <strong>setTransactionIsolation</strong>(integer level)</code>
<div class="details">
<p>Sets the transaction isolation level.</p><dl>
<dt>Parameters:</dt>
<dd>level - The level to set.</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/DBAL/Connection.php at line 432</div>
<h3 id="update()">update</h3>
<code class="signature">public integer <strong>update</strong>(mixed tableName, mixed data, array identifier, string table)</code>
<div class="details">
<p>Executes an SQL UPDATE statement on a table.</p><dl>
<dt>Parameters:</dt>
<dd>table - The name of the table to update.</dd>
<dd>identifier - The update criteria. An associative array containing column-value pairs.</dd>
<dt>Returns:</dt>
<dd>The number of affected rows.</dd>
</dl>
</div>
<hr>
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="../../doctrine/dbal/package-summary.html">Namespace</a></li>
<li class="active">Class</li>
<li><a href="../../doctrine/dbal/package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../index.html" target="_top">Frames</a>
<a href="../../doctrine/dbal/connection.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>
<p id="footer">This document was generated by <a href="http://peej.github.com/phpdoctor/">PHPDoctor: The PHP Documentation Creator</a></p>
</body>
</html>

129
lib/api/doctrine/dbal/connectionexception.html
View File

@ -1,129 +0,0 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang="en">
<head>
<meta name="generator" content="PHPDoctor 2RC4 (http://phpdoctor.sourceforge.net/)">
<meta name="when" content="Wed, 14 Apr 2010 15:12:03 +0000">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css">
<link rel="start" href="../../overview-summary.html">
<title>ConnectionException (Doctrine)</title>
</head>
<body id="definition" onload="parent.document.title=document.title;">
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="../../doctrine/dbal/package-summary.html">Namespace</a></li>
<li class="active">Class</li>
<li><a href="../../doctrine/dbal/package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../index.html" target="_top">Frames</a>
<a href="../../doctrine/dbal/connectionexception.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>
<div class="qualifiedName">Doctrine\DBAL\ConnectionException</div>
<div class="location">/Doctrine/DBAL/ConnectionException.php at line 33</div>
<h1>Class ConnectionException</h1>
<pre class="tree">Class:ConnectionException - Superclass: DBALException
Class:DBALException - Superclass: Exception
Exception<br>&lfloor;&nbsp;<a href="../../doctrine/dbal/dbalexception.html">DBALException</a><br> &lfloor;&nbsp;<strong>ConnectionException</strong><br /></pre>
<hr>
<p class="signature">public class <strong>ConnectionException</strong><br>extends <a href="../../doctrine/dbal/dbalexception.html">DBALException</a>
</p>
<div class="comment" id="overview_description"><p>Doctrine\DBAL\ConnectionException</p></div>
<dl>
<dt>License:</dt>
<dd>http://www.opensource.org/licenses/lgpl-license.php LGPL</dd>
<dt>See Also:</dt>
<dd><code>www.doctrine-project.org</code></dd>
<dt>Since:</dt>
<dd>2.0</dd>
<dt>Version:</dt>
<dd>$Revision: 4628 $</dd>
<dt>Author:</dt>
<dd>Jonathan H. Wage <jonwage@gmail.com</dd>
</dl>
<hr>
<table id="summary_method">
<tr><th colspan="2">Method Summary</th></tr>
<tr>
<td class="type">static void</td>
<td class="description"><p class="name"><a href="#commitFailedRollbackOnly()">commitFailedRollbackOnly</a>()</p></td>
</tr>
<tr>
<td class="type">static void</td>
<td class="description"><p class="name"><a href="#noActiveTransaction()">noActiveTransaction</a>()</p></td>
</tr>
</table>
<table class="inherit">
<tr><th colspan="2">Methods inherited from Doctrine\DBAL\DBALException</th></tr>
<tr><td><a href="../../doctrine/dbal/dbalexception.html#driverRequired()">driverRequired</a>, <a href="../../doctrine/dbal/dbalexception.html#invalidDriverClass()">invalidDriverClass</a>, <a href="../../doctrine/dbal/dbalexception.html#invalidPdoInstance()">invalidPdoInstance</a>, <a href="../../doctrine/dbal/dbalexception.html#invalidPlatformSpecified()">invalidPlatformSpecified</a>, <a href="../../doctrine/dbal/dbalexception.html#invalidTableName()">invalidTableName</a>, <a href="../../doctrine/dbal/dbalexception.html#invalidWrapperClass()">invalidWrapperClass</a>, <a href="../../doctrine/dbal/dbalexception.html#limitOffsetInvalid()">limitOffsetInvalid</a>, <a href="../../doctrine/dbal/dbalexception.html#noColumnsSpecifiedForTable()">noColumnsSpecifiedForTable</a>, <a href="../../doctrine/dbal/dbalexception.html#notSupported()">notSupported</a>, <a href="../../doctrine/dbal/dbalexception.html#typeExists()">typeExists</a>, <a href="../../doctrine/dbal/dbalexception.html#typeNotFound()">typeNotFound</a>, <a href="../../doctrine/dbal/dbalexception.html#unknownColumnType()">unknownColumnType</a>, <a href="../../doctrine/dbal/dbalexception.html#unknownDriver()">unknownDriver</a></td></tr></table>
<h2 id="detail_method">Method Detail</h2>
<div class="location">/Doctrine/DBAL/ConnectionException.php at line 35</div>
<h3 id="commitFailedRollbackOnly()">commitFailedRollbackOnly</h3>
<code class="signature">public static void <strong>commitFailedRollbackOnly</strong>()</code>
<div class="details">
</div>
<hr>
<div class="location">/Doctrine/DBAL/ConnectionException.php at line 40</div>
<h3 id="noActiveTransaction()">noActiveTransaction</h3>
<code class="signature">public static void <strong>noActiveTransaction</strong>()</code>
<div class="details">
</div>
<hr>
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="../../doctrine/dbal/package-summary.html">Namespace</a></li>
<li class="active">Class</li>
<li><a href="../../doctrine/dbal/package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../index.html" target="_top">Frames</a>
<a href="../../doctrine/dbal/connectionexception.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>
<p id="footer">This document was generated by <a href="http://peej.github.com/phpdoctor/">PHPDoctor: The PHP Documentation Creator</a></p>
</body>
</html>

242
lib/api/doctrine/dbal/dbalexception.html
View File

@ -1,242 +0,0 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang="en">
<head>
<meta name="generator" content="PHPDoctor 2RC4 (http://phpdoctor.sourceforge.net/)">
<meta name="when" content="Wed, 14 Apr 2010 15:12:03 +0000">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css">
<link rel="start" href="../../overview-summary.html">
<title>DBALException (Doctrine)</title>
</head>
<body id="definition" onload="parent.document.title=document.title;">
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="../../doctrine/dbal/package-summary.html">Namespace</a></li>
<li class="active">Class</li>
<li><a href="../../doctrine/dbal/package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../index.html" target="_top">Frames</a>
<a href="../../doctrine/dbal/dbalexception.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>
<div class="qualifiedName">Doctrine\DBAL\DBALException</div>
<div class="location">/Doctrine/DBAL/DBALException.php at line 5</div>
<h1>Class DBALException</h1>
<pre class="tree">Class:DBALException - Superclass: Exception
Exception<br>&lfloor;&nbsp;<strong>DBALException</strong><br /></pre>
<hr>
<p class="signature">public class <strong>DBALException</strong><br>extends Exception
</p>
<hr>
<table id="summary_method">
<tr><th colspan="2">Method Summary</th></tr>
<tr>
<td class="type">static void</td>
<td class="description"><p class="name"><a href="#driverRequired()">driverRequired</a>()</p></td>
</tr>
<tr>
<td class="type">static void</td>
<td class="description"><p class="name"><a href="#invalidDriverClass()">invalidDriverClass</a>(mixed driverClass)</p></td>
</tr>
<tr>
<td class="type">static void</td>
<td class="description"><p class="name"><a href="#invalidPdoInstance()">invalidPdoInstance</a>()</p></td>
</tr>
<tr>
<td class="type">static void</td>
<td class="description"><p class="name"><a href="#invalidPlatformSpecified()">invalidPlatformSpecified</a>()</p></td>
</tr>
<tr>
<td class="type">static <a href="../../doctrine/dbal/dbalexception.html">DBALException</a></td>
<td class="description"><p class="name"><a href="#invalidTableName()">invalidTableName</a>(string tableName)</p><p class="description"></p></td>
</tr>
<tr>
<td class="type">static void</td>
<td class="description"><p class="name"><a href="#invalidWrapperClass()">invalidWrapperClass</a>(mixed wrapperClass)</p></td>
</tr>
<tr>
<td class="type">static void</td>
<td class="description"><p class="name"><a href="#limitOffsetInvalid()">limitOffsetInvalid</a>()</p></td>
</tr>
<tr>
<td class="type">static <a href="../../doctrine/dbal/dbalexception.html">DBALException</a></td>
<td class="description"><p class="name"><a href="#noColumnsSpecifiedForTable()">noColumnsSpecifiedForTable</a>(string tableName)</p><p class="description"></p></td>
</tr>
<tr>
<td class="type">static void</td>
<td class="description"><p class="name"><a href="#notSupported()">notSupported</a>(mixed method)</p></td>
</tr>
<tr>
<td class="type">static void</td>
<td class="description"><p class="name"><a href="#typeExists()">typeExists</a>(mixed name)</p></td>
</tr>
<tr>
<td class="type">static void</td>
<td class="description"><p class="name"><a href="#typeNotFound()">typeNotFound</a>(mixed name)</p></td>
</tr>
<tr>
<td class="type">static void</td>
<td class="description"><p class="name"><a href="#unknownColumnType()">unknownColumnType</a>(mixed name)</p></td>
</tr>
<tr>
<td class="type">static void</td>
<td class="description"><p class="name"><a href="#unknownDriver()">unknownDriver</a>(mixed unknownDriverName, mixed knownDrivers)</p></td>
</tr>
</table>
<h2 id="detail_method">Method Detail</h2>
<div class="location">/Doctrine/DBAL/DBALException.php at line 27</div>
<h3 id="driverRequired()">driverRequired</h3>
<code class="signature">public static void <strong>driverRequired</strong>()</code>
<div class="details">
</div>
<hr>
<div class="location">/Doctrine/DBAL/DBALException.php at line 45</div>
<h3 id="invalidDriverClass()">invalidDriverClass</h3>
<code class="signature">public static void <strong>invalidDriverClass</strong>(mixed driverClass)</code>
<div class="details">
</div>
<hr>
<div class="location">/Doctrine/DBAL/DBALException.php at line 19</div>
<h3 id="invalidPdoInstance()">invalidPdoInstance</h3>
<code class="signature">public static void <strong>invalidPdoInstance</strong>()</code>
<div class="details">
</div>
<hr>
<div class="location">/Doctrine/DBAL/DBALException.php at line 12</div>
<h3 id="invalidPlatformSpecified()">invalidPlatformSpecified</h3>
<code class="signature">public static void <strong>invalidPlatformSpecified</strong>()</code>
<div class="details">
</div>
<hr>
<div class="location">/Doctrine/DBAL/DBALException.php at line 55</div>
<h3 id="invalidTableName()">invalidTableName</h3>
<code class="signature">public static <a href="../../doctrine/dbal/dbalexception.html">DBALException</a> <strong>invalidTableName</strong>(string tableName)</code>
<div class="details">
<p></p></div>
<hr>
<div class="location">/Doctrine/DBAL/DBALException.php at line 39</div>
<h3 id="invalidWrapperClass()">invalidWrapperClass</h3>
<code class="signature">public static void <strong>invalidWrapperClass</strong>(mixed wrapperClass)</code>
<div class="details">
</div>
<hr>
<div class="location">/Doctrine/DBAL/DBALException.php at line 69</div>
<h3 id="limitOffsetInvalid()">limitOffsetInvalid</h3>
<code class="signature">public static void <strong>limitOffsetInvalid</strong>()</code>
<div class="details">
</div>
<hr>
<div class="location">/Doctrine/DBAL/DBALException.php at line 64</div>
<h3 id="noColumnsSpecifiedForTable()">noColumnsSpecifiedForTable</h3>
<code class="signature">public static <a href="../../doctrine/dbal/dbalexception.html">DBALException</a> <strong>noColumnsSpecifiedForTable</strong>(string tableName)</code>
<div class="details">
<p></p></div>
<hr>
<div class="location">/Doctrine/DBAL/DBALException.php at line 7</div>
<h3 id="notSupported()">notSupported</h3>
<code class="signature">public static void <strong>notSupported</strong>(mixed method)</code>
<div class="details">
</div>
<hr>
<div class="location">/Doctrine/DBAL/DBALException.php at line 74</div>
<h3 id="typeExists()">typeExists</h3>
<code class="signature">public static void <strong>typeExists</strong>(mixed name)</code>
<div class="details">
</div>
<hr>
<div class="location">/Doctrine/DBAL/DBALException.php at line 84</div>
<h3 id="typeNotFound()">typeNotFound</h3>
<code class="signature">public static void <strong>typeNotFound</strong>(mixed name)</code>
<div class="details">
</div>
<hr>
<div class="location">/Doctrine/DBAL/DBALException.php at line 79</div>
<h3 id="unknownColumnType()">unknownColumnType</h3>
<code class="signature">public static void <strong>unknownColumnType</strong>(mixed name)</code>
<div class="details">
</div>
<hr>
<div class="location">/Doctrine/DBAL/DBALException.php at line 33</div>
<h3 id="unknownDriver()">unknownDriver</h3>
<code class="signature">public static void <strong>unknownDriver</strong>(mixed unknownDriverName, mixed knownDrivers)</code>
<div class="details">
</div>
<hr>
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="../../doctrine/dbal/package-summary.html">Namespace</a></li>
<li class="active">Class</li>
<li><a href="../../doctrine/dbal/package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../index.html" target="_top">Frames</a>
<a href="../../doctrine/dbal/dbalexception.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>
<p id="footer">This document was generated by <a href="http://peej.github.com/phpdoctor/">PHPDoctor: The PHP Documentation Creator</a></p>
</body>
</html>

175
lib/api/doctrine/dbal/driver.html
View File

@ -1,175 +0,0 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang="en">
<head>
<meta name="generator" content="PHPDoctor 2RC4 (http://phpdoctor.sourceforge.net/)">
<meta name="when" content="Wed, 14 Apr 2010 15:12:04 +0000">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css">
<link rel="start" href="../../overview-summary.html">
<title>Driver (Doctrine)</title>
</head>
<body id="definition" onload="parent.document.title=document.title;">
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="../../doctrine/dbal/package-summary.html">Namespace</a></li>
<li class="active">Class</li>
<li><a href="../../doctrine/dbal/package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../index.html" target="_top">Frames</a>
<a href="../../doctrine/dbal/driver.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>
<div class="qualifiedName">Doctrine\DBAL\Driver</div>
<div class="location">/Doctrine/DBAL/Driver.php at line 11</div>
<h1>Interface Driver</h1>
<pre class="tree"><strong>Driver</strong><br /></pre>
<hr>
<p class="signature">public interface <strong>Driver</strong></p>
<div class="comment" id="overview_description"><p>Driver interface.
Interface that all DBAL drivers must implement.</p></div>
<dl>
<dt>Since:</dt>
<dd>2.0</dd>
</dl>
<hr>
<table id="summary_method">
<tr><th colspan="2">Method Summary</th></tr>
<tr>
<td class="type"> Doctrine\DBAL\Driver\Connection</td>
<td class="description"><p class="name"><a href="#connect()">connect</a>(array params, string username, string password, array driverOptions)</p><p class="description">Attempts to create a connection with the database.</p></td>
</tr>
<tr>
<td class="type"> string</td>
<td class="description"><p class="name"><a href="#getDatabase()">getDatabase</a>(Doctrine\DBAL\Connection conn)</p><p class="description">Get the name of the database connected to for this driver.</p></td>
</tr>
<tr>
<td class="type"> Doctrine\DBAL\Platforms\AbstractPlatform</td>
<td class="description"><p class="name"><a href="#getDatabasePlatform()">getDatabasePlatform</a>()</p><p class="description">Gets the DatabasePlatform instance that provides all the metadata about
the platform this driver connects to.</p></td>
</tr>
<tr>
<td class="type"> string</td>
<td class="description"><p class="name"><a href="#getName()">getName</a>()</p><p class="description">Gets the name of the driver.</p></td>
</tr>
<tr>
<td class="type"> Doctrine\DBAL\SchemaManager</td>
<td class="description"><p class="name"><a href="#getSchemaManager()">getSchemaManager</a>(Doctrine\DBAL\Connection conn)</p><p class="description">Gets the SchemaManager that can be used to inspect and change the underlying
database schema of the platform this driver connects to.</p></td>
</tr>
</table>
<h2 id="detail_method">Method Detail</h2>
<div class="location">/Doctrine/DBAL/Driver.php at line 22</div>
<h3 id="connect()">connect</h3>
<code class="signature">public Doctrine\DBAL\Driver\Connection <strong>connect</strong>(array params, string username, string password, array driverOptions)</code>
<div class="details">
<p>Attempts to create a connection with the database.</p><dl>
<dt>Parameters:</dt>
<dd>params - All connection parameters passed by the user.</dd>
<dd>username - The username to use when connecting.</dd>
<dd>password - The password to use when connecting.</dd>
<dd>driverOptions - The driver options to use when connecting.</dd>
<dt>Returns:</dt>
<dd>The database connection.</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/DBAL/Driver.php at line 54</div>
<h3 id="getDatabase()">getDatabase</h3>
<code class="signature">public string <strong>getDatabase</strong>(Doctrine\DBAL\Connection conn)</code>
<div class="details">
<p>Get the name of the database connected to for this driver.</p><dl>
<dt>Returns:</dt>
<dd>$database</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/DBAL/Driver.php at line 30</div>
<h3 id="getDatabasePlatform()">getDatabasePlatform</h3>
<code class="signature">public Doctrine\DBAL\Platforms\AbstractPlatform <strong>getDatabasePlatform</strong>()</code>
<div class="details">
<p>Gets the DatabasePlatform instance that provides all the metadata about
the platform this driver connects to.</p><dl>
<dt>Returns:</dt>
<dd>The database platform.</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/DBAL/Driver.php at line 46</div>
<h3 id="getName()">getName</h3>
<code class="signature">public string <strong>getName</strong>()</code>
<div class="details">
<p>Gets the name of the driver.</p><dl>
<dt>Returns:</dt>
<dd>The name of the driver.</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/DBAL/Driver.php at line 39</div>
<h3 id="getSchemaManager()">getSchemaManager</h3>
<code class="signature">public Doctrine\DBAL\SchemaManager <strong>getSchemaManager</strong>(Doctrine\DBAL\Connection conn)</code>
<div class="details">
<p>Gets the SchemaManager that can be used to inspect and change the underlying
database schema of the platform this driver connects to.</p></div>
<hr>
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="../../doctrine/dbal/package-summary.html">Namespace</a></li>
<li class="active">Class</li>
<li><a href="../../doctrine/dbal/package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../index.html" target="_top">Frames</a>
<a href="../../doctrine/dbal/driver.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>
<p id="footer">This document was generated by <a href="http://peej.github.com/phpdoctor/">PHPDoctor: The PHP Documentation Creator</a></p>
</body>
</html>

210
lib/api/doctrine/dbal/driver/connection.html
View File

@ -1,210 +0,0 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang="en">
<head>
<meta name="generator" content="PHPDoctor 2RC4 (http://phpdoctor.sourceforge.net/)">
<meta name="when" content="Wed, 14 Apr 2010 15:12:04 +0000">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css">
<link rel="start" href="../../../overview-summary.html">
<title>Connection (Doctrine)</title>
</head>
<body id="definition" onload="parent.document.title=document.title;">
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="../../../doctrine/dbal/driver/package-summary.html">Namespace</a></li>
<li class="active">Class</li>
<li><a href="../../../doctrine/dbal/driver/package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../../index.html" target="_top">Frames</a>
<a href="../../../doctrine/dbal/driver/connection.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>
<div class="qualifiedName">Doctrine\DBAL\Driver\Connection</div>
<div class="location">/Doctrine/DBAL/Driver/Connection.php at line 32</div>
<h1>Interface Connection</h1>
<pre class="tree"><strong>Connection</strong><br /></pre>
<hr>
<p class="signature">public interface <strong>Connection</strong></p>
<div class="comment" id="overview_description"><p>Connection interface.
Driver connections must implement this interface.</p><p>This resembles (a subset of) the PDO interface.</p></div>
<dl>
<dt>Since:</dt>
<dd>2.0</dd>
</dl>
<hr>
<table id="summary_method">
<tr><th colspan="2">Method Summary</th></tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#beginTransaction()">beginTransaction</a>()</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#commit()">commit</a>()</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#errorCode()">errorCode</a>()</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#errorInfo()">errorInfo</a>()</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#exec()">exec</a>(mixed statement)</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#lastInsertId()">lastInsertId</a>(mixed name)</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#prepare()">prepare</a>(mixed prepareString)</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#query()">query</a>()</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#quote()">quote</a>(mixed input, mixed type)</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#rollBack()">rollBack</a>()</p></td>
</tr>
</table>
<h2 id="detail_method">Method Detail</h2>
<div class="location">/Doctrine/DBAL/Driver/Connection.php at line 39</div>
<h3 id="beginTransaction()">beginTransaction</h3>
<code class="signature">public void <strong>beginTransaction</strong>()</code>
<div class="details">
</div>
<hr>
<div class="location">/Doctrine/DBAL/Driver/Connection.php at line 40</div>
<h3 id="commit()">commit</h3>
<code class="signature">public void <strong>commit</strong>()</code>
<div class="details">
</div>
<hr>
<div class="location">/Doctrine/DBAL/Driver/Connection.php at line 42</div>
<h3 id="errorCode()">errorCode</h3>
<code class="signature">public void <strong>errorCode</strong>()</code>
<div class="details">
</div>
<hr>
<div class="location">/Doctrine/DBAL/Driver/Connection.php at line 43</div>
<h3 id="errorInfo()">errorInfo</h3>
<code class="signature">public void <strong>errorInfo</strong>()</code>
<div class="details">
</div>
<hr>
<div class="location">/Doctrine/DBAL/Driver/Connection.php at line 37</div>
<h3 id="exec()">exec</h3>
<code class="signature">public void <strong>exec</strong>(mixed statement)</code>
<div class="details">
</div>
<hr>
<div class="location">/Doctrine/DBAL/Driver/Connection.php at line 38</div>
<h3 id="lastInsertId()">lastInsertId</h3>
<code class="signature">public void <strong>lastInsertId</strong>(mixed name)</code>
<div class="details">
</div>
<hr>
<div class="location">/Doctrine/DBAL/Driver/Connection.php at line 34</div>
<h3 id="prepare()">prepare</h3>
<code class="signature">public void <strong>prepare</strong>(mixed prepareString)</code>
<div class="details">
</div>
<hr>
<div class="location">/Doctrine/DBAL/Driver/Connection.php at line 35</div>
<h3 id="query()">query</h3>
<code class="signature">public void <strong>query</strong>()</code>
<div class="details">
</div>
<hr>
<div class="location">/Doctrine/DBAL/Driver/Connection.php at line 36</div>
<h3 id="quote()">quote</h3>
<code class="signature">public void <strong>quote</strong>(mixed input, mixed type)</code>
<div class="details">
</div>
<hr>
<div class="location">/Doctrine/DBAL/Driver/Connection.php at line 41</div>
<h3 id="rollBack()">rollBack</h3>
<code class="signature">public void <strong>rollBack</strong>()</code>
<div class="details">
</div>
<hr>
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="../../../doctrine/dbal/driver/package-summary.html">Namespace</a></li>
<li class="active">Class</li>
<li><a href="../../../doctrine/dbal/driver/package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../../index.html" target="_top">Frames</a>
<a href="../../../doctrine/dbal/driver/connection.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>
<p id="footer">This document was generated by <a href="http://peej.github.com/phpdoctor/">PHPDoctor: The PHP Documentation Creator</a></p>
</body>
</html>

156
lib/api/doctrine/dbal/driver/oci8/driver.html
View File

@ -1,156 +0,0 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang="en">
<head>
<meta name="generator" content="PHPDoctor 2RC4 (http://phpdoctor.sourceforge.net/)">
<meta name="when" content="Wed, 14 Apr 2010 15:12:04 +0000">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css">
<link rel="start" href="../../../../overview-summary.html">
<title>Driver (Doctrine)</title>
</head>
<body id="definition" onload="parent.document.title=document.title;">
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="../../../../doctrine/dbal/driver/oci8/package-summary.html">Namespace</a></li>
<li class="active">Class</li>
<li><a href="../../../../doctrine/dbal/driver/oci8/package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../../../index.html" target="_top">Frames</a>
<a href="../../../../doctrine/dbal/driver/oci8/driver.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>
<div class="qualifiedName">Doctrine\DBAL\Driver\OCI8\Driver</div>
<div class="location">/Doctrine/DBAL/Driver/OCI8/Driver.php at line 32</div>
<h1>Class Driver</h1>
<pre class="tree"><strong>Driver</strong><br /></pre>
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>Driver </dt>
</dl>
<hr>
<p class="signature">public class <strong>Driver</strong></p>
<div class="comment" id="overview_description"><p>A Doctrine DBAL driver for the Oracle OCI8 PHP extensions.</p></div>
<dl>
<dt>Author:</dt>
<dd>Roman Borschel <roman@code-factory.org></dd>
<dt>Since:</dt>
<dd>2.0</dd>
</dl>
<hr>
<table id="summary_method">
<tr><th colspan="2">Method Summary</th></tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#connect()">connect</a>(mixed params, mixed username, mixed password, mixed driverOptions)</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#getDatabase()">getDatabase</a>(mixed conn)</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#getDatabasePlatform()">getDatabasePlatform</a>()</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#getName()">getName</a>()</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#getSchemaManager()">getSchemaManager</a>(mixed conn)</p></td>
</tr>
</table>
<h2 id="detail_method">Method Detail</h2>
<div class="location">/Doctrine/DBAL/Driver/OCI8/Driver.php at line 34</div>
<h3 id="connect()">connect</h3>
<code class="signature">public void <strong>connect</strong>(mixed params, mixed username, mixed password, mixed driverOptions)</code>
<div class="details">
</div>
<hr>
<div class="location">/Doctrine/DBAL/Driver/OCI8/Driver.php at line 88</div>
<h3 id="getDatabase()">getDatabase</h3>
<code class="signature">public void <strong>getDatabase</strong>(mixed conn)</code>
<div class="details">
</div>
<hr>
<div class="location">/Doctrine/DBAL/Driver/OCI8/Driver.php at line 73</div>
<h3 id="getDatabasePlatform()">getDatabasePlatform</h3>
<code class="signature">public void <strong>getDatabasePlatform</strong>()</code>
<div class="details">
</div>
<hr>
<div class="location">/Doctrine/DBAL/Driver/OCI8/Driver.php at line 83</div>
<h3 id="getName()">getName</h3>
<code class="signature">public void <strong>getName</strong>()</code>
<div class="details">
</div>
<hr>
<div class="location">/Doctrine/DBAL/Driver/OCI8/Driver.php at line 78</div>
<h3 id="getSchemaManager()">getSchemaManager</h3>
<code class="signature">public void <strong>getSchemaManager</strong>(mixed conn)</code>
<div class="details">
</div>
<hr>
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="../../../../doctrine/dbal/driver/oci8/package-summary.html">Namespace</a></li>
<li class="active">Class</li>
<li><a href="../../../../doctrine/dbal/driver/oci8/package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../../../index.html" target="_top">Frames</a>
<a href="../../../../doctrine/dbal/driver/oci8/driver.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>
<p id="footer">This document was generated by <a href="http://peej.github.com/phpdoctor/">PHPDoctor: The PHP Documentation Creator</a></p>
</body>
</html>

230
lib/api/doctrine/dbal/driver/oci8/oci8connection.html
View File

@ -1,230 +0,0 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang="en">
<head>
<meta name="generator" content="PHPDoctor 2RC4 (http://phpdoctor.sourceforge.net/)">
<meta name="when" content="Wed, 14 Apr 2010 15:12:04 +0000">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css">
<link rel="start" href="../../../../overview-summary.html">
<title>OCI8Connection (Doctrine)</title>
</head>
<body id="definition" onload="parent.document.title=document.title;">
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="../../../../doctrine/dbal/driver/oci8/package-summary.html">Namespace</a></li>
<li class="active">Class</li>
<li><a href="../../../../doctrine/dbal/driver/oci8/package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../../../index.html" target="_top">Frames</a>
<a href="../../../../doctrine/dbal/driver/oci8/oci8connection.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>
<div class="qualifiedName">Doctrine\DBAL\Driver\OCI8\OCI8Connection</div>
<div class="location">/Doctrine/DBAL/Driver/OCI8/OCI8Connection.php at line 29</div>
<h1>Class OCI8Connection</h1>
<pre class="tree"><strong>OCI8Connection</strong><br /></pre>
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>Driver Connection </dt>
</dl>
<hr>
<p class="signature">public class <strong>OCI8Connection</strong></p>
<div class="comment" id="overview_description"><p>OCI8 implementation of the Connection interface.</p></div>
<dl>
<dt>Since:</dt>
<dd>2.0</dd>
</dl>
<hr>
<table id="summary_constr">
<tr><th colspan="2">Constructor Summary</th></tr>
<tr>
<td class="description"><p class="name"><a href="#OCI8Connection()">OCI8Connection</a>(mixed username, mixed password, mixed db)</p></td>
</tr>
</table>
<table id="summary_method">
<tr><th colspan="2">Method Summary</th></tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#beginTransaction()">beginTransaction</a>()</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#commit()">commit</a>()</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#errorCode()">errorCode</a>()</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#errorInfo()">errorInfo</a>()</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#exec()">exec</a>(mixed statement)</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#lastInsertId()">lastInsertId</a>(mixed name)</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#prepare()">prepare</a>(mixed prepareString)</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#query()">query</a>()</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#quote()">quote</a>(mixed input, mixed type)</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#rollBack()">rollBack</a>()</p></td>
</tr>
</table>
<h2 id="detail_constr">Constructor Detail</h2>
<div class="location">/Doctrine/DBAL/Driver/OCI8/OCI8Connection.php at line 33</div>
<h3 id="OCI8Connection()">OCI8Connection</h3>
<code class="signature">public <strong>OCI8Connection</strong>(mixed username, mixed password, mixed db)</code>
<div class="details">
</div>
<hr>
<h2 id="detail_method">Method Detail</h2>
<div class="location">/Doctrine/DBAL/Driver/OCI8/OCI8Connection.php at line 73</div>
<h3 id="beginTransaction()">beginTransaction</h3>
<code class="signature">public void <strong>beginTransaction</strong>()</code>
<div class="details">
</div>
<hr>
<div class="location">/Doctrine/DBAL/Driver/OCI8/OCI8Connection.php at line 78</div>
<h3 id="commit()">commit</h3>
<code class="signature">public void <strong>commit</strong>()</code>
<div class="details">
</div>
<hr>
<div class="location">/Doctrine/DBAL/Driver/OCI8/OCI8Connection.php at line 94</div>
<h3 id="errorCode()">errorCode</h3>
<code class="signature">public void <strong>errorCode</strong>()</code>
<div class="details">
</div>
<hr>
<div class="location">/Doctrine/DBAL/Driver/OCI8/OCI8Connection.php at line 103</div>
<h3 id="errorInfo()">errorInfo</h3>
<code class="signature">public void <strong>errorInfo</strong>()</code>
<div class="details">
</div>
<hr>
<div class="location">/Doctrine/DBAL/Driver/OCI8/OCI8Connection.php at line 61</div>
<h3 id="exec()">exec</h3>
<code class="signature">public void <strong>exec</strong>(mixed statement)</code>
<div class="details">
</div>
<hr>
<div class="location">/Doctrine/DBAL/Driver/OCI8/OCI8Connection.php at line 68</div>
<h3 id="lastInsertId()">lastInsertId</h3>
<code class="signature">public void <strong>lastInsertId</strong>(mixed name)</code>
<div class="details">
</div>
<hr>
<div class="location">/Doctrine/DBAL/Driver/OCI8/OCI8Connection.php at line 41</div>
<h3 id="prepare()">prepare</h3>
<code class="signature">public void <strong>prepare</strong>(mixed prepareString)</code>
<div class="details">
</div>
<hr>
<div class="location">/Doctrine/DBAL/Driver/OCI8/OCI8Connection.php at line 46</div>
<h3 id="query()">query</h3>
<code class="signature">public void <strong>query</strong>()</code>
<div class="details">
</div>
<hr>
<div class="location">/Doctrine/DBAL/Driver/OCI8/OCI8Connection.php at line 56</div>
<h3 id="quote()">quote</h3>
<code class="signature">public void <strong>quote</strong>(mixed input, mixed type)</code>
<div class="details">
</div>
<hr>
<div class="location">/Doctrine/DBAL/Driver/OCI8/OCI8Connection.php at line 86</div>
<h3 id="rollBack()">rollBack</h3>
<code class="signature">public void <strong>rollBack</strong>()</code>
<div class="details">
</div>
<hr>
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="../../../../doctrine/dbal/driver/oci8/package-summary.html">Namespace</a></li>
<li class="active">Class</li>
<li><a href="../../../../doctrine/dbal/driver/oci8/package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../../../index.html" target="_top">Frames</a>
<a href="../../../../doctrine/dbal/driver/oci8/oci8connection.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>
<p id="footer">This document was generated by <a href="http://peej.github.com/phpdoctor/">PHPDoctor: The PHP Documentation Creator</a></p>
</body>
</html>

98
lib/api/doctrine/dbal/driver/oci8/oci8exception.html
View File

@ -1,98 +0,0 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang="en">
<head>
<meta name="generator" content="PHPDoctor 2RC4 (http://phpdoctor.sourceforge.net/)">
<meta name="when" content="Wed, 14 Apr 2010 15:12:04 +0000">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css">
<link rel="start" href="../../../../overview-summary.html">
<title>OCI8Exception (Doctrine)</title>
</head>
<body id="definition" onload="parent.document.title=document.title;">
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="../../../../doctrine/dbal/driver/oci8/package-summary.html">Namespace</a></li>
<li class="active">Class</li>
<li><a href="../../../../doctrine/dbal/driver/oci8/package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../../../index.html" target="_top">Frames</a>
<a href="../../../../doctrine/dbal/driver/oci8/oci8exception.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>
<div class="qualifiedName">Doctrine\DBAL\Driver\OCI8\OCI8Exception</div>
<div class="location">/Doctrine/DBAL/Driver/OCI8/OCI8Exception.php at line 24</div>
<h1>Class OCI8Exception</h1>
<pre class="tree">Class:OCI8Exception - Superclass: Exception
Exception<br>&lfloor;&nbsp;<strong>OCI8Exception</strong><br /></pre>
<hr>
<p class="signature">public class <strong>OCI8Exception</strong><br>extends Exception
</p>
<hr>
<table id="summary_method">
<tr><th colspan="2">Method Summary</th></tr>
<tr>
<td class="type">static void</td>
<td class="description"><p class="name"><a href="#fromErrorInfo()">fromErrorInfo</a>(mixed error)</p></td>
</tr>
</table>
<h2 id="detail_method">Method Detail</h2>
<div class="location">/Doctrine/DBAL/Driver/OCI8/OCI8Exception.php at line 26</div>
<h3 id="fromErrorInfo()">fromErrorInfo</h3>
<code class="signature">public static void <strong>fromErrorInfo</strong>(mixed error)</code>
<div class="details">
</div>
<hr>
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="../../../../doctrine/dbal/driver/oci8/package-summary.html">Namespace</a></li>
<li class="active">Class</li>
<li><a href="../../../../doctrine/dbal/driver/oci8/package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../../../index.html" target="_top">Frames</a>
<a href="../../../../doctrine/dbal/driver/oci8/oci8exception.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>
<p id="footer">This document was generated by <a href="http://peej.github.com/phpdoctor/">PHPDoctor: The PHP Documentation Creator</a></p>
</body>
</html>

253
lib/api/doctrine/dbal/driver/oci8/oci8statement.html
View File

@ -1,253 +0,0 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang="en">
<head>
<meta name="generator" content="PHPDoctor 2RC4 (http://phpdoctor.sourceforge.net/)">
<meta name="when" content="Wed, 14 Apr 2010 15:12:04 +0000">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css">
<link rel="start" href="../../../../overview-summary.html">
<title>OCI8Statement (Doctrine)</title>
</head>
<body id="definition" onload="parent.document.title=document.title;">
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="../../../../doctrine/dbal/driver/oci8/package-summary.html">Namespace</a></li>
<li class="active">Class</li>
<li><a href="../../../../doctrine/dbal/driver/oci8/package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../../../index.html" target="_top">Frames</a>
<a href="../../../../doctrine/dbal/driver/oci8/oci8statement.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>
<div class="qualifiedName">Doctrine\DBAL\Driver\OCI8\OCI8Statement</div>
<div class="location">/Doctrine/DBAL/Driver/OCI8/OCI8Statement.php at line 32</div>
<h1>Class OCI8Statement</h1>
<pre class="tree"><strong>OCI8Statement</strong><br /></pre>
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>Driver Statement </dt>
</dl>
<hr>
<p class="signature">public class <strong>OCI8Statement</strong></p>
<div class="comment" id="overview_description"><p>The OCI8 implementation of the Statement interface.</p></div>
<dl>
<dt>Since:</dt>
<dd>2.0</dd>
<dt>Author:</dt>
<dd>Roman Borschel <roman@code-factory.org></dd>
</dl>
<hr>
<table id="summary_constr">
<tr><th colspan="2">Constructor Summary</th></tr>
<tr>
<td class="description"><p class="name"><a href="#OCI8Statement()">OCI8Statement</a>(resource dbh, string statement)</p><p class="description">Creates a new OCI8Statement that uses the given connection handle and SQL statement.</p></td>
</tr>
</table>
<table id="summary_method">
<tr><th colspan="2">Method Summary</th></tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#bindParam()">bindParam</a>(mixed column, mixed variable, mixed type)</p><p class="description">{@inheritdoc}</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#bindValue()">bindValue</a>(mixed param, mixed value, mixed type)</p><p class="description">{@inheritdoc}</p></td>
</tr>
<tr>
<td class="type"> boolean</td>
<td class="description"><p class="name"><a href="#closeCursor()">closeCursor</a>()</p><p class="description">Closes the cursor, enabling the statement to be executed again.</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#columnCount()">columnCount</a>()</p><p class="description">{@inheritdoc}</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#errorCode()">errorCode</a>()</p><p class="description">{@inheritdoc}</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#errorInfo()">errorInfo</a>()</p><p class="description">{@inheritdoc}</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#execute()">execute</a>(mixed params)</p><p class="description">{@inheritdoc}</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#fetch()">fetch</a>(mixed fetchStyle)</p><p class="description">{@inheritdoc}</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#fetchAll()">fetchAll</a>(mixed fetchStyle)</p><p class="description">{@inheritdoc}</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#fetchColumn()">fetchColumn</a>(mixed columnIndex)</p><p class="description">{@inheritdoc}</p></td>
</tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#rowCount()">rowCount</a>()</p><p class="description">{@inheritdoc}</p></td>
</tr>
</table>
<h2 id="detail_constr">Constructor Detail</h2>
<div class="location">/Doctrine/DBAL/Driver/OCI8/OCI8Statement.php at line 51</div>
<h3 id="OCI8Statement()">OCI8Statement</h3>
<code class="signature">public <strong>OCI8Statement</strong>(resource dbh, string statement)</code>
<div class="details">
<p>Creates a new OCI8Statement that uses the given connection handle and SQL statement.</p><dl>
<dt>Parameters:</dt>
<dd>dbh - The connection handle.</dd>
<dd>statement - The SQL statement.</dd>
</dl>
</div>
<hr>
<h2 id="detail_method">Method Detail</h2>
<div class="location">/Doctrine/DBAL/Driver/OCI8/OCI8Statement.php at line 87</div>
<h3 id="bindParam()">bindParam</h3>
<code class="signature">public void <strong>bindParam</strong>(mixed column, mixed variable, mixed type)</code>
<div class="details">
<p></p></div>
<hr>
<div class="location">/Doctrine/DBAL/Driver/OCI8/OCI8Statement.php at line 79</div>
<h3 id="bindValue()">bindValue</h3>
<code class="signature">public void <strong>bindValue</strong>(mixed param, mixed value, mixed type)</code>
<div class="details">
<p></p></div>
<hr>
<div class="location">/Doctrine/DBAL/Driver/OCI8/OCI8Statement.php at line 99</div>
<h3 id="closeCursor()">closeCursor</h3>
<code class="signature">public boolean <strong>closeCursor</strong>()</code>
<div class="details">
<p>Closes the cursor, enabling the statement to be executed again.</p><dl>
<dt>Returns:</dt>
<dd>Returns TRUE on success or FALSE on failure.</dd>
</dl>
</div>
<hr>
<div class="location">/Doctrine/DBAL/Driver/OCI8/OCI8Statement.php at line 107</div>
<h3 id="columnCount()">columnCount</h3>
<code class="signature">public void <strong>columnCount</strong>()</code>
<div class="details">
<p></p></div>
<hr>
<div class="location">/Doctrine/DBAL/Driver/OCI8/OCI8Statement.php at line 115</div>
<h3 id="errorCode()">errorCode</h3>
<code class="signature">public void <strong>errorCode</strong>()</code>
<div class="details">
<p></p></div>
<hr>
<div class="location">/Doctrine/DBAL/Driver/OCI8/OCI8Statement.php at line 127</div>
<h3 id="errorInfo()">errorInfo</h3>
<code class="signature">public void <strong>errorInfo</strong>()</code>
<div class="details">
<p></p></div>
<hr>
<div class="location">/Doctrine/DBAL/Driver/OCI8/OCI8Statement.php at line 135</div>
<h3 id="execute()">execute</h3>
<code class="signature">public void <strong>execute</strong>(mixed params)</code>
<div class="details">
<p></p></div>
<hr>
<div class="location">/Doctrine/DBAL/Driver/OCI8/OCI8Statement.php at line 158</div>
<h3 id="fetch()">fetch</h3>
<code class="signature">public void <strong>fetch</strong>(mixed fetchStyle)</code>
<div class="details">
<p></p></div>
<hr>
<div class="location">/Doctrine/DBAL/Driver/OCI8/OCI8Statement.php at line 170</div>
<h3 id="fetchAll()">fetchAll</h3>
<code class="signature">public void <strong>fetchAll</strong>(mixed fetchStyle)</code>
<div class="details">
<p></p></div>
<hr>
<div class="location">/Doctrine/DBAL/Driver/OCI8/OCI8Statement.php at line 185</div>
<h3 id="fetchColumn()">fetchColumn</h3>
<code class="signature">public void <strong>fetchColumn</strong>(mixed columnIndex)</code>
<div class="details">
<p></p></div>
<hr>
<div class="location">/Doctrine/DBAL/Driver/OCI8/OCI8Statement.php at line 194</div>
<h3 id="rowCount()">rowCount</h3>
<code class="signature">public void <strong>rowCount</strong>()</code>
<div class="details">
<p></p></div>
<hr>
<div class="header">
<h1>Doctrine</h1>
<ul>
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="../../../../doctrine/dbal/driver/oci8/package-summary.html">Namespace</a></li>
<li class="active">Class</li>
<li><a href="../../../../doctrine/dbal/driver/oci8/package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="small_links">
<a href="../../../../index.html" target="_top">Frames</a>
<a href="../../../../doctrine/dbal/driver/oci8/oci8statement.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>
<p id="footer">This document was generated by <a href="http://peej.github.com/phpdoctor/">PHPDoctor: The PHP Documentation Creator</a></p>
</body>
</html>

33
lib/api/doctrine/dbal/driver/oci8/package-frame.html
View File

@ -1,33 +0,0 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang="en">
<head>
<meta name="generator" content="PHPDoctor 2RC4 (http://phpdoctor.sourceforge.net/)">
<meta name="when" content="Wed, 14 Apr 2010 15:12:03 +0000">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css">
<link rel="start" href="../../../../overview-summary.html">
<title>Doctrine\DBAL\Driver\OCI8 (Doctrine)</title>
</head>
<body id="frame">
<h1><a href="package-summary.html" target="main">Doctrine\DBAL\Driver\OCI8</a></h1>
<h2>Classes</h2>
<ul>
<li><a href="../../../../doctrine/dbal/driver/oci8/driver.html" target="main">Driver</a></li>
<li><a href="../../../../doctrine/dbal/driver/oci8/oci8connection.html" target="main">OCI8Connection</a></li>
<li><a href="../../../../doctrine/dbal/driver/oci8/oci8statement.html" target="main">OCI8Statement</a></li>
</ul>
<h2>Exceptions</h2>
<ul>
<li><a href="../../../../doctrine/dbal/driver/oci8/oci8exception.html" target="main">OCI8Exception</a></li>
</ul>
</body>
</html>

Some files were not shown because too many files have changed in this diff Show More