Release 1.0

Author: Tom H Anderson

README.md

@@ -1,6 +1,41 @@
+Doctrine ORM Data Validation
+============================
+
+For one reason or another you will build an ORM on top of an existing database.  The existing database may
+not have referential integrity for all it's relationships.
+
+You now have a database with an ORM and there is probably bad data in the database which does not conform
+to the relationships defined in the ORM.
+
+This tool is intended for devleopment only.
+
+
 Foreign Key Validation
-======================
+----------------------
+
+Create a report by scanning every relationship defined in your ORM for data
+which is missing it's foreign key.  Nullable relationships are not evaluated.
+
+```sh
+php index.php orm:data-validation:relationship --object-manager="doctrine.entitymanager.orm_default"
+```
+
+
+Configure Zend Framework 2 Module
+---------------------------------
+
+```php
+composer require "api-skeletons/zf-doctrine-orm-data-validation": "^1.0"
+```
+
+Add to `config/development.config.php.dist`:
+```php
+return array(
+    'modules' => array(
+        'ZF\\Doctrine\\Audit'
+        ...
+    ),
+```
 
-This library will generate sql to test for invalid data based on relationships between related tables.  This can happen if you overlay an Doctrine ORM on an existing database then use that metadata to create the database and import the old data in.
+Enable development mode to copy `development.config.php.dist` to `development.config.php`
 
-At import foreign key checks will be ignored.  This corrects for that inability to check relationships upon import.

config/module.config.php

@@ -13,7 +13,7 @@
             'routes' => [
                 'zf-doctrine-orm-data-validation-scan' => [
                     'options' => [
-                        'route' => 'orm:data-validation:relationship --objectManager=',
+                        'route' => 'orm:data-validation:relationship --object-manager=',
                         'defaults' => [
                             'controller' => 'ZF\Doctrine\ORM\DataValidation\Controller\ForeignKey',
                             'action' => 'relationship',

src/Controller/ForeignKeyController.php

@@ -27,13 +27,80 @@ public function relationshipAction()
 
         $console = $this->getServiceLocator()->get('console');
 
-        $objectManagerAlias = $this->params()->fromRoute('objectManager');
+        $objectManagerAlias = $this->params()->fromRoute('object-manager');
         $objectManager = $this->getServiceLocator()->get($objectManagerAlias);
 
-        $metadataFactory = $objectManager->getMetadataFactory();
+        $console->write(
+            'Count'
+            . "\t"
+            . 'Child Field'
+            . "\t"
+            . 'Child Entity'
+            . "\t"
+            . 'Parent Entity'
+            . "\n"
+        );
 
-        print_r($metadataFactory->getLoadedMetadata());
+        $allMetadata = $objectManager->getMetadataFactory()->getAllMetadata();
+        foreach ($allMetadata as $metadata) {
 
-        $console->write("End Metadata\n", Color::GREEN);
+            foreach ($metadata->getAssociationMappings() as $mapping) {
+                if ($mapping['type'] == 2) {
+                    $queryBuilder = $objectManager->createQueryBuilder();
+                    $queryBuilder2 = $objectManager->createQueryBuilder();
+
+                    $queryBuilder->select(
+                        "count(child) as ct, '"
+                        . $mapping['fieldName']
+                        . "' as childField, '"
+                        . $metadata->getName()
+                        . "' as childEntity, '"
+                        . $mapping['targetEntity']
+                        . "' as parentEntity"
+                        )
+                        ->from($metadata->getName(), 'child')
+                        ->andWhere($queryBuilder->expr()->not(
+                            $queryBuilder->expr()->exists(
+                                $queryBuilder2->select('parent')
+                                    ->from($mapping['targetEntity'], 'parent')
+                                    ->andWhere($queryBuilder2->expr()->eq(
+                                        'child.' . $mapping['fieldName'],
+                                        'parent'
+                                    ))
+                                    ->getQuery()
+                                    ->getDql()
+                                )
+                            )
+                        )
+                        ;
+
+                    // Do not query columns which are nullable and are null
+                    $childFieldMapping = $objectManager->getMetadataFactory()
+                        ->getMetadataFor($metadata->getName())
+                        ->getAssociationMapping($mapping['fieldName'])
+                        ;
+
+                    if (! isset($childFieldMapping['joinColumns'][0]['nullable'])
+                        || ! $childFieldMapping['joinColumns'][0]['nullable']) {
+
+                        $queryBuilder->andWhere($queryBuilder->expr()->isNotNull('child.' . $mapping['fieldName']));
+                    }
+
+                    $result = $queryBuilder->getQuery()->getOneOrNullResult();
+
+                    if ($result['ct']) {
+                        $console->write($result['ct']
+                            . "\t"
+                            . $result['childField']
+                            . "\t"
+                            . $result['childEntity']
+                            . "\t"
+                            . $result['parentEntity']
+                            . "\n"
+                        );
+                    }
+                }
+            }
+        }
     }
 }