[DDC-551] Add SQLFilter functionality

lib/Doctrine/ORM/Configuration.php

@@ -495,7 +495,33 @@ public function getClassMetadataFactoryName()
         }
         return $this->_attributes['classMetadataFactoryName'];
     }
-
+
+    /**
+     * Add a filter to the list of possible filters.
+     *
+     * @param string $name The name of the filter.
+     * @param string $className The class name of the filter.
+     */
+    public function addFilter($name, $className)
+    {
+        $this->_attributes['filters'][strtolower($name)] = $className;
+    }
+
+    /**
+     * Gets the class name for a given filter name.
+     *
+     * @param string $name The name of the filter.
+     *
+     * @return string The class name of the filter, or null of it is not
+     *  defined.
+     */
+    public function getFilterClassName($name)
+    {
+        $name = strtolower($name);
+        return isset($this->_attributes['filters'][$name]) ?
+                $this->_attributes['filters'][$name] : null;
+    }
+
     /**
      * Set default repository class.
      * 
@@ -523,4 +549,4 @@ public function getDefaultRepositoryClassName()
         return isset($this->_attributes['defaultRepositoryClassName']) ?
                 $this->_attributes['defaultRepositoryClassName'] : 'Doctrine\ORM\EntityRepository';
     }
-}
+}

lib/Doctrine/ORM/EntityManager.php

@@ -27,7 +27,8 @@
     Doctrine\ORM\Mapping\ClassMetadata,
     Doctrine\ORM\Mapping\ClassMetadataFactory,
     Doctrine\ORM\Query\ResultSetMapping,
-    Doctrine\ORM\Proxy\ProxyFactory;
+    Doctrine\ORM\Proxy\ProxyFactory,
+    Doctrine\ORM\Query\FilterCollection;
 
 /**
  * The EntityManager is the central access point to ORM functionality.
@@ -110,6 +111,13 @@ class EntityManager implements ObjectManager
      */
     private $closed = false;
 
+    /**
+     * Collection of query filters.
+     *
+     * @var Doctrine\ORM\Query\FilterCollection
+     */
+    private $filterCollection;
+
     /**
      * Creates a new EntityManager that operates on the given database connection
      * and uses the given Configuration and EventManager implementations.
@@ -788,4 +796,39 @@ public static function create($conn, Configuration $config, EventManager $eventM
 
         return new EntityManager($conn, $config, $conn->getEventManager());
     }
+
+    /**
+     * Gets the enabled filters.
+     *
+     * @return FilterCollection The active filter collection.
+     */
+    public function getFilters()
+    {
+        if(null === $this->filterCollection) {
+            $this->filterCollection = new FilterCollection($this);
+        }
+
+        return $this->filterCollection;
+    }
+
+    /**
+     * Checks whether the state of the filter collection is clean.
+     *
+     * @return boolean True, iff the filter collection is clean.
+     */
+    public function isFiltersStateClean()
+    {
+        return null === $this->filterCollection
+           || $this->filterCollection->isClean();
+    }
+
+    /**
+     * Checks whether the Entity Manager has filters.
+     *
+     * @return True, iff the EM has a filter collection.
+     */
+    public function hasFilters()
+    {
+        return null !== $this->filterCollection;
+    }
 }

lib/Doctrine/ORM/Persisters/BasicEntityPersister.php

@@ -72,6 +72,7 @@
  * @author Roman Borschel <roman@code-factory.org>
  * @author Giorgio Sironi <piccoloprincipeazzurro@gmail.com>
  * @author Benjamin Eberlei <kontakt@beberlei.de>
+ * @author Alexander <iam.asm89@gmail.com>
  * @since 2.0
  */
 class BasicEntityPersister
@@ -900,9 +901,16 @@ protected function _getSelectEntitiesSQL(array $criteria, $assoc = null, $lockMo
             $lockSql = ' ' . $this->_platform->getWriteLockSql();
         }
 
