This repository was archived by the owner on Sep 16, 2021. It is now read-only.
File tree Expand file tree Collapse file tree 3 files changed +12
-25
lines changed Expand file tree Collapse file tree 3 files changed +12
-25
lines changed Original file line number Diff line number Diff line change @@ -5,7 +5,7 @@ Path Exists Actions
5
5
-------------------
6
6
7
7
These are the default actions available to take if the path provided by a
8
- `path_provider ` already exists and so creating a new path would create a
8
+ `` path_provider ` ` already exists and so creating a new path would create a
9
9
conflict.
10
10
11
11
auto_increment
@@ -18,9 +18,7 @@ it finds a path which *doesn't* exist.
18
18
19
19
This action should typically be used in the ``content_name `` builder unit to
20
20
resolve conflicts. Using it in the ``content_path `` builder chain would not
21
- make much sense (I can't imagine any use cases at the moment).
22
-
23
- Example:
21
+ make much sense.
24
22
25
23
.. configuration-block ::
26
24
43
41
~~~
44
42
45
43
The ``use `` action will simply take the existing path and use it. For example,
46
- in our post example the first builder unit must first determine the blogs
47
- path, ``/my/blog ``, if this path exists (and it should) then we will *use * it
48
- in the stack.
44
+ in a forum the builder unit must first determine the category path, ``/my-category ``,
45
+ if this path exists (and it should) then it will be *used * in the stack.
49
46
50
47
This action should typically be used in one of the content path builder units
51
- to specify that we should use the existing route, on the other hand, using
48
+ to specify that it should use the existing route. On the other hand, using
52
49
this as the content name builder action should cause the old route to be
53
50
overwritten.
54
51
55
- Example:
56
-
57
52
.. configuration-block ::
58
53
59
54
.. code-block :: yaml
Original file line number Diff line number Diff line change @@ -10,9 +10,7 @@ These are the default actions available to take if the path provided by a
10
10
create
11
11
~~~~~~
12
12
13
- The ``create `` action will create the path. **currently ** all routes provided
14
- by the content path build units will be created as ``Generic `` documents,
15
- whilst the content name route will be created as an ``AutoRoute `` document.
13
+ The ``create `` action will create the path.
16
14
17
15
.. configuration-block ::
18
16
@@ -31,6 +29,12 @@ whilst the content name route will be created as an ``AutoRoute`` document.
31
29
'not_exists_action' => 'create',
32
30
);
33
31
32
+ .. note ::
33
+
34
+ **Currently ** all routes provided by the content path build units will be
35
+ created as ``Generic `` documents, whilst the content name route will be
36
+ created as an ``AutoRoute `` document.
37
+
34
38
throw_exception
35
39
~~~~~~~~~~~~~~~
36
40
Original file line number Diff line number Diff line change @@ -22,9 +22,6 @@ Options
22
22
23
23
* ``path `` - **required ** The path to provide.
24
24
25
- Example
26
- .......
27
-
28
25
.. configuration-block ::
29
26
30
27
.. code-block :: yaml
@@ -67,9 +64,6 @@ Options
67
64
68
65
- ``method ``: **required ** Method used to return the document whose route path you wish to use.
69
66
70
- Example
71
- .......
72
-
73
67
.. configuration-block ::
74
68
75
69
.. code-block :: yaml
@@ -109,9 +103,6 @@ Options
109
103
* ``method ``: **required ** Method used to return the route name/path/path elements.
110
104
* ``slugify ``: If the return value should be slugified, default is ``true ``.
111
105
112
- Example
113
- .......
114
-
115
106
.. configuration-block ::
116
107
117
108
.. code-block :: yaml
@@ -167,9 +158,6 @@ content_datetime
167
158
The ``content_datettime `` provider will provide a path from a ``DateTime ``
168
159
object provided by a designated method on the content document.
169
160
170
- Example
171
- .......
172
-
173
161
.. configuration-block ::
174
162
175
163
.. code-block :: yaml
You can’t perform that action at this time.
0 commit comments