SetBased / php-audit

src/Command/DiffCommand.php

Doc Comments +2 added lines, -2 removed lines

@@ -122,7 +122,7 @@ 
    *
    * @param array[] $columns The metadata of the columns.
    *
-   * @return array[]
+   * @return \array[]
    */
   private function addHighlighting($columns)
   {
@@ -253,7 +253,7 @@ 
   /**
    * Add not null to audit columns if it not nullable.
    *
-   * @param array $theColumns Audit columns.
+   * @param \array[] $theColumns Audit columns.
    *
    * @return array
    */

Indentation +205 added lines, -205 removed lines

@@ -21,70 +21,70 @@ 
  */
 class DiffCommand extends AuditCommand
 {
-  //--------------------------------------------------------------------------------------------------------------------
-  /**
-   * Array with columns for each table.
-   * array [
-   *    table_name [
-   *            column [
-   *                    data table type,
-   *                    audit table type
-   *                    ],
-   *                      ...
-   *               ]
-   *       ]
-   *
-   * @var array[]
-   */
-  private $diffColumns;
-
-  /**
-   * If set all tables and columns are shown.
-   *
-   * @var string
-   */
-  private $full;
-
-  //--------------------------------------------------------------------------------------------------------------------
-  /**
-   * Check full full and return array without new or obsolete columns if full not set.
-   *
-   * @param array[] $columns The metadata of the columns of a table.
-   *
-   * @return array[]
-   */
-  private static function removeMatchingColumns($columns)
-  {
+    //--------------------------------------------------------------------------------------------------------------------
+    /**
+     * Array with columns for each table.
+     * array [
+     *    table_name [
+     *            column [
+     *                    data table type,
+     *                    audit table type
+     *                    ],
+     *                      ...
+     *               ]
+     *       ]
+     *
+     * @var array[]
+     */
+    private $diffColumns;
+
+    /**
+     * If set all tables and columns are shown.
+     *
+     * @var string
+     */
+    private $full;
+
+    //--------------------------------------------------------------------------------------------------------------------
+    /**
+     * Check full full and return array without new or obsolete columns if full not set.
+     *
+     * @param array[] $columns The metadata of the columns of a table.
+     *
+     * @return array[]
+     */
+    private static function removeMatchingColumns($columns)
+    {
     $cleaned = [];
     foreach ($columns as $column)
     {
-      if (($column['data_table_type']!=$column['audit_table_type'] && $column['audit_table_type']!=$column['config_type']) || ($column['audit_table_type']!=$column['config_type'] && !empty($column['config_type'])))
-      {
+        if (($column['data_table_type']!=$column['audit_table_type'] && $column['audit_table_type']!=$column['config_type']) || ($column['audit_table_type']!=$column['config_type'] && !empty($column['config_type'])))
+        {
         $cleaned[] = $column;
-      }
+        }
     }
 
     return $cleaned;
-  }
-
-  //--------------------------------------------------------------------------------------------------------------------
-  /**
-   * {@inheritdoc}
-   */
-  protected function configure()
-  {
+    }
+
+    //--------------------------------------------------------------------------------------------------------------------
+    /**
+     * {@inheritdoc}
+     */
+    protected function configure()
+    {
     $this->setName('diff')
-         ->setDescription('Compares data tables and audit tables')
-         ->addArgument('config file', InputArgument::OPTIONAL, 'The audit configuration file', 'etc/audit.json')
-         ->addOption('full', 'f', InputOption::VALUE_NONE, 'Show all columns');
-  }
-
-  //--------------------------------------------------------------------------------------------------------------------
-  /**
-   * {@inheritdoc}
-   */
-  protected function execute(InputInterface $input, OutputInterface $output)
-  {
+            ->setDescription('Compares data tables and audit tables')
+            ->addArgument('config file', InputArgument::OPTIONAL, 'The audit configuration file', 'etc/audit.json')
+            ->addOption('full', 'f', InputOption::VALUE_NONE, 'Show all columns');
+    }
+
+    //--------------------------------------------------------------------------------------------------------------------
+    /**
+     * {@inheritdoc}
+     */
+    protected function execute(InputInterface $input, OutputInterface $output)
+    {
     $this->io = new StratumStyle($input, $output);
 
     // Style for column names with miss matched column types.
@@ -114,239 +114,239 @@ 
 
     $this->getDiff();
     $this->printDiff($output);
-  }
-
-  //--------------------------------------------------------------------------------------------------------------------
-  /**
-   * Add highlighting to columns.
-   *
-   * @param array[] $columns The metadata of the columns.
-   *
-   * @return array[]
-   */
-  private function addHighlighting($columns)
-  {
+    }
+
+    //--------------------------------------------------------------------------------------------------------------------
+    /**
+     * Add highlighting to columns.
+     *
+     * @param array[] $columns The metadata of the columns.
+     *
+     * @return array[]
+     */
+    private function addHighlighting($columns)
+    {
     $styledColumns = [];
     foreach ($columns as $column)
     {
-      $styledColumn = $column;
-      // Highlighting for data table column types and audit.
-      if (!empty($column['data_table_type']))
-      {
+        $styledColumn = $column;
+        // Highlighting for data table column types and audit.
+        if (!empty($column['data_table_type']))
+        {
         if (isset($column['data_table_type']) && !isset($column['audit_table_type']))
         {
-          $styledColumn['column_name']     = sprintf('<mm_column>%s</>', $styledColumn['column_name']);
-          $styledColumn['data_table_type'] = sprintf('<mm_type>%s</>', $styledColumn['data_table_type']);
+            $styledColumn['column_name']     = sprintf('<mm_column>%s</>', $styledColumn['column_name']);
+            $styledColumn['data_table_type'] = sprintf('<mm_type>%s</>', $styledColumn['data_table_type']);
         }
         else if (!isset($column['data_table_type']) && isset($column['audit_table_type']))
         {
-          $styledColumn['audit_table_type'] = sprintf('<mm_type>%s</>', $styledColumn['audit_table_type']);
+            $styledColumn['audit_table_type'] = sprintf('<mm_type>%s</>', $styledColumn['audit_table_type']);
         }
         else if (strcmp($column['data_table_type'], $column['audit_table_type']))
         {
-          $styledColumn['column_name']      = sprintf('<mm_column>%s</>', $styledColumn['column_name']);
-          $styledColumn['data_table_type']  = sprintf('<mm_type>%s</>', $styledColumn['data_table_type']);
-          $styledColumn['audit_table_type'] = sprintf('<mm_type>%s</>', $styledColumn['audit_table_type']);
+            $styledColumn['column_name']      = sprintf('<mm_column>%s</>', $styledColumn['column_name']);
+            $styledColumn['data_table_type']  = sprintf('<mm_type>%s</>', $styledColumn['data_table_type']);
+            $styledColumn['audit_table_type'] = sprintf('<mm_type>%s</>', $styledColumn['audit_table_type']);
         }
-      }
-      else
-      {
+        }
+        else
+        {
         // Highlighting for audit table column types and audit_columns in config file.
         $searchColumn = StaticDataLayer::searchInRowSet('column_name', $styledColumn['column_name'], $this->config['audit_columns']);
         if (isset($searchColumn))
         {
-          $configType = $this->config['audit_columns'][$searchColumn]['column_type'];
-          if (isset($configType) && !isset($column['audit_table_type']))
-          {
+            $configType = $this->config['audit_columns'][$searchColumn]['column_type'];
+            if (isset($configType) && !isset($column['audit_table_type']))
+            {
             $styledColumn['column_name'] = sprintf('<mm_column>%s</>', $styledColumn['column_name']);
             $styledColumn['config_type'] = sprintf('<mm_type>%s</>', $styledColumn['config_type']);
-          }
-          else if (!isset($configType) && isset($column['audit_table_type']))
-          {
+            }
+            else if (!isset($configType) && isset($column['audit_table_type']))
+            {
             $styledColumn['audit_table_type'] = sprintf('<mm_type>%s</>', $column['audit_table_type']);
-          }
-          else if (strcmp($configType, $column['audit_table_type']))
-          {
+            }
+            else if (strcmp($configType, $column['audit_table_type']))
+            {
             $styledColumn['column_name']      = sprintf('<mm_column>%s</>', $styledColumn['column_name']);
             $styledColumn['audit_table_type'] = sprintf('<mm_type>%s</>', $column['audit_table_type']);
             $styledColumn['config_type']      = sprintf('<mm_type>%s</>', $styledColumn['config_type']);
-          }
+            }
+        }
         }
-      }
-      $styledColumns[] = $styledColumn;
+        $styledColumns[] = $styledColumn;
     }
 
     return $styledColumns;
-  }
-
-  //--------------------------------------------------------------------------------------------------------------------
-  /**
-   * Get the difference between data and audit tables.
-   *
-   * @param Columns $dataColumns  The table columns from data schema.
-   * @param Columns $auditColumns The table columns from audit schema.
-   *
-   * @return array[]
-   */
-  private function createDiffArray($dataColumns, $auditColumns)
-  {
+    }
+
+    //--------------------------------------------------------------------------------------------------------------------
+    /**
+     * Get the difference between data and audit tables.
+     *
+     * @param Columns $dataColumns  The table columns from data schema.
+     * @param Columns $auditColumns The table columns from audit schema.
+     *
+     * @return array[]
+     */
+    private function createDiffArray($dataColumns, $auditColumns)
+    {
     $diff = [];
 
     foreach ($this->config['audit_columns'] as $column)
     {
-      $diff[$column['column_name']] = ['column_name'      => $column['column_name'],
-                                       'data_table_type'  => null,
-                                       'audit_table_type' => null,
-                                       'config_type'      => $column['column_type']];
+        $diff[$column['column_name']] = ['column_name'      => $column['column_name'],
+                                        'data_table_type'  => null,
+                                        'audit_table_type' => null,
+                                        'config_type'      => $column['column_type']];
     }
 
     foreach ($auditColumns->getColumns() as $column)
     {
-      $config_type = isset($diff[$column['column_name']]) ? $diff[$column['column_name']]['config_type'] : null;
+        $config_type = isset($diff[$column['column_name']]) ? $diff[$column['column_name']]['config_type'] : null;
 
-      $diff[$column['column_name']] = ['column_name'      => $column['column_name'],
-                                       'data_table_type'  => null,
-                                       'audit_table_type' => $auditColumns->getColumnTypeWithCharSetCollation($column['column_name']),
-                                       'config_type'      => $config_type];
+        $diff[$column['column_name']] = ['column_name'      => $column['column_name'],
+                                        'data_table_type'  => null,
+                                        'audit_table_type' => $auditColumns->getColumnTypeWithCharSetCollation($column['column_name']),
+                                        'config_type'      => $config_type];
     }
 
     foreach ($dataColumns->getColumns() as $column)
     {
-      $config_type      = isset($diff[$column['column_name']]) ? $diff[$column['column_name']]['config_type'] : null;
-      $audit_table_type = isset($diff[$column['column_name']]) ? $diff[$column['column_name']]['audit_table_type'] : null;
+        $config_type      = isset($diff[$column['column_name']]) ? $diff[$column['column_name']]['config_type'] : null;
+        $audit_table_type = isset($diff[$column['column_name']]) ? $diff[$column['column_name']]['audit_table_type'] : null;
 
-      $diff[$column['column_name']] = ['column_name'      => $column['column_name'],
-                                       'data_table_type'  => $dataColumns->getColumnTypeWithCharSetCollation($column['column_name']),
-                                       'audit_table_type' => $audit_table_type,
-                                       'config_type'      => $config_type];
+        $diff[$column['column_name']] = ['column_name'      => $column['column_name'],
+                                        'data_table_type'  => $dataColumns->getColumnTypeWithCharSetCollation($column['column_name']),
+                                        'audit_table_type' => $audit_table_type,
+                                        'config_type'      => $config_type];
     }
 
     return $diff;
-  }
-
-  //--------------------------------------------------------------------------------------------------------------------
-  /**
-   * Computes the difference between data and audit tables.
-   */
-  private function getDiff()
-  {
+    }
+
+    //--------------------------------------------------------------------------------------------------------------------
+    /**
+     * Computes the difference between data and audit tables.
+     */
+    private function getDiff()
+    {
     foreach ($this->dataSchemaTables as $table)
     {
-      if ($this->config['tables'][$table['table_name']]['audit'])
-      {
+        if ($this->config['tables'][$table['table_name']]['audit'])
+        {
         $res = StaticDataLayer::searchInRowSet('table_name', $table['table_name'], $this->auditSchemaTables);
         if (isset($res))
         {
-          $dataColumns  = new Columns(DataLayer::getTableColumns($this->config['database']['data_schema'], $table['table_name']));
-          $auditColumns = DataLayer::getTableColumns($this->config['database']['audit_schema'], $table['table_name']);
-          $auditColumns = $this->addNotNull($auditColumns);
-          $auditColumns = new Columns($auditColumns);
+            $dataColumns  = new Columns(DataLayer::getTableColumns($this->config['database']['data_schema'], $table['table_name']));
+            $auditColumns = DataLayer::getTableColumns($this->config['database']['audit_schema'], $table['table_name']);
+            $auditColumns = $this->addNotNull($auditColumns);
+            $auditColumns = new Columns($auditColumns);
 
-          $this->diffColumns[$table['table_name']] = $this->createDiffArray($dataColumns, $auditColumns);
+            $this->diffColumns[$table['table_name']] = $this->createDiffArray($dataColumns, $auditColumns);
+        }
         }
-      }
     }
-  }
-
-  //--------------------------------------------------------------------------------------------------------------------
-  /**
-   * Add not null to audit columns if it not nullable.
-   *
-   * @param array $theColumns Audit columns.
-   *
-   * @return array
-   */
-  private function addNotNull($theColumns)
-  {
+    }
+
+    //--------------------------------------------------------------------------------------------------------------------
+    /**
+     * Add not null to audit columns if it not nullable.
+     *
+     * @param array $theColumns Audit columns.
+     *
+     * @return array
+     */
+    private function addNotNull($theColumns)
+    {
     $modifiedColumns = [];
     foreach ($theColumns as $column)
     {
-      $modifiedColumn = $column;
-      $auditColumn    = StaticDataLayer::searchInRowSet('column_name', $modifiedColumn['column_name'], $this->config['audit_columns']);
-      if (isset($auditColumn))
-      {
+        $modifiedColumn = $column;
+        $auditColumn    = StaticDataLayer::searchInRowSet('column_name', $modifiedColumn['column_name'], $this->config['audit_columns']);
+        if (isset($auditColumn))
+        {
         if ($modifiedColumn['is_nullable']==='NO')
         {
-          $modifiedColumn['column_type'] = sprintf('%s not null', $modifiedColumn['column_type']);
+            $modifiedColumn['column_type'] = sprintf('%s not null', $modifiedColumn['column_type']);
+        }
         }
-      }
-      $modifiedColumns[] = $modifiedColumn;
+        $modifiedColumns[] = $modifiedColumn;
     }
 
     return $modifiedColumns;
-  }
-
-  //--------------------------------------------------------------------------------------------------------------------
-  /**
-   * Writes the difference between the audit tables and metadata tables to the output.
-   *
-   * @param OutputInterface $output The output.
-   */
-  private function diffTables($output)
-  {
+    }
+
+    //--------------------------------------------------------------------------------------------------------------------
+    /**
+     * Writes the difference between the audit tables and metadata tables to the output.
+     *
+     * @param OutputInterface $output The output.
+     */
+    private function diffTables($output)
+    {
     foreach ($this->config['tables'] as $tableName => $table)
     {
-      $res = StaticDataLayer::searchInRowSet('table_name', $tableName, $this->auditSchemaTables);
-      if ($table['audit'] && !isset($res))
-      {
+        $res = StaticDataLayer::searchInRowSet('table_name', $tableName, $this->auditSchemaTables);
+        if ($table['audit'] && !isset($res))
+        {
         $output->writeln(sprintf('<miss_table>%s</>', $tableName));
-      }
-      else if (!$table['audit'] && isset($res))
-      {
+        }
+        else if (!$table['audit'] && isset($res))
+        {
         $output->writeln(sprintf('<obsolete_table>%s</>', $tableName));
-      }
+        }
+    }
     }
-  }
-
-  //--------------------------------------------------------------------------------------------------------------------
-  /**
-   * Writes the difference between the audit and data tables to the output.
-   *
-   * @param OutputInterface $output The output.
-   */
-  private function printDiff($output)
-  {
+
+    //--------------------------------------------------------------------------------------------------------------------
+    /**
+     * Writes the difference between the audit and data tables to the output.
+     *
+     * @param OutputInterface $output The output.
+     */
+    private function printDiff($output)
+    {
     $first = true;
     if (isset($this->diffColumns))
     {
-      foreach ($this->diffColumns as $tableName => $columns)
-      {
+        foreach ($this->diffColumns as $tableName => $columns)
+        {
         // Remove matching columns unless the full option is used.
         if (!$this->full)
         {
-          $columns = self::removeMatchingColumns($columns);
+            $columns = self::removeMatchingColumns($columns);
         }
 
         if (!empty($columns))
         {
-          // Add an empty line between tables.
-          if ($first)
-          {
+            // Add an empty line between tables.
+            if ($first)
+            {
             $first = false;
-          }
-          else
-          {
+            }
+            else
+            {
             $output->writeln('');
-          }
+            }
 
-          // Write table name.
-          $output->writeln($tableName);
+            // Write table name.
+            $output->writeln($tableName);
 
-          // Write table with columns.
-          $columns = $this->addHighlighting($columns);
-          $rows    = new TableHelper($this->config['database']['data_schema'], $this->config['database']['audit_schema'], $tableName);
-          $rows->appendRows($columns);
-          $table = new Table($output);
-          $table->setHeaders(['column', 'data table', 'audit table', 'config'])
+            // Write table with columns.
+            $columns = $this->addHighlighting($columns);
+            $rows    = new TableHelper($this->config['database']['data_schema'], $this->config['database']['audit_schema'], $tableName);
+            $rows->appendRows($columns);
+            $table = new Table($output);
+            $table->setHeaders(['column', 'data table', 'audit table', 'config'])
                 ->setRows($rows->getRows());
-          $table->render();
+            $table->render();
+        }
         }
-      }
     }
     $this->diffTables($output);
-  }
+    }
 
-  //--------------------------------------------------------------------------------------------------------------------
+    //--------------------------------------------------------------------------------------------------------------------
 }
 
 //----------------------------------------------------------------------------------------------------------------------

src/MySql/Helper/TableHelper.php

Indentation +62 added lines, -62 removed lines

@@ -11,86 +11,86 @@
  */
 class TableHelper
 {
-  //--------------------------------------------------------------------------------------------------------------------
-  /**
-   * Array with rows for table.
-   *
-   * @var \array[]
-   */
-  private $rows = [];
+    //--------------------------------------------------------------------------------------------------------------------
+    /**
+     * Array with rows for table.
+     *
+     * @var \array[]
+     */
+    private $rows = [];
 
-  /**
-   * Table options from audit schema.
-   *
-   * @var array
-   */
-  private $auditTableOptions;
+    /**
+     * Table options from audit schema.
+     *
+     * @var array
+     */
+    private $auditTableOptions;
 
-  /**
-   * Table options from data schema.
-   *
-   * @var array
-   */
-  private $dataTableOptions;
+    /**
+     * Table options from data schema.
+     *
+     * @var array
+     */
+    private $dataTableOptions;
 
-  //--------------------------------------------------------------------------------------------------------------------
-  /**
-   * Object constructor.
-   *
-   * @param string $dataSchema  Data schema name.
-   * @param string $auditSchema Audit schema name.
-   * @param string $tableName   The table name.
-   */
-  public function __construct($dataSchema, $auditSchema, $tableName)
-  {
+    //--------------------------------------------------------------------------------------------------------------------
+    /**
+     * Object constructor.
+     *
+     * @param string $dataSchema  Data schema name.
+     * @param string $auditSchema Audit schema name.
+     * @param string $tableName   The table name.
+     */
+    public function __construct($dataSchema, $auditSchema, $tableName)
+    {
     $this->auditTableOptions = DataLayer::getTableOptions($auditSchema, $tableName);
     $this->dataTableOptions  = DataLayer::getTableOptions($dataSchema, $tableName);
-  }
+    }
 
-  //--------------------------------------------------------------------------------------------------------------------
-  /**
-   * Append row with table option.
-   *
-   * @param string $theOption
-   */
-  public function appendTableOption($theOption)
-  {
+    //--------------------------------------------------------------------------------------------------------------------
+    /**
+     * Append row with table option.
+     *
+     * @param string $theOption
+     */
+    public function appendTableOption($theOption)
+    {
     $this->rows[$theOption] = ['column_name'      => $theOption,
-                               'data_table_type'  => $this->dataTableOptions[$theOption],
-                               'audit_table_type' => $this->auditTableOptions[$theOption],
-                               'config_type'      => null];
-  }
+                                'data_table_type'  => $this->dataTableOptions[$theOption],
+                                'audit_table_type' => $this->auditTableOptions[$theOption],
+                                'config_type'      => null];
+    }
 
-  //--------------------------------------------------------------------------------------------------------------------
-  /**
-   * Appends rows.
-   *
-   * @param \array[] $theRows
-   */
-  public function appendRows($theRows)
-  {
+    //--------------------------------------------------------------------------------------------------------------------
+    /**
+     * Appends rows.
+     *
+     * @param \array[] $theRows
+     */
+    public function appendRows($theRows)
+    {
     foreach ($theRows as $row)
     {
-      $this->rows[] = $row;
+        $this->rows[] = $row;
     }
     $this->rows[] = new TableSeparator();
     $this->appendTableOption('engine');
     $this->appendTableOption('character_set_name');
-  }
+    }
 
-  //--------------------------------------------------------------------------------------------------------------------
-  /**
-   * Get rows.
-   *
-   * @return \array[]
-   */
-  public function getRows()
-  {
+    //--------------------------------------------------------------------------------------------------------------------
+    /**
+     * Get rows.
+     *
+     * @return \array[]
+     */
+    public function getRows()
+    {
     return $this->rows;
-  }
+    }
 
 
-  //--------------------------------------------------------------------------------------------------------------------
+    //--------------------------------------------------------------------------------------------------------------------
 }
 
 //----------------------------------------------------------------------------------------------------------------------