Skip to content

Fix lists (take 2) #403

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Mar 28, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
sort direction:

- asc(default): ascending sort order
- desc: descending sort order.
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
value can be a string or a closure/function.

a string must be one of the following values:

- "numeric": sorts numbers
- "text": sorts text alphabetically, taking case into account (case sensitive)
- "textnocase": sorts text alphabetically, without regard to case (case insensitive)

if you define a closure/function, the closure/function must accept 2 parameters of any type and return:
-1, if first parameter is "smaller" than second parameter
\-1, if first parameter is "smaller" than second parameter
0, if first parameter is equal to second parameter
1, first parameter is "bigger" than second parameter
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
A string specifying the algorithm used to encode the original
binary data into a string; must be one of the following:

- hex: characters 0-9 and A-F represent the hexadecimal value of each byte
- UU: data is encoded using the UNIX UUencode algorithm
- base64: data is encoded using the Base64 algorithm
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
A string that specifies the encoding method to use to represent the data; one of the following:

- Hex: use the characters 0-9 and A-F to represent the hexadecimal value of each byte.
- UU: use the UNIX UUencode algorithm to convert the data
- Base64: use the Base64 algorithm to convert the data, as specified by IETF RFC 2045, at www.ietf.org/rfc/rfc2045.txt.
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
define which cache instances information are returned

- "" or not set - information to all default caches (object,template,resource,query)
- "object" - information to "Default Object" Cache
- "template" - information to "Default Template" Cache
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
Where to send the results of cfdump. The following values are valid:

- browser: outputs in browser window
- console: outputs on (System.out stream; see also setting in lucee-server.xml {system-out})
- filename: outputs in a file
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@ A timezone must be specified in order to translate the date object to something

You can find a list of all available timezones in the Lucee administrator (Settings/Regional). Some examples of valid timezones include:

- AGT (for time in Argentina)
- Europe/Zurich (for time in Zurich/Switzerland)
- HST (Hawaiian Standard Time in the USA)
- AGT (for time in Argentina)
- Europe/Zurich (for time in Zurich/Switzerland)
- HST (Hawaiian Standard Time in the USA)
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
the usage of this argument depend on type defined with argument "type":

- com: not used (ignored)
- java: delimiter used for the classpath (default comma)
- webservice: not used (ignored)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
the usage of this argument depend on type defined with argument "type":

- com: Component ProgID for the object to invoke.
- java: java class to load
- webservice: WSDL url to call
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
the usage of this argument depend on type defined with argument "type":

- com: not used (ignored)
- java: classpath used to load the defined class, this can be a list of multiple paths (directories containing class files or jar files)
- webservice: a struct containing the following optional keys (username,password,proxyServer,proxyPort,proxyUser,proxyPassword)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
the usage of this argument depend on type defined with argument "type":

- java: delimiter used for the classpath (default comma) or bundle version when the previous argument was a bundle name
- webservice: not used (ignored)
- component: not used (ignored)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
one of the following:

- com: for loading a com Object
- java: for loading a java object
- webservice: for loading a remote webservice
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@ A timezone must be specified in order to translate the date object to something

You can find a list of all available timezones in the Lucee administrator (Settings/Regional). Some examples of valid timezones include:

- AGT (for time in Argentina)
- Europe/Zurich (for time in Zurich/Switzerland)
- HST (Hawaiian Standard Time in the USA)
- AGT (for time in Argentina)
- Europe/Zurich (for time in Zurich/Switzerland)
- HST (Hawaiian Standard Time in the USA)
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@ A timezone must be specified in order to translate the date object to something

You can find a list of all available timezones in the Lucee administrator (Settings/Regional). Some examples of valid timezones include:

- AGT (for time in Argentina)
- Europe/Zurich (for time in Zurich/Switzerland)
- HST (Hawaiian Standard Time in the USA)
- AGT (for time in Argentina)
- Europe/Zurich (for time in Zurich/Switzerland)
- HST (Hawaiian Standard Time in the USA)
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@ A timezone must be specified in order to translate the date object to something

You can find a list of all available timezones in the Lucee administrator (Settings/Regional). Some examples of valid timezones include:

- AGT (for time in Argentina)
- Europe/Zurich (for time in Zurich/Switzerland)
- HST (Hawaiian Standard Time in the USA)
- AGT (for time in Argentina)
- Europe/Zurich (for time in Zurich/Switzerland)
- HST (Hawaiian Standard Time in the USA)
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
The algorithm to use to decrypt the string. Must be the same as the algorithm used to encrypt the string.

- CFMX_COMPAT(default): the CFML specific algorithm. This algorithm is the least secure option
- AES: the Advanced Encryption Standard specified by the National Institute of Standards and Technology (NIST) FIPS-197
- BLOWFISH: the Blowfish algorithm defined by Bruce Schneier
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
The binary encoding used to represent the data as a string. Must be the same as the algorithm used to encrypt the string.

