Spiral\ORM\Schemas\Definitions\IndexDefinition

Complexity

Total Complexity

8

Size/Duplication

Total Lines	72
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	7	1
A	getColumns()	0	4	1
A	isUnique()	0	4	1
A	getName()	0	10	4
A	__toString()	0	4	1

<?php
/**
 * Spiral, Core Components
 *
 * @author Wolfy-J
 */

namespace Spiral\ORM\Schemas\Definitions;

/**
 * Index definition options.
 */
final class IndexDefinition
{
    /**
     * @var string|null
     */
    private $name;

    /**
     * @var array
     */
    private $index;

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

    /**
     * @param array       $columns
     * @param bool        $unique
     * @param string|null $name
     */
    public function __construct(array $columns, bool $unique = false, string $name = null)
    {
        $this->index = $columns;
        $this->unique = $unique;

        $this->name = $name;
    }

    /**
     * @return array
     */
    public function getColumns(): array
    {
        return $this->index;
    }

    /**
     * @return bool
     */
    public function isUnique(): bool
    {
        return $this->unique;
    }

    /**
     * Generate unique index name.
     *
     * @return string
     */
    public function getName(): string
    {
        if (!empty($this->name)) {
            return $this->name;
        }

        $name = ($this->isUnique() ? 'unique_' : 'index_') . join('_', $this->getColumns());

        return strlen($name) > 64 ? md5($name) : $name;
    }

    /**
     * So we can compare indexes.
     *
     * @return string
     */
    public function __toString()
    {
        return json_encode([$this->index, $this->unique]);
    }
}