-
-
Notifications
You must be signed in to change notification settings - Fork 188
Expand file tree
/
Copy pathHasSlug.php
More file actions
173 lines (138 loc) · 4.16 KB
/
HasSlug.php
File metadata and controls
173 lines (138 loc) · 4.16 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
<?php
namespace Spatie\Sluggable;
use Illuminate\Database\Eloquent\Model;
trait HasSlug
{
/** @var \Spatie\Sluggable\SlugOptions */
protected $slugOptions;
/**
* Get the options for generating the slug.
*/
abstract public function getSlugOptions(): SlugOptions;
/**
* Boot the trait.
*/
protected static function bootHasSlug()
{
static::creating(function (Model $model) {
$model->generateSlugOnCreate();
});
static::updating(function (Model $model) {
$model->generateSlugOnUpdate();
});
}
/**
* Handle adding slug on model creation.
*/
protected function generateSlugOnCreate()
{
$this->slugOptions = $this->getSlugOptions();
if (! $this->slugOptions->generateSlugsOnCreate) {
return;
}
$this->addSlug();
}
/**
* Handle adding slug on model update.
*/
protected function generateSlugOnUpdate()
{
$this->slugOptions = $this->getSlugOptions();
if (! $this->slugOptions->generateSlugsOnUpdate) {
return;
}
$this->addSlug();
}
/**
* Handle setting slug on explicit request.
*/
public function generateSlug()
{
$this->slugOptions = $this->getSlugOptions();
$this->addSlug();
}
/**
* Add the slug to the model.
*/
protected function addSlug()
{
$this->guardAgainstInvalidSlugOptions();
$slug = $this->generateNonUniqueSlug();
if ($this->slugOptions->generateUniqueSlugs) {
$slug = $this->makeSlugUnique($slug);
}
$slugField = $this->slugOptions->slugField;
$this->$slugField = $slug;
}
/**
* Generate a non unique slug for this record.
*/
protected function generateNonUniqueSlug(): string
{
if ($this->hasCustomSlugBeenUsed()) {
$slugField = $this->slugOptions->slugField;
return $this->$slugField;
}
return str_slug($this->getSlugSourceString());
}
/**
* Determine if a custom slug has been saved.
*/
protected function hasCustomSlugBeenUsed(): bool
{
$slugField = $this->slugOptions->slugField;
return $this->getOriginal($slugField) != $this->$slugField;
}
/**
* Get the string that should be used as base for the slug.
*/
protected function getSlugSourceString(): string
{
if (is_callable($this->slugOptions->generateSlugFrom)) {
$slugSourceString = call_user_func($this->slugOptions->generateSlugFrom, $this);
return substr($slugSourceString, 0, $this->slugOptions->maximumLength);
}
$slugSourceString = collect($this->slugOptions->generateSlugFrom)
->map(function (string $fieldName) : string {
return $this->$fieldName ?? '';
})
->implode('-');
return substr($slugSourceString, 0, $this->slugOptions->maximumLength);
}
/**
* Make the given slug unique.
*/
protected function makeSlugUnique(string $slug): string
{
$originalSlug = $slug;
$i = 1;
while ($this->otherRecordExistsWithSlug($slug) || $slug === '') {
$slug = $originalSlug.'-'.$i++;
}
return $slug;
}
/**
* Determine if a record exists with the given slug.
*/
protected function otherRecordExistsWithSlug(string $slug): bool
{
return (bool) static::where($this->slugOptions->slugField, $slug)
->where($this->getKeyName(), '!=', $this->getKey() ?? '0')
->first();
}
/**
* This function will throw an exception when any of the options is missing or invalid.
*/
protected function guardAgainstInvalidSlugOptions()
{
if (! count($this->slugOptions->generateSlugFrom)) {
throw InvalidOption::missingFromField();
}
if (! strlen($this->slugOptions->slugField)) {
throw InvalidOption::missingSlugField();
}
if ($this->slugOptions->maximumLength <= 0) {
throw InvalidOption::invalidMaximumLength();
}
}
}