- Base64: the Base64 algorithm, as specified by IETF RFC 2045
- Hex: the characters A-F and 0-9 represent the hexadecimal byte values
- UU(default): the UNIX standard UUEncode algorithm
1 change: 1 addition & 0 deletions docs/03.reference/01.functions/decrypt/_arguments/key.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
Key or seed used to encrypt the string.

- For the CFMX_COMPAT algorithm, any combination of any number of characters; used as a seed used to generate a 32-bit encryption key.
- For all other algorithms, a key in the format used by the algorithm. For these algorithms, use the GenerateSecretKey function to generate the key.
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
The algorithm to use to decrypt the string. Must be the same as the algorithm used to encrypt the string.

- CFMX_COMPAT(default): the CFML specific algorithm. This algorithm is the least secure option
- AES: the Advanced Encryption Standard specified by the National Institute of Standards and Technology (NIST) FIPS-197
- BLOWFISH: the Blowfish algorithm defined by Bruce Schneier
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
Key or seed used to encrypt the string.

- For the CFMX_COMPAT algorithm, any combination of any number of characters; used as a seed used to generate a 32-bit encryption key.
- For all other algorithms, a key in the format used by the algorithm. For these algorithms, use the GenerateSecretKey function to generate the key.
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
Filter to be used to filter the data copied:

- A string that uses "*" as a wildcard, for example, "*.cfm"
- a UDF (User defined Function) using the following pattern "functioname(String path):boolean", the function is run for every single file, if the function returns true, then the file is will be added to the list otherwise it will be omitted
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
Filter to be used to filter the results:

* A string that uses "*" as a wildcard, for example, "*.cfm"
* a UDF (User defined Function) with signature `Boolean function(String path)`. The function is run for each file in turn; if the function returns `true`, then the file is will be added to the result; otherwise it will be omitted.
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
type of the result returned:

- file: includes only filenames
- dir: includes only directory names
- all: includes both filenames and directory names
1 change: 1 addition & 0 deletions docs/03.reference/01.functions/dump/_arguments/format.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
specify the output format of the dump, the following formats are supported:

- simple: - a simple html output (no javascript or css)
- text (default output="console"): plain text output (no html)
- html (default output="browser"): regular output with html/css/javascript
Expand Down
1 change: 1 addition & 0 deletions docs/03.reference/01.functions/dump/_arguments/output.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
Where to send the results:

- console: the result is written to the console (System.out).
- browser (default): the result is written the the browser response stream.
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
The algorithm to use to decrypt the string. Must be the same as the algorithm used to encrypt the string.

- CFMX_COMPAT(default): the CFML specific algorithm. This algorithm is the least secure option
- AES: the Advanced Encryption Standard specified by the National Institute of Standards and Technology (NIST) FIPS-197
- BLOWFISH: the Blowfish algorithm defined by Bruce Schneier
- DES: the Data Encryption Standard algorithm defined by NIST FIPS-46-3
- DESEDE: the "Triple DES" algorithm defined by NIST FIPS-46-3

You may also specify other algorithm names as well as the feedback mode and padding scheme where applicable (in the format algorithm/mode/padding) as documented in the Java Cryptography Architecture (JCA) Reference Guide.
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
The binary encoding used to represent the data as a string. Must be the same as the algorithm used to encrypt the string.

- Base64: the Base64 algorithm, as specified by IETF RFC 2045.
- Hex: the characters A-F and 0-9 represent the hexadecimal byte values.
- UU(default): the UNIX standard UUEncode algorithm .
1 change: 1 addition & 0 deletions docs/03.reference/01.functions/encrypt/_arguments/key.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
Key or seed used to encrypt the string.

- For the CFMX_COMPAT algorithm, any combination of any number of characters; used as a seed used to generate a 32-bit encryption key.
- For all other algorithms, a key in the format used by the algorithm. For these algorithms, use the GenerateSecretKey function to generate the key.
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
The algorithm to use to decrypt the string. Must be the same as the algorithm used to encrypt the string.

- CFMX_COMPAT(default): the CFML specific algorithm. This algorithm is the least secure option
- AES: the Advanced Encryption Standard specified by the National Institute of Standards and Technology (NIST) FIPS-197
- BLOWFISH: the Blowfish algorithm defined by Bruce Schneier
- DES: the Data Encryption Standard algorithm defined by NIST FIPS-46-3
- DESEDE: the "Triple DES" algorithm defined by NIST FIPS-46-3

You may also specify other algorithm names as well as the feedback mode and padding scheme where applicable (in the format algorithm/mode/padding) as documented in the Java Cryptography Architecture (JCA) Reference Guide.
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
Key or seed used to encrypt the string.

