TableColumnsMetadata::getPreviousColumn() - Code Metrics - Inspection of "PHP Audit will developed for PHP 7.x only." - SetBased/php-audit - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( c95337...5e0152 )

by P.R.

created 2017-08-13 16:17 UTC

TableColumnsMetadata::getPreviousColumn() A

↳ Parent: TableColumnsMetadata

Complexity

Conditions	2
Paths	2

Size

Total Lines	12
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	2.0185

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
c	2
b	0
f	0
dl	0
loc	12
ccs	5
cts	6
cp	0.8333
rs	9.4285
cc	2
eloc	6
nc	2
nop	1
crap	2.0185

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

//----------------------------------------------------------------------------------------------------------------------
use SetBased\Exception\FallenException;

/**
 * Metadata of a set of table columns.
 */
class TableColumnsMetadata
{
  //--------------------------------------------------------------------------------------------------------------------
  /**
   * The metadata of the columns.
   *
   * @var ColumnMetadata[]
   */
  private $columns = [];

  //--------------------------------------------------------------------------------------------------------------------
  /**
   * Object constructor.
   *
   * @param \array[] $columns The metadata of the columns as returned by AuditDataLayer::getTableColumns().
   * @param string   $type    The class for columns metadata.
   */
  public function __construct($columns = [], $type = 'ColumnMetadata')
  {
    foreach ($columns as $columnName => $column)
    {
      $this->columns[$column['column_name']] = self::columnFactory($type, $column);
    }
  }

  //--------------------------------------------------------------------------------------------------------------------
  /**
   * Combines the metadata of two sets of metadata of table columns.
   *
   * @param TableColumnsMetadata $columns1 The first set of metadata of table columns.
   * @param TableColumnsMetadata $columns2 The second set of metadata of table columns.
   *
   * @return TableColumnsMetadata
   */
  public static function combine($columns1, $columns2)
  {
    $columns = new TableColumnsMetadata();

    foreach ($columns1->columns as $column)
    {
      $columns->appendTableColumn($column);
    }

    foreach ($columns2->columns as $column)
    {
      $columns->appendTableColumn($column);
    }

    return $columns;
  }

  //--------------------------------------------------------------------------------------------------------------------
  /**
   * Compares two sets of metadata of table columns and returns a set of metadata of table columns the are in both sets
   * but have different column type.
   *
   * @param TableColumnsMetadata $columns1 The first sets of metadata of table columns.
   * @param TableColumnsMetadata $columns2 The second sets of metadata of table columns.
   * @param string[]             $ignore   The properties to be ignored.
   *
   * @return TableColumnsMetadata
   */
  public static function differentColumnTypes($columns1, $columns2, $ignore = [])
  {
    $diff = new TableColumnsMetadata();
    foreach ($columns1->columns as $column_name => $column1)
    {
      if (isset($columns2->columns[$column_name]))
      {
        if (!ColumnMetadata::compare($column1, $columns2->columns[$column_name], $ignore))
        {
          $diff->appendTableColumn($column1);
        }
      }
    }

    return $diff;
  }

  //--------------------------------------------------------------------------------------------------------------------
  /**
   * Compares two sets of metadata of table columns and returns a set of metadata of table columns that are in the first
   * sets of metadata of table columns but not in the second sets of metadata of table columns.
   *
   * @param TableColumnsMetadata $columns1 The first sets of metadata of table columns.
   * @param TableColumnsMetadata $columns2 The second sets of metadata of table columns.
   *
   * @return TableColumnsMetadata
   */
  public static function notInOtherSet($columns1, $columns2)
  {
    $diff = new TableColumnsMetadata();
    foreach ($columns1->columns as $column_name => $column1)
    {
      if (!isset($columns2->columns[$column_name]))
      {
        $diff->appendTableColumn($column1);
      }
    }

    return $diff;
  }

  //--------------------------------------------------------------------------------------------------------------------
  /**
   * A factory for table column metadata.
   *
   * @param string $type   The type of the metadata.
   * @param array  $column The metadata of the column
   *
   * @return MultiSourceColumnMetadata|AlterColumnMetadata|AuditColumnMetadata|ColumnMetadata
   */
  private static function columnFactory($type, $column)
  {
    switch ($type)
    {
      case 'ColumnMetadata':
        return new ColumnMetadata($column);

      case 'AlterColumnMetadata':
        return new AlterColumnMetadata($column);

      case 'AuditColumnMetadata':
        return new AuditColumnMetadata($column);

      case 'MultiSourceColumnMetadata':
        return new MultiSourceColumnMetadata($column);

      default:
        throw new FallenException('type', $type);
    }
  }

