Moss\Storage\Model\Definition\Index\Index

Complexity

Total Complexity

12

Size/Duplication

Total Lines	116
Duplicated Lines	0 %

Coupling/Cohesion

Components	4
Dependencies	1

Importance

Changes	1
Bugs	0	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	9	1
A	assertFields()	0	6	2
A	table()	0	8	2
A	name()	0	4	1
A	type()	0	4	1
A	fields()	0	4	1
A	hasField()	0	4	1
A	isPrimary()	0	4	1
A	isUnique()	0	4	2

<?php

/*
 * This file is part of the Storage package
 *
 * (c) Michal Wachowski <wachowski.michal@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Moss\Storage\Model\Definition\Index;

use Moss\Storage\Model\Definition\DefinitionException;
use Moss\Storage\Model\Definition\IndexInterface;

/**
 * Index definition describing ordinary index
 *
 * @author  Michal Wachowski <wachowski.michal@gmail.com>
 * @package Moss\Storage
 */
class Index implements IndexInterface
{
    protected $table;
    protected $name;
    protected $type;
    protected $fields = [];

    /**
     * Constructor
     *
     * @param string $name
     * @param array $fields
     */
    public function __construct($name, array $fields)
    {
        $this->name = $name;
        $this->type = 'index';

        $this->assertFields($fields);

        $this->fields = $fields;
    }

    /**
     * Asserts index fields
     *
     * @param array $fields
     *
     * @throws DefinitionException
     */
    protected function assertFields($fields)
    {
        if (empty($fields)) {
            throw new DefinitionException(sprintf('No fields in index "%s" definition', $this->name));
        }
    }

    /**
     * Returns name of table
     *
     * @param string $table
     *
     * @return string
     */
    public function table($table = null)
    {
        if ($table !== null) {
            $this->table = $table;
        }

        return $this->table;
    }

    /**
     * Returns relation name in entity
     *
     * @return string
     */
    public function name()
    {
        return $this->name;
    }

    /**
     * Returns relation type
     *
     * @return string
     */
    public function type()
    {
        return $this->type;
    }

    /**
     * Returns array containing field names (unmapped) that are included in index
     *
     * @return array
     */
    public function fields()
    {
        return $this->fields;
    }

    /**
     * Checks if index uses field (unmapped)
     * Returns true if it does
     *
     * @param string $field
     *
     * @return bool
     */
    public function hasField($field)
    {
        return in_array($field, $this->fields);
    }

    /**
     * Returns true if index is primary index
     *
     * @return bool
     */
    public function isPrimary()
    {
        return $this->type == 'primary';
    }

    /**
     * Returns true if index is unique
     *
     * @return bool
     */
    public function isUnique()
    {
        return $this->type == 'unique' || $this->type == 'primary';
    }
}