Merge pull request #144 from seamuslee001/dao-FKs

generate foreign keys in DAOs

Author: totten

src/CRM/CivixBundle/Command/AddEntityBoilerplateCommand.php

@@ -25,10 +25,17 @@ protected function configure() {
       );
   }
 
+
+  /**
+   * Note: this function replicates a fair amount of the functionality of
+   * CRM_Core_CodeGen_Specification (which is a bit messy and hard to interact
+   * with). It's tempting to completely rewrite / rethink entity generation. Until
+   * then...
+   */
   protected function execute(InputInterface $input, OutputInterface $output) {
-    // load Civi to get access to civicrm_api_get_function_name
     Services::boot(['output' => $output]);
     $civicrm_api3 = Services::api3();
+
     if (!$civicrm_api3 || !$civicrm_api3->local) {
       $output->writeln("<error>Require access to local CiviCRM source tree. Configure civicrm_api3_conf_path.</error>");
       return 1;
@@ -42,33 +49,30 @@ protected function execute(InputInterface $input, OutputInterface $output) {
     $ctx['type'] = 'module';
     $ctx['basedir'] = \CRM\CivixBundle\Application::findExtDir();
     $basedir = new Path($ctx['basedir']);
-
     $info = new Info($basedir->string('info.xml'));
     $info->load($ctx);
     $attrs = $info->get()->attributes();
+
     if ($attrs['type'] != 'module') {
       $output->writeln('<error>Wrong extension type: ' . $attrs['type'] . '</error>');
       return;
     }
 
     $xmlSchemaGlob = "xml/schema/{$ctx['namespace']}/*.xml";
     $absXmlSchemaGlob = $basedir->string($xmlSchemaGlob);
-    // var_dump(($absXmlSchemaGlob));
     $xmlSchemas = glob($absXmlSchemaGlob);
 
-    if(!count($xmlSchemas)){
+    if (!count($xmlSchemas)) {
       throw new Exception("Could not find files matching '$xmlSchemaGlob'. You may want to run `civix generate:entity` before running this command.");
     }
 
-    $specification = new \CRM_Core_CodeGen_Specification;
+    $specification = new \CRM_Core_CodeGen_Specification();
     $specification->buildVersion = \CRM_Utils_System::majorVersion();
-
-    $config = new \stdClass;
+    $config = new \stdClass();
     $config->phpCodePath = $basedir->string('');
     $config->sqlCodePath = $basedir->string('sql/');
 
-    foreach($xmlSchemas as $xmlSchema){
-
+    foreach ($xmlSchemas as $xmlSchema) {
       $dom = new \DomDocument();
       $xmlString = file_get_contents($xmlSchema);
       $dom->loadXML($xmlString);
@@ -78,15 +82,23 @@ protected function execute(InputInterface $input, OutputInterface $output) {
         continue;
       }
       $specification->getTable($xml, $database, $tables);
+      $name = (string) $xml->name;
+      $tables[$name]['name'] = $name;
+      $tables[$name]['sourceFile'] = $xmlSchema;
+    }
 
-      $tables[(string) $xml->name]['sourceFile'] = $xmlSchema;
-      $config->tables = $tables;
-      $_namespace = ' ' . preg_replace(':/:', '_', $ctx['namespace']);
-      $dao = new \CRM_Core_CodeGen_DAO($config, (string) $xml->name, "{$_namespace}_ExtensionUtil::ts");
+    $config->tables = $tables;
+    $_namespace = ' ' . preg_replace(':/:', '_', $ctx['namespace']);
+    $this->orderTables($tables);
+    $this->resolveForeignKeys($tables);
+    $config->tables = $tables;
+
+    foreach ($tables as $table) {
+      $dao = new \CRM_Core_CodeGen_DAO($config, (string) $table['name'], "{$_namespace}_ExtensionUtil::ts");
       ob_start(); // Don't display gencode's output
       $dao->run();
       ob_end_clean(); // Don't display gencode's output
-      $daoFileName = $basedir->string("{$xml->base}/DAO/{$xml->class}.php");
+      $daoFileName = $basedir->string("{$table['base']}{$table['fileName']}");
       $output->writeln("<info>Write $daoFileName</info>");
     }
 
@@ -100,16 +112,56 @@ protected function execute(InputInterface $input, OutputInterface $output) {
     $schema->generateDropSql('auto_uninstall.sql');
     $output->writeln("<info>Write {$basedir->string('sql/auto_uninstall.sql')}</info>");
     ob_end_clean(); // Don't display gencode's output
-
     $module = new Module(Services::templating());
     $module->loadInit($ctx);
     $module->save($ctx, $output);
+    $upgraderClass = str_replace('/', '_', $ctx['namespace']) . '_Upgrader';
 
-    $upgraderClass = str_replace('/', '_', $ctx['namespace']).'_Upgrader';
-    if(!class_exists($upgraderClass)){
+    if (!class_exists($upgraderClass)) {
       $output->writeln('<comment>You are missing an upgrader class. Your generated SQL files will not be executed on enable and uninstall. Fix this by running `civix generate:upgrader`.</comment>');
     }
 
   }
 
+  private function orderTables(&$tables) {
+
+    $ordered = [];
+
+    while (count($tables)) {
+      foreach ($tables as $k => $table) {
+        if (!isset($table['foreignKey'])) {
+          $ordered[$k] = $table;
+          unset($tables[$k]);
+        }
+        foreach ($table['foreignKey'] as $fKey) {
+          if (in_array($fKey['table'], array_keys($tables))) {
+            continue;
+          }
+          $ordered[$k] = $table;
+          unset($tables[$k]);
+        }
+      }
+    }
+    $tables = $ordered;
+  }
+
+  private function resolveForeignKeys(&$tables) {
+    foreach ($tables as &$table) {
+      if (isset($table['foreignKey'])) {
+        foreach ($table['foreignKey'] as &$key) {
+          if (isset($tables[$key['table']])) {
+            $key['className'] = $tables[$key['table']]['className'];
+            $key['fileName'] = $tables[$key['table']]['fileName'];
+            $table['fields'][$key['name']]['FKClassName'] = $key['className'];
+          }
+          else {
+            $key['className'] = \CRM_Core_DAO_AllCoreTables::getClassForTable($key['table']);
+            $key['fileName'] = $key['className'] . '.php';
+            $table['fields'][$key['name']]['FKClassName'] = $key['className'];
+          }
+        }
+      }
+    }
+  }
+
 }