laravel sluggable

Eloquent 모델을 저장할 때 슬러그 생성

이 패키지는 Eloquent 모델을 저장할 때 고유한 슬러그를 생성하는 특성을 제공합니다.

 $model = new EloquentModel();$model->name = 'activerecord는 정말 멋지네요';$model->save();echo $model->slug; // "activerecord-is-awesome"을 출력합니다.

슬러그는 Laravels Str::slug 메소드를 사용하여 생성되며 공백은 '-'로 변환됩니다.

Spatie는 벨기에 앤트워프에 본사를 둔 웹 디자인 에이전시입니다. 당사 웹사이트에서 당사의 모든 오픈 소스 프로젝트에 대한 개요를 확인할 수 있습니다.

우리를 지원하세요

우리는 동급 최고의 오픈 소스 패키지를 만드는 데 많은 리소스를 투자합니다. 유료 제품 중 하나를 구매하여 우리를 지원할 수 있습니다.

귀하가 사용하고 있는 당사 패키지를 언급하면서 귀하의 고향에서 엽서를 보내주셔서 진심으로 감사드립니다. 연락처 페이지에서 주소를 확인하실 수 있습니다. 우리는 수신된 모든 엽서를 가상 엽서 월에 게시합니다.

설치

작곡가를 통해 패키지를 설치할 수 있습니다.

 작곡가는 spatie/laravel-sluggable이 필요합니다.

용법

Eloquent 모델은 SpatieSluggableHasSlug 특성과 SpatieSluggableSlugOptions 클래스를 사용해야 합니다.

특성에는 직접 구현해야 하는 추상 메서드 getSlugOptions() 포함되어 있습니다.

모델의 마이그레이션에는 생성된 슬러그를 저장할 필드가 있어야 합니다.

다음은 특성을 구현하는 방법에 대한 예입니다.

 네임스페이스 앱; SpatieSluggableHasSlug 사용; SpatieSluggableSlugOptions 사용; IlluminateDatabaseEloquentModel 사용; 클래스 YourEloquentModel 확장 모델
{use HasSlug;/** * 슬러그 생성을 위한 옵션을 가져옵니다.     */공용 함수 getSlugOptions() : SlugOptions{return SlugOptions::create()
            ->SlugsFrom('이름') 생성
            ->saveSlugsTo('슬러그');
    }
}

마이그레이션을 통해:

 IlluminateDatabaseMigrationsMigration 사용; IlluminateDatabaseSchemaBlueprint 사용; IlluminateSupportFacadesSchema 사용;클래스 CreateYourEloquentModelTable은 마이그레이션을 확장합니다.
{공용 함수 up()
    {
        Schema::create('your_eloquent_models', function (Blueprint $table) {$table->increments('id');$table->string('slug'); // `saveSlugsTo`$table과 동일한 필드 이름 ->string('이름');$table->timestamps();
        });
    }
}

경로에서 슬러그 사용

경로에서 생성된 슬러그를 사용하려면 Laravel의 암시적 경로 모델 바인딩을 사용해야 합니다.

 네임스페이스 앱; SpatieSluggableHasSlug 사용; SpatieSluggableSlugOptions 사용; IlluminateDatabaseEloquentModel 사용; 클래스 YourEloquentModel 확장 모델
{use HasSlug;/** * 슬러그 생성을 위한 옵션을 가져옵니다.     */공용 함수 getSlugOptions() : SlugOptions{return SlugOptions::create()
            ->SlugsFrom('이름') 생성
            ->saveSlugsTo('슬러그');
    }/** * 모델의 경로 키를 가져옵니다.     * * @return 문자열 */공용 함수 getRouteKeyName()
    {'슬러그'를 반환합니다;
    }
}

여러 필드를 사용하여 슬러그 만들기

슬러그의 기초로 여러 필드를 사용하고 싶으십니까? 괜찮아요!

 공개 함수 getSlugOptions() : SlugOptions{return SlugOptions::create()
        ->generateSlugsFrom(['first_name', 'last_name'])
        ->saveSlugsTo('슬러그');
}

슬러그 생성 사용자 정의

generateSlugsFrom 에 callable 을 전달할 수도 있습니다.

기본적으로 패키지는 이미 존재하는 슬러그에 '-'와 숫자를 추가하여 고유한 슬러그를 생성합니다.

allowDuplicateSlugs 호출하여 이 동작을 비활성화할 수 있습니다.

 공개 함수 getSlugOptions() : SlugOptions{return SlugOptions::create()
        ->SlugsFrom('이름') 생성
        ->saveSlugsTo('슬러그')
        ->allowDuplicateSlugs();
}

