Platine\Database\Schema\ForeignKey

Complexity

Total Complexity

10

Size/Duplication

Total Lines	114
Duplicated Lines	0 %

Importance

Changes	3
Bugs	1	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	references()	0	6	1
A	getActions()	0	3	1
A	__construct()	0	2	1
A	getColumns()	0	3	1
A	addAction()	0	10	2
A	getReferenceTable()	0	3	1
A	onUpdate()	0	3	1
A	getReferenceColumns()	0	3	1
A	onDelete()	0	3	1

<?php

/**
 * Platine Database
 *
 * Platine Database is the abstraction layer using PDO with support of query and schema builder
 *
 * This content is released under the MIT License (MIT)
 *
 * Copyright (c) 2020 Platine Database
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

/**
 *  @file ForeignKey.php
 *
 *  The foreign key schema class
 *
 *  @package    Platine\Database\Schema
 *  @author Platine Developers Team
 *  @copyright  Copyright (c) 2020
 *  @license    http://opensource.org/licenses/MIT  MIT License
 *  @link   https://www.platine-php.com
 *  @version 1.0.0
 *  @filesource
 */

declare(strict_types=1);

namespace Platine\Database\Schema;

/**
 * @class ForeignKey
 * @package Platine\Database\Schema
 */
class ForeignKey
{
    /**
     * The referenced table
     * @var string
     */
    protected string $referenceTable;

    /**
     * The referenced columns
     * @var string[]
     */
    protected array $referenceColumns = [];

    /**
     * The list of actions
     * @var array<string, string>
     */
    protected array $actions = [];

    /**
     * Class constructor
     * @param array<int, string> $columns The base table columns
     */
    public function __construct(protected array $columns)
    {
    }

    /**
     *
     * @return string
     */
    public function getReferenceTable(): string
    {
        return $this->referenceTable;
    }

    /**
     *
     * @return string[]
     */
    public function getReferenceColumns(): array
    {
        return $this->referenceColumns;
    }

    /**
     *
     * @return array<int, string>
     */
    public function getColumns(): array
    {
        return $this->columns;
    }

    /**
     *
     * @return array<string, string>
     */
    public function getActions(): array
    {
        return $this->actions;
    }

    /**
     * Set the references
     * @param string $table
     * @param string ...$columns
     * @return $this
     */
    public function references(string $table, string ...$columns): self
    {
        $this->referenceTable = $table;
        $this->referenceColumns = $columns;

        return $this;
    }

    /**
     *
     * @param string $action
     * @return $this
     */
    public function onDelete(string $action): self
    {
        return $this->addAction('ON DELETE', $action);
    }

    /**
     *
     * @param string $action
     * @return $this
     */
    public function onUpdate(string $action): self
    {
        return $this->addAction('ON UPDATE', $action);
    }

    /**
     * Add the action
     * @param string $on the type of action DELETE, UPDATE
     * @param string $action
     * @return $this
     */
    protected function addAction(string $on, string $action): self
    {
        $actionValue = strtoupper($action);
        if (!in_array($actionValue, ['RESTRICT', 'CASCADE', 'NO ACTION', 'SET NULL'])) {
            return $this;
        }

        $this->actions[$on] = $actionValue;

        return $this;
    }
}