documentation: regenerate documents from current code base

Signed-off-by: Jo-Philipp Wich <jo@mein.io>
This commit is contained in:
Jo-Philipp Wich 2018-04-30 14:45:25 +02:00
parent 00d242918f
commit 27dd9d75f9
34 changed files with 828 additions and 326 deletions

View File

@ -43,19 +43,15 @@
</li>
<li>
<a href="modules/luci.http.protocol.html">luci.http.protocol</a>
<a href="modules/luci.http.conditionals.html">luci.http.conditionals</a>
</li>
<li>
<a href="modules/luci.http.protocol.conditionals.html">luci.http.protocol.conditionals</a>
<a href="modules/luci.http.date.html">luci.http.date</a>
</li>
<li>
<a href="modules/luci.http.protocol.date.html">luci.http.protocol.date</a>
</li>
<li>
<a href="modules/luci.http.protocol.mime.html">luci.http.protocol.mime</a>
<a href="modules/luci.http.mime.html">luci.http.mime</a>
</li>
<li>
@ -214,22 +210,17 @@
</tr>
<tr>
<td class="name"><a href="modules/luci.http.protocol.html">luci.http.protocol</a></td>
<td class="name"><a href="modules/luci.http.conditionals.html">luci.http.conditionals</a></td>
<td class="summary"></td>
</tr>
<tr>
<td class="name"><a href="modules/luci.http.protocol.conditionals.html">luci.http.protocol.conditionals</a></td>
<td class="name"><a href="modules/luci.http.date.html">luci.http.date</a></td>
<td class="summary"></td>
</tr>
<tr>
<td class="name"><a href="modules/luci.http.protocol.date.html">luci.http.protocol.date</a></td>
<td class="summary"></td>
</tr>
<tr>
<td class="name"><a href="modules/luci.http.protocol.mime.html">luci.http.protocol.mime</a></td>
<td class="name"><a href="modules/luci.http.mime.html">luci.http.mime</a></td>
<td class="summary"></td>
</tr>

View File

@ -41,19 +41,15 @@
</li>
<li>
<a href="../modules/luci.http.protocol.html">luci.http.protocol</a>
<a href="../modules/luci.http.conditionals.html">luci.http.conditionals</a>
</li>
<li>
<a href="../modules/luci.http.protocol.conditionals.html">luci.http.protocol.conditionals</a>
<a href="../modules/luci.http.date.html">luci.http.date</a>
</li>
<li>
<a href="../modules/luci.http.protocol.date.html">luci.http.protocol.date</a>
</li>
<li>
<a href="../modules/luci.http.protocol.mime.html">luci.http.protocol.mime</a>
<a href="../modules/luci.http.mime.html">luci.http.mime</a>
</li>
<li>
@ -321,7 +317,6 @@ Create a CBI form model dispatching target.</td>
<td class="summary">
Fetch or create a dispatching node without setting the target module or
enabling the node.</td>
</tr>
@ -332,6 +327,13 @@ enabling the node.</td>
Dispatch an HTTP request.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#lookup">lookup</a>&nbsp;(...)</td>
<td class="summary">
Lookup node in dispatching tree.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#modifier">modifier</a>&nbsp;(func, order)</td>
<td class="summary">
@ -857,8 +859,8 @@ Create a CBI form model dispatching target.
Fetch or create a dispatching node without setting the target module or
enabling the node.
enabling the node.
<h3>Parameters</h3>
@ -909,6 +911,38 @@ Dispatch an HTTP request.
</dd>
<dt><a name="lookup"></a><strong>lookup</strong>&nbsp;(...)</dt>
<dd>
Lookup node in dispatching tree.
<h3>Parameters</h3>
<ul>
<li>
...: Virtual path
</li>
</ul>
<h3>Return value:</h3>
Node object, canonical url or nil if the path was not found.
</dd>

View File

