InheritsRelationsFromParentModel::getForeignKey() - Code Metrics - Inspection of "changelog" - Laravel-Backpack/Base - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( c7e07f...a7489e )

by Cristian

created 2019-03-01 07:12 UTC

InheritsRelationsFromParentModel::getForeignKey() A

↳ Parent: InheritsRelationsFromParentModel

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
nc	1
nop	0
dl	0
loc	4
rs	10
c	0
b	0
f	0

<?php

namespace Backpack\Base\app\Models\Traits;

use Illuminate\Support\Str;
use ReflectionClass;

/**
 * This trait helps a child model (ex: BackpackUser) inherit all relationships of its parent model (ex: User).
 * Laravel by default doesn't do that, so packages like Backpack\PermissionManager can't see relationships
 * on the BackpackUser model, because they haven't been inherited from User.
 *
 * The code below has been copy-pasted from https://github.com/tightenco/parental on Feb 27th 2019.
 * When they provide support for Laravel 5.8, this entire trait could go away (or load their trait).
 */
trait InheritsRelationsFromParentModel
{
    public $hasParent = true;

    public static function bootHasParent()
    {
        static::creating(function ($model) {
            if ($model->parentHasHasChildrenTrait()) {
                $model->forceFill(
                    [$model->getInheritanceColumn() => $model->classToAlias(get_class($model))]
                );
            }
        });
        static::addGlobalScope(function ($query) {
            $instance = new static();
            if ($instance->parentHasHasChildrenTrait()) {
                $query->where($instance->getInheritanceColumn(), $instance->classToAlias(get_class($instance)));
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            }
        });
    }

    public function parentHasHasChildrenTrait()
    {
        return $this->hasChildren ?? false;
class MyClass { }

$x = new MyClass();
$x->foo = true;
    }

    public function getTable()
    {
        if (!isset($this->table)) {
            return str_replace('\\', '', Str::snake(Str::plural(class_basename($this->getParentClass()))));
        }

        return $this->table;
class MyClass { }

$x = new MyClass();
$x->foo = true;
    }

    public function getForeignKey()
    {
        return Str::snake(class_basename($this->getParentClass())).'_'.$this->primaryKey;
class MyClass { }

$x = new MyClass();
$x->foo = true;
    }

    public function joiningTable($related, $instance = null)

    {
        $relatedClassName = method_exists((new $related()), 'getClassNameForRelationships')
            ? (new $related())->getClassNameForRelationships()
            : class_basename($related);
        $models = [
            Str::snake($relatedClassName),
            Str::snake($this->getClassNameForRelationships()),
        ];
        sort($models);

        return strtolower(implode('_', $models));
    }

    public function getClassNameForRelationships()
    {
        return class_basename($this->getParentClass());
    }

    public function getMorphClass()
    {
        if ($this->parentHasHasChildrenTrait()) {
            $parentClass = $this->getParentClass();

            return (new $parentClass())->getMorphClass();
        }

        return parent::getMorphClass();
    }

    protected function getParentClass()
    {
        static $parentClassName;

        return $parentClassName ?: $parentClassName = (new ReflectionClass($this))->getParentClass()->getName();
    }
}


1			<?php
2
3			namespace Backpack\Base\app\Models\Traits;
4
5			use Illuminate\Support\Str;
6			use ReflectionClass;
7
8			/**
9			* This trait helps a child model (ex: BackpackUser) inherit all relationships of its parent model (ex: User).
10			* Laravel by default doesn't do that, so packages like Backpack\PermissionManager can't see relationships
11			* on the BackpackUser model, because they haven't been inherited from User.
12			*
13			* The code below has been copy-pasted from https://github.com/tightenco/parental on Feb 27th 2019.
14			* When they provide support for Laravel 5.8, this entire trait could go away (or load their trait).
15			*/
16			trait InheritsRelationsFromParentModel
17			{
18			public $hasParent = true;
19
20			public static function bootHasParent()
21			{
22			static::creating(function ($model) {
23			if ($model->parentHasHasChildrenTrait()) {
24			$model->forceFill(
25			[$model->getInheritanceColumn() => $model->classToAlias(get_class($model))]
26			);
27			}
28			});
29			static::addGlobalScope(function ($query) {
30			$instance = new static();
31			if ($instance->parentHasHasChildrenTrait()) {
32			$query->where($instance->getInheritanceColumn(), $instance->classToAlias(get_class($instance)));
			0 ignored issues – show Bug introduced 2019-02-27 17:01 UTC by Report Bug Copy Issue Report It seems like `getInheritanceColumn()` 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... Bug introduced 2019-02-27 17:01 UTC by Report Bug Copy Issue Report It seems like `classToAlias()` 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...
33			}
34			});
35			}
36
37			public function parentHasHasChildrenTrait()
38			{
39			return $this->hasChildren ?? false;
			0 ignored issues – show Bug introduced 2019-02-27 17:01 UTC by Report Bug Copy Issue Report The property `hasChildren` 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...
40			}
41
42			public function getTable()
43			{
44			if (!isset($this->table)) {
45			return str_replace('\\', '', Str::snake(Str::plural(class_basename($this->getParentClass()))));
46			}
47
48			return $this->table;
			0 ignored issues – show Bug introduced 2019-02-27 17:01 UTC by Report Bug Copy Issue Report The property `table` 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...
49			}
50
51			public function getForeignKey()
52			{
53			return Str::snake(class_basename($this->getParentClass())).'_'.$this->primaryKey;
			0 ignored issues – show Bug introduced 2019-02-27 17:01 UTC by Report Bug Copy Issue Report The property `primaryKey` 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...
54			}
55
56			public function joiningTable($related, $instance = null)
			0 ignored issues – show Unused Code introduced 2019-02-27 17:01 UTC by Report Bug Copy Issue Report The parameter `$instance` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
57			{
58			$relatedClassName = method_exists((new $related()), 'getClassNameForRelationships')
59			? (new $related())->getClassNameForRelationships()
60			: class_basename($related);
61			$models = [
62			Str::snake($relatedClassName),
63			Str::snake($this->getClassNameForRelationships()),
64			];
65			sort($models);
66
67			return strtolower(implode('_', $models));
68			}
69
70			public function getClassNameForRelationships()
71			{
72			return class_basename($this->getParentClass());
73			}
74
75			public function getMorphClass()
76			{
77			if ($this->parentHasHasChildrenTrait()) {
78			$parentClass = $this->getParentClass();
79
80			return (new $parentClass())->getMorphClass();
81			}
82
83			return parent::getMorphClass();
84			}
85
86			protected function getParentClass()
87			{
88			static $parentClassName;
89
90			return $parentClassName ?: $parentClassName = (new ReflectionClass($this))->getParentClass()->getName();
91			}
92			}
93

Laravel-Backpack / Base

Push — master ( c7e07f...a7489e )

InheritsRelationsFromParentModel::getForeignKey() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like