SetBased\Audit\MySql\Metadata\ColumnMetadata

Complexity

Total Complexity

11

Size/Duplication

Total Lines	105
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

100%

Importance

Changes	2
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	makeNullable()	0	4	1
A	__construct()	0	10	3
A	getProperties()	0	4	1
A	getProperty()	0	9	2
A	compare()	0	17	4

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

//----------------------------------------------------------------------------------------------------------------------
/**
 * Metadata of table columns.
 */
class ColumnMetadata
{
  //--------------------------------------------------------------------------------------------------------------------
  /**
   * The properties of the column that are stored by this class.
   *
   * var string[]
   */
  protected static $fields = ['column_name',
                              'column_type',
                              'is_nullable',
                              'character_set_name',
                              'collation_name'];

  /**
   * The the properties of this table column.
   *
   * @var array<string,string>
   */
  protected $properties = [];

  //--------------------------------------------------------------------------------------------------------------------
  /**
   * Object constructor.
   *
   * @param array[] $properties The metadata of the column.
   */
  public function __construct($properties)
  {
    foreach (static::$fields as $field)
    {
      if (isset($properties[$field]))
      {
        $this->properties[$field] = $properties[$field];
      }
    }
  }

  //--------------------------------------------------------------------------------------------------------------------
  /**
   * Compares two the metadata of the columns.
   *
   * @param ColumnMetadata $column1 The metadata of the first column.
   * @param ColumnMetadata $column2 The metadata of the second column.
   * @param string[]       $ignore  The properties to be ignored.
   *
   * @return bool True if the columns are equal, false otherwise.
   */
  public static function compare($column1, $column2, $ignore = [])
  {
    $equal = true;

    foreach (self::$fields as $field)
    {
      if (!in_array($field, $ignore))
      {
        if ($column1->getProperty($field)!=$column2->getProperty($field))
        {
          $equal = false;
        }
      }
    }

    return $equal;
  }

  //--------------------------------------------------------------------------------------------------------------------
  /**
   * Returns the properties of this table column as an array.
   *
   * @return array<string,string>
   */
  public function getProperties()
  {
    return $this->properties;
  }

  //--------------------------------------------------------------------------------------------------------------------
  /**
   * Returns a property of this table column.
   *
   * @param string $name The name of the property.
   *
   * @return string|null
   */
  public function getProperty($name)
  {
    if (isset($this->properties[$name]))
    {
      return $this->properties[$name];
    }

    return null;
  }
  //--------------------------------------------------------------------------------------------------------------------
  /**
   * Make this column nullable.
   */
  public function makeNullable()
  {
    $this->properties['is_nullable'] = 'YES';
  }

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

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