@ -41,19 +41,15 @@
<li><strong>luci.http</strong></li>
<li>
<a href="../modules/luci.http.protocol.html">luci.http.protocol</a>
<a href="../modules/luci.http.conditionals.html">luci.http.conditionals</a>
</li>
<li>
<a href="../modules/luci.http.protocol.conditionals.html">luci.http.protocol.conditionals</a>
<a href="../modules/luci.http.date.html">luci.http.date</a>
</li>
<li>
<a href="../modules/luci.http.protocol.date.html">luci.http.protocol.date</a>
</li>
<li>
<a href="../modules/luci.http.protocol.mime.html">luci.http.protocol.mime</a>
<a href="../modules/luci.http.mime.html">luci.http.mime</a>
</li>
<li>
@ -256,7 +252,6 @@ Get the value of a certain HTTP-Cookie.</td>
<td class="summary">
Get the value of a certain HTTP environment variable
or the environment table itself.</td>
</tr>
@ -267,6 +262,20 @@ or the environment table itself.</td>
Send a HTTP-Header.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#mimedecode_message_body">mimedecode_message_body</a>&nbsp;(src, msg, filecb)</td>
<td class="summary">
Decode a mime encoded http message body with multipart/form-data Content-Type.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#parse_message_body">parse_message_body</a>&nbsp;(src, msg, filecb)</td>
<td class="summary">
Try to extract and decode a http message body from the given ltn12 source.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#prepare_content">prepare_content</a>&nbsp;(mime)</td>
<td class="summary">
@ -310,6 +319,44 @@ Splice data from a filedescriptor to the client.</td>
Set the HTTP status code and status message.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#urldecode">urldecode</a>&nbsp;(str, no_plus)</td>
<td class="summary">
Return the URL-decoded equivalent of a string.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#urldecode_message_body">urldecode_message_body</a>&nbsp;(src, msg)</td>
<td class="summary">
Decode an urlencoded http message body with application/x-www-urlencoded
Content-Type.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#urldecode_params">urldecode_params</a>&nbsp;(url, tbl)</td>
<td class="summary">
Extract and split urlencoded data pairs, separated bei either "&" or ";"
from given url or string.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#urlencode">urlencode</a>&nbsp;(str)</td>
<td class="summary">
Return the URL-encoded equivalent of a string.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#urlencode_params">urlencode_params</a>&nbsp;(tbl)</td>
<td class="summary">
Encode each key-value-pair in given table to x-www-urlencoded format,
separated by "&".</td>
</tr>
<tr>
<td class="name" nowrap><a href="#write">write</a>&nbsp;(content, src_err)</td>
<td class="summary">
@ -377,7 +424,6 @@ Encoded HTTP query string
Close the HTTP-Connection.
@ -527,8 +573,8 @@ String containing cookie data
Get the value of a certain HTTP environment variable
or the environment table itself.
or the environment table itself.
<h3>Parameters</h3>
@ -583,6 +629,135 @@ Send a HTTP-Header.
</dd>
<dt><a name="mimedecode_message_body"></a><strong>mimedecode_message_body</strong>&nbsp;(src, msg, filecb)</dt>
<dd>
Decode a mime encoded http message body with multipart/form-data Content-Type.
Stores all extracted data associated with its parameter name
in the params table within the given message object. Multiple parameter
values are stored as tables, ordinary ones as strings.
If an optional file callback function is given then it is feeded with the
file contents chunk by chunk and only the extracted file name is stored
within the params table. The callback function will be called subsequently
with three arguments:
o Table containing decoded (name, file) and raw (headers) mime header data
o String value containing a chunk of the file data
o Boolean which indicates wheather the current chunk is the last one (eof)
<h3>Parameters</h3>
<ul>
<li>
src: Ltn12 source function
</li>
<li>
msg: HTTP message object
</li>
<li>
filecb: File callback function (optional)
</li>
</ul>
<h3>Return values:</h3>
<ol>
<li>Value indicating successful operation (not nil means "ok")
<li>String containing the error if unsuccessful
</ol>
<h3>See also:</h3>
<ul>
<li><a href="">
parse_message_header
</a>
</ul>
</dd>
<dt><a name="parse_message_body"></a><strong>parse_message_body</strong>&nbsp;(src, msg, filecb)</dt>
<dd>
Try to extract and decode a http message body from the given ltn12 source.
This function will examine the Content-Type within the given message object
to select the appropriate content decoder.
Currently the application/x-www-urlencoded and application/form-data
mime types are supported. If the encountered content encoding can't be
handled then the whole message body will be stored unaltered as "content"
property within the given message object.
<h3>Parameters</h3>
<ul>
<li>
src: Ltn12 source function
</li>
<li>
msg: HTTP message object
</li>
<li>
filecb: File data callback (optional, see mimedecode_message_body())
</li>
</ul>
<h3>Return values:</h3>
<ol>
<li>Value indicating successful operation (not nil means "ok")
<li>String containing the error if unsuccessful
</ol>
<h3>See also:</h3>
<ul>
<li><a href="">
parse_message_header
</a>
</ul>
</dd>
@ -759,6 +934,243 @@ Set the HTTP status code and status message.
</dd>
<dt><a name="urldecode"></a><strong>urldecode</strong>&nbsp;(str, no_plus)</dt>
<dd>
Return the URL-decoded equivalent of a string.
<h3>Parameters</h3>
<ul>
<li>
str: URL-encoded string
</li>
<li>
no_plus: Don't decode + to " "
</li>
</ul>
<h3>Return value:</h3>
URL-decoded string
<h3>See also:</h3>
<ul>
<li><a href="#urlencode">
urlencode
</a>
</ul>
</dd>
<dt><a name="urldecode_message_body"></a><strong>urldecode_message_body</strong>&nbsp;(src, msg)</dt>
<dd>
Decode an urlencoded http message body with application/x-www-urlencoded
Content-Type.
Stores all extracted data associated with its parameter name in the params
table within the given message object. Multiple parameter values are stored
as tables, ordinary ones as strings.
<h3>Parameters</h3>
<ul>
<li>
src: Ltn12 source function
</li>
<li>
msg: HTTP message object
</li>
</ul>
<h3>Return values:</h3>
<ol>
<li>Value indicating successful operation (not nil means "ok")
<li>String containing the error if unsuccessful
</ol>
<h3>See also:</h3>
<ul>
<li><a href="">
parse_message_header
</a>
</ul>
</dd>
<dt><a name="urldecode_params"></a><strong>urldecode_params</strong>&nbsp;(url, tbl)</dt>
<dd>
Extract and split urlencoded data pairs, separated bei either "&" or ";"
from given url or string. Returns a table with urldecoded values.
Simple parameters are stored as string values associated with the parameter
name within the table. Parameters with multiple values are stored as array
containing the corresponding values.
<h3>Parameters</h3>
<ul>
<li>
url: The url or string which contains x-www-urlencoded form data
</li>
<li>
tbl: Use the given table for storing values (optional)
</li>
</ul>
<h3>Return value:</h3>
Table containing the urldecoded parameters
<h3>See also:</h3>
<ul>
<li><a href="#urlencode_params">
urlencode_params
</a>
</ul>
</dd>
<dt><a name="urlencode"></a><strong>urlencode</strong>&nbsp;(str)</dt>
<dd>
Return the URL-encoded equivalent of a string.
<h3>Parameters</h3>
<ul>
<li>
str: Source string
</li>
</ul>
<h3>Return value:</h3>
URL-encoded string
<h3>See also:</h3>
<ul>
<li><a href="#urldecode">
urldecode
</a>
</ul>
</dd>
<dt><a name="urlencode_params"></a><strong>urlencode_params</strong>&nbsp;(tbl)</dt>
<dd>
Encode each key-value-pair in given table to x-www-urlencoded format,
separated by "&".
Tables are encoded as parameters with multiple values by repeating the
parameter name with each value.
<h3>Parameters</h3>
<ul>
<li>
tbl: Table with the values
</li>
</ul>
<h3>Return value:</h3>
String containing encoded values
<h3>See also:</h3>
<ul>
<li><a href="#urldecode_params">
urldecode_params
</a>
</ul>
</dd>
@ -771,7 +1183,8 @@ Set the HTTP status code and status message.
Send a chunk of content data to the client.
This function is as a valid LTN12 sink.
If the content chunk is nil this function will automatically invoke close.
If the content chunk is nil this function will automatically invoke close.
<h3>Parameters</h3>

