Cviebrock\EloquentSluggable\SluggableTrait

Complexity

Total Complexity

55

Size/Duplication

Total Lines	437
Duplicated Lines	3.66 %

Coupling/Cohesion

Components	2
Dependencies	2

Importance

Changes	42
Bugs	8	Features	7

22 Methods

Rating	Name	Duplication	Size	Complexity
A	needsSlugging()	0	16	4
A	getSlugSource()	0	13	2
B	generateSource()	0	17	5
B	generateSlug()	0	24	6
A	getSlugEngine()	0	4	1
B	validateSlug()	0	24	5
B	makeSlugUnique()	0	30	6
A	generateSuffix()	0	23	2
B	getExistingSlugs()	0	30	4
A	usesSoftDeleting()	0	4	1
A	setSlug()	0	6	1
A	getSlug()	0	7	1
A	sluggify()	0	20	4
A	resluggify()	0	4	1
A	createSlug()	0	8	1
A	scopeWhereSlug()	0	6	1
A	findBySlug()	0	4	1
A	findBySlugOrFail()	0	4	1
A	getSluggableConfig()	0	9	2
A	findBySlugOrIdOrFail()	8	8	2
A	findBySlugOrId()	8	8	2
A	findBySlugOrNew()	0	9	2

<?php namespace Cviebrock\EloquentSluggable;

use Cocur\Slugify\Slugify;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Support\Collection;

/**
 * Class SluggableTrait
 *
 * @package Cviebrock\EloquentSluggable
 */
trait SluggableTrait
{
    /**
     * Determines whether the model needs slugging.
     *
     * @return bool
     */
    protected function needsSlugging()
    {
        $config = $this->getSluggableConfig();
        $save_to = $config['save_to'];
        $on_update = $config['on_update'];

        if (empty($this->attributes[$save_to])) {

The property attributes does not exist. Did you maybe forget to declare it?

            return true;
        }

        if ($this->isDirty($save_to)) {

It seems like isDirty() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            return false;
        }

        return (!$this->exists || $on_update);

The property exists does not exist. Did you maybe forget to declare it?

    }

    /**
     * Get the source string for the slug.
     *
     * @return string
     */
    protected function getSlugSource()
    {
        $config = $this->getSluggableConfig();
        $from = $config['build_from'];

        if (is_null($from)) {
            return $this->__toString();

It seems like __toString() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        }

        $source = array_map([$this, 'generateSource'], (array)$from);

        return join($source, ' ');
    }

    /**
     * Get value for slug.
     *
     * @param string $key
     * @return string|null
     */
    protected function generateSource($key)
    {
        if (isset($this->{$key})) {
            return $this->{$key};
        }

        $object = $this;
        foreach (explode('.', $key) as $segment) {
            if (!is_object($object) || !$tmp = $object->{$segment}) {
                return null;
            }

            $object = $object->{$segment};
        }

        return $object;
    }

    /**
     * Generate a slug from the given source string.
     *
     * @param string $source
     * @return string
     * @throws \UnexpectedValueException
     */
    protected function generateSlug($source)
    {
        $config = $this->getSluggableConfig();
        $separator = $config['separator'];
        $method = $config['method'];
        $max_length = $config['max_length'];

        if (empty($source)) {
            $slug = null;
        } elseif ($method === null) {
            $slugEngine = $this->getSlugEngine();
            $slug = $slugEngine->slugify($source, $separator);
        } elseif (is_callable($method)) {
            $slug = call_user_func($method, $source, $separator);
        } else {
            throw new \UnexpectedValueException('Sluggable method is not callable or null.');
        }

        if (is_string($slug) && $max_length) {
            $slug = substr($slug, 0, $max_length);
        }

        return $slug;
    }

    /**
     * Return a class that has a `slugify()` method, used to convert
     * strings into slugs.
     *
     * @return Slugify
     */
    protected function getSlugEngine()
    {
        return new Slugify();
    }

