Quantum\Libraries\Database\Adapters\Idiorm\Statements\Join

Complexity

Total Complexity

16

Size/Duplication

Total Lines	137
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	join()	0	4	1
A	applyBelongsTo()	0	8	1
A	applyHasRelation()	0	8	1
A	getValidatedRelation()	0	20	5
A	leftJoin()	0	4	1
A	innerJoin()	0	4	1
A	rightJoin()	0	4	1
A	joinTo()	0	26	5

<?php

/**
 * Quantum PHP Framework
 *
 * An open source software development framework for PHP
 *
 * @package Quantum
 * @author Arman Ag. <arman.ag@softberg.org>
 * @copyright Copyright (c) 2018 Softberg LLC (https://softberg.org)
 * @link http://quantum.softberg.org/
 * @since 2.9.9
 */

namespace Quantum\Libraries\Database\Adapters\Idiorm\Statements;

use Quantum\Libraries\Database\Adapters\Idiorm\IdiormPatch;
use Quantum\Libraries\Database\Contracts\DbalInterface;
use Quantum\Libraries\Database\Enums\Relation;
use Quantum\Model\Exceptions\ModelException;
use Quantum\App\Exceptions\BaseException;
use Quantum\Model\QtModel;

/**
 * Trait Join
 * @package Quantum\Libraries\Database
 */
trait Join
{

    /**
     * @inheritDoc
     * @throws BaseException
     */
    public function join(string $table, array $constraint, ?string $tableAlias = null): DbalInterface
    {
        $this->getOrmModel()->join($table, $constraint, $tableAlias);

It seems like getOrmModel() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        return $this;

The expression return $this returns the type Quantum\Libraries\Database\Adapters\Idiorm\Statements\Join which is incompatible with the type-hinted return Quantum\Libraries\Database\Contracts\DbalInterface.

    }

    /**
     * @inheritDoc
     * @throws BaseException
     */
    public function innerJoin(string $table, array $constraint, ?string $tableAlias = null): DbalInterface
    {
        $this->getOrmModel()->inner_join($table, $constraint, $tableAlias);
        return $this;

The expression return $this returns the type Quantum\Libraries\Database\Adapters\Idiorm\Statements\Join which is incompatible with the type-hinted return Quantum\Libraries\Database\Contracts\DbalInterface.

    }

    /**
     * @inheritDoc
     * @throws BaseException
     */
    public function leftJoin(string $table, array $constraint, ?string $tableAlias = null): DbalInterface
    {
        IdiormPatch::getInstance()->use($this->getOrmModel())->leftJoin($table, $constraint, $tableAlias);
        return $this;

The expression return $this returns the type Quantum\Libraries\Database\Adapters\Idiorm\Statements\Join which is incompatible with the type-hinted return Quantum\Libraries\Database\Contracts\DbalInterface.

    }

    /**
     * @inheritDoc
     * @throws BaseException
     */
    public function rightJoin(string $table, array $constraint, ?string $tableAlias = null): DbalInterface
    {
        IdiormPatch::getInstance()->use($this->getOrmModel())->rightJoin($table, $constraint, $tableAlias);
        return $this;

The expression return $this returns the type Quantum\Libraries\Database\Adapters\Idiorm\Statements\Join which is incompatible with the type-hinted return Quantum\Libraries\Database\Contracts\DbalInterface.

    }

    /**
     * @inheritDoc
     * @throws BaseException
     * @throws ModelException
     */
    public function joinTo(QtModel $relatedModel, bool $switch = true): DbalInterface
    {
        $relation = $this->getValidatedRelation($relatedModel);

        switch ($relation['type']) {
            case Relation::HAS_ONE:
            case Relation::HAS_MANY:
                $this->applyHasRelation($relatedModel, $relation);
                break;

            case Relation::BELONGS_TO:
                $this->applyBelongsTo($relatedModel, $relation);
                break;

            default:
                throw ModelException::unsupportedRelationType($relation['type']);
        }

        if ($switch) {
            $this->modelName = get_class($relatedModel);

The property modelName does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

            $this->table = $relatedModel->table;

The property table does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

            $this->idColumn = $relatedModel->idColumn;

The property idColumn does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

            $this->foreignKeys = $relatedModel->relations();

The property foreignKeys does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        }

        return $this;

The expression return $this returns the type Quantum\Libraries\Database\Adapters\Idiorm\Statements\Join which is incompatible with the type-hinted return Quantum\Libraries\Database\Contracts\DbalInterface.

    }

    /**
     * @param QtModel $relatedModel
     * @param array $relation
     * @return void
     * @throws BaseException
     */
    protected function applyHasRelation(QtModel $relatedModel, array $relation): void
    {
        $this->getOrmModel()->join(
            $relatedModel->table,
            [
                $relatedModel->table . '.' . $relation['foreign_key'],
                '=',
                $this->table . '.' . $relation['local_key']
            ]
        );
    }

    /**
     * @param QtModel $relatedModel
     * @param array $relation
     * @return void
     * @throws BaseException
     */
    protected function applyBelongsTo(QtModel $relatedModel, array $relation): void
    {
        $this->getOrmModel()->join(
            $relatedModel->table,
            [
                $relatedModel->table . '.' . $relation['local_key'],
                '=',
                $this->table . '.' . $relation['foreign_key']
            ]
        );
    }

    /**
     * @param QtModel $modelToJoin
     * @return array
     * @throws ModelException
     */
    private function getValidatedRelation(QtModel $modelToJoin): array
    {
        $relations = $this->getForeignKeys();

It seems like getForeignKeys() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        $relatedModelName = get_class($modelToJoin);

        if (!isset($relations[$relatedModelName])) {
            throw ModelException::wrongRelation($this->getModelName(), $relatedModelName);

It seems like getModelName() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        }

        $relation = $relations[$relatedModelName];

        if (empty($relation['type'])) {
            throw ModelException::relationTypeMissing($this->getModelName(), $relatedModelName);
        }

        if (empty($relation['foreign_key']) || empty($relation['local_key'])) {
            throw ModelException::missingRelationKeys($this->getModelName(), $relatedModelName);
        }

        return $relation;
    }
}