View File

@ -43,19 +43,15 @@
</li>
<li>
<a href="../modules/luci.http.protocol.html">luci.http.protocol</a>
<a href="../modules/luci.http.conditionals.html">luci.http.conditionals</a>
</li>
<li>
<a href="../modules/luci.http.protocol.conditionals.html">luci.http.protocol.conditionals</a>
<a href="../modules/luci.http.date.html">luci.http.date</a>
</li>
<li>
<a href="../modules/luci.http.protocol.date.html">luci.http.protocol.date</a>
</li>
<li>
<a href="../modules/luci.http.protocol.mime.html">luci.http.protocol.mime</a>
<a href="../modules/luci.http.mime.html">luci.http.mime</a>
</li>
<li><strong>luci.i18n</strong></li>

View File

@ -43,19 +43,15 @@
</li>
<li>
<a href="../modules/luci.http.protocol.html">luci.http.protocol</a>
<a href="../modules/luci.http.conditionals.html">luci.http.conditionals</a>
</li>
<li>
<a href="../modules/luci.http.protocol.conditionals.html">luci.http.protocol.conditionals</a>
<a href="../modules/luci.http.date.html">luci.http.date</a>
</li>
<li>
<a href="../modules/luci.http.protocol.date.html">luci.http.protocol.date</a>
</li>
<li>
<a href="../modules/luci.http.protocol.mime.html">luci.http.protocol.mime</a>
<a href="../modules/luci.http.mime.html">luci.http.mime</a>
</li>
<li>

View File

@ -43,19 +43,15 @@
</li>
<li>
<a href="../modules/luci.http.protocol.html">luci.http.protocol</a>
<a href="../modules/luci.http.conditionals.html">luci.http.conditionals</a>
</li>
<li>
<a href="../modules/luci.http.protocol.conditionals.html">luci.http.protocol.conditionals</a>
<a href="../modules/luci.http.date.html">luci.http.date</a>
</li>
<li>
<a href="../modules/luci.http.protocol.date.html">luci.http.protocol.date</a>
</li>
<li>
<a href="../modules/luci.http.protocol.mime.html">luci.http.protocol.mime</a>
<a href="../modules/luci.http.mime.html">luci.http.mime</a>
</li>
<li>

View File

@ -43,19 +43,15 @@
</li>
<li>
<a href="../modules/luci.http.protocol.html">luci.http.protocol</a>
<a href="../modules/luci.http.conditionals.html">luci.http.conditionals</a>
</li>
<li>
<a href="../modules/luci.http.protocol.conditionals.html">luci.http.protocol.conditionals</a>
<a href="../modules/luci.http.date.html">luci.http.date</a>
</li>
<li>
<a href="../modules/luci.http.protocol.date.html">luci.http.protocol.date</a>
</li>
<li>
<a href="../modules/luci.http.protocol.mime.html">luci.http.protocol.mime</a>
<a href="../modules/luci.http.mime.html">luci.http.mime</a>
</li>
<li>

View File

@ -43,19 +43,15 @@
</li>
<li>
<a href="../modules/luci.http.protocol.html">luci.http.protocol</a>
<a href="../modules/luci.http.conditionals.html">luci.http.conditionals</a>
</li>
<li>
<a href="../modules/luci.http.protocol.conditionals.html">luci.http.protocol.conditionals</a>
<a href="../modules/luci.http.date.html">luci.http.date</a>
</li>
<li>
<a href="../modules/luci.http.protocol.date.html">luci.http.protocol.date</a>
</li>
<li>
<a href="../modules/luci.http.protocol.mime.html">luci.http.protocol.mime</a>
<a href="../modules/luci.http.mime.html">luci.http.mime</a>
</li>
<li>

View File

@ -43,19 +43,15 @@
</li>
<li>
<a href="../modules/luci.http.protocol.html">luci.http.protocol</a>
<a href="../modules/luci.http.conditionals.html">luci.http.conditionals</a>
</li>
<li>
<a href="../modules/luci.http.protocol.conditionals.html">luci.http.protocol.conditionals</a>
<a href="../modules/luci.http.date.html">luci.http.date</a>
</li>
<li>
<a href="../modules/luci.http.protocol.date.html">luci.http.protocol.date</a>
</li>
<li>
<a href="../modules/luci.http.protocol.mime.html">luci.http.protocol.mime</a>
<a href="../modules/luci.http.mime.html">luci.http.mime</a>
</li>
<li>

View File

@ -43,19 +43,15 @@
</li>
<li>
<a href="../modules/luci.http.protocol.html">luci.http.protocol</a>
<a href="../modules/luci.http.conditionals.html">luci.http.conditionals</a>
</li>
<li>
<a href="../modules/luci.http.protocol.conditionals.html">luci.http.protocol.conditionals</a>
<a href="../modules/luci.http.date.html">luci.http.date</a>
</li>
<li>
<a href="../modules/luci.http.protocol.date.html">luci.http.protocol.date</a>
</li>
<li>
<a href="../modules/luci.http.protocol.mime.html">luci.http.protocol.mime</a>
<a href="../modules/luci.http.mime.html">luci.http.mime</a>
</li>
<li>