    /**
     * Checks that the given slug is not a reserved word.
     *
     * @param string $slug
     * @return string
     * @throws \UnexpectedValueException
     */
    protected function validateSlug($slug)
    {
        $config = $this->getSluggableConfig();
        $reserved = $config['reserved'];

        if ($reserved === null) {
            return $slug;
        }

        // check for reserved names
        if ($reserved instanceof \Closure) {
            $reserved = $reserved($this);
        }

        if (is_array($reserved)) {
            if (in_array($slug, $reserved)) {
                return $slug . $config['separator'] . '1';
            }

            return $slug;
        }

        throw new \UnexpectedValueException('Sluggable reserved is not null, an array, or a closure that returns null/array.');
    }

    /**
     * Checks if the slug should be unique, and makes it so if needed.
     *
     * @param string $slug
     * @return string
     */
    protected function makeSlugUnique($slug)
    {
        $config = $this->getSluggableConfig();
        if (!$config['unique']) {
            return $slug;
        }

        $separator = $config['separator'];

        // find all models where the slug is like the current one
        $list = $this->getExistingSlugs($slug);

        // if ...
        // 	a) the list is empty
        // 	b) our slug isn't in the list
        // 	c) our slug is in the list and it's for our model
        // ... we are okay
        if (
          count($list) === 0 ||
          !in_array($slug, $list) ||
          (array_key_exists($this->getKey(),

It seems like getKey() must be provided by classes using this trait. How about adding it as abstract method to this trait?

              $list) && $list[$this->getKey()] === $slug)

It seems like getKey() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        ) {
            return $slug;
        }

        $suffix = $this->generateSuffix($slug, $list);

        return $slug . $separator . $suffix;
    }

    /**
     * Generate a unique suffix for the given slug (and list of existing, "similar" slugs.
     *
     * @param string $slug
     * @param array $list
     *
     * @return string
     */
    protected function generateSuffix($slug, $list)
    {
        $config = $this->getSluggableConfig();
        $separator = $config['separator'];
        $len = strlen($slug . $separator);

        // If the slug already exists, but belongs to
        // our model, return the current suffix.
        if ($this->id === array_search($this->slug, $list)) {

The property id does not exist. Did you maybe forget to declare it?

            $suffix = explode($separator, $this->slug);

The property slug does not exist. Did you maybe forget to declare it?

            return end($suffix);
        }

        array_walk($list, function (&$value, $key) use ($len) {

The parameter $key is not used and could be removed.

            $value = intval(substr($value, $len));
        });

        // find the highest increment
        rsort($list);

        return reset($list) + 1;
    }

    /**
     * Get all existing slugs that are similar to the given slug.
     *
     * @param string $slug
     * @return array
     */
    protected function getExistingSlugs($slug)
    {
        $config = $this->getSluggableConfig();
        $save_to = $config['save_to'];
        $include_trashed = $config['include_trashed'];

        $instance = new static;

        //check for direct match or something that has a separator followed by a suffix
        $query = $instance->where(function ($query) use (

It seems like where() must be provided by classes using this trait. How about adding it as abstract method to this trait?

          $save_to,
          $config,
          $slug
        ) {
            $query->where($save_to, $slug);
            $query->orWhere($save_to, 'LIKE',
              $slug . $config['separator'] . '%');
        });

        // include trashed models if required
        if ($include_trashed && $this->usesSoftDeleting()) {
            $query = $query->withTrashed();
        }

        // get a list of all matching slugs
        $list = $query->lists($save_to, $this->getKeyName());

It seems like getKeyName() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        // Laravel 5.0/5.1 check
        return $list instanceof Collection ? $list->all() : $list;
    }

    /**
     * Does this model use softDeleting?
     *
     * @return bool
     */
    protected function usesSoftDeleting()
    {
        return method_exists($this, 'BootSoftDeletes');
    }

    /**
     * Set the slug manually.
     *
     * @param string $slug
     */
    protected function setSlug($slug)
    {
        $config = $this->getSluggableConfig();
        $save_to = $config['save_to'];
        $this->setAttribute($save_to, $slug);

It seems like setAttribute() must be provided by classes using this trait. How about adding it as abstract method to this trait?

    }