슬러그의 길이 제한

생성된 슬러그에 최대 크기 제한을 설정할 수도 있습니다.

 공개 함수 getSlugOptions() : SlugOptions{return SlugOptions::create()
        ->SlugsFrom('이름') 생성
        ->saveSlugsTo('슬러그')
        ->슬러그는더 이상 길지 않아야 합니다(50);
}

슬러그는 고유하게 만들기 위해 추가된 접미사로 인해 지정된 값보다 약간 길어질 수 있습니다.

usingSeparator 호출하여 사용자 정의 구분 기호를 사용할 수도 있습니다.

 공개 함수 getSlugOptions() : SlugOptions{return SlugOptions::create()
        ->SlugsFrom('이름') 생성
        ->saveSlugsTo('슬러그')
        ->Separator('_')를 사용;
}

슬러그 언어 설정

Str::slug 에서 사용되는 언어를 설정하려면 usingLanguage 호출하면 됩니다.

 공개 함수 getSlugOptions() : SlugOptions{return SlugOptions::create()
        ->SlugsFrom('이름') 생성
        ->saveSlugsTo('슬러그')
        ->usingLanguage('nl');
}

슬러그 재정의

생성된 슬러그가 아닌 다른 값으로 설정하여 생성된 슬러그를 재정의할 수도 있습니다.

 $model = EloquentModel::create(['name' => '내 이름']); //슬러그는 이제 "my-name"입니다;$model->slug = 'my-custom-url';$model->save(); //슬러그는 이제 "my-custom-url"입니다.

일부 조건에서 슬러그가 생성되는 것을 방지합니다.

모델에 상태가 있을 때 슬러그를 생성하지 않으려면 skipGenerateWhen 함수를 사용할 수 있습니다.

 공개 함수 getSlugOptions() : SlugOptions{return SlugOptions::create()
        ->SlugsFrom('이름') 생성
        ->saveSlugsTo('슬러그')
        ->skipGenerateWhen(fn () => $this->state === '초안');
}

생성 시 슬러그가 생성되지 않도록 방지

모델이 처음 생성될 때 슬러그를 생성하지 않으려면 doNotGenerateSlugsOnCreate() 함수를 사용하도록 설정할 수 있습니다.

 공개 함수 getSlugOptions() : SlugOptions{return SlugOptions::create()
        ->SlugsFrom('이름') 생성
        ->saveSlugsTo('슬러그')
        ->doNotGenerateSlugsOnCreate();
}

슬러그 업데이트 방지

마찬가지로, 모델 업데이트 시 슬러그가 업데이트되는 것을 방지하려면 doNotGenerateSlugsOnUpdate() 호출하세요.

 공개 함수 getSlugOptions() : SlugOptions{return SlugOptions::create()
        ->SlugsFrom('이름') 생성
        ->saveSlugsTo('슬러그')
        ->doNotGenerateSlugsOnUpdate();
}

이는 명시적으로 원할 때까지 변경되지 않는 영구 링크를 만드는 데 도움이 될 수 있습니다.

 $model = EloquentModel::create(['name' => '내 이름']); //슬러그는 이제 "my-name"입니다;$model->save();$model->name = 'changed name';$model->save(); //슬러그는 "my-name"으로 유지됩니다.

슬러그 재생

모델의 슬러그를 명시적으로 업데이트하려면 언제든지 모델에서 generateSlug() 호출하여 다른 옵션에 따라 슬러그를 만들 수 있습니다. 데이터베이스에 대한 업데이트를 유지하려면 모델을 save() 하는 것을 잊지 마세요.

덮어쓰기 방지

슬러그를 덮어쓰는 것을 방지할 수 있습니다.

 공개 함수 getSlugOptions() : SlugOptions{return SlugOptions::create()
        ->SlugsFrom('이름') 생성
        ->saveSlugsTo('슬러그')
        ->겹쳐쓰기 방지();
}

범위 사용

고려해야 할 전역 범위가 있는 경우 extraScope 사용하여 이를 정의할 수도 있습니다. 예를 들어 여러 웹사이트의 페이지를 포함하는 페이지 테이블이 있고 모든 웹사이트에 고유한 슬러그가 있는 경우입니다.

 공개 함수 getSlugOptions() : SlugOptions{return SlugOptions::create()
        ->SlugsFrom('이름') 생성
        ->saveSlugsTo('슬러그')
        ->extraScope(fn ($builder) => $builder->where('scope_id', $this->scope_id));
}

슬러그 접미사 시작 인덱스 설정