- For the CFMX_COMPAT algorithm, any combination of any number of characters; used as a seed used to generate a 32-bit encryption key.
- For all other algorithms, a key in the format used by the algorithm. For these algorithms, use the GenerateSecretKey function to generate the key.
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
The following options to customize the output (only used when second argument is "id"):

- ignorecase: Ignores the case of sort order when set to true. Use only if you specify the sortorder parameter.
- offset: Specifies the position from which to retrieve the objects.
- maxResults: Specifies the maximum number of objects to be retrieved.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
given value is encoded as:

- url: also decodes html-encoded content in lucee 4
- html (not in lucee 4)
- html (not in lucee 4)
1 change: 1 addition & 0 deletions docs/03.reference/01.functions/fileopen/_arguments/mode.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
Action to perform on the file, including the following:

- read
- readBinary
- write
Expand Down
Original file line number Diff line number Diff line change
@@ -1,14 +1,17 @@
A three-digit value, in which each digit specifies the file access for individuals and groups:

- The first digit represents the owner.
- The second digit represents a group.
- The third digit represents anyone.

Each digit of this code sets permissions for the appropriate individual or group:

- 4 specifies read permission.
- 2 specifies write permission.
- 1 specifies execute permission.

You use the sums of these numbers to indicate combinations of the permissions:

- 3 specifies write and execute permission.
- 5 specifies read and execute permission.
- 6 indicates read and write permission.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
One of the following:

- readOnly
- hidden
- normal

Set the attribute to normal to make a file not read-only and not hidden.
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
Hashing algorithm used for generating key
Example Values:

- PBKDF2WithHmacSHA1
- PBKDF2WithSHA1
- PBKDF2WithSHA224
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
one of the following

- form
- url
2 changes: 1 addition & 1 deletion docs/03.reference/01.functions/getlocale/function.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: GetLocale
id: function-getlocale
related:
categories:
- i18n
- internationalization
---

Gets the current geographic/language locale value.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: GetLocaleDisplayName
id: function-getlocaledisplayname
related:
categories:
- i18n
- internationalization
---

Gets a locale value and displays the name in a manner
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
type of the memory informtion, valid values are:

- heap
- non_heap

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ categories:

Gets all the sections of an initialization file.
An initialization file, as a struct whose format is as follows:

- Each initialization file section name is a key in the
struct
- Each list of entries in a section of an initialization
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
base unit for the function, valid values are:

- nano: nano seconds
- milli (default): milli seconds
- second: seconds
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
The algorithm to use to hash the string. Supported are the following algorithms:

- CFMX_COMPAT: generating a hash string using classic CFML algorithm.
- MD5: (default) Generates a 32-character, hexadecimal string, using the MD5 algorithm.
- SHA: Generates a 28-character string using the Secure Hash Standard SHA-1 algorithm specified by Nation Institute of Standards and Technology (NIST) FIPS-180-2.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
The type of border:

- zero: Sets the border color to black.
- constant: Sets the border to the specified color (default).
- copy: Sets sample values to copies of the nearest valid pixel. For example, pixels to the left of the valid rectangle assume the value of the valid edge pixel in the same row. Pixels both above and to the left of the valid rectangle assume the value of the upper-left pixel.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
Specify whether the arc is filled:

- true: The arc is filled with the specified drawing color.
- false (default): Only the outline of the arc is drawn.
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
Specify whether the rectangle is filled:

- true: The rectangle is filled with the specified drawing color.
- false (default): Only the outline of the rectangle is drawn.
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
Specify whether the rectangle appears raised above the surface or sunk into the surface:

- true: The rectangle is raised.
- false (default): The rectangle is sunk.
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
Specify whether the polygon is filled:

- true: The polygon is filled with the specified drawing color.
- false (default): Only the outline of the polygon is drawn.
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
Specify whether the lines form a polygon:

- true: The lines are connected to form a polygon.
- false (default): The lines do not form a polygon.
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
Specify whether the oval is filled:

- true: The oval is filled with the specified drawing color.
- false (default): Only the outline of the oval is drawn.
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
Specify whether the rectangle is filled:

- true: The rectangle is filled with the specified drawing color.
- false (default): Only the outline of the rectangle is drawn.
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
Specify whether the rectangle is filled:

- true: The rectangle is filled with the specified drawing color.
- false (default): Only the outline of the rectangle is drawn.
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
a structure used to specify the text characteristics. the following keys are supported:

- font: The name of the font used to draw the text string. If you do not specify the font attribute, the text is drawn in the default system font.
- size: The font size for the text string. The default value is 10 points.
- style: The style to apply to the font ( bold,italic,boldItalic,plain (default) ).
Expand Down
Loading