think\model\relation\BelongsToMany

Complexity

Total Complexity

87

Size/Duplication

Total Lines	689
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes

0

28 Methods

Rating	Name	Duplication	Size	Complexity
A	name()	0	4	1
A	hydratePivot()	0	17	5
A	pivot()	0	4	1
A	buildQuery()	0	11	1
A	newPivot()	0	9	3
A	__construct()	0	16	2
A	relationCount()	0	17	3
A	select()	0	6	1
A	getRelation()	0	14	2
A	hasWhere()	0	3	1
A	has()	0	3	1
A	wherePivot()	0	4	1
A	selectOrFail()	0	3	1
A	paginate()	0	6	1
A	findOrFail()	0	3	1
A	find()	0	9	2
A	getRelationCountQuery()	0	11	2
A	eagerlyResultSet()	0	29	6
A	eagerlyResult()	0	17	3
B	attach()	0	42	9
B	sync()	0	41	9
A	belongsToManyQuery()	0	18	2
A	save()	0	4	1
A	saveAll()	0	15	4
B	eagerlyManyToMany()	0	37	9
A	baseQuery()	0	10	3
B	detach()	0	31	9
A	attached()	0	14	3

<?php
// +----------------------------------------------------------------------

You must use "/**" style comments for a file comment

// | ThinkPHP [ WE CAN DO IT JUST THINK ]
// +----------------------------------------------------------------------
// | Copyright (c) 2006~2019 http://thinkphp.cn All rights reserved.
// +----------------------------------------------------------------------
// | Licensed ( http://www.apache.org/licenses/LICENSE-2.0 )
// +----------------------------------------------------------------------
// | Author: liu21st <liu21st@gmail.com>
// +----------------------------------------------------------------------

namespace think\model\relation;

use Closure;
use think\App;
use think\Collection;
use think\db\Query;
use think\db\Raw;
use think\Exception;
use think\Model;
use think\model\Pivot;
use think\model\Relation;
use think\Paginator;

/**
 * 多对多关联类
 */

Missing @category tag in class comment

Missing @package tag in class comment

Missing @author tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

class BelongsToMany extends Relation
{
    /**
     * 中间表表名
     * @var string
     */
    protected $middle;

    /**
     * 中间表模型名称
     * @var string
     */
    protected $pivotName;

    /**
     * 中间表模型对象
     * @var Pivot
     */
    protected $pivot;

    /**
     * 中间表数据名称
     * @var string
     */
    protected $pivotDataName = 'pivot';

    /**
     * 架构函数
     * @access public
     * @param  Model  $parent     上级模型对象
     * @param  string $model      模型名
     * @param  string $table      中间表名
     * @param  string $foreignKey 关联模型外键
     * @param  string $localKey   当前模型关联键
     */
    public function __construct(Model $parent, string $model, string $table, string $foreignKey, string $localKey)
    {
        $this->parent     = $parent;
        $this->model      = $model;
        $this->foreignKey = $foreignKey;
        $this->localKey   = $localKey;

        if (false !== strpos($table, '\\')) {
            $this->pivotName = $table;
            $this->middle    = App::classBaseName($table);
        } else {
            $this->middle = $table;
        }

        $this->query = (new $model)->db();
        $this->pivot = $this->newPivot();
    }

    /**

Parameter $pivot should have a doc-comment as per coding-style.

     * 设置中间表模型
     * @access public
     * @param  $pivot

Missing parameter name

     * @return $this
     */
    public function pivot(string $pivot)
    {
        $this->pivotName = $pivot;
        return $this;
    }

    /**
     * 设置中间表数据名称
     * @access public
     * @param  string $name

Missing parameter comment

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

    /**

Parameter $data should have a doc-comment as per coding-style.

     * 实例化中间表模型
     * @access public
     * @param  $data

Missing parameter name

     * @return Pivot
     * @throws Exception
     */
    protected function newPivot(array $data = []): Pivot
    {
        $class = $this->pivotName ?: '\\think\\model\\Pivot';
        $pivot = new $class($data, $this->parent, $this->middle);

        if ($pivot instanceof Pivot) {
            return $pivot;
        } else {
            throw new Exception('pivot model must extends: \think\model\Pivot');
        }
    }

    /**
     * 合成中间表模型
     * @access protected
     * @param  array|Collection|Paginator $models

Missing parameter comment

     */

Missing @return tag in function comment

