Yiisoft\Db\Constraint\Constraint

Complexity

Total Complexity

4

Size/Duplication

Total Lines	41
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	name()	0	4	1
A	columnNames()	0	4	1
A	getName()	0	3	1
A	getColumnNames()	0	3	1

<?php

declare(strict_types=1);

namespace Yiisoft\Db\Constraint;

/**
 * Represents a constraint in a database.
 *
 * A constraint is a rule that's enforced on the data in a table, such as a primary key, a foreign key, a default value,
 * check or index constraint.
 *
 * It's the base class for all constraint classes, and defines methods that are common and shared by all constrained
 * classes, with name and columnNames being the most common ones.
 */
class Constraint
{
    private string|array|null $columnNames = null;
    private string|null|object $name = null;

    /**
     * @return array|string|null The list of column names the constraint belongs to.
     */
    public function getColumnNames(): array|string|null
    {
        return $this->columnNames;
    }

    /**
     * @return object|string|null The constraint name.
     */
    public function getName(): object|string|null
    {
        return $this->name;
    }

    /**
     * Set the list of column names the constraint belongs to.
     *
     * @param array|string|null $value The list of column names the constraint belongs to.
     */
    public function columnNames(array|string|null $value): static
    {
        $this->columnNames = $value;
        return $this;
    }

    /**
     * Set the constraint name.
     *
     * @param object|string|null $value The constraint name.
     */
    public function name(object|string|null $value): static
    {
        $this->name = $value;
        return $this;
    }
}