  //--------------------------------------------------------------------------------------------------------------------
  /**
   * Appends a table column to the table columns.
   *
   * @param ColumnMetadata $column The metadata of the table columns.
   */
  public function appendTableColumn($column)
  {
    $this->columns[$column->getProperty('column_name')] = $column;
  }

  //--------------------------------------------------------------------------------------------------------------------
  /**
   * Returns the underlying array with metadata of the columns.
   *
   * @return ColumnMetadata[]
   */
  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 TableColumnsMetadata.
   *
   * @param string $columnName The column name.
   *
   * @return int|null
   */
  public function getPreviousColumn($columnName)
  {
    $columns = array_keys($this->columns);
    $key     = array_search($columnName, $columns);

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

    return null;
  }

  //--------------------------------------------------------------------------------------------------------------------
  /**
   * Makes all columns nullable.
   */
  public function makeNullable()
  {
    foreach ($this->columns as $column)
    {
      $column->makeNullable();
    }
  }

  //--------------------------------------------------------------------------------------------------------------------
  /**
   * Remove column.
   *
   * @param string $columnName The columns name.
   */
  public function removeColumn($columnName)
  {
    unset($this->columns[$columnName]);
  }

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

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


1		<?php
2		//----------------------------------------------------------------------------------------------------------------------
3		namespace SetBased\Audit\MySql\Metadata;
4
5		//----------------------------------------------------------------------------------------------------------------------
6		use SetBased\Exception\FallenException;
7
8		/**
9		* Metadata of a set of table columns.
10		*/
11		class TableColumnsMetadata
12		{
13		//--------------------------------------------------------------------------------------------------------------------
14		/**
15		* The metadata of the columns.
16		*
17		* @var ColumnMetadata[]
18		*/
19		private $columns = [];
20
21		//--------------------------------------------------------------------------------------------------------------------
22		/**
23		* Object constructor.
24		*
25		* @param \array[] $columns The metadata of the columns as returned by AuditDataLayer::getTableColumns().
26		* @param string $type The class for columns metadata.
27		*/
28	19	public function __construct($columns = [], $type = 'ColumnMetadata')
29		{
30	19	foreach ($columns as $columnName => $column)
31		{
32	18	$this->columns[$column['column_name']] = self::columnFactory($type, $column);
33		}
34	19	}
35
36		//--------------------------------------------------------------------------------------------------------------------
37		/**
38		* Combines the metadata of two sets of metadata of table columns.
39		*
40		* @param TableColumnsMetadata $columns1 The first set of metadata of table columns.
41		* @param TableColumnsMetadata $columns2 The second set of metadata of table columns.
42		*
43		* @return TableColumnsMetadata
44		*/
45	16	public static function combine($columns1, $columns2)
46		{
47	16	$columns = new TableColumnsMetadata();
48
49	16	foreach ($columns1->columns as $column)
50		{
51	9	$columns->appendTableColumn($column);
52		}
53
54	16	foreach ($columns2->columns as $column)
55		{
56	16	$columns->appendTableColumn($column);
57		}
58
59	16	return $columns;
60		}
61
62		//--------------------------------------------------------------------------------------------------------------------
63		/**
64		* Compares two sets of metadata of table columns and returns a set of metadata of table columns the are in both sets
65		* but have different column type.
66		*
67		* @param TableColumnsMetadata $columns1 The first sets of metadata of table columns.
68		* @param TableColumnsMetadata $columns2 The second sets of metadata of table columns.
69		* @param string[] $ignore The properties to be ignored.
70		*
71		* @return TableColumnsMetadata
72		*/
73	5	public static function differentColumnTypes($columns1, $columns2, $ignore = [])
74		{
75	5	$diff = new TableColumnsMetadata();
76	5	foreach ($columns1->columns as $column_name => $column1)
77		{
78	5	if (isset($columns2->columns[$column_name]))
79		{
80	5	if (!ColumnMetadata::compare($column1, $columns2->columns[$column_name], $ignore))
81		{
82	5	$diff->appendTableColumn($column1);
83		}
84		}
85		}
86
87	5	return $diff;
88		}
89
90		//--------------------------------------------------------------------------------------------------------------------
91		/**
92		* Compares two sets of metadata of table columns and returns a set of metadata of table columns that are in the first
93		* sets of metadata of table columns but not in the second sets of metadata of table columns.
94		*
95		* @param TableColumnsMetadata $columns1 The first sets of metadata of table columns.
96		* @param TableColumnsMetadata $columns2 The second sets of metadata of table columns.
97		*
98		* @return TableColumnsMetadata
99		*/
100	16	public static function notInOtherSet($columns1, $columns2)
101		{
102	16	$diff = new TableColumnsMetadata();
103	16	foreach ($columns1->columns as $column_name => $column1)
104		{
105	16	if (!isset($columns2->columns[$column_name]))
106		{
107	16	$diff->appendTableColumn($column1);
108		}
109		}
110
111	16	return $diff;
112		}
113
114		//--------------------------------------------------------------------------------------------------------------------
115		/**
116		* A factory for table column metadata.
117		*
118		* @param string $type The type of the metadata.
119		* @param array $column The metadata of the column
120		*
121		* @return MultiSourceColumnMetadata\|AlterColumnMetadata\|AuditColumnMetadata\|ColumnMetadata
122		*/
123	18	private static function columnFactory($type, $column)
124		{
125		switch ($type)
126		{
127	18	case 'ColumnMetadata':
128	18	return new ColumnMetadata($column);
129
130	13	case 'AlterColumnMetadata':
131		return new AlterColumnMetadata($column);
132
133	13	case 'AuditColumnMetadata':
134	9	return new AuditColumnMetadata($column);
135
136	4	case 'MultiSourceColumnMetadata':
137	4	return new MultiSourceColumnMetadata($column);
138
139		default:
140		throw new FallenException('type', $type);
141		}
142		}
143
144		//--------------------------------------------------------------------------------------------------------------------
145		/**
146		* Appends a table column to the table columns.
147		*
148		* @param ColumnMetadata $column The metadata of the table columns.
149		*/
150	16	public function appendTableColumn($column)
151		{
152	16	$this->columns[$column->getProperty('column_name')] = $column;
153	16	}
154
155		//--------------------------------------------------------------------------------------------------------------------
156		/**
157		* Returns the underlying array with metadata of the columns.
158		*
159		* @return ColumnMetadata[]
160		*/
161	18	public function getColumns()
162		{
163	18	return $this->columns;
164		}
165
166		//--------------------------------------------------------------------------------------------------------------------
167		/**
168		* Returns the number of columns.
169		*
170		* @return int
171		*/
172	16	public function getNumberOfColumns()
173		{
174	16	return count($this->columns);
175		}
176
177		//--------------------------------------------------------------------------------------------------------------------
178		/**
179		* Returns previous column of a columns. Returns null if the column name is not found in this TableColumnsMetadata.
180		*
181		* @param string $columnName The column name.
182		*
183		* @return int\|null
184		*/
185	1	public function getPreviousColumn($columnName)
186		{
187	1	$columns = array_keys($this->columns);
188	1	$key = array_search($columnName, $columns);
189
190	1	if ($key>=1)
191		{
192	1	return $columns[$key - 1];
193		}
194
195		return null;
196		}
197
198		//--------------------------------------------------------------------------------------------------------------------
199		/**
200		* Makes all columns nullable.
201		*/
202	13	public function makeNullable()
203		{
204	13	foreach ($this->columns as $column)
205		{
206	13	$column->makeNullable();
207		}
208	13	}
209
210		//--------------------------------------------------------------------------------------------------------------------
211		/**
212		* Remove column.
213		*
214		* @param string $columnName The columns name.
215		*/
216	4	public function removeColumn($columnName)
217		{
218	4	unset($this->columns[$columnName]);
219	4	}
220
221		//--------------------------------------------------------------------------------------------------------------------
222		}
223
224		//----------------------------------------------------------------------------------------------------------------------
225

SetBased / php-audit

Push — master ( c95337...5e0152 )

TableColumnsMetadata::getPreviousColumn() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like