    protected function hydratePivot(iterable $models)
    {
        foreach ($models as $model) {
            $pivot = [];

            foreach ($model->getData() as $key => $val) {
                if (strpos($key, '__')) {
                    list($name, $attr) = explode('__', $key, 2);

                    if ('pivot' == $name) {
                        $pivot[$attr] = $val;
                        unset($model->$key);
                    }
                }
            }

            $model->setRelation($this->pivotDataName, $this->newPivot($pivot));
        }
    }

    /**
     * 创建关联查询Query对象
     * @access protected
     * @return Query
     */
    protected function buildQuery(): Query
    {
        $foreignKey = $this->foreignKey;
        $localKey   = $this->localKey;

        // 关联查询
        $pk = $this->parent->getPk();

        $condition = ['pivot.' . $localKey, '=', $this->parent->$pk];

        return $this->belongsToManyQuery($foreignKey, $localKey, [$condition]);
    }

    /**
     * 延迟获取关联数据
     * @access public
     * @param  array    $subRelation 子关联名
     * @param  Closure  $closure     闭包查询条件
     * @return Collection
     */
    public function getRelation(array $subRelation = [], Closure $closure = null): Collection
    {
        if ($closure) {
            $closure($this);
        }

        $result = $this->buildQuery()
            ->relation($subRelation)
            ->select()
            ->setParent(clone $this->parent);

The method setParent() does not exist on think\Collection. Maybe you want to declare this class abstract?

        $this->hydratePivot($result);

        return $result;

The expression return $result could return the type array which is incompatible with the type-hinted return think\Collection. Consider adding an additional type-check to rule them out.

    }

    /**
     * 重载select方法
     * @access public
     * @param  mixed $data

Missing parameter comment

     * @return Collection
     */
    public function select($data = null): Collection
    {
        $result = $this->buildQuery()->select($data);
        $this->hydratePivot($result);

        return $result;

The expression return $result could return the type array which is incompatible with the type-hinted return think\Collection. Consider adding an additional type-check to rule them out.

    }

    /**
     * 重载paginate方法
     * @access public
     * @param  int|array $listRows

Missing parameter comment

     * @param  int|bool  $simple

Missing parameter comment

     * @param  array     $config

Missing parameter comment

     * @return Paginator
     */
    public function paginate($listRows = null, $simple = false, $config = []): Paginator
    {
        $result = $this->buildQuery()->paginate($listRows, $simple, $config);
        $this->hydratePivot($result);

        return $result;
    }

    /**
     * 重载find方法
     * @access public
     * @param  mixed $data

Missing parameter comment

     * @return Model
     */
    public function find($data = null)
    {
        $result = $this->buildQuery()->find($data);

        if (!$result->isEmpty()) {
            $this->hydratePivot([$result]);
        }

        return $result;
    }

    /**
     * 查找多条记录 如果不存在则抛出异常
     * @access public
     * @param  array|string|Query|\Closure $data

Missing parameter comment

     * @return Collection
     */
    public function selectOrFail($data = null): Collection
    {
        return $this->buildQuery()->failException(true)->select($data);

The expression return $this->buildQuery()->failException(true)->select($data) could return the type array which is incompatible with the type-hinted return think\Collection. Consider adding an additional type-check to rule them out.

    }

    /**
     * 查找单条记录 如果不存在则抛出异常
     * @access public
     * @param  array|string|Query|\Closure $data

Missing parameter comment

     * @return Model
     */
    public function findOrFail($data = null): Model
    {
        return $this->buildQuery()->failException(true)->find($data);
    }

    /**
     * 根据关联条件查询当前模型
     * @access public
     * @param  string  $operator 比较操作符
     * @param  integer $count    个数
     * @param  string  $id       关联表的统计字段
     * @param  string  $joinType JOIN类型
     * @return Model
     */
    public function has(string $operator = '>=', $count = 1, $id = '*', string $joinType = 'INNER')
    {
        return $this->parent;
    }

    /**
     * 根据关联条件查询当前模型
     * @access public
     * @param  mixed  $where 查询条件（数组或者闭包）

Expected 4 spaces after parameter name; 1 found

     * @param  mixed  $fields 字段

Expected 3 spaces after parameter name; 1 found

     * @param  string $joinType JOIN类型
     * @return Query
     * @throws Exception
     */
    public function hasWhere($where = [], $fields = null, string $joinType = '')
    {
        throw new Exception('relation not support: hasWhere');
    }

