AlgoWeb\PODataLaravel\Models\ObjectMap\Entities\Associations\AssociationStubBase

Complexity

Total Complexity

42

Size/Duplication

Total Lines	317
Duplicated Lines	0 %

Importance

Changes	9
Bugs	1	Features	0

24 Methods

Rating	Name	Duplication	Size	Complexity
B	compare()	0	22	10
A	addAssociation()	0	3	1
A	setTargType()	0	3	1
A	getEntity()	0	3	1
A	getKeyFieldName()	0	3	1
A	getAssociations()	0	3	1
A	getThroughFieldChain()	0	3	1
A	__construct()	0	10	1
A	getRelationName()	0	3	1
A	setMultiplicity()	0	3	1
A	setThroughFieldChain()	0	3	1
A	getTargType()	0	3	1
A	setRelationName()	0	3	2
A	setForeignFieldName()	0	3	1
A	getForeignFieldName()	0	3	1
A	getKeyField()	0	3	2
A	setKeyFieldName()	0	3	2
A	getBaseType()	0	3	1
A	getMultiplicity()	0	3	1
A	setEntity()	0	3	1
A	isCompatible()	0	13	4
A	isOk()	0	15	1
A	setBaseType()	0	3	2
A	checkStringInput()	0	7	3

<?php

declare(strict_types=1);

namespace AlgoWeb\PODataLaravel\Models\ObjectMap\Entities\Associations;

use AlgoWeb\PODataLaravel\Models\ObjectMap\Entities\EntityField;
use AlgoWeb\PODataLaravel\Models\ObjectMap\Entities\EntityGubbins;

abstract class AssociationStubBase
{
    /**
     * @var AssociationStubRelationType
     */
    protected $multiplicity;

    /**
     * Foreign key field of this end of relation.
     *
     * @var string
     */
    protected $keyFieldName;

    /**
     * A list of fields to Traverse between keyField and foreignField.
     *
     * @var string[]
     */
    protected $throughFieldChain;

    /**
     * Foreign key field of other end of relation.
     *
     * @var string|null
     */
    protected $foreignFieldName;

    /**
     * @var string
     */
    protected $relationName;

    /**
     * Target type this relation points to, if known.  Is null for known-side polymorphic relations.
     *
     * @var string|null
     */
    protected $targType;

    /**
     * Base type this relation is attached to.
     *
     * @var string|null
     */
    protected $baseType;

    /**
     * Any associations this stub is a member of.
     *
     * @var Association[]
     */
    protected $associations = [];

    /**
     * @var EntityGubbins the entity this stub lives on
     */
    protected $entity;

    /**
     * AssociationStubBase constructor.
     * @param string                      $relationName
     * @param string                      $keyFieldName
     * @param string[]                    $throughFieldChain
     * @param AssociationStubRelationType $multiplicity
     */
    public function __construct(
        string $relationName,
        string $keyFieldName,
        array $throughFieldChain,
        AssociationStubRelationType $multiplicity
    ) {
        $this->relationName      = $relationName;
        $this->keyFieldName      = $keyFieldName;
        $this->throughFieldChain = $throughFieldChain;
        $this->multiplicity      = $multiplicity;
    }

    /**
     * Sets the entity owning this AssocationStub.
     *
     * @param EntityGubbins $entity
     */
    public function setEntity(EntityGubbins $entity): void
    {
        $this->entity = $entity;
    }

    /**
     * Gets the entity owning this AssocationStub.
     *
     * @return EntityGubbins
     */
    public function getEntity(): EntityGubbins
    {
        return $this->entity;
    }
    /**
     * Adds this stub as a member of an association.
     *
     * @param Association $newAssociation the new association to be a member of
     */
    public function addAssociation(Association $newAssociation): void
    {
        $this->associations[spl_object_hash($newAssociation)] = $newAssociation;
    }

    /**
     * Gets all associations assigned to this stub.
     *
     * @return Association[] All associations this stub is a member of
     */
    public function getAssociations(): array
    {
        return array_values($this->associations);
    }

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

    /**
     * @param string $relationName
     */
    public function setRelationName(string $relationName): void
    {
        $this->relationName = $this->checkStringInput($relationName) ? $relationName : $this->relationName;
    }