View File

@ -43,19 +43,15 @@
</li>
<li>
<a href="../modules/luci.http.protocol.html">luci.http.protocol</a>
<a href="../modules/luci.http.conditionals.html">luci.http.conditionals</a>
</li>
<li>
<a href="../modules/luci.http.protocol.conditionals.html">luci.http.protocol.conditionals</a>
<a href="../modules/luci.http.date.html">luci.http.date</a>
</li>
<li>
<a href="../modules/luci.http.protocol.date.html">luci.http.protocol.date</a>
</li>
<li>
<a href="../modules/luci.http.protocol.mime.html">luci.http.protocol.mime</a>
<a href="../modules/luci.http.mime.html">luci.http.mime</a>
</li>
<li>
@ -309,6 +305,13 @@ Get an option or list and return values as table.</td>
Get the directory for uncomitted changes.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Cursor.get_session_id">Cursor:get_session_id</a>&nbsp;()</td>
<td class="summary">
Get the effective session ID.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Cursor.load">Cursor:load</a>&nbsp;(config)</td>
<td class="summary">
@ -365,6 +368,13 @@ Set given values as list.</td>
Set the directory for uncommited changes.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Cursor.set_session_id">Cursor:set_session_id</a>&nbsp;(id)</td>
<td class="summary">
Set the effective session ID.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Cursor.substate">Cursor:substate</a>&nbsp;()</td>
<td class="summary">
@ -631,8 +641,8 @@ Delete all sections of a given type that match certain criteria.
</li>
<li>
comparator: Function that will be called for each section and
returns a boolean whether to delete the current section (optional)
comparator: Function that will be called for each section and returns
a boolean whether to delete the current section (optional)
</li>
</ul>
@ -903,8 +913,8 @@ Get an option or list and return values as table.
<h3>Return value:</h3>
table. If the option was not found, you will simply get
an empty table.
table. If the option was not found, you will simply get an empty
table.
@ -936,6 +946,29 @@ Save directory
<dt><a name="Cursor.get_session_id"></a><strong>Cursor:get_session_id</strong>&nbsp;()</dt>
<dd>
Get the effective session ID.
<h3>Return value:</h3>
String containing the session ID
</dd>
<dt><a name="Cursor.load"></a><strong>Cursor:load</strong>&nbsp;(config)</dt>
<dd>
@ -1222,7 +1255,8 @@ has the same effect as deleting the option.
</li>
<li>
value: value or table. Raw values will become a single item table.
value: Value or table. Non-table values will be set as single
item UCI list.
</li>
</ul>
@ -1264,6 +1298,38 @@ Set the directory for uncommited changes.
<h3>Return value:</h3>
Boolean whether operation succeeded
</dd>
<dt><a name="Cursor.set_session_id"></a><strong>Cursor:set_session_id</strong>&nbsp;(id)</dt>
<dd>
Set the effective session ID.
<h3>Parameters</h3>
<ul>
<li>
id: String containing the session ID to set
</li>
</ul>
<h3>Return value:</h3>
Boolean whether operation succeeded
@ -1278,10 +1344,11 @@ Boolean whether operation succeeded
<dd>
Create a sub-state of this cursor. The sub-state is tied to the parent
Create a sub-state of this cursor.
curser, means it the parent unloads or loads configs, the sub state will
do so as well.
The sub-state is tied to the parent curser, means it the parent unloads or
loads configs, the sub state will do so as well.

View File

@ -43,19 +43,15 @@
</li>
<li>
<a href="../modules/luci.http.protocol.html">luci.http.protocol</a>
<a href="../modules/luci.http.conditionals.html">luci.http.conditionals</a>
</li>
<li>
<a href="../modules/luci.http.protocol.conditionals.html">luci.http.protocol.conditionals</a>
<a href="../modules/luci.http.date.html">luci.http.date</a>
</li>
<li>
<a href="../modules/luci.http.protocol.date.html">luci.http.protocol.date</a>
</li>
<li>
<a href="../modules/luci.http.protocol.mime.html">luci.http.protocol.mime</a>
<a href="../modules/luci.http.mime.html">luci.http.mime</a>
</li>
<li>

View File

@ -43,19 +43,15 @@
</li>
<li>
<a href="../modules/luci.http.protocol.html">luci.http.protocol</a>
<a href="../modules/luci.http.conditionals.html">luci.http.conditionals</a>
</li>
<li>
<a href="../modules/luci.http.protocol.conditionals.html">luci.http.protocol.conditionals</a>
<a href="../modules/luci.http.date.html">luci.http.date</a>
</li>
<li>
<a href="../modules/luci.http.protocol.date.html">luci.http.protocol.date</a>
</li>
<li>
<a href="../modules/luci.http.protocol.mime.html">luci.http.protocol.mime</a>
<a href="../modules/luci.http.mime.html">luci.http.mime</a>
</li>
<li>

View File

@ -43,19 +43,15 @@
</li>
<li>
<a href="../modules/luci.http.protocol.html">luci.http.protocol</a>
<a href="../modules/luci.http.conditionals.html">luci.http.conditionals</a>
</li>
<li>
<a href="../modules/luci.http.protocol.conditionals.html">luci.http.protocol.conditionals</a>
<a href="../modules/luci.http.date.html">luci.http.date</a>
</li>
<li>
<a href="../modules/luci.http.protocol.date.html">luci.http.protocol.date</a>
</li>
<li>
<a href="../modules/luci.http.protocol.mime.html">luci.http.protocol.mime</a>
<a href="../modules/luci.http.mime.html">luci.http.mime</a>
</li>
<li>

View File