    /**
     * 设置中间表的查询条件
     * @access public
     * @param  string $field

Missing parameter comment

     * @param  string $op

Missing parameter comment

     * @param  mixed  $condition

Missing parameter comment

     * @return $this
     */
    public function wherePivot($field, $op = null, $condition = null)
    {
        $this->query->where('pivot.' . $field, $op, $condition);
        return $this;
    }

    /**
     * 预载入关联查询（数据集）
     * @access public
     * @param  array   $resultSet   数据集
     * @param  string  $relation    当前关联名
     * @param  array   $subRelation 子关联名
     * @param  Closure $closure     闭包
     * @return void
     */
    public function eagerlyResultSet(array &$resultSet, string $relation, array $subRelation, Closure $closure = null): void
    {
        $localKey = $this->localKey;
        $pk       = $resultSet[0]->getPk();
        $range    = [];

        foreach ($resultSet as $result) {
            // 获取关联外键列表
            if (isset($result->$pk)) {
                $range[] = $result->$pk;
            }
        }

        if (!empty($range)) {
            // 查询关联数据
            $data = $this->eagerlyManyToMany([

The opening parenthesis of a multi-line function call should be the last content on the line.

                ['pivot.' . $localKey, 'in', $range],
            ], $relation, $subRelation, $closure);

For multi-line function calls, the closing parenthesis should be on a new line.

            // 关联属性名
            $attr = App::parseName($relation);

            // 关联数据封装
            foreach ($resultSet as $result) {
                if (!isset($data[$result->$pk])) {
                    $data[$result->$pk] = [];
                }

                $result->setRelation($attr, $this->resultSetBuild($data[$result->$pk], clone $this->parent));
            }
        }
    }

    /**
     * 预载入关联查询（单个数据）
     * @access public
     * @param  Model   $result      数据对象
     * @param  string  $relation    当前关联名
     * @param  array   $subRelation 子关联名
     * @param  Closure $closure     闭包
     * @return void
     */
    public function eagerlyResult(Model $result, string $relation, array $subRelation, Closure $closure = null): void
    {
        $pk = $result->getPk();

        if (isset($result->$pk)) {
            $pk = $result->$pk;
            // 查询管理数据
            $data = $this->eagerlyManyToMany([

The opening parenthesis of a multi-line function call should be the last content on the line.

                ['pivot.' . $this->localKey, '=', $pk],
            ], $relation, $subRelation, $closure);

For multi-line function calls, the closing parenthesis should be on a new line.

            // 关联数据封装
            if (!isset($data[$pk])) {
                $data[$pk] = [];
            }

            $result->setRelation(App::parseName($relation), $this->resultSetBuild($data[$pk], clone $this->parent));
        }
    }

    /**
     * 关联统计
     * @access public
     * @param  Model   $result  数据对象

Expected 4 spaces after parameter name; 2 found

     * @param  Closure $closure 闭包

Expected 3 spaces after parameter name; 1 found

     * @param  string  $aggregate 聚合查询方法
     * @param  string  $field 字段

Expected 5 spaces after parameter name; 1 found

     * @param  string  $name 统计字段别名

Expected 6 spaces after parameter name; 1 found

     * @return integer
     */
    public function relationCount(Model $result, Closure $closure = null, string $aggregate = 'count', string $field = '*', string &$name = null): float
    {
        $pk = $result->getPk();

        if (!isset($result->$pk)) {
            return 0;
        }

        $pk = $result->$pk;

        if ($closure) {
            $closure($this, $name);
        }

        return $this->belongsToManyQuery($this->foreignKey, $this->localKey, [

The opening parenthesis of a multi-line function call should be the last content on the line.

            ['pivot.' . $this->localKey, '=', $pk],
        ])->$aggregate($field);

For multi-line function calls, the closing parenthesis should be on a new line.

    }

    /**
     * 获取关联统计子查询
     * @access public
     * @param  Closure $closure 闭包

Expected 3 spaces after parameter name; 1 found

     * @param  string  $aggregate 聚合查询方法
     * @param  string  $field 字段

Expected 5 spaces after parameter name; 1 found

     * @param  string  $name 统计字段别名

Expected 6 spaces after parameter name; 1 found

     * @return string
     */
    public function getRelationCountQuery(Closure $closure = null, string $aggregate = 'count', string $field = '*', string &$name = null): string
    {
        if ($closure) {
            $closure($this, $name);
        }

        return $this->belongsToManyQuery($this->foreignKey, $this->localKey, [

The opening parenthesis of a multi-line function call should be the last content on the line.

            [
                'pivot.' . $this->localKey, 'exp', new Raw('=' . $this->parent->db(false)->getTable() . '.' . $this->parent->getPk()),

Are you sure $this->parent->getPk() of type array|string can be used in concatenation?

false of type false is incompatible with the type array expected by parameter $scope of think\Model::db().

            ],
        ])->fetchSql()->$aggregate($field);

For multi-line function calls, the closing parenthesis should be on a new line.

    }

