Spiral\ORM\Schemas\Definitions\RelationDefinition

Complexity

Total Complexity

12

Size/Duplication

Total Lines	176
Duplicated Lines	0 %

Coupling/Cohesion

Components	3
Dependencies	1

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	13	1
A	getName()	0	4	1
A	getType()	0	4	1
A	getTarget()	0	4	1
A	getOptions()	0	4	1
A	sourceContext()	0	8	2
A	targetContext()	0	4	1
A	withContext()	0	8	1
A	withOptions()	0	7	1
A	needInversion()	0	4	1
A	getInverse()	0	4	1

<?php
/**
 * components
 *
 * @author    Wolfy-J
 */
namespace Spiral\ORM\Schemas\Definitions;

use Spiral\ORM\Exceptions\SchemaException;

/**
 * Defines relation in schema.
 */
final class RelationDefinition
{
    /**
     * Relation name.
     *
     * @var string
     */
    private $name;

    /**
     * @var string
     */
    private $type;

    /**
     * @var string
     */
    private $target;

    /**
     * @var array
     */
    private $options = [];

    /**
     * Name of relation to be inversed to.
     *
     * @var string
     */
    private $inverse = null;

    /**
     * Defines where relation comes from.
     *
     * @var RelationContext
     */
    private $sourceContext;

    /**
     * Defines where relation points to (if any).
     *
     * @var RelationContext|null
     */
    private $targetContext;

    /**
     * @param string $name
     * @param string $type
     * @param string $target
     * @param array  $options
     * @param mixed  $inverse Name of relation to inversed to.
     */
    public function __construct(
        string $name,
        string $type,
        string $target,
        array $options,
        string $inverse = null
    ) {
        $this->name = $name;
        $this->type = $type;
        $this->target = $target;
        $this->options = $options;
        $this->inverse = $inverse;
    }

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

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

    /**
     * Target class name, see more information about target context via targetContext() method.
     *
     * @return string
     */
    public function getTarget(): string
    {
        return $this->target;
    }

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

    /**
     * Source context (where relation comes from).
     *
     * @return RelationContext
     */
    public function sourceContext(): RelationContext
    {
        if (empty($this->sourceContext)) {
            throw new SchemaException("Source context not set");
        }

        return $this->sourceContext;
    }

    /**
     * Target context if any.
     *
     * @return null|RelationContext
     */
    public function targetContext()
    {
        return $this->targetContext;
    }

    /**
     * Set relation contexts.
     *
     * @param RelationContext      $source
     * @param RelationContext|null $target
     *
     * @return RelationDefinition
     */
    public function withContext(RelationContext $source, RelationContext $target = null): self
    {
        $definition = clone $this;
        $definition->sourceContext = $source;
        $definition->targetContext = $target;

        return $definition;
    }

    /**
     * Create version of definition with different set of options.
     *
     * @param array $options
     *
     * @return RelationDefinition
     */
    public function withOptions(array $options): self
    {
        $definition = clone $this;
        $definition->options = $options;

        return $definition;
    }

    /**
     * Checks if inversion if required.
     *
     * @return bool
     */
    public function needInversion(): bool
    {
        return !empty($this->inverse);
    }

    /**
     * Name of relation to be inversed to.
     *
     * @return string
     */
    public function getInverse(): string
    {
        return $this->inverse;
    }
}