Server : Apache System : Linux server2.corals.io 4.18.0-348.2.1.el8_5.x86_64 #1 SMP Mon Nov 15 09:17:08 EST 2021 x86_64 User : corals ( 1002) PHP Version : 7.4.33 Disable Function : exec,passthru,shell_exec,system Directory : /home/corals/mcoil.corals.io/vendor/doctrine/dbal/src/Schema/ |
<?php
declare(strict_types=1);
namespace Doctrine\DBAL\Schema;
use Doctrine\DBAL\Platforms\AbstractPlatform;
use function array_filter;
use function array_keys;
use function array_map;
use function array_search;
use function array_shift;
use function count;
use function strtolower;
class Index extends AbstractAsset
{
/**
* Asset identifier instances of the column names the index is associated with.
*
* @var array<string, Identifier>
*/
protected array $_columns = [];
protected bool $_isUnique = false;
protected bool $_isPrimary = false;
/**
* Platform specific flags for indexes.
*
* @var array<string, true>
*/
protected array $_flags = [];
/**
* @param array<int, string> $columns
* @param array<int, string> $flags
* @param array<string, mixed> $options
*/
public function __construct(
?string $name,
array $columns,
bool $isUnique = false,
bool $isPrimary = false,
array $flags = [],
private readonly array $options = [],
) {
$isUnique = $isUnique || $isPrimary;
if ($name !== null) {
$this->_setName($name);
}
$this->_isUnique = $isUnique;
$this->_isPrimary = $isPrimary;
foreach ($columns as $column) {
$this->_addColumn($column);
}
foreach ($flags as $flag) {
$this->addFlag($flag);
}
}
protected function _addColumn(string $column): void
{
$this->_columns[$column] = new Identifier($column);
}
/**
* Returns the names of the referencing table columns the constraint is associated with.
*
* @return list<string>
*/
public function getColumns(): array
{
return array_keys($this->_columns);
}
/**
* Returns the quoted representation of the column names the constraint is associated with.
*
* But only if they were defined with one or a column name
* is a keyword reserved by the platform.
* Otherwise, the plain unquoted value as inserted is returned.
*
* @param AbstractPlatform $platform The platform to use for quotation.
*
* @return list<string>
*/
public function getQuotedColumns(AbstractPlatform $platform): array
{
$subParts = $platform->supportsColumnLengthIndexes() && $this->hasOption('lengths')
? $this->getOption('lengths') : [];
$columns = [];
foreach ($this->_columns as $column) {
$length = array_shift($subParts);
$quotedColumn = $column->getQuotedName($platform);
if ($length !== null) {
$quotedColumn .= '(' . $length . ')';
}
$columns[] = $quotedColumn;
}
return $columns;
}
/** @return array<int, string> */
public function getUnquotedColumns(): array
{
return array_map($this->trimQuotes(...), $this->getColumns());
}
/**
* Is the index neither unique nor primary key?
*/
public function isSimpleIndex(): bool
{
return ! $this->_isPrimary && ! $this->_isUnique;
}
public function isUnique(): bool
{
return $this->_isUnique;
}
public function isPrimary(): bool
{
return $this->_isPrimary;
}
public function hasColumnAtPosition(string $name, int $pos = 0): bool
{
$name = $this->trimQuotes(strtolower($name));
$indexColumns = array_map('strtolower', $this->getUnquotedColumns());
return array_search($name, $indexColumns, true) === $pos;
}
/**
* Checks if this index exactly spans the given column names in the correct order.
*
* @param array<int, string> $columnNames
*/
public function spansColumns(array $columnNames): bool
{
$columns = $this->getColumns();
$numberOfColumns = count($columns);
$sameColumns = true;
for ($i = 0; $i < $numberOfColumns; $i++) {
if (
isset($columnNames[$i])
&& $this->trimQuotes(strtolower($columns[$i])) === $this->trimQuotes(strtolower($columnNames[$i]))
) {
continue;
}
$sameColumns = false;
}
return $sameColumns;
}
/**
* Checks if the other index already fulfills all the indexing and constraint needs of the current one.
*/
public function isFulfilledBy(Index $other): bool
{
// allow the other index to be equally large only. It being larger is an option
// but it creates a problem with scenarios of the kind PRIMARY KEY(foo,bar) UNIQUE(foo)
if (count($other->getColumns()) !== count($this->getColumns())) {
return false;
}
// Check if columns are the same, and even in the same order
$sameColumns = $this->spansColumns($other->getColumns());
if ($sameColumns) {
if (! $this->samePartialIndex($other)) {
return false;
}
if (! $this->hasSameColumnLengths($other)) {
return false;
}
if (! $this->isUnique() && ! $this->isPrimary()) {
// this is a special case: If the current key is neither primary or unique, any unique or
// primary key will always have the same effect for the index and there cannot be any constraint
// overlaps. This means a primary or unique index can always fulfill the requirements of just an
// index that has no constraints.
return true;
}
if ($other->isPrimary() !== $this->isPrimary()) {
return false;
}
return $other->isUnique() === $this->isUnique();
}
return false;
}
/**
* Detects if the other index is a non-unique, non primary index that can be overwritten by this one.
*/
public function overrules(Index $other): bool
{
if ($other->isPrimary()) {
return false;
}
if ($this->isSimpleIndex() && $other->isUnique()) {
return false;
}
return $this->spansColumns($other->getColumns())
&& ($this->isPrimary() || $this->isUnique())
&& $this->samePartialIndex($other);
}
/**
* Returns platform specific flags for indexes.
*
* @return array<int, string>
*/
public function getFlags(): array
{
return array_keys($this->_flags);
}
/**
* Adds Flag for an index that translates to platform specific handling.
*
* @example $index->addFlag('CLUSTERED')
*/
public function addFlag(string $flag): self
{
$this->_flags[strtolower($flag)] = true;
return $this;
}
/**
* Does this index have a specific flag?
*/
public function hasFlag(string $flag): bool
{
return isset($this->_flags[strtolower($flag)]);
}
/**
* Removes a flag.
*/
public function removeFlag(string $flag): void
{
unset($this->_flags[strtolower($flag)]);
}
public function hasOption(string $name): bool
{
return isset($this->options[strtolower($name)]);
}
public function getOption(string $name): mixed
{
return $this->options[strtolower($name)];
}
/** @return array<string, mixed> */
public function getOptions(): array
{
return $this->options;
}
/**
* Return whether the two indexes have the same partial index
*/
private function samePartialIndex(Index $other): bool
{
if (
$this->hasOption('where')
&& $other->hasOption('where')
&& $this->getOption('where') === $other->getOption('where')
) {
return true;
}
return ! $this->hasOption('where') && ! $other->hasOption('where');
}
/**
* Returns whether the index has the same column lengths as the other
*/
private function hasSameColumnLengths(self $other): bool
{
$filter = static function (?int $length): bool {
return $length !== null;
};
return array_filter($this->options['lengths'] ?? [], $filter)
=== array_filter($other->options['lengths'] ?? [], $filter);
}
}