    /**
     * 多对多 关联模型预查询
     * @access protected
     * @param  array   $where       关联预查询条件
     * @param  string  $relation    关联名
     * @param  array   $subRelation 子关联
     * @param  Closure $closure     闭包
     * @return array
     */
    protected function eagerlyManyToMany(array $where, string $relation, array $subRelation = [], Closure $closure = null): array
    {
        if ($closure) {
            $closure($this);
        }

        // 预载入关联查询 支持嵌套预载入
        $list = $this->belongsToManyQuery($this->foreignKey, $this->localKey, $where)
            ->with($subRelation)
            ->select();

        // 组装模型数据
        $data = [];
        foreach ($list as $set) {
            $pivot = [];
            foreach ($set->getData() as $key => $val) {
                if (strpos($key, '__')) {
                    list($name, $attr) = explode('__', $key, 2);
                    if ('pivot' == $name) {
                        $pivot[$attr] = $val;
                        unset($set->$key);
                    }
                }
            }

            $key = $pivot[$this->localKey];

            if ($this->withLimit && isset($data[$key]) && count($data[$key]) >= $this->withLimit) {
                continue;
            }

            $set->setRelation($this->pivotDataName, $this->newPivot($pivot));

            $data[$key][] = $set;
        }

        return $data;
    }

    /**
     * BELONGS TO MANY 关联查询
     * @access protected
     * @param  string $foreignKey 关联模型关联键
     * @param  string $localKey   当前模型关联键
     * @param  array  $condition  关联查询条件
     * @return Query
     */
    protected function belongsToManyQuery(string $foreignKey, string $localKey, array $condition = []): Query
    {
        // 关联查询封装
        $tableName = $this->query->getTable();
        $table     = $this->pivot->db()->getTable();
        $fields    = $this->getQueryFields($tableName);

        $query = $this->query
            ->field($fields)
            ->tableField(true, $table, 'pivot', 'pivot__');

        if (empty($this->baseQuery)) {
            $relationFk = $this->query->getPk();
            $query->join([$table => 'pivot'], 'pivot.' . $foreignKey . '=' . $tableName . '.' . $relationFk)

Are you sure $relationFk of type array|string can be used in concatenation?

                ->where($condition);
        }

        return $query;
    }

    /**
     * 保存（新增）当前关联数据对象
     * @access public
     * @param  mixed $data  数据 可以使用数组 关联模型对象 和 关联对象的主键
     * @param  array $pivot 中间表额外数据
     * @return array|Pivot
     */
    public function save($data, array $pivot = [])
    {
        // 保存关联表/中间表数据
        return $this->attach($data, $pivot);
    }

    /**
     * 批量保存当前关联数据对象
     * @access public
     * @param  iterable $dataSet   数据集
     * @param  array    $pivot     中间表额外数据
     * @param  bool     $samePivot 额外数据是否相同
     * @return array|false
     */
    public function saveAll(iterable $dataSet, array $pivot = [], bool $samePivot = false)
    {
        $result = [];

        foreach ($dataSet as $key => $data) {
            if (!$samePivot) {
                $pivotData = $pivot[$key] ?? [];
            } else {
                $pivotData = $pivot;
            }

            $result[] = $this->attach($data, $pivotData);
        }

        return empty($result) ? false : $result;
    }