@ -43,19 +43,15 @@
</li>
<li>
<a href="../modules/luci.http.protocol.html">luci.http.protocol</a>
<a href="../modules/luci.http.conditionals.html">luci.http.conditionals</a>
</li>
<li>
<a href="../modules/luci.http.protocol.conditionals.html">luci.http.protocol.conditionals</a>
<a href="../modules/luci.http.date.html">luci.http.date</a>
</li>
<li>
<a href="../modules/luci.http.protocol.date.html">luci.http.protocol.date</a>
</li>
<li>
<a href="../modules/luci.http.protocol.mime.html">luci.http.protocol.mime</a>
<a href="../modules/luci.http.mime.html">luci.http.mime</a>
</li>
<li>

View File

@ -43,19 +43,15 @@
</li>
<li>
<a href="../modules/luci.http.protocol.html">luci.http.protocol</a>
<a href="../modules/luci.http.conditionals.html">luci.http.conditionals</a>
</li>
<li>
<a href="../modules/luci.http.protocol.conditionals.html">luci.http.protocol.conditionals</a>
<a href="../modules/luci.http.date.html">luci.http.date</a>
</li>
<li>
<a href="../modules/luci.http.protocol.date.html">luci.http.protocol.date</a>
</li>
<li>
<a href="../modules/luci.http.protocol.mime.html">luci.http.protocol.mime</a>
<a href="../modules/luci.http.mime.html">luci.http.mime</a>
</li>
<li>

View File

@ -43,19 +43,15 @@
</li>
<li>
<a href="../modules/luci.http.protocol.html">luci.http.protocol</a>
<a href="../modules/luci.http.conditionals.html">luci.http.conditionals</a>
</li>
<li>
<a href="../modules/luci.http.protocol.conditionals.html">luci.http.protocol.conditionals</a>
<a href="../modules/luci.http.date.html">luci.http.date</a>
</li>
<li>
<a href="../modules/luci.http.protocol.date.html">luci.http.protocol.date</a>
</li>
<li>
<a href="../modules/luci.http.protocol.mime.html">luci.http.protocol.mime</a>
<a href="../modules/luci.http.mime.html">luci.http.mime</a>
</li>
<li>

View File

@ -43,19 +43,15 @@
</li>
<li>
<a href="../modules/luci.http.protocol.html">luci.http.protocol</a>
<a href="../modules/luci.http.conditionals.html">luci.http.conditionals</a>
</li>
<li>
<a href="../modules/luci.http.protocol.conditionals.html">luci.http.protocol.conditionals</a>
<a href="../modules/luci.http.date.html">luci.http.date</a>
</li>
<li>
<a href="../modules/luci.http.protocol.date.html">luci.http.protocol.date</a>
</li>
<li>
<a href="../modules/luci.http.protocol.mime.html">luci.http.protocol.mime</a>
<a href="../modules/luci.http.mime.html">luci.http.mime</a>
</li>
<li>

View File

@ -43,19 +43,15 @@
</li>
<li>
<a href="../modules/luci.http.protocol.html">luci.http.protocol</a>
<a href="../modules/luci.http.conditionals.html">luci.http.conditionals</a>
</li>
<li>
<a href="../modules/luci.http.protocol.conditionals.html">luci.http.protocol.conditionals</a>
<a href="../modules/luci.http.date.html">luci.http.date</a>
</li>
<li>
<a href="../modules/luci.http.protocol.date.html">luci.http.protocol.date</a>
</li>
<li>
<a href="../modules/luci.http.protocol.mime.html">luci.http.protocol.mime</a>
<a href="../modules/luci.http.mime.html">luci.http.mime</a>
</li>
<li>

View File

@ -43,19 +43,15 @@
</li>
<li>
<a href="../modules/luci.http.protocol.html">luci.http.protocol</a>
<a href="../modules/luci.http.conditionals.html">luci.http.conditionals</a>
</li>
<li>
<a href="../modules/luci.http.protocol.conditionals.html">luci.http.protocol.conditionals</a>
<a href="../modules/luci.http.date.html">luci.http.date</a>
</li>
<li>
<a href="../modules/luci.http.protocol.date.html">luci.http.protocol.date</a>
</li>
<li>
<a href="../modules/luci.http.protocol.mime.html">luci.http.protocol.mime</a>
<a href="../modules/luci.http.mime.html">luci.http.mime</a>
</li>
<li>

View File