    /**
     * @return AssociationStubRelationType
     */
    public function getMultiplicity(): AssociationStubRelationType
    {
        return $this->multiplicity;
    }

    /**
     * @param AssociationStubRelationType $multiplicity
     */
    public function setMultiplicity(AssociationStubRelationType $multiplicity): void
    {
        $this->multiplicity = $multiplicity;
    }

    /**
     * @return string
     */
    public function getKeyFieldName(): string
    {
        return $this->keyFieldName ?? '';
    }

    public function getKeyField(): ?EntityField
    {
        return (null === $this->entity) ? null : $this->entity->getFields()[$this->getKeyFieldName()];
    }

    /**
     * @param string $keyFieldName
     */
    public function setKeyFieldName(string $keyFieldName): void
    {
        $this->keyFieldName = $this->checkStringInput($keyFieldName) ? $keyFieldName : $this->keyFieldName;
    }

    public function isCompatible(AssociationStubBase $otherStub): bool
    {
        if ($this->morphicType() != $otherStub->morphicType()) {
            return false;
        }

        if (!$this->isOk()) {
            return false;
        }
        if (!$otherStub->isOk()) {
            return false;
        }
        return count($this->getThroughFieldChain()) === count($otherStub->getThroughFieldChain());
    }

    /**
     * Is this AssociationStub sane?
     */
    public function isOk(): bool
    {
        $required = [
            $this->relationName,
            $this->keyFieldName,
            $this->baseType,
        ];
        $requireResult = array_filter($required, [$this, 'checkStringInput']);

        $isOk = true;
        $isOk &= $required == $requireResult;
        $isOk &= (null === $this->targType) === (null ===  $this->foreignFieldName);
        $isOk &= count($this->throughFieldChain) >= 2;

        return boolval($isOk);
    }

    /**
     * @return string|null
     */
    public function getTargType(): ?string
    {
        return $this->targType;
    }

    /**
     * @param string|null $targType
     */
    public function setTargType(?string $targType): void
    {
        $this->targType = $targType;
    }

    /**
     * @return string|null
     */
    public function getBaseType(): ?string
    {
        return $this->baseType;
    }

    /**
     * @param string $baseType
     */
    public function setBaseType(string $baseType): void
    {
        $this->baseType = $this->checkStringInput($baseType) ? $baseType : $this->baseType;
    }

    /**
     * @return string|null
     */
    public function getForeignFieldName(): ?string
    {
        return $this->foreignFieldName;
    }

    /**
     * @param string $foreignFieldName
     */
    public function setForeignFieldName($foreignFieldName): void
    {
        $this->foreignFieldName = $foreignFieldName;
    }

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

    /**
     * @param string[] $keyChain
     */
    public function setThroughFieldChain(array $keyChain): void
    {
        $this->throughFieldChain = $keyChain;
    }
    /**
     * Supply a canonical sort ordering to determine order in associations.
     *
     * @param AssociationStubBase $other
     *
     * @return int
     */
    public function compare(AssociationStubBase $other): int
    {
        $thisFirst  = null === $this->getKeyField() ? false : $this->getKeyField()->getIsKeyField();
        $otherFirst = null === $other->getKeyField() ? false : $other->getKeyField()->getIsKeyField();
        if (
            ($thisFirst || $otherFirst) &&
            !($thisFirst && $otherFirst)
            ) {
            return $thisFirst ? -1 : 1;
        }
        $cmps = [
            [get_class($this), get_class($other)],
            [$this->getBaseType() ?? '', $other->getBaseType() ?? ''],
            [$this->getRelationName() ?? '', $other->getRelationName() ?? ''],
        ];
        foreach ($cmps as $cmpvals) {
            $cmp = strcmp($cmpvals[0], $cmpvals[1]);
            if (0 !== $cmp) {
                return $cmp <=> 0;
            }
        }
        return 0;
    }

    /**
     * Return what type of stub this is - polymorphic, monomorphic, or something else.
     *
     * @return string
     */
    abstract public function morphicType(): string;

    /**
     * @param  mixed $input
     * @return bool
     */
    protected function checkStringInput($input): bool
    {
        // null inputs are caught by the is_string check
        if (!is_string($input) || empty($input)) {
            return false;
        }
        return true;
    }
}