-<?php namespace BookStack\Entities\Tools;
+<?php
-use BookStack\Entities\Models\Entity;
+namespace BookStack\Entities\Tools;
+
+use BookStack\App\Model;
+use BookStack\App\Sluggable;
+use BookStack\Entities\Models\BookChild;
use Illuminate\Support\Str;
class SlugGenerator
{
-
/**
* Generate a fresh slug for the given entity.
- * The slug will generated so it does not conflict within the same parent item.
+ * The slug will be generated so that it doesn't conflict within the same parent item.
*/
- public function generate(Entity $entity): string
+ public function generate(Sluggable $model): string
{
- $slug = $this->formatNameAsSlug($entity->name);
- while ($this->slugInUse($slug, $entity)) {
- $slug .= '-' . substr(md5(rand(1, 500)), 0, 3);
+ $slug = $this->formatNameAsSlug($model->name);
+ while ($this->slugInUse($slug, $model)) {
+ $slug .= '-' . Str::random(3);
}
+
return $slug;
}
protected function formatNameAsSlug(string $name): string
{
$slug = Str::slug($name);
- if ($slug === "") {
+ if ($slug === '') {
$slug = substr(md5(rand(1, 500)), 0, 5);
}
+
return $slug;
}
/**
* Check if a slug is already in-use for this
* type of model within the same parent.
+ *
+ * @param Sluggable&Model $model
*/
- protected function slugInUse(string $slug, Entity $entity): bool
+ protected function slugInUse(string $slug, Sluggable $model): bool
{
- $query = $entity->newQuery()->where('slug', '=', $slug);
+ $query = $model->newQuery()->where('slug', '=', $slug);
- if ($entity instanceof BookChild) {
- $query->where('book_id', '=', $entity->book_id);
+ if ($model instanceof BookChild) {
+ $query->where('book_id', '=', $model->book_id);
}
- if ($entity->id) {
- $query->where('id', '!=', $entity->id);
+ if ($model->id) {
+ $query->where('id', '!=', $model->id);
}
return $query->count() > 0;