AutoWithTrait::autoWith() - Code Metrics - Inspection of "add TopicListener" - NauxLiu/phphub-server - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( be2db5...c83fb2 )

by 刘

created 2015-12-11 11:53 UTC

AutoWithTrait::autoWith() A

↳ Parent: AutoWithTrait

Complexity

Conditions	3
Paths	3

Size

Total Lines	20
Code Lines	12

Duplication

Lines	0
Ratio	0 %

Importance

Changes	6
Bugs	0	Features	1

Metric	Value
dl	0
loc	20
rs	9.4286
c	6
b	0
f	1
cc	3
eloc	12
nc	3
nop	0

<?php

/**
 * Created by PhpStorm.
 * User: xuan
 * Date: 9/22/15
 * Time: 12:06 AM.
 */
namespace PHPHub\Repositories\Eloquent\Traits;

use Exception;
use Input;
use PHPHub\Transformers\IncludeManager\IncludeManager;

trait AutoWithTrait
{
    /**
     * 用户请求引入字段.
     *
     * @var array
     */
    protected $param_columns = null;

    /**
     * 根节点的字段.
     *
     * @var array
     */
    protected $param_root_columns = [];

    /**
     * 自动 with include 的关联.
     *
     * @return $this
     */
    public function autoWith()
    {
        $include_manager = app(IncludeManager::class);

        $param_columns = $this->parseColumnsParam();
        $which_includes = $include_manager->figureOutWhichIncludes();

        foreach ($which_includes as $include_name) {
            $include = $include_manager->getIncludable($include_name);
            $include->setColumns(array_get($param_columns, $include_name, []));

            if (! $include->getForeignKey()) {
                $this->with($include->getRelation());
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            } else {
                $this->withOnly($include->getRelation(), $include->figureOutWhichColumns(), $include->isWithTrashed());
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            }
        }

        return $this;
    }

    /**
     * 添加一个可用的引入项.
     *
     * @param $name
     * @param $default_columns
     *
     * @return $this
     *
     * @throws Exception
     */
    public function addAvailableInclude($name, $default_columns)
    {
        $method_name = camel_case('include_'.str_replace('.', '_', $name));

        if (! method_exists($this, $method_name)) {
            throw new Exception("You should define $method_name in your repository");
        }

        call_user_func([$this, $method_name], $default_columns);

        return $this;
    }

    /**
     * 设置数据要查询的字段,自动绑定 include 关联的外键.
     *
     * @param $columns
     *
     * @return $this
     */
    public function autoWithRootColumns($columns)
    {
        $this->parseColumnsParam();

        $include_manager = app(IncludeManager::class);
        $this->model = $this->model
class MyClass { }

$x = new MyClass();
$x->foo = true;
            ->select(array_merge($this->param_root_columns, $columns, $include_manager->getForeignKeys()));

        return $this;
    }

    /**
     * 解析 columns 参数，用于指定 include 关联的字段
     * eg. ?include=user&columns=user(name,avatar,gender).
     *
     * @return array
     */
    private function parseColumnsParam()
    {
        if (null !== $this->param_columns) {
            $this->param_columns;
        }
        $result = [];
        $items = explode(',', Input::get('columns'));

        foreach ($items as $item) {
            $arr = explode('(', $item);
            if (count($arr) !== 2) {
                continue;
            }

            list($include, $columns_str) = $arr;

            $result[$include] = explode(':', trim($columns_str, ')'));
        }

        $this->param_root_columns = array_get($result, 'root', []);


        return $this->param_columns = array_except($result, ['root']);
    }
}


1			<?php
2
3			/**
4			* Created by PhpStorm.
5			* User: xuan
6			* Date: 9/22/15
7			* Time: 12:06 AM.
8			*/
9			namespace PHPHub\Repositories\Eloquent\Traits;
10
11			use Exception;
12			use Input;
13			use PHPHub\Transformers\IncludeManager\IncludeManager;
14
15			trait AutoWithTrait
16			{
17			/**
18			* 用户请求引入字段.
19			*
20			* @var array
21			*/
22			protected $param_columns = null;
23
24			/**
25			* 根节点的字段.
26			*
27			* @var array
28			*/
29			protected $param_root_columns = [];
30
31			/**
32			* 自动 with include 的关联.
33			*
34			* @return $this
35			*/
36			public function autoWith()
37			{
38			$include_manager = app(IncludeManager::class);
39
40			$param_columns = $this->parseColumnsParam();
41			$which_includes = $include_manager->figureOutWhichIncludes();
42
43			foreach ($which_includes as $include_name) {
44			$include = $include_manager->getIncludable($include_name);
45			$include->setColumns(array_get($param_columns, $include_name, []));
46
47			if (! $include->getForeignKey()) {
48			$this->with($include->getRelation());
			0 ignored issues – show Bug introduced 2015-12-03 14:27 UTC by Report Bug Copy Issue Report It seems like `with()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
49			} else {
50			$this->withOnly($include->getRelation(), $include->figureOutWhichColumns(), $include->isWithTrashed());
			0 ignored issues – show Bug introduced 2015-12-03 14:27 UTC by Report Bug Copy Issue Report It seems like `withOnly()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
51			}
52			}
53
54			return $this;
55			}
56
57			/**
58			* 添加一个可用的引入项.
59			*
60			* @param $name
61			* @param $default_columns
62			*
63			* @return $this
64			*
65			* @throws Exception
66			*/
67			public function addAvailableInclude($name, $default_columns)
68			{
69			$method_name = camel_case('include_'.str_replace('.', '_', $name));
70
71			if (! method_exists($this, $method_name)) {
72			throw new Exception("You should define $method_name in your repository");
73			}
74
75			call_user_func([$this, $method_name], $default_columns);
76
77			return $this;
78			}
79
80			/**
81			* 设置数据要查询的字段,自动绑定 include 关联的外键.
82			*
83			* @param $columns
84			*
85			* @return $this
86			*/
87			public function autoWithRootColumns($columns)
88			{
89			$this->parseColumnsParam();
90
91			$include_manager = app(IncludeManager::class);
92			$this->model = $this->model
			0 ignored issues – show Bug introduced 2015-12-03 14:27 UTC by Report Bug Copy Issue Report The property `model` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
93			->select(array_merge($this->param_root_columns, $columns, $include_manager->getForeignKeys()));
94
95			return $this;
96			}
97
98			/**
99			* 解析 columns 参数，用于指定 include 关联的字段
100			* eg. ?include=user&columns=user(name,avatar,gender).
101			*
102			* @return array
103			*/
104			private function parseColumnsParam()
105			{
106			if (null !== $this->param_columns) {
107			$this->param_columns;
108			}
109			$result = [];
110			$items = explode(',', Input::get('columns'));
111
112			foreach ($items as $item) {
113			$arr = explode('(', $item);
114			if (count($arr) !== 2) {
115			continue;
116			}
117
118			list($include, $columns_str) = $arr;
119
120			$result[$include] = explode(':', trim($columns_str, ')'));
121			}
122
123			$this->param_root_columns = array_get($result, 'root', []);
			0 ignored issues – show Documentation Bug introduced 2015-12-03 14:27 UTC by Report Bug Copy Issue Report It seems like `array_get($result, 'root', array())` of type `*` is incompatible with the declared type `array` of property `$param_root_columns`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
124
125			return $this->param_columns = array_except($result, ['root']);
126			}
127			}
128

NauxLiu / phphub-server

Push — master ( be2db5...c83fb2 )

AutoWithTrait::autoWith() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like