    /**
     * 附加关联的一个中间表数据
     * @access public
     * @param  mixed $data  数据 可以使用数组、关联模型对象 或者 关联对象的主键
     * @param  array $pivot 中间表额外数据
     * @return array|Pivot
     * @throws Exception
     */
    public function attach($data, array $pivot = [])
    {
        if (is_array($data)) {
            if (key($data) === 0) {
                $id = $data;
            } else {
                // 保存关联表数据
                $model = new $this->model;
                $id    = $model->insertGetId($data);
            }
        } elseif (is_numeric($data) || is_string($data)) {
            // 根据关联表主键直接写入中间表
            $id = $data;
        } elseif ($data instanceof Model) {
            // 根据关联表主键直接写入中间表
            $relationFk = $data->getPk();
            $id         = $data->$relationFk;
        }

        if (!empty($id)) {
            // 保存中间表数据
            $pk                     = $this->parent->getPk();
            $pivot[$this->localKey] = $this->parent->$pk;
            $ids                    = (array) $id;

            foreach ($ids as $id) {
                $pivot[$this->foreignKey] = $id;
                $this->pivot->replace()
                    ->exists(false)
                    ->data([])
                    ->save($pivot);
                $result[] = $this->newPivot($pivot);
            }

            if (count($result) == 1) {

The variable $result seems to be defined by a foreach iteration on line 570. Are you sure the iterator is never empty, otherwise this variable is not defined?

                // 返回中间表模型对象
                $result = $result[0];
            }

            return $result;
        } else {
            throw new Exception('miss relation data');
        }
    }

    /**
     * 判断是否存在关联数据
     * @access public
     * @param  mixed $data 数据 可以使用关联模型对象 或者 关联对象的主键
     * @return Pivot|false
     */
    public function attached($data)
    {
        if ($data instanceof Model) {
            $id = $data->getKey();
        } else {
            $id = $data;
        }

        $pivot = $this->pivot
            ->where($this->localKey, $this->parent->getKey())

The method where() does not exist on think\model\Pivot. Since you implemented __call, consider adding a @method annotation.

            ->where($this->foreignKey, $id)
            ->find();

        return $pivot ?: false;
    }

    /**
     * 解除关联的一个中间表数据
     * @access public
     * @param  integer|array $data        数据 可以使用关联对象的主键
     * @param  bool          $relationDel 是否同时删除关联表数据
     * @return integer
     */
    public function detach($data = null, bool $relationDel = false): int
    {
        if (is_array($data)) {
            $id = $data;
        } elseif (is_numeric($data) || is_string($data)) {
            // 根据关联表主键直接写入中间表
            $id = $data;
        } elseif ($data instanceof Model) {
            // 根据关联表主键直接写入中间表
            $relationFk = $data->getPk();
            $id         = $data->$relationFk;
        }

        // 删除中间表数据
        $pk      = $this->parent->getPk();
        $pivot   = [];
        $pivot[] = [$this->localKey, '=', $this->parent->$pk];

        if (isset($id)) {
            $pivot[] = [$this->foreignKey, is_array($id) ? 'in' : '=', $id];
        }

        $result = $this->pivot->where($pivot)->delete();

        // 删除关联表数据
        if (isset($id) && $relationDel) {
            $model = $this->model;
            $model::destroy($id);
        }

        return $result;
    }

    /**
     * 数据同步
     * @access public
     * @param  array $ids

Missing parameter comment

     * @param  bool  $detaching

Missing parameter comment

     * @return array
     */
    public function sync(array $ids, bool $detaching = true): array
    {
        $changes = [
            'attached' => [],
            'detached' => [],
            'updated'  => [],
        ];

        $pk = $this->parent->getPk();

        $current = $this->pivot
            ->where($this->localKey, $this->parent->$pk)
            ->column($this->foreignKey);

        $records = [];

        foreach ($ids as $key => $value) {
            if (!is_array($value)) {
                $records[$value] = [];
            } else {
                $records[$key] = $value;
            }
        }

        $detach = array_diff($current, array_keys($records));

        if ($detaching && count($detach) > 0) {
            $this->detach($detach);
            $changes['detached'] = $detach;
        }

        foreach ($records as $id => $attributes) {
            if (!in_array($id, $current)) {
                $this->attach($id, $attributes);
                $changes['attached'][] = $id;
            } elseif (count($attributes) > 0 && $this->attach($id, $attributes)) {
                $changes['updated'][] = $id;
            }
        }

        return $changes;
    }

    /**
     * 执行基础查询（仅执行一次）
     * @access protected
     * @return void
     */
    protected function baseQuery(): void
    {
        if (empty($this->baseQuery) && $this->parent->getData()) {
            $pk    = $this->parent->getPk();
            $table = $this->pivot->getTable();

The method getTable() does not exist on think\model\Pivot. Since you implemented __call, consider adding a @method annotation.

            $this->query
                ->join([$table => 'pivot'], 'pivot.' . $this->foreignKey . '=' . $this->query->getTable() . '.' . $this->query->getPk())

Are you sure $this->query->getPk() of type array|string can be used in concatenation?

                ->where('pivot.' . $this->localKey, $this->parent->$pk);
            $this->baseQuery = true;
        }
    }

}