Skip to content

Commit 4ee819f

Browse files
authored
Update Slugged.md
1 parent 0da38f2 commit 4ee819f

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

docs/Behavior/Slugged.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -39,11 +39,11 @@ A CakePHP behavior to automatically create and store slugs.
3939
<td> `'url'` </td>
4040
<td>
4141
<ul>
42-
<li> <b>ascii: </b> retuns an ascii slug generated using the core Inflector::slug() function </li>
42+
<li> <b>ascii: </b> returns an ASCII slug generated using the core Inflector::slug() function </li>
4343
<li> <b>display: </b> a dummy mode which returns a slug legal for display - removes illegal (not unprintable) characters </li>
4444
<li> <b>url: </b> returns a slug appropriate to put in a URL </li>
45-
<li> <b>class: </b> a dummy mode which returns a slug appropriate to put in a html class (there are no restrictions) </li>
46-
<li> <b>id: </b> returns a slug appropriate to use in a html id </li>
45+
<li> <b>class: </b> a dummy mode which returns a slug appropriate to put in a HTML class (there are no restrictions) </li>
46+
<li> <b>id: </b> returns a slug appropriate to use in a HTML id </li>
4747
<li> <b>{callable}: </b> Use your custom callable to pass in your slugger method </li>
4848
</ul>
4949
</td>
@@ -64,8 +64,11 @@ A CakePHP behavior to automatically create and store slugs.
6464
<td>
6565
has the following values
6666
<ul>
67-
<li> <b>false: </b> once the slug has been saved, do not change it (use if you are doing lookups based on slugs) </li>
68-
<li> <b>true: </b> if the label field values change, regenerate the slug (use if you are the slug is just window-dressing) </li>
67+
<li> <b>false: </b> Once the slug has been saved, do not change it (use if you are doing lookups based on slugs) </li>
68+
<li>
69+
<b>true: </b> If the label field values change, regenerate the slug (use if the slug is just window-dressing).
70+
Note: For multi-field labels, all fields are required to be present once one label field has been touched (dirty set to true).
71+
</li>
6972
</ul>
7073
</td>
7174
</tr>
@@ -75,7 +78,7 @@ A CakePHP behavior to automatically create and store slugs.
7578
<td>
7679
has the following values
7780
<ul>
78-
<li> <b>false: </b> will not enforce a unique slug, whatever the label is is direclty slugged without checking for duplicates </li>
81+
<li> <b>false: </b> will not enforce a unique slug, whatever the label is is directly slugged without checking for duplicates </li>
7982
<li> <b>true: </b> use if you are doing lookups based on slugs (see overwrite) </li>
8083
</ul>
8184
</td>

0 commit comments

Comments
 (0)