summaryrefslogtreecommitdiffhomepage
path: root/modules/luci-base/luasrc/dispatcher.luadoc
blob: ddf534b3e1e8f140b7a0f37f1eadbb29d93a586f (plain)
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
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
---[[
LuCI web dispatcher.
]]
module "luci.dispatcher"

---[[
Build the URL relative to the server webroot from given virtual path.

@class function
@name build_url
@param ...	Virtual path
@return 		Relative URL
]]

---[[
Check whether a dispatch node shall be visible

@class function
@name node_visible
@param node	Dispatch node
@return		Boolean indicating whether the node should be visible
]]

---[[
Return a sorted table of visible childs within a given node

@class function
@name node_childs
@param node	Dispatch node
@return		Ordered table of child node names
]]

---[[
Send a 404 error code and render the "error404" template if available.

@class function
@name error404
@param message	Custom error message (optional)
@return			false
]]

---[[
Send a 500 error code and render the "error500" template if available.

@class function
@name error500
@param message	Custom error message (optional)#
@return			false
]]

---[[
Dispatch an HTTP request.

@class function
@name httpdispatch
@param request	LuCI HTTP Request object
]]

---[[
Dispatches a LuCI virtual path.

@class function
@name dispatch
@param request	Virtual path
]]

---[[
Generate the dispatching index using the native file-cache based strategy.


@class function
@name createindex
]]

---[[
Create the dispatching tree from the index.

Build the index before if it does not exist yet.

@class function
@name createtree
]]

---[[
Register a tree modifier.

@class function
@name modifier
@param	func	Modifier function
@param	order	Modifier order value (optional)
]]

---[[
Clone a node of the dispatching tree to another position.

@class function
@name assign
@param	path	Virtual path destination
@param	clone	Virtual path source
@param	title	Destination node title (optional)
@param	order	Destination node order value (optional)
@return			Dispatching tree node
]]

---[[
Create a new dispatching node and define common parameters.

@class function
@name entry
@param	path	Virtual path
@param	target	Target function to call when dispatched.
@param	title	Destination node title
@param	order	Destination node order value (optional)
@return			Dispatching tree node
]]

---[[
Fetch or create a dispatching node without setting the target module or
enabling the node.

@class function
@name get
@param	...		Virtual path
@return			Dispatching tree node
]]

---[[
Fetch or create a new dispatching node.

@class function
@name node
@param	...		Virtual path
@return			Dispatching tree node
]]

---[[
Lookup node in dispatching tree.

@class function
@name lookup
@param  ...		Virtual path
@return Node object, canonical url or nil if the path was not found.
]]

---[[
Alias the first (lowest order) page automatically


@class function
@name firstchild
]]

---[[
Create a redirect to another dispatching node.

@class function
@name alias
@param	...		Virtual path destination
]]

---[[
Rewrite the first x path values of the request.

@class function
@name rewrite
@param	n		Number of path values to replace
@param	...		Virtual path to replace removed path values with
]]

---[[
Create a function-call dispatching target.

@class function
@name call
@param	name	Target function of local controller
@param	...		Additional parameters passed to the function
]]

---[[
Create a template render dispatching target.

@class function
@name template
@param	name	Template to be rendered
]]

---[[
Create a CBI model dispatching target.

@class function
@name cbi
@param	model	CBI model to be rendered
]]

---[[
Create a combined dispatching target for non argv and argv requests.

@class function
@name arcombine
@param trg1	Overview Target
@param trg2	Detail Target
]]

---[[
Create a CBI form model dispatching target.

@class function
@name form
@param	model	CBI form model tpo be rendered
]]

---[[
Access the luci.i18n translate() api.

@class  function
@name   translate
@param  text    Text to translate
]]

---[[
No-op function used to mark translation entries for menu labels.

This function does not actually translate the given argument but
is used by build/i18n-scan.pl to find translatable entries.

@class function
@name _
]]