+        $alias = $this->_getSQLTableAlias($this->_class->name);
+
+        if('' !== $filterSql = $this->generateFilterConditionSQL($this->_class, $alias)) {
+            if($conditionSql) $conditionSql .= ' AND ';
+            $conditionSql .= $filterSql;
+        }
+
         return $this->_platform->modifyLimitQuery('SELECT ' . $this->_getSelectColumnListSQL()
              . $this->_platform->appendLockHint(' FROM ' . $this->_class->getQuotedTableName($this->_platform) . ' '
-             . $this->_getSQLTableAlias($this->_class->name), $lockMode)
+             . $alias, $lockMode)
              . $this->_selectJoinSql . $joinSql
              . ($conditionSql ? ' WHERE ' . $conditionSql : '')
              . $orderBySql, $limit, $offset)
@@ -1018,10 +1026,16 @@ protected function _getSelectColumnListSQL()
                         if ( ! $first) {
                             $this->_selectJoinSql .= ' AND ';
                         }
+                        $tableAlias = $this->_getSQLTableAlias($assoc['targetEntity'], $assocAlias);
                         $this->_selectJoinSql .= $this->_getSQLTableAlias($assoc['sourceEntity']) . '.' . $sourceCol . ' = '
-                                               . $this->_getSQLTableAlias($assoc['targetEntity'], $assocAlias) . '.' . $targetCol;
+                                               . $tableAlias . '.' . $targetCol;
                         $first = false;
                     }
+
+                    // Add filter SQL
+                    if('' !== $filterSql = $this->generateFilterConditionSQL($eagerEntity, $tableAlias)) {
+                        $this->_selectJoinSql .= ' AND ' . $filterSql;
+                    }
                 } else {
                     $eagerEntity = $this->_em->getClassMetadata($assoc['targetEntity']);
                     $owningAssoc = $eagerEntity->getAssociationMapping($assoc['mappedBy']);
@@ -1267,10 +1281,10 @@ public function lock(array $criteria, $lockMode)
      *
      * @return string
      */
-    protected function getLockTablesSql()
+    protected function getLockTablesSql($alias = null)
     {
         return 'FROM ' . $this->_class->getQuotedTableName($this->_platform) . ' '
-             . $this->_getSQLTableAlias($this->_class->name);
+             . (null !== $alias ? $alias : $this->_getSQLTableAlias($this->_class->name));
     }
 
     /**
@@ -1521,10 +1535,16 @@ public function exists($entity, array $extraConditions = array())
             $criteria = array_merge($criteria, $extraConditions);
         }
 
+        $alias = $this->_getSQLTableAlias($this->_class->name);
+
         $sql = 'SELECT 1 '
-             . $this->getLockTablesSql()
+             . $this->getLockTablesSql($alias)
              . ' WHERE ' . $this->_getSelectConditionSQL($criteria);
 
+        if('' !== $filterSql = $this->generateFilterConditionSQL($this->_class, $alias)) {
+            $sql .= ' AND ' . $filterSql;
+        }
+
         list($params, $types) = $this->expandParameters($criteria);
 
         return (bool) $this->_conn->fetchColumn($sql, $params);
@@ -1562,4 +1582,25 @@ public function getSQLColumnAlias($columnName)
             substr($columnName . $this->_sqlAliasCounter++, -$this->_platform->getMaxIdentifierLength())
         );
     }
+
+    /**
+     * Generates the filter SQL for a given entity and table alias.
+     *
+     * @param ClassMetadata $targetEntity Metadata of the target entity.
+     * @param string $targetTableAlias The table alias of the joined/selected table.
+     *
+     * @return string The SQL query part to add to a query.
+     */
+    protected function generateFilterConditionSQL(ClassMetadata $targetEntity, $targetTableAlias)
+    {
+        $filterClauses = array();
+
+        foreach($this->_em->getFilters()->getEnabledFilters() as $filter) {
+            if('' !== $filterExpr = $filter->addFilterConstraint($targetEntity, $targetTableAlias)) {
+                $filterClauses[] = '(' . $filterExpr . ')';
+            }
+        }
+
+        return implode(' AND ', $filterClauses);
+    }
 }

lib/Doctrine/ORM/Persisters/JoinedSubclassPersister.php

@@ -31,6 +31,7 @@
  *
  * @author Roman Borschel <roman@code-factory.org>
  * @author Benjamin Eberlei <kontakt@beberlei.de>
+ * @author Alexander <iam.asm89@gmail.com>
  * @since 2.0
  * @see http://martinfowler.com/eaaCatalog/classTableInheritance.html
  */
