SluggableScopeHelpers::findBySlugOrFail() - Code Metrics - Inspection of "add `onUpdate` back" - cviebrock/eloquent-sluggable - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 5b1cad...834a37 )

by Colin

created 2016-06-17 21:34 UTC

SluggableScopeHelpers::findBySlugOrFail() A

↳ Parent: SluggableScopeHelpers

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

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

<?php namespace Cviebrock\EloquentSluggable;

/**
 * Class PrimarySlug
 *
 * Helper trait for defining the primary slug of a model
 * and providing useful scopes and query methods.
 *
 * @package Cviebrock\EloquentSluggable
 */
trait SluggableScopeHelpers
{

    /**
     * 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;
        }

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

        return reset($keys);
    }

    /**
     * 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 its primary slug.
     *
     * @param \Illuminate\Database\Eloquent\Builder $scope
     * @param string $slug
     * @return \Illuminate\Database\Eloquent\Builder
     */
    public function scopeWhereSlug($scope, $slug)
    {
        return $scope->where($this->getSlugKeyName(), $slug);
    }

    /**
     * Find a model by its primary slug.
     *
     * @param string $slug
     * @param array $columns
     * @return \Illuminate\Database\Eloquent\Model|\Illuminate\Database\Eloquent\Collection|static[]|static|null
     */
    public static function findBySlug($slug, array $columns = ['*'])
    {
        return static::whereSlug($slug)->first($columns);

    }

    /**
     * Find a model by its primary slug or throw an exception.
     *
     * @param string $slug
     * @param array $columns
     * @return \Illuminate\Database\Eloquent\Model|\Illuminate\Database\Eloquent\Collection
     *
     * @throws \Illuminate\Database\Eloquent\ModelNotFoundException
     */
    public static function findBySlugOrFail($slug, array $columns = ['*'])
    {
        return static::whereSlug($slug)->firstOrFail($columns);

    }
}


1			<?php namespace Cviebrock\EloquentSluggable;
2
3			/**
4			* Class PrimarySlug
5			*
6			* Helper trait for defining the primary slug of a model
7			* and providing useful scopes and query methods.
8			*
9			* @package Cviebrock\EloquentSluggable
10			*/
11			trait SluggableScopeHelpers
12			{
13
14			/**
15			* Primary slug column of this model.
16			*
17			* @return string
18			*/
19			public function getSlugKeyName()
20			{
21			if (property_exists($this, 'slugKeyName')) {
22			return $this->slugKeyName;
			0 ignored issues – show Bug introduced 2016-06-17 21:36 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...
23			}
24
25			$keys = array_keys($this->sluggable());
			0 ignored issues – show Bug introduced 2016-06-17 21:36 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...
26
27			return reset($keys);
28			}
29
30			/**
31			* Primary slug value of this model.
32			*
33			* @return string
34			*/
35			public function getSlugKey()
36			{
37			return $this->getAttribute($this->getSlugKeyName());
			0 ignored issues – show Bug introduced 2016-06-17 21:36 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...
38			}
39
40			/**
41			* Query scope for finding a model by its primary slug.
42			*
43			* @param \Illuminate\Database\Eloquent\Builder $scope
44			* @param string $slug
45			* @return \Illuminate\Database\Eloquent\Builder
46			*/
47			public function scopeWhereSlug($scope, $slug)
48			{
49			return $scope->where($this->getSlugKeyName(), $slug);
50			}
51
52			/**
53			* Find a model by its primary slug.
54			*
55			* @param string $slug
56			* @param array $columns
57			* @return \Illuminate\Database\Eloquent\Model\|\Illuminate\Database\Eloquent\Collection\|static[]\|static\|null
58			*/
59			public static function findBySlug($slug, array $columns = ['*'])
60			{
61			return static::whereSlug($slug)->first($columns);
			0 ignored issues – show Bug introduced 2016-06-17 21:36 UTC by Report Bug Copy Issue Report The method `whereSlug()` does not exist on `Cviebrock\EloquentSluggable\SluggableScopeHelpers`. 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...
62			}
63
64			/**
65			* Find a model by its primary slug or throw an exception.
66			*
67			* @param string $slug
68			* @param array $columns
69			* @return \Illuminate\Database\Eloquent\Model\|\Illuminate\Database\Eloquent\Collection
70			*
71			* @throws \Illuminate\Database\Eloquent\ModelNotFoundException
72			*/
73			public static function findBySlugOrFail($slug, array $columns = ['*'])
74			{
75			return static::whereSlug($slug)->firstOrFail($columns);
			0 ignored issues – show Bug introduced 2016-06-17 21:36 UTC by Report Bug Copy Issue Report The method `whereSlug()` does not exist on `Cviebrock\EloquentSluggable\SluggableScopeHelpers`. 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...
76			}
77			}
78

cviebrock / eloquent-sluggable

Push — master ( 5b1cad...834a37 )

SluggableScopeHelpers::findBySlugOrFail() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like