PrimarySlug - Code Metrics - Inspection of "Merge pull request #280 from unstoppablecarl/prima..." - cviebrock/eloquent-sluggable - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 304470...5b1cad )

by Colin

created 2016-06-17 19:02 UTC

PrimarySlug A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	62
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes	2
Bugs	0	Features	1

Metric	Value
wmc	6
c	2
b	0
f	1
lcom	1
cbo	1
dl	0
loc	62
rs	10

5 Methods

Rating	Name	Size	Complexity
A	getSlugKeyName()	8	2
A	getSlugKey()	4	1
A	scopeWhereSlug()	4	1
A	findBySlug()	4	1
A	findBySlugOrFail()	4	1

<?php

namespace Cviebrock\EloquentSluggable;

use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Support\Collection;

/**
 * Class PrimarySlug
 * Helper trait for defining the primary slug of a model.
 *
 * @package Cviebrock\EloquentSluggable
 */
trait PrimarySlug
{

    /**
     * Primary slug column of this model.
     *
     * @return string
     */
    public function getSlugKeyName()
    {
        if (property_exists($this, 'slugKeyName')) {
            return $this->slugKeyName;
class MyClass { }

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

        return array_first(array_keys($this->sluggable()));
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }

    /**
     * Primary slug value of this model.
     *
     * @return string
     */
    public function getSlugKey()
    {
        return $this->getAttribute($this->getSlugKeyName());
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }

    /**
     * Query scope for finding a model by primary slug.
     *
     * @param Builder $scope
     * @param string $slug
     * @return Builder
     */
    public function scopeWhereSlug($scope, $slug)
    {
        return $scope->where($this->getSlugKeyName(), $slug);
    }

    /**
     * Find Model by primary slug. Fallback to find by id. Fail if not found.
     *
     * @param string $slug
     * @return Model|Collection|null
     */
    public static function findBySlug($slug)
    {
        return static::whereSlug($slug)->first();

    }

    /**
     * Find by primary slug. Fail if not found.
     *
     * @param string $slug
     * @return Model
     */
    public static function findBySlugOrFail($slug)
    {
        return static::whereSlug($slug)->firstOrFail();

    }

}


1			<?php
2
3			namespace Cviebrock\EloquentSluggable;
4
5			use Illuminate\Database\Eloquent\Builder;
6			use Illuminate\Database\Eloquent\Model;
7			use Illuminate\Support\Collection;
8
9			/**
10			* Class PrimarySlug
11			* Helper trait for defining the primary slug of a model.
12			*
13			* @package Cviebrock\EloquentSluggable
14			*/
15			trait PrimarySlug
16			{
17
18			/**
19			* Primary slug column of this model.
20			*
21			* @return string
22			*/
23			public function getSlugKeyName()
24			{
25			if (property_exists($this, 'slugKeyName')) {
26			return $this->slugKeyName;
			0 ignored issues – show Bug introduced 2016-06-17 16:51 UTC by Report Bug Copy Issue Report The property `slugKeyName` 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...
27			}
28
29			return array_first(array_keys($this->sluggable()));
			0 ignored issues – show Bug introduced 2016-06-17 16:51 UTC by Report Bug Copy Issue Report It seems like `sluggable()` 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...
30			}
31
32			/**
33			* Primary slug value of this model.
34			*
35			* @return string
36			*/
37			public function getSlugKey()
38			{
39			return $this->getAttribute($this->getSlugKeyName());
			0 ignored issues – show Bug introduced 2016-06-17 16:51 UTC by Report Bug Copy Issue Report It seems like `getAttribute()` 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...
40			}
41
42			/**
43			* Query scope for finding a model by primary slug.
44			*
45			* @param Builder $scope
46			* @param string $slug
47			* @return Builder
48			*/
49			public function scopeWhereSlug($scope, $slug)
50			{
51			return $scope->where($this->getSlugKeyName(), $slug);
52			}
53
54			/**
55			* Find Model by primary slug. Fallback to find by id. Fail if not found.
56			*
57			* @param string $slug
58			* @return Model\|Collection\|null
59			*/
60			public static function findBySlug($slug)
61			{
62			return static::whereSlug($slug)->first();
			0 ignored issues – show Bug introduced 2016-06-17 14:46 UTC by Report Bug Copy Issue Report The method `whereSlug()` does not exist on `Cviebrock\EloquentSluggable\PrimarySlug`. Did you maybe mean `scopeWhereSlug()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
63			}
64
65			/**
66			* Find by primary slug. Fail if not found.
67			*
68			* @param string $slug
69			* @return Model
70			*/
71			public static function findBySlugOrFail($slug)
72			{
73			return static::whereSlug($slug)->firstOrFail();
			0 ignored issues – show Bug introduced 2016-06-17 14:46 UTC by Report Bug Copy Issue Report The method `whereSlug()` does not exist on `Cviebrock\EloquentSluggable\PrimarySlug`. Did you maybe mean `scopeWhereSlug()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
74			}
75
76			}
77

cviebrock / eloquent-sluggable

Push — master ( 304470...5b1cad )

PrimarySlug A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

5 Methods

Duplication Side-by-Side

Filter issues like