@@ -327,6 +328,13 @@ protected function _getSelectEntitiesSQL(array $criteria, $assoc = null, $lockMo
                 if ($first) $first = false; else $joinSql .= ' AND ';
 
                 $joinSql .= $baseTableAlias . '.' . $idColumn . ' = ' . $tableAlias . '.' . $idColumn;
+
+                if($parentClass->name === $this->_class->rootEntityName) {
+                    // Add filters on the root class
+                    if('' !== $filterSql = $this->generateFilterConditionSQL($parentClass, $tableAlias)) {
+                        $joinSql .= ' AND ' . $filterSql;
+                    }
+                }
             }
         }
 
@@ -374,6 +382,14 @@ protected function _getSelectEntitiesSQL(array $criteria, $assoc = null, $lockMo
 
         $conditionSql = $this->_getSelectConditionSQL($criteria, $assoc);
 
+        // If the current class in the root entity, add the filters
+        if($this->_class->name === $this->_class->rootEntityName) {
+            if('' !== $filterSql = $this->generateFilterConditionSQL($this->_class, $baseTableAlias)) {
+                if($conditionSql) $conditionSql .= ' AND ';
+                $conditionSql .= $filterSql;
+            }
+        }
+
         $orderBy = ($assoc !== null && isset($assoc['orderBy'])) ? $assoc['orderBy'] : $orderBy;
         $orderBySql = $orderBy ? $this->_getOrderBySQL($orderBy, $baseTableAlias) : '';
 
@@ -401,10 +417,10 @@ protected function _getSelectEntitiesSQL(array $criteria, $assoc = null, $lockMo
      *
      * @return string
      */
-    public function getLockTablesSql()
+    public function getLockTablesSql($alias = null)
     {
         $idColumns = $this->_class->getIdentifierColumnNames();
-        $baseTableAlias = $this->_getSQLTableAlias($this->_class->name);
+        $baseTableAlias = null !== $alias ? $alias : $this->_getSQLTableAlias($this->_class->name);
 
         // INNER JOIN parent tables
         $joinSql = '';
@@ -473,4 +489,5 @@ protected function assignDefaultVersionValue($entity, $id)
         $value = $this->fetchVersionValue($this->_getVersionedClassMetadata(), $id);
         $this->_class->setFieldValue($entity, $this->_class->versionField, $value);
     }
+
 }

lib/Doctrine/ORM/Persisters/ManyToManyPersister.php

@@ -21,14 +21,16 @@
 
 namespace Doctrine\ORM\Persisters;
 
-use Doctrine\ORM\PersistentCollection,
+use Doctrine\ORM\Mapping\ClassMetadata,
+    Doctrine\ORM\PersistentCollection,
     Doctrine\ORM\UnitOfWork;
 
 /**
  * Persister for many-to-many collections.
  *
  * @author  Roman Borschel <roman@code-factory.org>
  * @author  Guilherme Blanco <guilhermeblanco@hotmail.com>
+ * @author  Alexander <iam.asm89@gmail.com>
  * @since   2.0
  */
 class ManyToManyPersister extends AbstractCollectionPersister
@@ -215,10 +217,16 @@ public function count(PersistentCollection $coll)
                 ? $id[$class->getFieldForColumn($joinColumns[$joinTableColumn])]
                 : $id[$class->fieldNames[$joinColumns[$joinTableColumn]]];
         }
-
+
+        list($joinTargetEntitySQL, $filterSql) = $this->getFilterSql($mapping);
+        if('' !== $filterSql) {
+            $whereClauses[] = $filterSql;
+        }
+
         $sql = 'SELECT COUNT(*)'
-             . ' FROM ' . $class->getQuotedJoinTableName($mapping, $this->_conn->getDatabasePlatform()) 
-             . ' WHERE ' . implode(' AND ', $whereClauses);
+            . ' FROM ' . $class->getQuotedJoinTableName($mapping, $this->_conn->getDatabasePlatform()) . ' t'
+            . $joinTargetEntitySQL
+            . ' WHERE ' . implode(' AND ', $whereClauses);
 
         return $this->_conn->fetchColumn($sql, $params);
     }
@@ -250,7 +258,7 @@ public function contains(PersistentCollection $coll, $element)
             return false;
         }
 