기본적으로 접미사 색인은 1부터 시작하며 시작 번호를 설정할 수 있습니다.

 공개 함수 getSlugOptions() : SlugOptions{return SlugOptions::create()
        ->SlugsFrom('이름') 생성
        ->saveSlugsTo('슬러그')
        ->startSlugSuffixFrom(2);
}

laravel-translateable과 통합

laravel-translatable과 함께 이 패키지를 사용하여 각 로케일에 대한 슬러그를 생성할 수 있습니다. HasSlug 특성을 사용하는 대신 HasTranslatableSlug 특성을 사용하고 슬러그 필드의 이름을 $translatable 배열에 추가해야 합니다. 단일 필드 또는 여러 필드에서 생성된 슬러그의 경우 다른 항목을 변경할 필요가 없습니다.

 네임스페이스 앱; SpatieSluggableHasTranslatableSlug 사용; SpatieSluggableSlugOptions 사용; SpatieTranslatableHasTranslations 사용; IlluminateDatabaseEloquentModel 사용; 클래스 YourEloquentModel 확장 모델
{use HasTranslations, HasTranslatableSlug;public $translatable = ['name', 'slug'];/** * 슬러그 생성을 위한 옵션을 가져옵니다.     */공용 함수 getSlugOptions() : SlugOptions{return SlugOptions::create()
            ->SlugsFrom('이름') 생성
            ->saveSlugsTo('슬러그');
    }
}

콜러블에서 생성된 슬러그의 경우 createWithLocales 메서드를 사용하여 SlugOptions 를 인스턴스화해야 합니다. 콜러블은 이제 하나가 아닌 두 개의 인수를 사용합니다. $model 과 $locale 모두 사용하여 슬러그를 생성할 수 있습니다.

 네임스페이스 앱; SpatieSluggableHasTranslatableSlug 사용; SpatieSluggableSlugOptions 사용; SpatieTranslatableHasTranslations 사용; IlluminateDatabaseEloquentModel 사용; 클래스 YourEloquentModel 확장 모델
{use HasTranslations, HasTranslatableSlug;public $translatable = ['name', 'slug'];/** * 슬러그 생성을 위한 옵션을 가져옵니다.     */공용 함수 getSlugOptions() : SlugOptions{return SlugOptions::createWithLocales(['en', 'nl'])
            ->generateSlugsFrom(function($model, $locale) {return "{$locale} {$model->id}";
            })
            ->saveSlugsTo('슬러그');
    }
}

암시적 경로 모델 바인딩

또한 컨트롤러 내에서 Laravels 암시적 경로 모델 바인딩을 사용하여 모델을 자동으로 확인할 수도 있습니다. 이 기능을 사용하려면 슬러그 열이 routeNameKey 와 일치하는지 확인하세요.
현재 일부 데이터베이스 유형만 JSON 작업을 지원합니다. JSON을 지원하는 데이터베이스에 대한 자세한 내용은 Laravel 문서에서 확인할 수 있습니다.

 네임스페이스 앱; SpatieSluggableHasSlug 사용; SpatieSluggableSlugOptions 사용; IlluminateDatabaseEloquentModel 사용; 클래스 YourEloquentModel 확장 모델
{use HasTranslations, HasTranslatableSlug;public $translatable = ['name', 'slug'];/** * 슬러그 생성을 위한 옵션을 가져옵니다.     */공용 함수 getSlugOptions() : SlugOptions{return SlugOptions::create()
            ->SlugsFrom('이름') 생성
            ->saveSlugsTo('슬러그');
    }/** * 모델의 경로 키를 가져옵니다.     * * @return 문자열 */공용 함수 getRouteKeyName()
    {'슬러그'를 반환합니다;
    }
}

슬러그로 모델 찾기

편의상 findBySlug 별칭을 사용하여 모델을 검색할 수 있습니다. 쿼리는 SlugOptions 를 정의할 때 saveSlugsTo 에 전달된 필드와 비교됩니다.

 $model = Article::findBySlug('내 기사');

findBySlug 또한 기본 Eloquent find 메소드와 마찬가지로 두 번째 매개변수 $columns 허용합니다.

변경 내역

최근 변경된 사항에 대한 자세한 내용은 CHANGELOG를 참조하세요.

테스트

 작곡가 테스트

기여

자세한 내용은 CONTRIBUTING을 참조하세요.

보안

보안 관련 버그를 발견한 경우 이슈 트래커를 사용하는 대신 [email protected]로 메일을 보내주세요.

크레딧

• 프리크 반 데르 헤르텐

• 모든 기여자

특허

MIT 라이센스(MIT). 자세한 내용은 라이센스 파일을 참조하십시오.