SetBased\Audit\MySql\Table\Columns

Complexity

Total Complexity

21

Size/Duplication

Total Lines	183
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

66.67%

Importance

Changes	7
Bugs	1	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	7	2
A	combine()	0	17	3
B	differentColumnTypes()	0	22	4
A	notInOtherSet()	0	18	4
A	getColumnTypeWithCharSetCollation()	0	16	4
A	getColumns()	0	4	1
A	getNumberOfColumns()	0	4	1
A	getPreviousColumn()	0	12	2

<?php
//----------------------------------------------------------------------------------------------------------------------
namespace SetBased\Audit\MySql\Table;

//----------------------------------------------------------------------------------------------------------------------
/**
 * Class for metadata of table columns.
 */
class Columns
{
  //--------------------------------------------------------------------------------------------------------------------
  /**
   * The metadata of the columns.
   *
   * @var array<string,ColumnType>
   */
  private $columns = [];

  //--------------------------------------------------------------------------------------------------------------------
  /**
   * Object constructor.
   *
   * @param array[] $columns The metadata of the columns as returned by DataLayer::getTableColumns().
   */
  public function __construct($columns)
  {
    foreach ($columns as $column)
    {
      $this->columns[$column['column_name']] = new ColumnType($column);
    }
  }

  //--------------------------------------------------------------------------------------------------------------------
  /**
   * Generate array with audit columns and columns from data table.
   *
   * @param Columns $auditColumnsMetadata   AuditApplication columns for adding to exist columns
   * @param Columns $currentColumnsMetadata Exist table columns
   *
   * @return Columns
   */
  public static function combine($auditColumnsMetadata, $currentColumnsMetadata)
  {
    $columns = [];

    /** @var ColumnType $column */
    foreach ($auditColumnsMetadata->columns as $column)
    {
      $columns[] = $column->getType();
    }
    /** @var ColumnType $column */
    foreach ($currentColumnsMetadata->columns as $column)
    {
      $columns[] = $column->getType();
    }

    return new Columns($columns);
  }

  //--------------------------------------------------------------------------------------------------------------------
  /**
   * Compares two Columns objects and returns an array with columns that are in the first columns object and in the
   * second Columns object but have different types.
   *
   * @param Columns $columns1 The first Columns object.
   * @param Columns $columns2 The second Columns object.
   *
   * @return Columns
   */
  public static function differentColumnTypes($columns1, $columns2)
  {
    $diff = [];
    foreach ($columns2->columns as $column2)
    {
      /** @var ColumnType $column2 */
      $column2 = $column2->getType();
      if (isset($columns1->columns[$column2['column_name']]))
      {
        $column1 = $columns1->columns[$column2['column_name']];

        /** @var ColumnType $column1 */
        $column1 = $column1->getType();
        if ($column2['column_type']!=$column1['column_type'])
        {
          $diff[] = $column1;
        }
      }
    }

    return new Columns($diff);
  }

  //--------------------------------------------------------------------------------------------------------------------
  /**
   * Compares two Columns objects and returns an array with columns that are in the first columns object but not in the
   * second Columns object.
   *
   * @param Columns $columns1 The first Columns object.
   * @param Columns $columns2 The second Columns object.
   *
   * @return Columns
   */
  public static function notInOtherSet($columns1, $columns2)
  {
    $diff = [];
    if (isset($columns1))
    {
      foreach ($columns1->columns as $column1)
      {
        /** @var ColumnType $column1 */
        $column1 = $column1->getType();
        if (!isset($columns2->columns[$column1['column_name']]))
        {
          $diff[] = $column1;
        }
      }
    }

    return new Columns($diff);
  }

  //--------------------------------------------------------------------------------------------------------------------
  /**
   * Return column type with character set and collation.
   *
   * @param string $columnName The column name.
   *
   * @return null|string
   */
  public function getColumnTypeWithCharSetCollation($columnName)
  {
    $columns = array_keys($this->columns);
    $key     = array_search($columnName, $columns);

    if ($key!==false)
    {
      $column                       = $this->columns[$columns[$key]];
      $column['character_set_name'] = isset($column['character_set_name']) ? ' '.$column['character_set_name'] : '';
      $column['collation_name']     = isset($column['collation_name']) ? ' '.$column['collation_name'] : '';

      return sprintf('%s%s%s', $column['column_type'], $column['character_set_name'], $column['collation_name']);
    }

    return null;
  }

  //--------------------------------------------------------------------------------------------------------------------
  /**
   * Returns the underlying array with metadata of the columns.
   *
   * @return array[]

Should the return type not be array<string,\SetBased\Audit\MySQl\Table\ColumnType>?

   */
  public function getColumns()
  {
    return $this->columns;
  }

  //--------------------------------------------------------------------------------------------------------------------
  /**
   * Returns the number of columns.
   *
   * @return int
   */
  public function getNumberOfColumns()
  {
    return count($this->columns);
  }

  //--------------------------------------------------------------------------------------------------------------------
  /**
   * Returns previous column of a columns. Returns null if the column name is not found in this Columns.
   *
   * @param string $columnName The column name.
   *
   * @return null|string
   */
  public function getPreviousColumn($columnName)
  {
    $columns = array_keys($this->columns);
    $key     = array_search($columnName, $columns);

    if ($key>=1)
    {
      return $columns[$key - 1];
    }

    return null;
  }

  //--------------------------------------------------------------------------------------------------------------------
}

//----------------------------------------------------------------------------------------------------------------------