Zortje\MySQLKeeper\Database\Table\Index

Complexity

Total Complexity

10

Size/Duplication

Total Lines	109
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

73.08%

Importance

Changes	5
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	getKeyName()	0	3	1
A	isUnique()	0	3	1
A	getColumns()	0	3	1
A	__construct()	0	5	1
A	isPrimaryKey()	0	5	1
B	isDuplicate()	0	22	4
A	isColumnsEqual()	0	5	1

<?php

namespace Zortje\MySQLKeeper\Database\Table;

/**
 * Class Index
 *
 * @package Zortje\MySQLKeeper\Database\Table
 */
class Index {

	/**
	 * @var string
	 */
	private $keyName;

	/**
	 * @var bool
	 */
	private $unique;

	/**
	 * @var string[]
	 */
	private $columns;

	/**
	 * @param string   $keyName Index key name
	 * @param bool     $unique  Index unique
	 * @param string[] $columns Index column names
	 */
	public function __construct($keyName, $unique, $columns) {
		$this->keyName = $keyName;
		$this->unique  = $unique;
		$this->columns = $columns;
	}

	/**
	 * Get Index key name
	 *
	 * @return string Index key name
	 */
	public function getKeyName() {
		return $this->keyName;
	}

	/**
	 * Is Index primary key
	 *
	 * @return bool TRUE if primary key, otherwise FALSE
	 */
	public function isPrimaryKey() {
		$isPrimaryKey = $this->getKeyName() === 'PRIMARY';

		return $isPrimaryKey;
	}

	/**
	 * Is Index unique
	 *
	 * @return bool TRUE if unique, otherwise FALSE
	 */
	public function isUnique() {
		return $this->unique;
	}

	/**
	 * Get Index column names
	 *
	 * @return string[] Index column names
	 */
	public function getColumns() {
		return $this->columns;
	}

	/**
	 * Check if given Index is duplicate of this
	 *
	 * @param Index $index Index
	 *
	 * @return bool TRUE if duplicate, otherwise FALSE
	 */
	public function isDuplicate(Index $index) {
		/**
		 * Check if columns are the same
		 */
		$duplicate = $this->getColumns() === $index->getColumns();

		/**
		 * If indices have different unique status they cant be duplicates
		 */
		if ($this->isUnique() !== $index->isUnique()) {
			$duplicate = false;
		}

		/**
		 * If one of the indicies is the primary key they cant be duplicates
		 */
		if ($this->isPrimaryKey() === true || $index->isPrimaryKey() === true) {
			$duplicate = false;
		}

		return $duplicate;
	}

	/**
	 * Check if given columns are equal to this index columns
	 *
	 * @param string[] $columns
	 *
	 * @return bool TRUE if equal, otherwise FALSE
	 */
	public function isColumnsEqual($columns) {
		$equal = $this->getColumns() === $columns;

		return $equal;
	}
}