luci-base: switch to lucihttp.urldecode() and lucihttp.urlencode()
[project/luci.git] / modules / luci-base / luasrc / http / protocol.luadoc
index 67a60d9..cf3d5b2 100644 (file)
@@ -7,18 +7,6 @@ decoding and to retrive form data from raw http messages.
 module "luci.http.protocol"
 
 ---[[
-Decode an urlencoded string - optionally without decoding
-
-the "+" sign to " " - and return the decoded string.
-@class function
-@name urldecode
-@param str             Input string in x-www-urlencoded format
-@param no_plus Don't decode "+" signs to spaces
-@return                        The decoded string
-@see                           urlencode
-]]
-
----[[
 Extract and split urlencoded data pairs, separated bei either "&" or ";"
 
 from given url or string. Returns a table with urldecoded values.
@@ -34,16 +22,6 @@ containing the corresponding values.
 ]]
 
 ---[[
-Encode given string to x-www-urlencoded format.
-
-@class function
-@name urlencode
-@param str     String to encode
-@return                String containing the encoded data
-@see                   urldecode
-]]
-
----[[
 Encode each key-value-pair in given table to x-www-urlencoded format,
 
 separated by "&". Tables are encoded as parameters with multiple values by
@@ -69,7 +47,7 @@ data line by line with the trailing \r\n stripped of.
 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 withing the given message object. Multiple parameter
+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
@@ -92,7 +70,7 @@ with three arguments:
 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 withing the given message object. Multiple parameter
+in the params table within the given message object. Multiple parameter
 values are stored as tables, ordinary ones as strings.
 @class function
 @name urldecode_message_body