Neurony\Url\Options\SlugOptions

Complexity

Total Complexity

11

Size/Duplication

Total Lines	171
Duplicated Lines	5.85 %

Coupling/Cohesion

Components	7
Dependencies	0

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__get()	10	10	2
A	instance()	0	4	1
A	generateSlugFrom()	0	10	2
A	saveSlugTo()	0	6	1
A	allowDuplicateSlugs()	0	6	1
A	usingSeparator()	0	6	1
A	usingLanguage()	0	6	1
A	doNotGenerateSlugOnCreate()	0	6	1
A	doNotGenerateSlugOnUpdate()	0	6	1

<?php

namespace Neurony\Url\Options;

use Exception;

class SlugOptions
{
    /**
     * The field used to generate the slug from.
     *
     * @var string|array|callable
     */
    private $fromField;

    /**
     * The field where to store the generated slug.
     *
     * @var string
     */
    private $toField;

    /**
     * Flag whether slugs should be unique or not.
     *
     * @var bool
     */
    private $uniqueSlugs = true;

    /**
     * The separator used between words in the slug.
     *
     * @var string
     */
    private $slugSeparator = '-';

    /**
     * The language used to transform the UTF-8 slug to ASCII.
     *
     * @var string
     */
    private $slugLanguage = 'en';

    /**
     * Flag whether to generate slug on model create event or not.
     *
     * @var bool
     */
    private $generateSlugOnCreate = true;

    /**
     * Flag whether to generate slug on model update event or not.
     *
     * @var bool
     */
    private $generateSlugOnUpdate = true;

    /**
     * Get the value of a property of this class.
     *
     * @param $name
     * @return mixed
     * @throws Exception
     */
    public function __get($name)

This method seems to be duplicated in your project.

    {
        if (property_exists(static::class, $name)) {
            return $this->{$name};
        }

        throw new Exception(
            'The property "'.$name.'" does not exist in class "'.static::class.'"'
        );
    }

    /**
     * Get a fresh instance of this class.
     *
     * @return SlugOptions
     */
    public static function instance(): self
    {
        return new static();
    }

    /**
     * Set the $fromField to work with in the Neurony\Url\Traits\HasSlug trait.
     *
     * @param string|array|callable $field
     * @return SlugOptions
     */
    public function generateSlugFrom($field): self
    {
        if (is_string($field)) {
            $field = [$field];
        }

        $this->fromField = $field;

        return $this;
    }

    /**
     * Set the $toField to work with in the Neurony\Url\Traits\HasSlug trait.
     *
     * @param string $field
     * @return SlugOptions
     */
    public function saveSlugTo(string $field): self
    {
        $this->toField = $field;

        return $this;
    }

    /**
     * Set the $uniqueSlugs to work with in the Neurony\Url\Traits\HasSlug trait.
     *
     * @return SlugOptions
     */
    public function allowDuplicateSlugs(): self
    {
        $this->uniqueSlugs = false;

        return $this;
    }

    /**
     * Set the $slugSeparator to work with in the Neurony\Url\Traits\HasSlug trait.
     *
     * @param string $separator
     * @return SlugOptions
     */
    public function usingSeparator(string $separator): self
    {
        $this->slugSeparator = $separator;

        return $this;
    }

    /**
     * Set the $slugLanguage to work with in the Neurony\Url\Traits\HasSlug trait.
     *
     * @param string $separator
     * @return SlugOptions
     */
    public function usingLanguage(string $separator): self
    {
        $this->slugLanguage = $separator;

        return $this;
    }

    /**
     * Set the $generateSlugOnCreate to work with in the Neurony\Url\Traits\HasSlug trait.
     *
     * @return SlugOptions
     */
    public function doNotGenerateSlugOnCreate(): self
    {
        $this->generateSlugOnCreate = false;

        return $this;
    }

    /**
     * Set the $generateSlugOnUpdate to work with in the Neurony\Url\Traits\HasSlug trait.
     *
     * @return SlugOptions
     */
    public function doNotGenerateSlugOnUpdate(): self
    {
        $this->generateSlugOnUpdate = false;

        return $this;
    }
}