README

此包由Spatie创建。我们已分叉它，以便添加我们需要的功能，并且在我们升级到新的Laravel版本之前，我们不依赖于Spatie。

$model = new EloquentModel();
$model->name = 'activerecord is awesome';
$model->save();

echo $model->slug; // ouputs "activerecord-is-awesome"

短链接使用Laravel的Str::slug方法生成，其中空格转换为'-'。

安装

您可以通过composer安装此包

composer require marshmallow/sluggable

用法

您的Eloquent模型应使用Marshmallow\Sluggable\HasSlug特质和Marshmallow\Sluggable\SlugOptions类。

特质包含一个必须由您自己实现的抽象方法getSlugOptions()。

您的模型迁移应该有一个字段来保存生成的短链接。

以下是实现特质的示例

namespace App;

use Marshmallow\Sluggable\HasSlug;
use Marshmallow\Sluggable\SlugOptions;
use Illuminate\Database\Eloquent\Model;

class YourEloquentModel extends Model
{
    use HasSlug;

    /**
     * Get the options for generating the slug.
     */
    public function getSlugOptions() : SlugOptions
    {
        return SlugOptions::create()
            ->generateSlugsFrom('name')
            ->saveSlugsTo('slug');
    }
}

及其迁移

use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;

class CreateYourEloquentModelTable extends Migration
{
    /**
     * Run the migrations.
     *
     * @return void
     */
    public function up()
    {
        Schema::create('your_eloquent_models', function (Blueprint $table) {
            $table->increments('id');
            $table->string('slug'); // Field name same as your `saveSlugsTo`
            $table->string('name');
            $table->timestamps();
        });
    }
}

要在路由中使用生成的短链接，请记住使用Laravel的隐式路由模型绑定

namespace App;

use Marshmallow\Sluggable\HasSlug;
use Marshmallow\Sluggable\SlugOptions;
use Illuminate\Database\Eloquent\Model;

class YourEloquentModel extends Model
{
    use HasSlug;

    /**
     * Get the options for generating the slug.
     */
    public function getSlugOptions() : SlugOptions
    {
        return SlugOptions::create()
            ->generateSlugsFrom('name')
            ->saveSlugsTo('slug');
    }

    /**
     * Get the route key for the model.
     *
     * @return string
     */
    public function getRouteKeyName()
    {
        return 'slug';
    }
}

想要使用多个字段作为短链接的基础？没问题！

public function getSlugOptions() : SlugOptions
{
    return SlugOptions::create()
        ->generateSlugsFrom(['first_name', 'last_name'])
        ->saveSlugsTo('slug');
}

您还可以将一个callable传递给generateSlugsFrom。

默认情况下，此包将通过追加'-'和数字到已存在的短链接来生成唯一的短链接。

您可以通过调用allowDuplicateSlugs来禁用此行为。

public function getSlugOptions() : SlugOptions
{
    return SlugOptions::create()
        ->generateSlugsFrom('name')
        ->saveSlugsTo('slug')
        ->allowDuplicateSlugs();
}

您还可以对创建的短链接设置最大长度限制

public function getSlugOptions() : SlugOptions
{
    return SlugOptions::create()
        ->generateSlugsFrom('name')
        ->saveSlugsTo('slug')
        ->slugsShouldBeNoLongerThan(50);
}

由于添加了用于使它唯一的后缀，短链接可能略长于指定的值。

您还可以通过调用usingSeparator使用自定义分隔符

public function getSlugOptions() : SlugOptions
{
    return SlugOptions::create()
        ->generateSlugsFrom('name')
        ->saveSlugsTo('slug')
        ->usingSeparator('_');
}

要设置Str::slug使用的语言，您可以通过调用usingLanguage来设置

public function getSlugOptions() : SlugOptions
{
    return SlugOptions::create()
        ->generateSlugsFrom('name')
        ->saveSlugsTo('slug')
        ->usingLanguage('nl');
}

您还可以通过将其设置为与生成短链接不同的值来覆盖生成的短链接。

$model = EloquentModel:create(['name' => 'my name']); //slug is now "my-name";
$model->slug = 'my-custom-url';
$model->save(); //slug is now "my-custom-url";

如果您不想在模型最初创建时创建短链接，可以设置doNotGenerateSlugsOnCreate()函数。

public function getSlugOptions() : SlugOptions
{
    return SlugOptions::create()
        ->generateSlugsFrom('name')
        ->saveSlugsTo('slug')
        ->doNotGenerateSlugsOnCreate();
}

类似地，如果您想在模型更新时重新生成短链接，请调用generateSlugsOnUpdate()。

public function getSlugOptions() : SlugOptions
{
    return SlugOptions::create()
        ->generateSlugsFrom('name')
        ->saveSlugsTo('slug')
        ->generateSlugsOnUpdate();
}

这有助于创建直到您明确想要更改才更改的永久链接。

$model = EloquentModel:create(['name' => 'my name']); //slug is now "my-name";
$model->save();

$model->name = 'changed name';
$model->save(); //slug stays "my-name"

如果您想在模型上显式更新短链接，可以在任何时间通过在模型上调用generateSlug()来生成短链接，根据您的其他选项。不要忘记save()模型以将更新持久化到数据库。

变更日志

有关最近更改的更多信息，请参阅变更日志

安全

如果您发现任何安全相关的问题，请通过电子邮件stef@marshmallow.dev报告，而不是使用问题跟踪器。

鸣谢

• Freek Van der Herten
• 所有贡献者

许可证

MIT许可证（MIT）。有关更多信息，请参阅许可证文件