@ -43,19 +43,15 @@
</li>
<li>
<a href="../modules/luci.http.protocol.html">luci.http.protocol</a>
<a href="../modules/luci.http.conditionals.html">luci.http.conditionals</a>
</li>
<li>
<a href="../modules/luci.http.protocol.conditionals.html">luci.http.protocol.conditionals</a>
<a href="../modules/luci.http.date.html">luci.http.date</a>
</li>
<li>
<a href="../modules/luci.http.protocol.date.html">luci.http.protocol.date</a>
</li>
<li>
<a href="../modules/luci.http.protocol.mime.html">luci.http.protocol.mime</a>
<a href="../modules/luci.http.mime.html">luci.http.mime</a>
</li>
<li>
@ -274,13 +270,6 @@ This is a coroutine-safe drop-in replacement for Lua's "xpcall"-function
</td>
</tr>
<tr>
<td class="name" nowrap><a href="#dtable">dtable</a>&nbsp;()</td>
<td class="summary">
Create a dynamic table which automatically creates subtables.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#dumptable">dumptable</a>&nbsp;(t, maxdepth)</td>
<td class="summary">
@ -349,7 +338,6 @@ Returns the absolute path to LuCI base directory.</td>
<td class="summary">
Parse certain units from the given string and return the canonical integer
value or 0 if the unit is unknown.</td>
</tr>
@ -379,7 +367,6 @@ Restore data previously serialized with serialize_data().</td>
<td class="summary">
Recursively serialize given data to lua code, suitable for restoring
with loadstring().</td>
</tr>
@ -391,12 +378,18 @@ Convert data structure to JSON
</td>
</tr>
<tr>
<td class="name" nowrap><a href="#shellquote">shellquote</a>&nbsp;(value)</td>
<td class="summary">
Safely quote value for use in shell commands.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#spairs">spairs</a>&nbsp;(t, f)</td>
<td class="summary">
Return a key, value iterator which returns the values sorted according to
the provided callback function.</td>
</tr>
@ -405,7 +398,6 @@ the provided callback function.</td>
<td class="summary">
Splits given string on a defined separator sequence and return a table
containing the resulting substrings.</td>
</tr>
@ -428,7 +420,6 @@ Strip HTML tags from given string.</td>
<td class="summary">
Create a new or get an already existing thread local store associated with
the current active coroutine.</td>
</tr>
@ -453,6 +444,20 @@ Issue an ubus call.</td>
Update values in given table with the values from the second given table.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#urldecode">urldecode</a>&nbsp;(str, decode_plus)</td>
<td class="summary">
Decode an URL-encoded string - optionally decoding the "+" sign to space.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#urlencode">urlencode</a>&nbsp;(str)</td>
<td class="summary">
URL-encode given string.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#vspairs">vspairs</a>&nbsp;(t)</td>
<td class="summary">
@ -549,7 +554,8 @@ Classes can inherit member functions and values from a base class.
Class can be instantiated by calling them. All parameters will be passed
to the __init__ function of this class - if such a function exists.
The __init__ function must be used to set any object parameters that are not shared
with other objects of this class. Any return values will be ignored.
with other objects of this class. Any return values will be ignored.
<h3>Parameters</h3>
@ -728,8 +734,8 @@ Checks whether the given table contains the given value.
<h3>Return value:</h3>
number indicating the first index at which the given value occurs
within table or false.
Number indicating the first index at which the given value occurs
within table or false.
@ -766,7 +772,7 @@ This is a coroutine-safe drop-in replacement for Lua's "pcall"-function
<h3>Return value:</h3>
A boolean whether the function call succeeded and the returns
values of the function or the error object
values of the function or the error object
@ -807,30 +813,7 @@ This is a coroutine-safe drop-in replacement for Lua's "xpcall"-function
<h3>Return value:</h3>
A boolean whether the function call succeeded and the return
values of either the function or the error handler
</dd>
<dt><a name="dtable"></a><strong>dtable</strong>&nbsp;()</dt>
<dd>
Create a dynamic table which automatically creates subtables.
<h3>Return value:</h3>
Dynamic Table
values of either the function or the error handler
@ -944,8 +927,8 @@ Iterator
Return the current runtime bytecode of the given data. The byte code
will be stripped before it is returned.
will be stripped before it is returned.
<h3>Parameters</h3>
@ -976,11 +959,12 @@ String value containing the bytecode of the given data
<dd>
Return a matching iterator for the given value. The iterator will return
Return a matching iterator for the given value.
one token per invocation, the tokens are separated by whitespace. If the
input value is a table, it is transformed into a string first. A nil value
will result in a valid interator which aborts with the first invocation.
The iterator will return one token per invocation, the tokens are separated by
whitespace. If the input value is a table, it is transformed into a string first.
A nil value will result in a valid interator which aborts with the first invocation.
<h3>Parameters</h3>
@ -1094,7 +1078,8 @@ Sorted table containing the keys
Return a key, value iterator for the given table.
The table pairs are sorted by key.
The table pairs are sorted by key.
<h3>Parameters</h3>
@ -1149,9 +1134,11 @@ String containing the directory path
Parse certain units from the given string and return the canonical integer
value or 0 if the unit is unknown.
value or 0 if the unit is unknown. Upper- or lower case is irrelevant.
Upper- or lower case is irrelevant.
Recognized units are:
o "y" - one year (60*60*24*366)
o "m" - one month (60*60*24*31)
o "w" - one week (60*60*24*7)
@ -1163,7 +1150,8 @@ Recognized units are:
o "gb" - one gigabyte (1024*1024*1024)
o "kib" - one si kilobyte (1000)
o "mib" - one si megabyte (1000*1000)
o "gib" - one si gigabyte (1000*1000*1000)
o "gib" - one si gigabyte (1000*1000*1000)
<h3>Parameters</h3>
@ -1304,8 +1292,8 @@ Value containing the restored data structure
Recursively serialize given data to lua code, suitable for restoring
with loadstring().
with loadstring().
<h3>Parameters</h3>
@ -1381,13 +1369,45 @@ String containing the JSON if called without write callback
<dt><a name="shellquote"></a><strong>shellquote</strong>&nbsp;(value)</dt>
<dd>
Safely quote value for use in shell commands.
<h3>Parameters</h3>
<ul>
<li>
value: String containing the value to quote
</li>
</ul>
<h3>Return value:</h3>
Single-quote enclosed string with embedded quotes escaped
</dd>
<dt><a name="spairs"></a><strong>spairs</strong>&nbsp;(t, f)</dt>
<dd>
Return a key, value iterator which returns the values sorted according to
the provided callback function.
the provided callback function.
<h3>Parameters</h3>
@ -1423,11 +1443,13 @@ Function value containing the corresponding iterator
Splits given string on a defined separator sequence and return a table
containing the resulting substrings.
containing the resulting substrings. The optional max parameter specifies
the number of bytes to process, regardless of the actual length of the given
string. The optional last parameter, regex, specifies whether the separator
sequence is interpreted as regular expression.
The optional max parameter specifies the number of bytes to process,
regardless of the actual length of the given string. The optional last
parameter, regex, specifies whether the separator sequence is
nterpreted as regular expression.
<h3>Parameters</h3>
@ -1471,10 +1493,11 @@ Table containing the resulting substrings
<dd>
Strips unnescessary lua bytecode from given string. Information like line
Strips unnescessary lua bytecode from given string.
numbers and debugging numbers will be discarded. Original version by
Peter Cawley (http://lua-users.org/lists/lua-l/2008-02/msg01158.html)
Information like line numbers and debugging numbers will be discarded.
Original version by Peter Cawley (http://lua-users.org/lists/lua-l/2008-02/msg01158.html)
<h3>Parameters</h3>
@ -1538,9 +1561,11 @@ String with HTML tags stripped of
Create a new or get an already existing thread local store associated with
the current active coroutine.
the current active coroutine. A thread local store is private a table object
whose values can't be accessed from outside of the running coroutine.
A thread local store is private a table object
whose values can't be accessed from outside of the running coroutine.
@ -1636,7 +1661,8 @@ Table containin the ubus result
Update values in given table with the values from the second given table.
Both table are - in fact - merged together.
Both table are - in fact - merged together.
<h3>Parameters</h3>
@ -1667,13 +1693,100 @@ Always nil
<dt><a name="urldecode"></a><strong>urldecode</strong>&nbsp;(str, decode_plus)</dt>
<dd>
Decode an URL-encoded string - optionally decoding the "+" sign to space.
<h3>Parameters</h3>
<ul>
<li>
str: Input string in x-www-urlencoded format
</li>
<li>
decode_plus: Decode "+" signs to spaces if true (optional)
</li>
</ul>
<h3>Return value:</h3>
The decoded string
<h3>See also:</h3>
<ul>
<li><a href="#urlencode">
urlencode
</a>
</ul>
</dd>
<dt><a name="urlencode"></a><strong>urlencode</strong>&nbsp;(str)</dt>
<dd>
URL-encode given string.
<h3>Parameters</h3>
<ul>
<li>
str: String to encode
</li>
</ul>
<h3>Return value:</h3>
String containing the encoded data
<h3>See also:</h3>
<ul>
<li><a href="#urldecode">
urldecode
</a>
</ul>
</dd>
<dt><a name="vspairs"></a><strong>vspairs</strong>&nbsp;(t)</dt>
<dd>
Return a key, value iterator for the given table.
The table pairs are sorted by value.
The table pairs are sorted by value.
<h3>Parameters</h3>

View File

@ -43,19 +43,15 @@
</li>
<li>
<a href="../modules/luci.http.protocol.html">luci.http.protocol</a>
<a href="../modules/luci.http.conditionals.html">luci.http.conditionals</a>
</li>
<li>
<a href="../modules/luci.http.protocol.conditionals.html">luci.http.protocol.conditionals</a>
<a href="../modules/luci.http.date.html">luci.http.date</a>
</li>
<li>
<a href="../modules/luci.http.protocol.date.html">luci.http.protocol.date</a>
</li>
<li>
<a href="../modules/luci.http.protocol.mime.html">luci.http.protocol.mime</a>
<a href="../modules/luci.http.mime.html">luci.http.mime</a>
</li>
<li>

View File

@ -43,19 +43,15 @@
</li>
<li>
<a href="../modules/luci.http.protocol.html">luci.http.protocol</a>
<a href="../modules/luci.http.conditionals.html">luci.http.conditionals</a>
</li>
<li>
<a href="../modules/luci.http.protocol.conditionals.html">luci.http.protocol.conditionals</a>
<a href="../modules/luci.http.date.html">luci.http.date</a>
</li>
<li>
<a href="../modules/luci.http.protocol.date.html">luci.http.protocol.date</a>
</li>
<li>
<a href="../modules/luci.http.protocol.mime.html">luci.http.protocol.mime</a>
<a href="../modules/luci.http.mime.html">luci.http.mime</a>
</li>
<li>

View File

@ -43,19 +43,15 @@
</li>
<li>
<a href="../modules/luci.http.protocol.html">luci.http.protocol</a>
<a href="../modules/luci.http.conditionals.html">luci.http.conditionals</a>
</li>
<li>
<a href="../modules/luci.http.protocol.conditionals.html">luci.http.protocol.conditionals</a>
<a href="../modules/luci.http.date.html">luci.http.date</a>
</li>
<li>
<a href="../modules/luci.http.protocol.date.html">luci.http.protocol.date</a>
</li>
<li>
<a href="../modules/luci.http.protocol.mime.html">luci.http.protocol.mime</a>
<a href="../modules/luci.http.mime.html">luci.http.mime</a>
</li>
<li>

View File

@ -43,19 +43,15 @@
</li>
<li>
<a href="../modules/luci.http.protocol.html">luci.http.protocol</a>
<a href="../modules/luci.http.conditionals.html">luci.http.conditionals</a>
</li>
<li>
<a href="../modules/luci.http.protocol.conditionals.html">luci.http.protocol.conditionals</a>
<a href="../modules/luci.http.date.html">luci.http.date</a>
</li>
<li>
<a href="../modules/luci.http.protocol.date.html">luci.http.protocol.date</a>
</li>
<li>
<a href="../modules/luci.http.protocol.mime.html">luci.http.protocol.mime</a>
<a href="../modules/luci.http.mime.html">luci.http.mime</a>
</li>
<li>

View File

@ -43,19 +43,15 @@
</li>
<li>
<a href="../modules/luci.http.protocol.html">luci.http.protocol</a>
<a href="../modules/luci.http.conditionals.html">luci.http.conditionals</a>
</li>
<li>
<a href="../modules/luci.http.protocol.conditionals.html">luci.http.protocol.conditionals</a>
<a href="../modules/luci.http.date.html">luci.http.date</a>
</li>
<li>
<a href="../modules/luci.http.protocol.date.html">luci.http.protocol.date</a>
</li>
<li>
<a href="../modules/luci.http.protocol.mime.html">luci.http.protocol.mime</a>
<a href="../modules/luci.http.mime.html">luci.http.mime</a>
</li>
<li>

View File

@ -43,19 +43,15 @@
</li>
<li>
<a href="../modules/luci.http.protocol.html">luci.http.protocol</a>
<a href="../modules/luci.http.conditionals.html">luci.http.conditionals</a>
</li>
<li>
<a href="../modules/luci.http.protocol.conditionals.html">luci.http.protocol.conditionals</a>
<a href="../modules/luci.http.date.html">luci.http.date</a>
</li>
<li>
<a href="../modules/luci.http.protocol.date.html">luci.http.protocol.date</a>
</li>
<li>
<a href="../modules/luci.http.protocol.mime.html">luci.http.protocol.mime</a>
<a href="../modules/luci.http.mime.html">luci.http.mime</a>
</li>
<li>

View File

@ -43,19 +43,15 @@
</li>
<li>
<a href="../modules/luci.http.protocol.html">luci.http.protocol</a>
<a href="../modules/luci.http.conditionals.html">luci.http.conditionals</a>
</li>
<li>
<a href="../modules/luci.http.protocol.conditionals.html">luci.http.protocol.conditionals</a>
<a href="../modules/luci.http.date.html">luci.http.date</a>
</li>
<li>
<a href="../modules/luci.http.protocol.date.html">luci.http.protocol.date</a>
</li>
<li>
<a href="../modules/luci.http.protocol.mime.html">luci.http.protocol.mime</a>
<a href="../modules/luci.http.mime.html">luci.http.mime</a>
</li>
<li>

View File

@ -43,19 +43,15 @@
</li>
<li>
<a href="../modules/luci.http.protocol.html">luci.http.protocol</a>
<a href="../modules/luci.http.conditionals.html">luci.http.conditionals</a>
</li>
<li>
<a href="../modules/luci.http.protocol.conditionals.html">luci.http.protocol.conditionals</a>
<a href="../modules/luci.http.date.html">luci.http.date</a>
</li>
<li>
<a href="../modules/luci.http.protocol.date.html">luci.http.protocol.date</a>
</li>
<li>
<a href="../modules/luci.http.protocol.mime.html">luci.http.protocol.mime</a>
<a href="../modules/luci.http.mime.html">luci.http.mime</a>
</li>
<li>

View File

@ -43,19 +43,15 @@
</li>
<li>
<a href="../modules/luci.http.protocol.html">luci.http.protocol</a>
<a href="../modules/luci.http.conditionals.html">luci.http.conditionals</a>
</li>
<li>
<a href="../modules/luci.http.protocol.conditionals.html">luci.http.protocol.conditionals</a>
<a href="../modules/luci.http.date.html">luci.http.date</a>
</li>
<li>
<a href="../modules/luci.http.protocol.date.html">luci.http.protocol.date</a>
</li>
<li>
<a href="../modules/luci.http.protocol.mime.html">luci.http.protocol.mime</a>
<a href="../modules/luci.http.mime.html">luci.http.mime</a>
</li>
<li>

View File

@ -43,19 +43,15 @@
</li>
<li>
<a href="../modules/luci.http.protocol.html">luci.http.protocol</a>
<a href="../modules/luci.http.conditionals.html">luci.http.conditionals</a>
</li>
<li>
<a href="../modules/luci.http.protocol.conditionals.html">luci.http.protocol.conditionals</a>
<a href="../modules/luci.http.date.html">luci.http.date</a>
</li>
<li>
<a href="../modules/luci.http.protocol.date.html">luci.http.protocol.date</a>
</li>
<li>
<a href="../modules/luci.http.protocol.mime.html">luci.http.protocol.mime</a>
<a href="../modules/luci.http.mime.html">luci.http.mime</a>
</li>
<li>

View File

@ -43,19 +43,15 @@
</li>
<li>
<a href="../modules/luci.http.protocol.html">luci.http.protocol</a>
<a href="../modules/luci.http.conditionals.html">luci.http.conditionals</a>
</li>
<li>
<a href="../modules/luci.http.protocol.conditionals.html">luci.http.protocol.conditionals</a>
<a href="../modules/luci.http.date.html">luci.http.date</a>
</li>
<li>
<a href="../modules/luci.http.protocol.date.html">luci.http.protocol.date</a>
</li>
<li>
<a href="../modules/luci.http.protocol.mime.html">luci.http.protocol.mime</a>
<a href="../modules/luci.http.mime.html">luci.http.mime</a>
</li>
<li>

View File

@ -43,19 +43,15 @@
</li>
<li>
<a href="../modules/luci.http.protocol.html">luci.http.protocol</a>
<a href="../modules/luci.http.conditionals.html">luci.http.conditionals</a>
</li>
<li>
<a href="../modules/luci.http.protocol.conditionals.html">luci.http.protocol.conditionals</a>
<a href="../modules/luci.http.date.html">luci.http.date</a>
</li>
<li>
<a href="../modules/luci.http.protocol.date.html">luci.http.protocol.date</a>
</li>
<li>
<a href="../modules/luci.http.protocol.mime.html">luci.http.protocol.mime</a>
<a href="../modules/luci.http.mime.html">luci.http.mime</a>
</li>
<li>

View File

@ -43,19 +43,15 @@
</li>
<li>
<a href="../modules/luci.http.protocol.html">luci.http.protocol</a>
<a href="../modules/luci.http.conditionals.html">luci.http.conditionals</a>
</li>
<li>
<a href="../modules/luci.http.protocol.conditionals.html">luci.http.protocol.conditionals</a>
<a href="../modules/luci.http.date.html">luci.http.date</a>
</li>
<li>
<a href="../modules/luci.http.protocol.date.html">luci.http.protocol.date</a>
</li>
<li>
<a href="../modules/luci.http.protocol.mime.html">luci.http.protocol.mime</a>
<a href="../modules/luci.http.mime.html">luci.http.mime</a>
</li>
<li>