    /**
     * Get the current slug.
     *
     * @return mixed
     */
    public function getSlug()
    {
        $config = $this->getSluggableConfig();
        $save_to = $config['save_to'];

        return $this->getAttribute($save_to);

It seems like getAttribute() must be provided by classes using this trait. How about adding it as abstract method to this trait?

    }

    /**
     * Manually slug the current model.
     *
     * @param bool $force
     * @return $this
     */
    public function sluggify($force = false)
    {
        if ($this->fireModelEvent('slugging') === false) {

It seems like fireModelEvent() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            return $this;
        }

        if ($force || $this->needsSlugging()) {
            $source = $this->getSlugSource();
            $slug = $this->generateSlug($source);

            $slug = $this->validateSlug($slug);
            $slug = $this->makeSlugUnique($slug);

            $this->setSlug($slug);

            $this->fireModelEvent('slugged');

It seems like fireModelEvent() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        }

        return $this;
    }

    /**
     * Force slugging of current model.
     *
     * @return SluggableTrait

The return type SluggableTrait is a trait, and thus cannot be used for type-hinting in PHP. Maybe consider adding an interface and use that for type-hinting?

     */
    public function resluggify()
    {
        return $this->sluggify(true);
    }

    /**
     * Generate a unique slug for a given string.
     *
     * @param  string $fromString
     * @return string
     */
    public static function createSlug($fromString)
    {
        $model = new self();
        $slug = $model->generateSlug($fromString);
        $slug = $model->validateSlug($slug);

        return $model->makeSlugUnique($slug);
    }

    /**
     * Query scope for finding a model by its slug.
     *
     * @param $scope
     * @param $slug
     * @return mixed
     */
    public function scopeWhereSlug($scope, $slug)
    {
        $config = $this->getSluggableConfig();

        return $scope->where($config['save_to'], $slug);
    }

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

The method whereSlug() does not exist on Cviebrock\EloquentSluggable\SluggableTrait. Did you maybe mean scopeWhereSlug()?

    }

    /**
     * Find a model by slug or fail.
     *
     * @param $slug
     * @param array  $columns
     * @return \Illuminate\Database\Eloquent\Model
     */
    public static function findBySlugOrFail($slug, array $columns = ['*'])
    {
        return self::whereSlug($slug)->firstOrFail($columns);

The method whereSlug() does not exist on Cviebrock\EloquentSluggable\SluggableTrait. Did you maybe mean scopeWhereSlug()?

    }

    /**
     * Get the default configuration and merge in any model-specific overrides.
     *
     * @return array
     */
    protected function getSluggableConfig()
    {
        $defaults = app('config')->get('sluggable');
        if (property_exists($this, 'sluggable')) {
            return array_merge($defaults, $this->sluggable);

The property sluggable does not exist. Did you maybe forget to declare it?

        }

        return $defaults;
    }

    /**
     * Simple find by Id if it's numeric or slug if not. Fail if not found.
     *
     * @param $slug
     * @param array  $columns
     * @return \Illuminate\Database\Eloquent\Model|\Illuminate\Support\Collection
     */
    public static function findBySlugOrIdOrFail($slug, array $columns = ['*'])

This method seems to be duplicated in your project.

    {
        if (!$result = self::findBySlug($slug, $columns)) {
            return self::findOrFail((int)$slug, $columns);
        }

        return $result;
    }

    /**
     * Simple find by Id if it's numeric or slug if not.
     *
     * @param $slug
     * @param array  $columns
     * @return \Illuminate\Database\Eloquent\Model|\Illuminate\Support\Collection|null
     */
    public static function findBySlugOrId($slug, array $columns = ['*'])

This method seems to be duplicated in your project.

    {
        if (!$result = self::findBySlug($slug, $columns)) {
            return self::find($slug, $columns);
        }

        return $result;
    }

    /**
     * Find a model by slug or create new instance of model.
     *
     * @param $slug
     * @param array  $columns
     * @return \Illuminate\Database\Eloquent\Model
     */
    public static function findBySlugOrNew($slug, array $columns = ['*'])
    {
        $model =  self::findBySlug($slug,$columns);

        if(is_null($model)){
            return (new self);
        }
        return $model;
    }
}