X-Git-Url: https://git.archive.openwrt.org/?a=blobdiff_plain;ds=sidebyside;f=documentation%2Fapi%2Fmodules%2Fluci.util.html;h=d3d45a1800a849d0174ece8c760bb04c4d7b39df;hb=dcfc4569c483f4218cf41b26ef0f4dfed0441c55;hp=847230bbbda4fbb443ea0ccf5e1f3a481c07749b;hpb=6b627a934f525feebbaf72cd233c8f237d908918;p=project%2Fluci.git diff --git a/documentation/api/modules/luci.util.html b/documentation/api/modules/luci.util.html index 847230bbb..d3d45a180 100644 --- a/documentation/api/modules/luci.util.html +++ b/documentation/api/modules/luci.util.html @@ -43,19 +43,15 @@
  • - luci.http.protocol + luci.http.conditionals
  • - luci.http.protocol.conditionals + luci.http.date
  • - luci.http.protocol.date -
  • - -
  • - luci.http.protocol.mime + luci.http.mime
  • @@ -275,13 +271,6 @@ This is a coroutine-safe drop-in replacement for Lua's "xpcall"-function - dtable () - - -Create a dynamic table which automatically creates subtables. - - - dumptable (t, maxdepth) @@ -349,7 +338,6 @@ Returns the absolute path to LuCI base directory. Parse certain units from the given string and return the canonical integer - value or 0 if the unit is unknown. @@ -379,7 +367,6 @@ Restore data previously serialized with serialize_data(). Recursively serialize given data to lua code, suitable for restoring - with loadstring(). @@ -392,11 +379,17 @@ Convert data structure to JSON + shellquote (value) + + +Safely quote value for use in shell commands. + + + spairs (t, f) Return a key, value iterator which returns the values sorted according to - the provided callback function. @@ -405,7 +398,6 @@ the provided callback function. Splits given string on a defined separator sequence and return a table - containing the resulting substrings. @@ -428,7 +420,6 @@ Strip HTML tags from given string. Create a new or get an already existing thread local store associated with - the current active coroutine. @@ -454,6 +445,20 @@ Update values in given table with the values from the second given table. + urldecode (str, decode_plus) + + +Decode an URL-encoded string - optionally decoding the "+" sign to space. + + + + urlencode (str) + + +URL-encode given string. + + + vspairs (t) @@ -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. +

    Parameters

    @@ -629,7 +635,7 @@ Cloned table value
    -Count the occurrences of given substring in given string. +Count the occurrences of given substring in given string. @@ -728,8 +734,8 @@ Checks whether the given table contains the given value.

    Return value:

    -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

    Return value:

    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

    Return value:

    A boolean whether the function call succeeded and the return - values of either the function or the error handler - - - -
    - - - - -
    dtable ()
    -
    - - -Create a dynamic table which automatically creates subtables. - - - - - - - - -

    Return value:

    -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. +

    Parameters

    @@ -976,11 +959,12 @@ String value containing the bytecode of the given data
    -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. +

    Parameters

    @@ -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. +

    Parameters

    @@ -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) +

    Parameters

    @@ -1304,8 +1292,8 @@ Value containing the restored data structure Recursively serialize given data to lua code, suitable for restoring - -with loadstring(). +with loadstring(). +

    Parameters

    @@ -1381,13 +1369,45 @@ String containing the JSON if called without write callback +
    shellquote (value)
    +
    + + +Safely quote value for use in shell commands. + + + +

    Parameters

    + + + + + + + +

    Return value:

    +Single-quote enclosed string with embedded quotes escaped + + + +
    + + + +
    spairs (t, f)
    Return a key, value iterator which returns the values sorted according to - -the provided callback function. +the provided callback function. +

    Parameters

    @@ -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. +

    Parameters

    @@ -1471,10 +1493,11 @@ Table containing the resulting substrings
    -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) +

    Parameters

    @@ -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. +

    Parameters

    @@ -1667,13 +1693,100 @@ Always nil +
    urldecode (str, decode_plus)
    +
    + + +Decode an URL-encoded string - optionally decoding the "+" sign to space. + + + +

    Parameters

    + + + + + + + +

    Return value:

    +The decoded string + + + +

    See also:

    + + +
    + + + + +
    urlencode (str)
    +
    + + +URL-encode given string. + + + +

    Parameters

    + + + + + + + +

    Return value:

    +String containing the encoded data + + + +

    See also:

    + + +
    + + + +
    vspairs (t)
    Return a key, value iterator for the given table. -The table pairs are sorted by value. +The table pairs are sorted by value. +

    Parameters