aram-zahedi/persian-sluggable

Generate Persian slugs when saving Eloquent models

1.8 2020-08-07 12:53 UTC

Requires

• php: ^7.2.5
• ext-ctype: *
• ext-mbstring: *
• illuminate/database: ^5.8|^6.0|^7.0

MIT

• Aram Zahedi

• aram-zahedi
• persian-sluggable

README

This package is a localized version of Spatie\Sluggable with Persian language support.

معرفی پکیج

با استفاده از این پکیج میتوانید برای مدل های خود در لاراول به صورت خودکار اسلاگ (نامک) تولید کنید.
ورژن های پشتیبانی شده لاراول: 5.8 و 6 و 7

به مثال زیر توجه کنید:

$model = new EloquentModel();
$model->name = 'سلام دنیا';
$model->save();

echo $model->slug; // "سلام-دنیا"

نامک توسط کلاس Slug داخل پکیج تولید میشود که تمام فاصله داخل متن مشخص شده را به خط تیره - تبدیل میکند.

نصب پکیج

با استفاده از Composer دستور زير را وارد کنيد تا پکيج نصب شود.

composer require aram-zahedi/persian-sluggable

طریقه استفاده

مدل های شما باید از Trait پکیج به اسم AramZahedi\Sluggable\HasSlug استفاده کند و تابع زیر را با توجه به نیاز خود در مدل تعریف کرده باشد. مایگریشن شما نیز باید یک ستون مخصوص برای ذخیره نامک یا Slug داشته باشد. به عنوان مثال:

<?php

namespace App;

use AramZahedi\Sluggable\HasSlug;
use AramZahedi\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'); // اسم ستونی که نامک در آن ذخیره میشود
            $table->string('name');
            $table->timestamps();
        });
    }
}

همچنین میتوانید کلید اصلی مدل را برای روتر به شکل زیر به نام تغییر دهید.

namespace App;

use AramZahedi\Sluggable\HasSlug;
use AramZahedi\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'; // کلید جدید برای router
    }
}

میخواهید نام از ترکیب دو ستون مختلف تولید شود؟ پس به این شکل عمل کنید.

public function getSlugOptions() : SlugOptions
{
    return SlugOptions::create()
        ->generateSlugsFrom(['first_name', 'last_name']) //تولید نامک از ترکیب دو ستون نام و نام خانوادگی
        ->saveSlugsTo('slug');
}

به طور پیش فرض نام های تولید شده، یکتا بوده و امکان وجود نامک تکراری وجود ندارد. در صورتی که بخواهید اجازه وجود نامک های تکراری را بدهید، باید به متد getSlugOptions خط زیر را اضافه کنید:

->allowDuplicateSlugs()

به این شکل:

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

همچنین میتوانید حداکثر طول هر نامک را با فراخوانی تابع زیر تعیین کنید:

->slugsShouldBeNoLongerThan()

به این شکل:

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('.');
}

به محض ایجاد مدل، نامک به صورت خودکار تولید میشود و میتوان دستی نامک را تغییر داد:

$model = EloquentModel:create(['name' => 'hello world']); // نامک hello-world 
$model->slug = 'my-custom-url';
$model->save(); //نامک جدید "my-custom-url"; 

در صورتی که مایل باشید موقع ایجاد مدل جدید، نامک به صورت خودکار تولید نشود میتوانید تابع زیر را فرخوانی کنید:

->doNotGenerateSlugsOnCreate()

به اين شکل:

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

هر موقع مقدار name را (که تعیین کردید نامک از روی آن تولید شود) تغییر دهید، پس از ذخیره مدل، نامک نیز به طور خودکار از روی مقدار جدید مجدداً تولید میشود: در صورتی که میخواهید پس از تغییر مقدار ستون انتخابی نا، نامک مجدداً به صورت خودکار تولید نشود تابع زیر را فراخوانی کنید:

->doNotGenerateSlugsOnUpdate()

به اين شکل:

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

این کار برای زمانی ضروری است که بخواهید از روی نامک، لینک صفحات سایت را تولید کنید که به علت اعتبار در گوگل و... نباید مقدارشان عوض شود.

$model = EloquentModel:create(['name' => 'my name']); //نامک "my-name"; 
$model->save();

$model->name = 'new name';
$model->save(); //نامک مثل قبل "my-name"

هرگاه خواستید نامک مجدداً از روی ستون انتخابی ما تولید شود، میتوانید به صورت دستی تابع زیر را روی مدل خود فراخوانی کنید:

->generateSlug()

در این صورت فراموش نکنید که حتماً با فراخوانی تابع save مدل خود را ذخیره نمایید.

$model = EloquentModel:create(['name' => 'my name']); //نامک "my-name"; 
$model->save();

$model->name = 'new name';
$model->save(); //نامک مثل قبل "my-name"

$model->generateSlug();
$model->save();//نامک اکنون "new-name"

تست پکیج

composer test

امنیت

در صورت بروز هر گونه مشکل میتوانید از طریق آدرس ایمیل زیر، با ما در ارتباط باشید:

[e-mail]