-        list($quotedJoinTable, $whereClauses, $params) = $this->getJoinTableRestrictions($coll, $element);
+        list($quotedJoinTable, $whereClauses, $params) = $this->getJoinTableRestrictions($coll, $element, true);
 
         $sql = 'SELECT 1 FROM ' . $quotedJoinTable . ' WHERE ' . implode(' AND ', $whereClauses);
 
@@ -271,7 +279,7 @@ public function removeElement(PersistentCollection $coll, $element)
             return false;
         }
 
-        list($quotedJoinTable, $whereClauses, $params) = $this->getJoinTableRestrictions($coll, $element);
+        list($quotedJoinTable, $whereClauses, $params) = $this->getJoinTableRestrictions($coll, $element, false);
 
         $sql = 'DELETE FROM ' . $quotedJoinTable . ' WHERE ' . implode(' AND ', $whereClauses);
 
@@ -281,9 +289,10 @@ public function removeElement(PersistentCollection $coll, $element)
     /**
      * @param Doctrine\ORM\PersistentCollection $coll
      * @param object $element
+     * @param boolean $addFilters Whether the filter SQL should be included or not.
      * @return array
      */
-    private function getJoinTableRestrictions(PersistentCollection $coll, $element)
+    private function getJoinTableRestrictions(PersistentCollection $coll, $element, $addFilters)
     {
         $uow     = $this->_em->getUnitOfWork();
         $mapping = $coll->getMapping();
@@ -321,7 +330,65 @@ private function getJoinTableRestrictions(PersistentCollection $coll, $element)
                 ? $sourceId[$sourceClass->getFieldForColumn($mapping['relationToSourceKeyColumns'][$joinTableColumn])]
                 : $sourceId[$sourceClass->fieldNames[$mapping['relationToSourceKeyColumns'][$joinTableColumn]]];
         }
+
+        if($addFilters) {
+            list($joinTargetEntitySQL, $filterSql) = $this->getFilterSql($mapping);
+            if('' !== $filterSql) {
+                $quotedJoinTable .= ' t ' . $joinTargetEntitySQL;
+                $whereClauses[] = $filterSql;
+            }
+        }
 
         return array($quotedJoinTable, $whereClauses, $params);
     }
-}
+
+    /**
+     * Generates the filter SQL for a given mapping.
+     *
+     * @param array $targetEntity Array containing mapping information.
+     *
+     * @return string The SQL query part to add to a query.
+     */
+    public function getFilterSql($mapping)
+    {
+        $targetClass = $this->_em->getClassMetadata($mapping['targetEntity']);
+
+        // A join is needed if there is filtering on the target entity
+        $joinTargetEntitySQL = '';
+        if('' !== $filterSql = $this->generateFilterConditionSQL($targetClass, 'te')) {
+            $joinTargetEntitySQL = ' JOIN '
+                . $targetClass->getQuotedTableName($this->_conn->getDatabasePlatform()) . ' te'
+                . ' ON';
+
+            $joinTargetEntitySQLClauses = array();
+            foreach($mapping['relationToTargetKeyColumns'] as $joinTableColumn => $targetTableColumn) {
+                $joinTargetEntitySQLClauses[] = ' t.' . $joinTableColumn . ' = ' . 'te.' . $targetTableColumn;
+            }
+
+            $joinTargetEntitySQL .= implode(' AND ', $joinTargetEntitySQLClauses);
+        }
+
+        return array($joinTargetEntitySQL, $filterSql);
+    }
+
+    /**
+     * Generates the filter SQL for a given entity and table alias.
+     *
+     * @param ClassMetadata $targetEntity Metadata of the target entity.
+     * @param string $targetTableAlias The table alias of the joined/selected table.
+     *
+     * @return string The SQL query part to add to a query.
+     */
+    protected function generateFilterConditionSQL(ClassMetadata $targetEntity, $targetTableAlias)
+    {
+        $filterClauses = array();
+
+        foreach($this->_em->getFilters()->getEnabledFilters() as $filter) {
+            if('' !== $filterExpr = $filter->addFilterConstraint($targetEntity, $targetTableAlias)) {
+                $filterClauses[] = '(' . $filterExpr . ')';
+            }
+        }
+
+        return implode(' AND ', $filterClauses);
+    }
+}