Edofre/laravel-sluggable

<?php

namespace Edofre\Sluggable;

/**
 * Class SlugOptions
 * @package Edofre\Sluggable
 */
class SlugOptions
{
    /** @var string|array|callable */
    public $generateSlugFrom;
    /** @var string */
    public $slugField;
    /** @var bool */
    public $generateUniqueSlugs = true;
    /** @var int */
    public $maximumLength = 250;
    /** @var bool */
    public $generateSlugsOnCreate = true;
    /** @var bool */
    public $generateSlugsOnUpdate = true;

    /**
     * @return static
     */
    public static function create()
    {
        return new static();
    }

    /**
     * @param string|array|callable $fieldName
     * @return \Edofre\Sluggable\SlugOptions
     */
    public function generateSlugsFrom($fieldName)
    {
        $this->generateSlugFrom = $fieldName;
        return $this;
    }

    /**
     * @param $fieldName
     * @return $this
     */
    public function saveSlugsTo($fieldName)
    {
        $this->slugField = $fieldName;
        return $this;
    }

    /**
     * @return $this
     */
    public function allowDuplicateSlugs()
    {
        $this->generateUniqueSlugs = false;
        return $this;
    }

    /**
     * @param $maximumLength
     * @return $this
     */
    public function slugsShouldBeNoLongerThan($maximumLength)
    {
        $this->maximumLength = $maximumLength;
        return $this;
    }

    /**
     * @return $this
     */
    public function doNotGenerateSlugsOnCreate()
    {
        $this->generateSlugsOnCreate = false;
        return $this;
    }

    /**
     * @return $this
     */
    public function doNotGenerateSlugsOnUpdate()
    {
        $this->generateSlugsOnUpdate = false;
        return $this;
    }
}