From 7bb2d6977f0b2045ded294a7d5ec4a20af9ce018 Mon Sep 17 00:00:00 2001 From: KamasamaK Date: Sat, 30 Mar 2024 21:04:29 -0400 Subject: [PATCH 1/3] Update CF min version and more (A-O functions) --- data/en/addsoaprequestheader.json | 6 +++--- data/en/addsoapresponseheader.json | 6 +++--- data/en/ajaxlink.json | 10 +++------- data/en/ajaxonload.json | 10 +++------- data/en/arraycontains.json | 11 +++-------- data/en/arraygetmetadata.json | 9 ++++++++- data/en/decryptbinary.json | 10 +++++----- data/en/encryptbinary.json | 8 ++++---- data/en/entitymerge.json | 2 +- data/en/entityreload.json | 2 +- data/en/entitysave.json | 4 ++-- data/en/getauthuser.json | 12 ++++-------- data/en/getcomponentmetadata.json | 4 ++-- data/en/getcontextroot.json | 4 ++-- data/en/getencoding.json | 14 +++++--------- data/en/getgatewayhelper.json | 10 +++------- data/en/getk2serverdoccount.json | 4 ++-- data/en/getk2serverdoccountlimit.json | 4 ++-- data/en/getlocaledisplayname.json | 13 ++++++++----- data/en/getlocalhostip.json | 6 +++--- data/en/getmetadata.json | 24 +++++++----------------- data/en/getprinterinfo.json | 4 ++-- data/en/getprinterlist.json | 4 ++-- data/en/getprofilesections.json | 15 ++++++--------- data/en/getreadableimageformats.json | 6 +++--- data/en/getsoaprequest.json | 10 +++++----- data/en/getsoaprequestheader.json | 6 +++--- data/en/getsoapresponse.json | 8 ++++---- data/en/getsoapresponseheader.json | 8 ++++---- data/en/getuserroles.json | 4 ++-- data/en/getvfsmetadata.json | 10 +++------- data/en/getwriteableimageformats.json | 12 ++++-------- data/en/imagesetantialiasing.json | 22 ++++++++++------------ data/en/imagexordrawingmode.json | 19 ++++++++----------- data/en/isddx.json | 12 ++++-------- data/en/isimage.json | 26 +++++++++++++++----------- data/en/isimagefile.json | 20 +++++++++++++------- data/en/isinstanceof.json | 23 ++++++++++------------- data/en/isipv6.json | 15 ++++++++------- data/en/isjson.json | 12 ++++++------ data/en/islocalhost.json | 15 ++++++--------- data/en/isobject.json | 8 ++++---- data/en/ispdfobject.json | 6 +++--- data/en/issoaprequest.json | 14 +++++--------- data/en/isspreadsheetfile.json | 12 ++++++------ data/en/isspreadsheetobject.json | 6 +++--- data/en/isuserinanyrole.json | 8 ++++---- data/en/isuserinrole.json | 8 ++++---- data/en/isuserloggedin.json | 14 +++++--------- data/en/isxml.json | 11 ++++++----- data/en/isxmlattribute.json | 4 ++-- data/en/isxmldoc.json | 4 ++-- data/en/isxmlelem.json | 2 +- data/en/isxmlnode.json | 4 ++-- data/en/isxmlroot.json | 4 ++-- data/en/location.json | 20 ++++++++------------ data/en/objectequals.json | 20 ++++++++------------ data/en/ormclearsession.json | 9 +++------ data/en/ormclosesession.json | 9 +++------ data/en/ormevictcollection.json | 24 ++++++++++-------------- data/en/ormevictentity.json | 26 +++++++++++--------------- data/en/ormevictqueries.json | 17 +++++++---------- data/en/ormflush.json | 8 ++++---- data/en/ormgetsession.json | 10 ++++------ data/en/ormgetsessionfactory.json | 12 +++++------- data/en/ormreload.json | 13 +++++-------- 66 files changed, 309 insertions(+), 388 deletions(-) diff --git a/data/en/addsoaprequestheader.json b/data/en/addsoaprequestheader.json index 897b56bfd..63e439757 100644 --- a/data/en/addsoaprequestheader.json +++ b/data/en/addsoaprequestheader.json @@ -13,7 +13,7 @@ {"name":"mustUnderstand","description":"The mustUnderstand attribute indicates whether processing of the header is optional or mandatory.\nThis basically translates to the node trying to find an appropriate handler that matches the header\nand proceed with processing the message in a manner consistent with its specification. If it can't find an appropriate handler\nit must return an error and stop further processing. If mustUnderstand is set to `true`\nthe node is not allowed to ignore it.","required":false,"default":"false","type":"boolean","values":[]} ], "engines": { - "coldfusion": {"minimum_version":"", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-a-b/addsoaprequestheader.html"}, + "coldfusion": {"minimum_version":"7", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-a-b/addsoaprequestheader.html"}, "lucee": {"minimum_version":"", "notes":"", "docs":"https://docs.lucee.org/reference/functions/addsoaprequestheader.html"}, "railo": {"minimum_version":"", "notes":"", "docs":"http://railodocs.org/index.cfm/function/addsoaprequestheader"}, "openbd": {"minimum_version":"", "notes":"", "docs":"http://openbd.org/manual/?/function/addsoaprequestheader"} @@ -23,9 +23,9 @@ { "title": "Set the username header as a string", "description": "", - "code": "/ws = createObject(\"webservice\", \"http://localhost/soapheaders/headerservice.cfc?WSDL\");\r\naddSOAPRequestHeader(ws, \"http://mynamespace/\", \"username\", \"tom\", false);", + "code": "/ws = createObject(\"webservice\", \"http://localhost/soapheaders/headerservice.cfc?WSDL\");\naddSOAPRequestHeader(ws, \"http://mynamespace/\", \"username\", \"tom\", false);", "result": "", - "runnable":false + "runnable":false } ] } diff --git a/data/en/addsoapresponseheader.json b/data/en/addsoapresponseheader.json index 0c9ad1759..28b616597 100644 --- a/data/en/addsoapresponseheader.json +++ b/data/en/addsoapresponseheader.json @@ -12,7 +12,7 @@ {"name":"mustUnderstand","description":"The mustUnderstand attribute indicates whether processing of the header is optional or mandatory.\nThis basically translates to the node trying to find an appropriate handler that matches the header\nand proceed with processing the message in a manner consistent with its specification. If it can't find an appropriate handler\nit must return an error and stop further processing. If mustUnderstand is set to `true`\nthe node is not allowed to ignore it.","required":false,"default":"","type":"boolean","values":[]} ], "engines": { - "coldfusion": {"minimum_version":"", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-a-b/addsoapresponseheader.html"}, + "coldfusion": {"minimum_version":"7", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-a-b/addsoapresponseheader.html"}, "lucee": {"minimum_version":"", "notes":"", "docs":"https://docs.lucee.org/reference/functions/addsoapresponseheader.html"}, "railo": {"minimum_version":"", "notes":"", "docs":"http://railodocs.org/index.cfm/function/addsoapresponseheader"}, "openbd": {"minimum_version":"", "notes":"", "docs":"http://openbd.org/manual/?/function/addsoapresponseheader"} @@ -22,9 +22,9 @@ { "title": "Set the username header as a string and get the first header as an object (string) and as XML", "description": "", - "code": "ws = createObject(\"webservice\", \"http://localhost/soapheaders/headerservice.cfc?WSDL\");\r\naddSOAPRequestHeader(ws, \"http://mynamespace/\", \"username\", \"tom\", false);\r\nret = ws.echo_me(\"argument\");\r\nheader = getSOAPResponseHeader(ws, \"http://www.tomj.org/myns\", \"returnheader\"); \r\nXMLheader = getSOAPResponseHeader(ws, \"http://www.tomj.org/myns\", \"returnheader\", true);", + "code": "ws = createObject(\"webservice\", \"http://localhost/soapheaders/headerservice.cfc?WSDL\");\naddSOAPRequestHeader(ws, \"http://mynamespace/\", \"username\", \"tom\", false);\nret = ws.echo_me(\"argument\");\nheader = getSOAPResponseHeader(ws, \"http://www.tomj.org/myns\", \"returnheader\"); \nXMLheader = getSOAPResponseHeader(ws, \"http://www.tomj.org/myns\", \"returnheader\", true);", "result": "", - "runnable":false + "runnable":false } ] } diff --git a/data/en/ajaxlink.json b/data/en/ajaxlink.json index b5e47480f..c3f0deb57 100644 --- a/data/en/ajaxlink.json +++ b/data/en/ajaxlink.json @@ -4,18 +4,14 @@ "syntax":"ajaxLink(url)", "returns":"void", "related":[], - "description":" Causes an HTML href attribute to display link results in the current Ajax container.", + "description":"Causes an HTML href attribute to display link results in the current Ajax container.", "params": [ {"name":"url","description":"The URL of the link.","required":true,"default":"","type":"string","values":[]} - ], "engines": { - "coldfusion": {"minimum_version":"", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-a-b/ajaxlink.html"}, + "coldfusion": {"minimum_version":"8", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-a-b/ajaxlink.html"}, "lucee": {"minimum_version":"", "notes":"", "docs":"https://docs.lucee.org/reference/functions/ajaxlink.html"}, "railo": {"minimum_version":"", "notes":"", "docs":"http://railodocs.org/index.cfm/function/ajaxlink"} }, - "links": [ - - ] - + "links": [] } diff --git a/data/en/ajaxonload.json b/data/en/ajaxonload.json index dabe50a02..1d857f421 100644 --- a/data/en/ajaxonload.json +++ b/data/en/ajaxonload.json @@ -4,18 +4,14 @@ "syntax":"ajaxOnLoad(functionName)", "returns":"void", "related":[], - "description":" Causes the specified JavaScript function to run when the page loads.", + "description":"Causes the specified JavaScript function to run when the page loads.", "params": [ {"name":"functionName","description":"The name of the function to run when the page loads.","required":true,"default":"","type":"string","values":[]} - ], "engines": { - "coldfusion": {"minimum_version":"", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-a-b/ajaxonload.html"}, + "coldfusion": {"minimum_version":"8", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-a-b/ajaxonload.html"}, "lucee": {"minimum_version":"", "notes":"", "docs":"https://docs.lucee.org/reference/functions/ajaxonload.html"}, "railo": {"minimum_version":"", "notes":"", "docs":"http://railodocs.org/index.cfm/function/ajaxonload"} }, - "links": [ - - ] - + "links": [] } diff --git a/data/en/arraycontains.json b/data/en/arraycontains.json index 000342748..e68044425 100644 --- a/data/en/arraycontains.json +++ b/data/en/arraycontains.json @@ -9,17 +9,14 @@ "params": [ {"name":"array","description":"The array in which to search.","required":true,"default":"","type":"array","values":[]}, {"name":"value","description":"The value to search for in the array.","required":true,"default":"","type":"any","values":[]}, - {"name":"substringMatch","description":" Lucee4.5+ If set to true then a substring match will also return an array position. This will only work with simple values. Passing true with complex objects will throw an exception.","required":false,"default":"false","type":"any","values":[]} - + {"name":"substringMatch","description":"Lucee4.5+ If set to true then a substring match will also return an array position. This will only work with simple values. Passing true with complex objects will throw an exception.","required":false,"default":"false","type":"any","values":[]} ], "engines": { - "coldfusion": {"minimum_version":"", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-a-b/arraycontains.html"}, + "coldfusion": {"minimum_version":"9", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-a-b/arraycontains.html"}, "lucee": {"minimum_version":"", "notes":"Returns the position of the array instead of boolean value.", "docs":"https://docs.lucee.org/reference/functions/arraycontains.html"}, "openbd": {"minimum_version":"", "notes":"", "docs":"http://openbd.org/manual/?/function/arraycontains"} }, - "links": [ - - ], + "links": [], "examples": [ { "title": "Array Contains", @@ -52,6 +49,4 @@ "result": "1" } ] - - } diff --git a/data/en/arraygetmetadata.json b/data/en/arraygetmetadata.json index c3a2313e1..472d05f56 100644 --- a/data/en/arraygetmetadata.json +++ b/data/en/arraygetmetadata.json @@ -12,7 +12,7 @@ "engines": { "coldfusion": {"minimum_version":"2016.0.2", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-a-b/arraygetmetadata.html"} }, - "links": [], + "links": [], "examples": [ { "title": "Simple Example", @@ -25,6 +25,13 @@ "description": "", "code": "// Create an array\narrayList = [\"apple\", \"pineapple\", \"mango\"];\n\n// Fetch meta data\ndata = arrayList.getMetadata();\n\n// Print array type\nwriteOutput(data.type);", "result": "synchronized" + }, + { + "title":"Dump Metadata of Typed Array (Member syntax)", + "description":"CF2018+ Return struct has a new key called `dimensions` and can also have a defined datatype. Supported datatypes are String, Numeric, Boolean, Date, Array, Struct, Query, Component, [Component name], Binary, and Function.", + "code":"arr = arrayNew['String'](1);\nwriteOutput(serializeJson(arr.getMetadata()));", + "result":"{\"dimensions\":1,\"datatype\":\"String\",\"type\":\"synchronized\"}", + "runnable": true } ] } diff --git a/data/en/decryptbinary.json b/data/en/decryptbinary.json index 215c4f2c4..8587fc9c4 100644 --- a/data/en/decryptbinary.json +++ b/data/en/decryptbinary.json @@ -4,18 +4,18 @@ "syntax":"decryptBinary(binaryData, key [, algorithm [, encoding] [, iv | salt [, iterations]]])", "returns":"string", "related":["encryptBinary","decrypt","encrypt"], - "description":" Decrypts encrypted binary data with the specified key, value, algorithm, salt, and iterations.", + "description":"Decrypts encrypted binary data with the specified key, value, algorithm, salt, and iterations.", "params": [ {"name":"binaryData","description":"Binary data to decrypt.","required":true,"default":"","type":"string","values":[]}, {"name":"key","description":"Key or seed used to encrypt the string.\n* For the `CFMX_COMPAT` algorithm, any combination of any number of characters; used as a seed used to generate a 32-bit encryption key.\n* For all other algorithms, a key in the format used by the algorithm. For these algorithms, use the `GenerateSecretKey` function to generate the key.","required":true,"default":"","type":"string","values":[]}, - {"name":"algorithm","description":"The algorithm to use to decrypt the string. Must be the same as the algorithm used to encrypt the string. See the `encrypt` function for additional algorithms.\nColdFusion Standard Edition installs the following algorithms:\n* CFMX_COMPAT: the algorithm used in ColdFusion MX and prior releases. This algorithm is the least secure option (default).\n* AES: the Advanced Encryption Standard specified by the National Institute of Standards and Technology (NIST) FIPS-197.\n* BLOWFISH: the Blowfish algorithm defined by Bruce Schneier.\n* DES: the Data Encryption Standard algorithm defined by NIST FIPS-46-3.\n* DESEDE: the \"Triple DES\" algorithm defined by NIST FIPS-46-3.\n\nNOTE: ColdFusion Enterprise Edition installs RSA BSafe Crypto-J library, which provides FIPS-140 Compliant Strong Cryptography. This also includes:\n* DESX: The extended Data Encryption Standard symmetric encryption algorithm.\n* RC2: The RC2 block symmetric encryption algorithm defined by RFC 2268.\n* RC4: The RC4 symmetric encryption algorithm.\n* RC5: The RC5 encryption algorithm.\n* PBE: Password-based encryption algorithm defined in PKCS #5.\n* AES/GCM/NoPadding: Encryption algorithm.\n\nNOTE: If you install additional cryptography algorithms, you can also specify any of its encryption and decryption algorithms.","required":false,"default":"CFMX_COMPAT","type":"string","values":["CFMX_COMPAT","AES","BLOWFISH","DES","DESEDE","DESX","RC2","RC4","RC5","PBE","AES/GCM/NoPadding"]}, + {"name":"algorithm","description":"The algorithm to use to decrypt the string. Must be the same as the algorithm used to encrypt the string. See the `encrypt` function for additional algorithms.\nColdFusion Standard Edition installs the following algorithms:\n* CFMX_COMPAT: the algorithm used in ColdFusion MX and prior releases. This algorithm is the least secure option and not recommended. (default).\n* AES: the Advanced Encryption Standard specified by the National Institute of Standards and Technology (NIST) FIPS-197.\n* BLOWFISH: the Blowfish algorithm defined by Bruce Schneier.\n* DES: the Data Encryption Standard algorithm defined by NIST FIPS-46-3.\n* DESEDE: the \"Triple DES\" algorithm defined by NIST FIPS-46-3.\n\nNOTE: ColdFusion Enterprise Edition installs RSA BSafe Crypto-J library, which provides FIPS-140 Compliant Strong Cryptography. This also includes:\n* DESX: The extended Data Encryption Standard symmetric encryption algorithm.\n* RC2: The RC2 block symmetric encryption algorithm defined by RFC 2268.\n* RC4: The RC4 symmetric encryption algorithm.\n* RC5: The RC5 encryption algorithm.\n* PBE: Password-based encryption algorithm defined in PKCS #5.\n* AES/GCM/NoPadding: Encryption algorithm.\n\nNOTE: If you install additional cryptography algorithms, you can also specify any of its encryption and decryption algorithms.","required":false,"default":"CFMX_COMPAT","type":"string","values":["CFMX_COMPAT","AES","BLOWFISH","DES","DESEDE","DESX","RC2","RC4","RC5","PBE","AES/GCM/NoPadding"]}, {"name":"encoding","description":"The binary encoding used to represent the data as a string. Must be the same as the algorithm used to encrypt the string.\n* Base64: the Base64 algorithm, as specified by IETF RFC 2045.\n* Hex: the characters A-F and 0-9 represent the hexadecimal byte values.\n* UU: the UNIX standard UUEncode algorithm (default).\n\nNOTE: If you specify this parameter, you must also specify the `algorithm` parameter.","required":false,"default":"UU","type":"string","values":["UU","Base64","Hex"]}, - {"name":"iv","description":"THIS PARAMETER IS MUTUALLY EXCLUSIVE WITH `SALT`.\n\nSpecify this parameter to adjust ColdFusion encryption to match the details of other encryption software.\n* For Block Encryption Algorithms: This is the binary Initialization Vector value to use with the algorithm. The algorithm must contain a Feedback Mode other than ECB. This must be a binary value that is exactly the same size as the algorithm block size.\nNOTE: If you specify this parameter, you must also specify the `algorithm` parameter.","required":false,"default":"","type":"binary","values":[]}, - {"name":"salt","description":"THIS PARAMETER IS MUTUALLY EXCLUSIVE WITH `IV`.\n\nSpecify this parameter to adjust ColdFusion encryption to match the details of other encryption software.\n* For Password Based Encryption Algorithms: This is the binary Salt value to transform the password into a key.\nNOTE: If you specify this parameter, you must also specify the `algorithm` parameter.","required":false,"default":"","type":"binary","values":[]}, + {"name":"iv","description":"THIS PARAMETER IS MUTUALLY EXCLUSIVE WITH `salt`.\n\nSpecify this parameter to adjust ColdFusion encryption to match the details of other encryption software.\n* For Block Encryption Algorithms: This is the binary Initialization Vector value to use with the algorithm. The algorithm must contain a Feedback Mode other than ECB. This must be a binary value that is exactly the same size as the algorithm block size.\nNOTE: If you specify this parameter, you must also specify the `algorithm` parameter.","required":false,"default":"","type":"binary","values":[]}, + {"name":"salt","description":"THIS PARAMETER IS MUTUALLY EXCLUSIVE WITH `iv`.\n\nSpecify this parameter to adjust ColdFusion encryption to match the details of other encryption software.\n* For Password Based Encryption Algorithms: This is the binary Salt value to transform the password into a key.\nNOTE: If you specify this parameter, you must also specify the `algorithm` parameter.","required":false,"default":"","type":"binary","values":[]}, {"name":"iterations","description":"The number of iterations to transform the password into a binary key. Specify this parameter to adjust ColdFusion encryption to match the details of other encryption software.\n\nNOTE: If you specify this parameter, you must also specify the `algorithm` parameter with a Password Based Encryption (PBE) algorithm.\nNOTE: This parameter is used with the `salt` parameter. Do not specify this parameter for Block Encryption Algorithms.\nNOTE: You must use the same value to encrypt and decrypt the data.","required":false,"default":"0","type":"numeric","values":[]} ], "engines": { - "coldfusion": {"minimum_version":"", "notes":"CF2018+ uses separate `iv` or `salt` named parameters.", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-c-d/DecryptBinary.html"}, + "coldfusion": {"minimum_version":"7.0.1", "notes":"CF2018+ uses separate `iv` or `salt` named parameters.", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-c-d/DecryptBinary.html"}, "lucee": {"minimum_version":"", "notes":"Uses `IVorSalt` parameter or aliases of `iv` and `salt`.", "docs":"https://docs.lucee.org/reference/functions/decryptbinary.html"}, "railo": {"minimum_version":"", "notes":"", "docs":"http://railodocs.org/index.cfm/function/decryptbinary"}, "openbd": {"minimum_version":"", "notes":"", "docs":"http://openbd.org/manual/?/function/decryptbinary"} diff --git a/data/en/encryptbinary.json b/data/en/encryptbinary.json index 213d8e5b6..b728107b1 100644 --- a/data/en/encryptbinary.json +++ b/data/en/encryptbinary.json @@ -3,18 +3,18 @@ "type":"function", "syntax":"encryptBinary(binaryData, key [, algorithm [, encoding] [, iv | salt [, iterations]]])", "returns":"string", - "related":["decryptBinary", "GenerateSecretKey"], + "related":["decryptBinary", "generateSecretKey"], "description":"Encrypts binary data using a specific algorithm and encoding method.", "params": [ {"name":"binaryData","description":"Binary data to encrypt.","required":true,"default":"","type":"any","values":[]}, {"name":"key","description":"Key or seed used to encrypt the string.\n* For the `CFMX_COMPAT` algorithm, any combination of any number of characters; used as a seed used to generate a 32-bit encryption key.\n* For all other algorithms, a key in the format used by the algorithm. For these algorithms, use the `GenerateSecretKey` function to generate the key.","required":true,"default":"","type":"string","values":[]}, {"name":"algorithm","description":"The algorithm to use to encrypt the string. \nColdFusion Standard Edition installs the following algorithms:\n* CFMX_COMPAT: the algorithm used in ColdFusion MX and prior releases. This algorithm is the least secure option (default).\n* AES: the Advanced Encryption Standard specified by the National Institute of Standards and Technology (NIST) FIPS-197.\n* BLOWFISH: the Blowfish algorithm defined by Bruce Schneier.\n* DES: the Data Encryption Standard algorithm defined by NIST FIPS-46-3.\n* DESEDE: the \"Triple DES\" algorithm defined by NIST FIPS-46-3.\n\nNOTE: ColdFusion Enterprise Edition installs RSA BSafe Crypto-J library, which provides FIPS-140 Compliant Strong Cryptography. This also includes:\n* DESX: The extended Data Encryption Standard symmetric encryption algorithm.\n* RC2: The RC2 block symmetric encryption algorithm defined by RFC 2268.\n* RC4: The RC4 symmetric encryption algorithm.\n* RC5: The RC5 encryption algorithm.\n* PBE: Password-based encryption algorithm defined in PKCS #5.\n* AES/GCM/NoPadding: Encryption algorithm. \nNOTE: If you install additional cryptography algorithms, you can also specify any of its encryption and decryption algorithms.","required":false,"default":"CFMX_COMPAT","type":"string","values":["CFMX_COMPAT","AES","BLOWFISH","DES","DESEDE","DESX","RC2","RC4","RC5","PBE","AES/GCM/NoPadding"]}, - {"name":"iv","description":"THIS PARAMETER IS MUTUALLY EXCLUSIVE WITH `SALT`.\n\nSpecify this parameter to adjust ColdFusion encryption to match the details of other encryption software.\n* For Block Encryption Algorithms: This is the binary Initialization Vector value to use with the algorithm. The algorithm must contain a Feedback Mode other than ECB. This must be a binary value that is exactly the same size as the algorithm block size.\nNOTE: If you specify this parameter, you must also specify the `algorithm` parameter.","required":false,"default":"","type":"binary","values":[]}, - {"name":"salt","description":"THIS PARAMETER IS MUTUALLY EXCLUSIVE WITH `IV`.\n\nSpecify this parameter to adjust ColdFusion encryption to match the details of other encryption software.\n* For Password Based Encryption Algorithms: This is the binary Salt value to transform the password into a key.\nNOTE: If you specify this parameter, you must also specify the `algorithm` parameter.","required":false,"default":"","type":"binary","values":[]}, + {"name":"iv","description":"THIS PARAMETER IS MUTUALLY EXCLUSIVE WITH `salt`.\n\nSpecify this parameter to adjust ColdFusion encryption to match the details of other encryption software.\n* For Block Encryption Algorithms: This is the binary Initialization Vector value to use with the algorithm. The algorithm must contain a Feedback Mode other than ECB. This must be a binary value that is exactly the same size as the algorithm block size.\nNOTE: If you specify this parameter, you must also specify the `algorithm` parameter.","required":false,"default":"","type":"binary","values":[]}, + {"name":"salt","description":"THIS PARAMETER IS MUTUALLY EXCLUSIVE WITH `iv`.\n\nSpecify this parameter to adjust ColdFusion encryption to match the details of other encryption software.\n* For Password Based Encryption Algorithms: This is the binary Salt value to transform the password into a key.\nNOTE: If you specify this parameter, you must also specify the `algorithm` parameter.","required":false,"default":"","type":"binary","values":[]}, {"name":"iterations","description":"The number of iterations to transform the password into a binary key. Specify this parameter to adjust ColdFusion encryption to match the details of other encryption software.\n\nNOTE: If you specify this parameter, you must also specify the `algorithm` parameter with a Password Based Encryption (PBE) algorithm.\nNOTE: This parameter is used with the `salt` parameter. Do not specify this parameter for Block Encryption Algorithms.\nNOTE: You must use the same value to encrypt and decrypt the data.","required":false,"default":"0","type":"numeric","values":[]} ], "engines": { - "coldfusion": {"minimum_version":"", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-e-g/encryptbinary.html"}, + "coldfusion": {"minimum_version":"7.0.1", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-e-g/encryptbinary.html"}, "lucee": {"minimum_version":"", "notes":"", "docs":"https://docs.lucee.org/reference/functions/encryptbinary.html"}, "railo": {"minimum_version":"", "notes":"", "docs":"http://railodocs.org/index.cfm/function/encryptbinary"}, "openbd": {"minimum_version":"", "notes":"", "docs":"http://openbd.org/manual/?/function/encryptbinary"} diff --git a/data/en/entitymerge.json b/data/en/entitymerge.json index 798ca2079..d3b737743 100644 --- a/data/en/entitymerge.json +++ b/data/en/entitymerge.json @@ -9,7 +9,7 @@ {"name":"entity","description":"The entity that must be attached to the ORM session.","required":true,"default":"","type":"variableName","values":[]} ], "engines": { - "coldfusion": {"minimum_version":"", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-e-g/entitymerge.html"}, + "coldfusion": {"minimum_version":"9", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-e-g/entitymerge.html"}, "lucee": {"minimum_version":"", "notes":"", "docs":"https://docs.lucee.org/reference/functions/entitymerge.html"}, "railo": {"minimum_version":"", "notes":"", "docs":"http://railodocs.org/index.cfm/function/entitymerge"} }, diff --git a/data/en/entityreload.json b/data/en/entityreload.json index 4b97ad775..49d7e3d60 100644 --- a/data/en/entityreload.json +++ b/data/en/entityreload.json @@ -9,7 +9,7 @@ {"name":"entity","description":"Name of the entity to be reloaded","required":true,"default":"","type":"variableName","values":[]} ], "engines": { - "coldfusion": {"minimum_version":"", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-e-g/entityreload.html"}, + "coldfusion": {"minimum_version":"9", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-e-g/entityreload.html"}, "lucee": {"minimum_version":"", "notes":"", "docs":"https://docs.lucee.org/reference/functions/entityreload.html"}, "railo": {"minimum_version":"", "notes":"", "docs":"http://railodocs.org/index.cfm/function/entityreload"} }, diff --git a/data/en/entitysave.json b/data/en/entitysave.json index e25d49af5..9dca6a671 100644 --- a/data/en/entitysave.json +++ b/data/en/entitysave.json @@ -10,7 +10,7 @@ {"name":"forceInsert","description":"If true, then ColdFusion always tries to insert the entity as a new record.","required":false,"default":"false","type":"boolean","values":[]} ], "engines": { - "coldfusion": {"minimum_version":"", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-e-g/entitysave.html"}, + "coldfusion": {"minimum_version":"9", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-e-g/entitysave.html"}, "lucee": {"minimum_version":"", "notes":"", "docs":"https://docs.lucee.org/reference/functions/entitysave.html"}, "railo": {"minimum_version":"", "notes":"", "docs":"http://railodocs.org/index.cfm/function/entitysave"} }, @@ -19,7 +19,7 @@ { "title":"Save a new ORM entity", "description":"Use entitySave to save a newly created entity.", - "code":"var company = entityNew(\"Company\");\r\ncompany.setName(form.companyName);\r\ncompany.setIndustry(form.industry);\r\ncompany.setEmployees(form.employeeCount);\r\ncompany.setWebsite(form.companyWebsite);\r\nentitySave(company);", + "code":"var company = entityNew(\"Company\");\ncompany.setName(form.companyName);\ncompany.setIndustry(form.industry);\ncompany.setEmployees(form.employeeCount);\ncompany.setWebsite(form.companyWebsite);\nentitySave(company);", "result":"", "runnable":false } diff --git a/data/en/getauthuser.json b/data/en/getauthuser.json index 61fd50a5d..e80dc67c6 100644 --- a/data/en/getauthuser.json +++ b/data/en/getauthuser.json @@ -4,17 +4,13 @@ "syntax":"getAuthUser()", "returns":"string", "related":[], - "description":" Gets the name of an authenticated user.", - "params": [ - ], + "description":"Gets the name of an authenticated user.", + "params": [], "engines": { - "coldfusion": {"minimum_version":"", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-e-g/getauthuser.html"}, + "coldfusion": {"minimum_version":"6", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-e-g/getauthuser.html"}, "lucee": {"minimum_version":"", "notes":"", "docs":"https://docs.lucee.org/reference/functions/getauthuser.html"}, "railo": {"minimum_version":"", "notes":"", "docs":"http://railodocs.org/index.cfm/function/getauthuser"}, "openbd": {"minimum_version":"", "notes":"", "docs":"http://openbd.org/manual/?/function/getauthuser"} }, - "links": [ - - ] - + "links": [] } diff --git a/data/en/getcomponentmetadata.json b/data/en/getcomponentmetadata.json index a9acb6f28..d32bc6434 100644 --- a/data/en/getcomponentmetadata.json +++ b/data/en/getcomponentmetadata.json @@ -4,12 +4,12 @@ "syntax":"getComponentMetadata(path)", "returns":"struct", "related":["componentCacheList","componentCacheClear","cfcomponent","cfcache"], - "description":" Gets metadata (such as the functions and implemented interfaces of a component) for a CFC or ColdFusion interface.", + "description":"Gets metadata (such as the functions and implemented interfaces of a component) for a CFC or ColdFusion interface.", "params": [ {"name":"path","description":"The dot-delimited path of the interface or CFC definition.","required":true,"default":"","type":"string","values":[]} ], "engines": { - "coldfusion": {"minimum_version":"", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-e-g/getcomponentmetadata.html"}, + "coldfusion": {"minimum_version":"8", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-e-g/getcomponentmetadata.html"}, "lucee": {"minimum_version":"", "notes":"", "docs":"https://docs.lucee.org/reference/functions/getcomponentmetadata.html"}, "railo": {"minimum_version":"", "notes":"", "docs":"http://railodocs.org/index.cfm/function/getcomponentmetadata"}, "openbd": {"minimum_version":"", "notes":"", "docs":"http://openbd.org/manual/?/function/getcomponentmetadata"} diff --git a/data/en/getcontextroot.json b/data/en/getcontextroot.json index f615561f6..aa5e542e4 100644 --- a/data/en/getcontextroot.json +++ b/data/en/getcontextroot.json @@ -4,10 +4,10 @@ "syntax":"getContextRoot()", "returns":"string", "related":["getCurrentContext"], - "description":" Returns path to the J2EE server context root for the current request.", + "description":"Returns path to the J2EE server context root for the current request.", "params": [], "engines": { - "coldfusion": {"minimum_version":"", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-e-g/getcontextroot.html"}, + "coldfusion": {"minimum_version":"7", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-e-g/getcontextroot.html"}, "lucee": {"minimum_version":"", "notes":"", "docs":"https://docs.lucee.org/reference/functions/getcontextroot.html"}, "railo": {"minimum_version":"", "notes":"", "docs":"http://railodocs.org/index.cfm/function/getcontextroot"}, "openbd": {"minimum_version":"", "notes":"", "docs":"http://openbd.org/manual/?/function/getcontextroot"} diff --git a/data/en/getencoding.json b/data/en/getencoding.json index f13af7348..38f9ddb85 100644 --- a/data/en/getencoding.json +++ b/data/en/getencoding.json @@ -1,22 +1,18 @@ { "name":"getEncoding", "type":"function", - "syntax":"getEncoding(scope_name)", + "syntax":"getEncoding(scope)", "returns":"string", "related":[], - "description":" Returns the encoding (character set) of the Form or URL scope.", + "description":"Returns the encoding (character set) of the Form or URL scope.", "params": [ - {"name":"scope_name","description":"","required":true,"default":"","type":"string","values":["form","url"]} - + {"name":"scope","description":"","required":true,"default":"","type":"string","values":["form","url"]} ], "engines": { - "coldfusion": {"minimum_version":"", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-e-g/getencoding.html"}, + "coldfusion": {"minimum_version":"6", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-e-g/getencoding.html"}, "lucee": {"minimum_version":"", "notes":"", "docs":"https://docs.lucee.org/reference/functions/getencoding.html"}, "railo": {"minimum_version":"", "notes":"", "docs":"http://railodocs.org/index.cfm/function/getencoding"}, "openbd": {"minimum_version":"", "notes":"", "docs":"http://openbd.org/manual/?/function/getencoding"} }, - "links": [ - - ] - + "links": [] } diff --git a/data/en/getgatewayhelper.json b/data/en/getgatewayhelper.json index 8a752af11..8291ff00c 100644 --- a/data/en/getgatewayhelper.json +++ b/data/en/getgatewayhelper.json @@ -4,16 +4,12 @@ "syntax":"getGatewayHelper(gatewayID)", "returns":"any", "related":[], - "description":" Gets a Java GatewayHelper object that provides methods\n and properties for use with a ColdFusion event gateway.", + "description":"Gets a Java GatewayHelper object that provides methods and properties for use with a ColdFusion event gateway.", "params": [ {"name":"gatewayID","description":"Identifier of the gateway that provides the GatewayHelper object.","required":true,"default":"","type":"string","values":[]} - ], "engines": { - "coldfusion": {"minimum_version":"", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-e-g/getgatewayhelper.html"} + "coldfusion": {"minimum_version":"7", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-e-g/getgatewayhelper.html"} }, - "links": [ - - ] - + "links": [] } diff --git a/data/en/getk2serverdoccount.json b/data/en/getk2serverdoccount.json index e74800bd5..fa79e035a 100644 --- a/data/en/getk2serverdoccount.json +++ b/data/en/getk2serverdoccount.json @@ -4,10 +4,10 @@ "syntax":"getK2ServerDocCount()", "returns":"numeric", "related":["getK2ServerDoccountLimit"], - "description":"Determines the number of documents that can be searched by the\n CFML registered K2 Server. This function is used\n primarily by the CFML Verity and K2Server Administrator\n pages, and requires significant processing time. Avoid using\n it in production applications. This function uses Verity\n K2Server Release K2.2.0.", + "description":"Determines the number of documents that can be searched by the CFML registered K2 Server. This function is used primarily by the CFML Verity and K2Server Administrator pages, and requires significant processing time. Avoid using it in production applications. This function uses Verity K2Server Release K2.2.0.", "params": [], "engines": { - "coldfusion": {"minimum_version":"", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-e-g/getk2serverdoccount.html", "deprecated":"6.1"}, + "coldfusion": {"minimum_version":"6", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-e-g/getk2serverdoccount.html", "deprecated":"6.1"}, "lucee": {"minimum_version":"", "notes":"", "docs":"https://docs.lucee.org/reference/functions/getk2serverdoccount.html"}, "railo": {"minimum_version":"", "notes":"", "docs":"http://railodocs.org/index.cfm/function/getk2serverdoccount"} }, diff --git a/data/en/getk2serverdoccountlimit.json b/data/en/getk2serverdoccountlimit.json index 89a653ff1..dcc497b95 100644 --- a/data/en/getk2serverdoccountlimit.json +++ b/data/en/getk2serverdoccountlimit.json @@ -4,10 +4,10 @@ "syntax":"getK2ServerDocCountLimit()", "returns":"numeric", "related":["getK2ServerDocCount"], - "description":"Gets the maximum number of documents that the CFML\n registered K2 Server is permitted to return from a search.\n This function is used primarily by the CFML Verity and\n K2Server Administrator pages. This function uses Verity\n K2Server Release K2.2.0.", + "description":"Gets the maximum number of documents that the CFML registered K2 Server is permitted to return from a search. This function is used primarily by the CFML Verity and K2Server Administrator pages. This function uses Verity K2Server Release K2.2.0.", "params": [], "engines": { - "coldfusion": {"minimum_version":"", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-e-g/getk2serverdoccountlimit.html", "deprecated":"6.1"}, + "coldfusion": {"minimum_version":"6", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-e-g/getk2serverdoccountlimit.html", "deprecated":"6.1"}, "lucee": {"minimum_version":"", "notes":"", "docs":"https://docs.lucee.org/reference/functions/getk2serverdoccountlimit.html"}, "railo": {"minimum_version":"", "notes":"", "docs":"http://railodocs.org/index.cfm/function/getk2serverdoccountlimit"} }, diff --git a/data/en/getlocaledisplayname.json b/data/en/getlocaledisplayname.json index 32e9f2c98..455543362 100644 --- a/data/en/getlocaledisplayname.json +++ b/data/en/getlocaledisplayname.json @@ -1,13 +1,16 @@ { "name":"getLocaleDisplayName", "type":"function", - "syntax":"getLocaleDisplayName()", + "syntax":"getLocaleDisplayName([locale, inLocale])", "returns":"string", "related":["getLocale","getLocaleInfo","getLocaleCountry","getLocaleLanguage"], - "description":" Gets a locale value and displays the name in a manner\n that is appropriate to a specific locale. By default,\n gets the current locale in the current locale's language.", - "params": [], + "description":"Gets a locale value and displays the name in a manner that is appropriate to a specific locale. By default, gets the current locale in the current locale's language.", + "params": [ + {"name":"locale","description":"The locale whose name you want. The default is the current ColdFusion locale, or if no ColdFusion locale has been set, the JVM locale.","required":false,"default":"","type":"string","values":[]}, + {"name":"inLocale","description":"The locale in which to return the name. The default is the current ColdFusion locale, or if no ColdFusion locale has been set, the JVM locale.","required":false,"default":"","type":"string","values":[]} + ], "engines": { - "coldfusion": {"minimum_version":"", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-e-g/getlocaledisplayname.html"}, + "coldfusion": {"minimum_version":"7", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-e-g/getlocaledisplayname.html"}, "lucee": {"minimum_version":"", "deprecated":"5", "notes":"Lucee5+ Deprecated in favor of getLocaleInfo()", "docs":"https://docs.lucee.org/reference/functions/getlocaledisplayname.html"}, "railo": {"minimum_version":"", "notes":"", "docs":"http://railodocs.org/index.cfm/function/getlocaledisplayname"}, "openbd": {"minimum_version":"", "notes":"", "docs":"http://openbd.org/manual/?/function/getlocaledisplayname"} @@ -16,7 +19,7 @@ "examples": [{ "title":"Output current Locale's display name than set it to swiss locale", "description":"", - "code":"writeOutput(getLocaleDisplayName());\r\nwriteOutput(' → ');\r\nsetLocale('de_ch');\r\nwriteOutput(getLocaleDisplayName());", + "code":"writeOutput(getLocaleDisplayName());\nwriteOutput(' → ');\nsetLocale('de_ch');\nwriteOutput(getLocaleDisplayName());", "result":"English (United States) → Deutsch (Schweiz)", "runnable":true }] diff --git a/data/en/getlocalhostip.json b/data/en/getlocalhostip.json index 65d1a7225..95fe15d80 100644 --- a/data/en/getlocalhostip.json +++ b/data/en/getlocalhostip.json @@ -4,10 +4,10 @@ "syntax":"getLocalhostIP()", "returns":"string", "related":["isIPInRange","isIPV6"], - "description":" Returns the localhost IP address, which is 127.0.0.1 for IPv4 and ::1 for IPv6 addresses.", + "description":"Returns the localhost IP address, which is 127.0.0.1 for IPv4 and ::1 for IPv6 addresses.", "params": [], "engines": { - "coldfusion": {"minimum_version":"", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-e-g/getlocalhostip.html"}, + "coldfusion": {"minimum_version":"7.0.1", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-e-g/getlocalhostip.html"}, "lucee": {"minimum_version":"", "notes":"", "docs":"https://docs.lucee.org/reference/functions/getlocalhostip.html"}, "railo": {"minimum_version":"", "notes":"", "docs":"http://railodocs.org/index.cfm/function/getlocalhostip"}, "openbd": {"minimum_version":"", "notes":"", "docs":"http://openbd.org/manual/?/function/getlocalhostip"} @@ -17,7 +17,7 @@ { "title": "getLocalhostIP Example", "description":"Here we've example to get localhost ip address using getLocalhostIP()", - "code":" writeOutput(getLocalhostIP()) ;" + "code":"writeOutput(getLocalhostIP());" } ] } diff --git a/data/en/getmetadata.json b/data/en/getmetadata.json index b1331a4a4..01b53a7c7 100644 --- a/data/en/getmetadata.json +++ b/data/en/getmetadata.json @@ -1,37 +1,27 @@ { "name":"getMetadata", "type":"function", - "syntax":"getMetadata(Object)", - "member":"arr.getMetadata()", + "syntax":"getMetadata(value)", "returns":"any", "related":["getFunctionData","getTagData","arrayGetMetadata"], - "description":" Gets metadata (the methods, properties, and parameters of a\n component) associated with an object that is deployed on the\n CFML server.", + "description":"Gets metadata (the methods, properties, and parameters of a component) associated with an object that is deployed on the CFML server.", "params": [ - {"name":"Object","description":"","required":true,"default":"","type":"any","values":[]} - + {"name":"value","description":"A ColdFusion component, user-defined function, or ColdFusion query. Within a CFC, the parameter can also specify the `this` scope.","required":true,"default":"","type":"any","values":[]} ], "engines": { - "coldfusion": {"minimum_version":"", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-e-g/getmetadata.html"}, + "coldfusion": {"minimum_version":"6", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-e-g/getmetadata.html"}, "lucee": {"minimum_version":"", "notes":"", "docs":"https://docs.lucee.org/reference/functions/getmetadata.html"}, "railo": {"minimum_version":"", "notes":"", "docs":"http://railodocs.org/index.cfm/function/getmetadata"}, "openbd": {"minimum_version":"", "notes":"", "docs":"http://openbd.org/manual/?/function/getmetadata"} }, - "links": [ - - ], + "links": [], "examples": [ { "title":"Dump Metadata of CFC Instance", "description":"CF9+", "code":"writeDump(getMetadata(new Query()));", - "result":"" - }, - { - "title":"Dump Metadata of Array", - "description":"CF2018+ Struct has a new key called dimensions and can also have a defined datatype. Supported datatypes are String, Numeric, Boolean, Date, Array, Struct, Query, Component, Binary, and Function.", - "code":"arr = arrayNew['String'](1);\nwriteDump(arr.getMetadata());", - "result":"" + "result":"", + "runnable": true } ] - } diff --git a/data/en/getprinterinfo.json b/data/en/getprinterinfo.json index 91305b468..35945bb49 100644 --- a/data/en/getprinterinfo.json +++ b/data/en/getprinterinfo.json @@ -9,13 +9,13 @@ {"name":"printer","description":"Name of the printer","required":false,"default":"","type":"string","values":[]} ], "engines": { - "coldfusion": {"minimum_version":"", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-e-g/getprinterinfo.html"} + "coldfusion": {"minimum_version":"8", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-e-g/getprinterinfo.html"} }, "links": [], "examples": [{ "title": "Output printer info if exists", "description": "", - "code": "try {\r\n writeDump(getPrinterInfo());\r\n}\r\ncatch (Application e) {\r\n writeOutput(e.message&\"
\"&e.detail);\r\n}\r\ncatch (any e) {\r\n rethrow;\r\n}", + "code": "try {\n\twriteDump(getPrinterInfo());\n}\ncatch (Application e) {\n\twriteOutput(e.message & \"
\" & e.detail);\n}\ncatch (any e) {\n\trethrow;\n}", "result": "", "runnable": true }] diff --git a/data/en/getprinterlist.json b/data/en/getprinterlist.json index 82d33b146..a8bc84e11 100644 --- a/data/en/getprinterlist.json +++ b/data/en/getprinterlist.json @@ -4,12 +4,12 @@ "syntax":"getPrinterList([delimiter])", "returns":"string", "related":["getPrinterInfo","cfprint"], - "description":" Returns list of printers accessible by the ColdFusion server", + "description":"Returns list of printers accessible by the ColdFusion server", "params": [ {"name":"delimiter","description":"list separator","required":false,"default":"","type":"string","values":[]} ], "engines": { - "coldfusion": {"minimum_version":"", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-e-g/getprinterlist.html"}, + "coldfusion": {"minimum_version":"8", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-e-g/getprinterlist.html"}, "lucee": {"minimum_version":"", "notes":"", "docs":"https://docs.lucee.org/reference/functions/getprinterlist.html"}, "railo": {"minimum_version":"", "notes":"", "docs":"http://railodocs.org/index.cfm/function/getprinterlist"} }, diff --git a/data/en/getprofilesections.json b/data/en/getprofilesections.json index e538be1e0..e2b6f660c 100644 --- a/data/en/getprofilesections.json +++ b/data/en/getprofilesections.json @@ -1,22 +1,19 @@ { "name":"getProfileSections", "type":"function", - "syntax":"getProfileSections(inifile)", + "syntax":"getProfileSections(path [,encoding])", "returns":"struct", "related":[], - "description":" Gets all the sections of an initialization file.\n An initialization file, as a struct whose format is as follows:\n - Each initialization file section name is a key in the\n struct\n - Each list of entries in a section of an initialization\n file is a value in the struct", + "description":"Gets all the sections of an initialization file.\nReturns a struct whose format is as follows:\n- Each initialization file section name is a key in the struct\n- Each list of entries in a section of an initialization file is a value in the struct", "params": [ - {"name":"inifile","description":"","required":true,"default":"","type":"string","values":[]} - + {"name":"path","description":"Absolute path of initialization file","required":true,"default":"","type":"string","values":[]}, + {"name":"encoding","description":"CF11+ Encoding of the initialization (ini) file","required":false,"default":"","type":"string","values":["utf-8","iso-8859-1","windows-1252","us-ascii","shift_jis","iso-2022-jp","euc-jp","euc-kr","big5","euc-cn","utf-16"]} ], "engines": { - "coldfusion": {"minimum_version":"", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-e-g/getprofilesections.html"}, + "coldfusion": {"minimum_version":"6", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-e-g/getprofilesections.html"}, "lucee": {"minimum_version":"", "notes":"", "docs":"https://docs.lucee.org/reference/functions/getprofilesections.html"}, "railo": {"minimum_version":"", "notes":"", "docs":"http://railodocs.org/index.cfm/function/getprofilesections"}, "openbd": {"minimum_version":"", "notes":"", "docs":"http://openbd.org/manual/?/function/getprofilesections"} }, - "links": [ - - ] - + "links": [] } diff --git a/data/en/getreadableimageformats.json b/data/en/getreadableimageformats.json index d16299acf..2eb4169b1 100644 --- a/data/en/getreadableimageformats.json +++ b/data/en/getreadableimageformats.json @@ -4,10 +4,10 @@ "syntax":"getReadableImageFormats()", "returns":"string", "related":["cfimage"], - "description":" Returns a list of image formats that ColdFusion can read on the operating system where ColdFusion is deployed.", + "description":"Returns a list of image formats that ColdFusion can read on the operating system where ColdFusion is deployed.", "params": [], "engines": { - "coldfusion": {"minimum_version":"", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-e-g/getreadableimageformats.html"}, + "coldfusion": {"minimum_version":"8", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-e-g/getreadableimageformats.html"}, "lucee": {"minimum_version":"", "notes":"", "docs":"https://docs.lucee.org/reference/functions/getreadableimageformats.html"}, "railo": {"minimum_version":"", "notes":"", "docs":"http://railodocs.org/index.cfm/function/getreadableimageformats"} }, @@ -15,7 +15,7 @@ "examples": [{ "title": "Show all available image file extensions", "description": "", - "code": "LCase(ListChangeDelims(getReadableImageFormats(),\", \"))", + "code": "lCase(listChangeDelims(getReadableImageFormats(),\", \"))", "result": "", "runnable": true }] diff --git a/data/en/getsoaprequest.json b/data/en/getsoaprequest.json index d035c9505..4fee7eb22 100644 --- a/data/en/getsoaprequest.json +++ b/data/en/getsoaprequest.json @@ -4,12 +4,12 @@ "syntax":"getSOAPRequest(webservice)", "returns":"any", "related":["getSOAPRequestHeader","getSOAPResponse","getSOAPResponseHeader"], - "description":" Returns an XML object that contains the entire SOAP\n request. Usually called from within a web service CFC.", + "description":"Returns an XML object that contains the entire SOAP request. Usually called from within a web service CFC.", "params": [ - {"name":"webservice","description":"A webservice object as returned from the cfobject tag or the CreateObject function","required":false,"default":"","type":"any","values":[]} + {"name":"webservice","description":"A webservice object as returned from the cfobject tag or the createObject function","required":false,"default":"","type":"any","values":[]} ], "engines": { - "coldfusion": {"minimum_version":"", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-e-g/getsoaprequest.html"}, + "coldfusion": {"minimum_version":"7", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-e-g/getsoaprequest.html"}, "lucee": {"minimum_version":"", "notes":"", "docs":"https://docs.lucee.org/reference/functions/getsoaprequest.html"}, "railo": {"minimum_version":"", "notes":"", "docs":"http://railodocs.org/index.cfm/function/getsoaprequest"}, "openbd": {"minimum_version":"", "notes":"", "docs":"http://openbd.org/manual/?/function/getsoaprequest"} @@ -18,8 +18,8 @@ "examples": [ { "title":"Create a SOAP call and retrieve the request", - "description":"Create a SOAP webservice to call, then we can use getSOAPRequest() to view the request", - "code":"soapURL = \"https://graphical.weather.gov/xml/SOAP_server/ndfdXMLserver.php?wsdl\";\r\nws = CreateObject(\"webservice\", soapURL);\r\nzipLatLong = ws.LatLonListZipCode(\"10001\");\r\nreq = getSOAPRequest(ws);\r\nwriteDump(req);", + "description":"Create a SOAP webservice to call, then we can use getSOAPRequest() to view the request", + "code":"soapURL = \"https://graphical.weather.gov/xml/SOAP_server/ndfdXMLserver.php?wsdl\";\nws = createObject(\"webservice\", soapURL);\nzipLatLong = ws.LatLonListZipCode(\"10001\");\nreq = getSOAPRequest(ws);\nwriteDump(req);", "result":"", "runnable":false } diff --git a/data/en/getsoaprequestheader.json b/data/en/getsoaprequestheader.json index f7bf3b8b3..42bd6a0c2 100644 --- a/data/en/getsoaprequestheader.json +++ b/data/en/getsoaprequestheader.json @@ -4,14 +4,14 @@ "syntax":"getSOAPRequestHeader(namespace, name [, asXML])", "returns":"any", "related":["getSOAPRequest","addSOAPRequestHeader","getSOAPResponse","getSOAPResponseHeader"], - "description":" Obtains a SOAP request header. Call only from within\n a CFC web service function that is processing a request\n as a SOAP web service.", + "description":"Obtains a SOAP request header. Call only from within a CFC web service function that is processing a request as a SOAP web service.", "params": [ {"name":"namespace","description":"A String that is the namespace for the header","required":true,"default":"","type":"string","values":[]}, {"name":"name","description":"A String that is the name of the header","required":true,"default":"","type":"string","values":[]}, - {"name":"asXML","description":"If True, the header is returned as a CFML XML object;\n if false (default), the header is returned as a Java object.","required":false,"default":"","type":"boolean","values":[true,false]} + {"name":"asXML","description":"If True, the header is returned as a CFML XML object;\n if false (default), the header is returned as a Java object.","required":false,"default":false,"type":"boolean","values":[]} ], "engines": { - "coldfusion": {"minimum_version":"", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-e-g/getsoaprequestheader.html"}, + "coldfusion": {"minimum_version":"7", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-e-g/getsoaprequestheader.html"}, "lucee": {"minimum_version":"", "notes":"", "docs":"https://docs.lucee.org/reference/functions/getsoaprequestheader.html"}, "railo": {"minimum_version":"", "notes":"", "docs":"http://railodocs.org/index.cfm/function/getsoaprequestheader"}, "openbd": {"minimum_version":"", "notes":"", "docs":"http://openbd.org/manual/?/function/getsoaprequestheader"} diff --git a/data/en/getsoapresponse.json b/data/en/getsoapresponse.json index f96778d2a..59fad2cba 100644 --- a/data/en/getsoapresponse.json +++ b/data/en/getsoapresponse.json @@ -4,12 +4,12 @@ "syntax":"getSOAPResponse(webservice)", "returns":"any", "related":["getSOAPRequest","getSOAPRequestHeader","getSOAPResponseHeader"], - "description":" Returns an XML object that contains the entire\n SOAP response after invoking a web service.", + "description":"Returns an XML object that contains the entire SOAP response after invoking a web service.", "params": [ - {"name":"webservice","description":"A webservice object as returned from the cfobject tag or the CreateObject function.","required":true,"default":"","type":"any","values":[]} + {"name":"webservice","description":"A webservice object as returned from the cfobject tag or the createObject function.","required":true,"default":"","type":"any","values":[]} ], "engines": { - "coldfusion": {"minimum_version":"", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-e-g/getsoapresponse.html"}, + "coldfusion": {"minimum_version":"7", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-e-g/getsoapresponse.html"}, "lucee": {"minimum_version":"", "notes":"", "docs":"https://docs.lucee.org/reference/functions/getsoapresponse.html"}, "railo": {"minimum_version":"", "notes":"", "docs":"http://railodocs.org/index.cfm/function/getsoapresponse"}, "openbd": {"minimum_version":"", "notes":"", "docs":"http://openbd.org/manual/?/function/getsoapresponse"} @@ -19,7 +19,7 @@ { "title":"Create a SOAP call and retrieve the response", "description":"Create a SOAP webservice to call, then we can use getSOAPResponse() to view the full response", - "code":"soapURL = \"https://graphical.weather.gov/xml/SOAP_server/ndfdXMLserver.php?wsdl\";\r\nws = CreateObject(\"webservice\", soapURL);\r\nzipLatLong = ws.LatLonListZipCode(\"10001\");\r\nres = getSOAPResponse(ws);\r\nwriteDump(res);", + "code":"soapURL = \"https://graphical.weather.gov/xml/SOAP_server/ndfdXMLserver.php?wsdl\";\nws = createObject(\"webservice\", soapURL);\nzipLatLong = ws.LatLonListZipCode(\"10001\");\nres = getSOAPResponse(ws);\nwriteDump(res);", "result":"", "runnable":false } diff --git a/data/en/getsoapresponseheader.json b/data/en/getsoapresponseheader.json index 348c3b292..3eab0078f 100644 --- a/data/en/getsoapresponseheader.json +++ b/data/en/getsoapresponseheader.json @@ -4,15 +4,15 @@ "syntax":"getSOAPResponseHeader(webservice, namespace, name [, asXML])", "returns":"any", "related":["getSOAPRequest","getSOAPRequestHeader","getSOAPResponse"], - "description":" Returns a SOAP response header. Call this function\n from within code that is invoking a web service after\n making a web service request.", + "description":"Returns a SOAP response header. Call this function from within code that is invoking a web service after making a web service request.", "params": [ - {"name":"webservice","description":"A webservice object as returned from the cfobject tag\n or the Createobject function.","required":true,"default":"","type":"any","values":[]}, + {"name":"webservice","description":"A webservice object as returned from the cfobject tag or the createObject function.","required":true,"default":"","type":"any","values":[]}, {"name":"namespace","description":"A String that is the namespace for the header.","required":true,"default":"","type":"string","values":[]}, {"name":"name","description":"A String that is the name of the SOAP header.","required":true,"default":"","type":"string","values":[]}, - {"name":"asXML","description":"If True, the header is returned as a CFML XML object;\n if false (default), the header is returned as a Java object.","required":false,"default":"","type":"boolean","values":[true,false]} + {"name":"asXML","description":"If True, the header is returned as a CFML XML object;\n if false (default), the header is returned as a Java object.","required":false,"default":false,"type":"boolean","values":[]} ], "engines": { - "coldfusion": {"minimum_version":"", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-e-g/getsoapresponseheader.html"}, + "coldfusion": {"minimum_version":"7", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-e-g/getsoapresponseheader.html"}, "lucee": {"minimum_version":"", "notes":"", "docs":"https://docs.lucee.org/reference/functions/getsoapresponseheader.html"}, "railo": {"minimum_version":"", "notes":"", "docs":"http://railodocs.org/index.cfm/function/getsoapresponseheader"}, "openbd": {"minimum_version":"", "notes":"", "docs":"http://openbd.org/manual/?/function/getsoapresponseheader"} diff --git a/data/en/getuserroles.json b/data/en/getuserroles.json index 0bbf59bc4..e9fb64d76 100644 --- a/data/en/getuserroles.json +++ b/data/en/getuserroles.json @@ -4,10 +4,10 @@ "syntax":"getUserRoles()", "returns":"string", "related":["isUserInAnyRole","isUserInRole"], - "description":" Retrieves the list of roles for the current user.", + "description":"Retrieves the list of roles for the current user.", "params": [], "engines": { - "coldfusion": {"minimum_version":"", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-e-g/getuserroles.html"}, + "coldfusion": {"minimum_version":"8", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-e-g/getuserroles.html"}, "lucee": {"minimum_version":"", "notes":"", "docs":"https://docs.lucee.org/reference/functions/getuserroles.html"}, "railo": {"minimum_version":"", "notes":"", "docs":"http://railodocs.org/index.cfm/function/getuserroles"} }, diff --git a/data/en/getvfsmetadata.json b/data/en/getvfsmetadata.json index 188806083..c84218165 100644 --- a/data/en/getvfsmetadata.json +++ b/data/en/getvfsmetadata.json @@ -4,18 +4,14 @@ "syntax":"getVFSMetadata(fileSystemType)", "returns":"struct", "related":[], - "description":" Returns metadata for VFS", + "description":"Returns metadata for VFS", "params": [ {"name":"fileSystemType","description":"","required":true,"default":"","type":"string","values":[]} - ], "engines": { - "coldfusion": {"minimum_version":"", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-e-g/getvfsmetadata.html"}, + "coldfusion": {"minimum_version":"9", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-e-g/getvfsmetadata.html"}, "lucee": {"minimum_version":"", "notes":"", "docs":"https://docs.lucee.org/reference/functions/getvfsmetadata.html"}, "railo": {"minimum_version":"", "notes":"", "docs":"http://railodocs.org/index.cfm/function/getvfsmetadata"} }, - "links": [ - - ] - + "links": [] } diff --git a/data/en/getwriteableimageformats.json b/data/en/getwriteableimageformats.json index 1f067a392..2955478c0 100644 --- a/data/en/getwriteableimageformats.json +++ b/data/en/getwriteableimageformats.json @@ -4,16 +4,12 @@ "syntax":"getWriteableImageFormats()", "returns":"string", "related":[], - "description":" No Help Available", - "params": [ - ], + "description":"Returns a list of image formats that ColdFusion can write on the operating system where ColdFusion is deployed.", + "params": [], "engines": { - "coldfusion": {"minimum_version":"", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-e-g/getwriteableimageformats.html"}, + "coldfusion": {"minimum_version":"8", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-e-g/getwriteableimageformats.html"}, "lucee": {"minimum_version":"", "notes":"", "docs":"https://docs.lucee.org/reference/functions/getwriteableimageformats.html"}, "railo": {"minimum_version":"", "notes":"", "docs":"http://railodocs.org/index.cfm/function/getwriteableimageformats"} }, - "links": [ - - ] - + "links": [] } diff --git a/data/en/imagesetantialiasing.json b/data/en/imagesetantialiasing.json index cde8112a7..9e72613bc 100644 --- a/data/en/imagesetantialiasing.json +++ b/data/en/imagesetantialiasing.json @@ -1,36 +1,34 @@ { "name":"imageSetAntialiasing", "type":"function", - "syntax":"imageSetAntialiasing(name [, antialias])", + "syntax":"imageSetAntialiasing(image [, antialias])", "member":"someImage.setAntialiasing(antialias)", "returns":"void", - "related":["ImageRotateDrawingAxis", "ImageSetBackgroundColor", "ImageSetDrawingColor", "ImageSetDrawingStroke", "ImageSetDrawingTransparency", "IsImageFile"], - "description":" Switches antialiasing on or off in rendered graphics.", + "related":["imageRotateDrawingAxis", "imageSetBackgroundColor", "imageSetDrawingColor", "imageSetDrawingStroke", "imageSetDrawingTransparency", "isImageFile"], + "description":"Switches antialiasing on or off in rendered graphics.", "params": [ - {"name":"name","description":"The ColdFusion image on which this operation is performed.","required":true,"default":"","type":"string","values":[]}, - {"name":"antialias","description":"Antialiasing switch","required":false,"default":"on","type":"boolean","values":["on","off"]} + {"name":"image","description":"The ColdFusion image on which this operation is performed.","required":true,"default":"","type":"string","values":[]}, + {"name":"antialias","description":"Antialiasing switch","required":false,"default":"on","type":"string","values":["on","true","off","false"]} ], "engines": { - "coldfusion": {"minimum_version":"", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-h-im/imagesetantialiasing.html"}, + "coldfusion": {"minimum_version":"8", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-h-im/imagesetantialiasing.html"}, "lucee": {"minimum_version":"", "notes":"", "docs":"https://docs.lucee.org/reference/functions/imagesetantialiasing.html"}, "railo": {"minimum_version":"", "notes":"", "docs":"http://railodocs.org/index.cfm/function/imagesetantialiasing"}, "openbd": {"minimum_version":"", "notes":"", "docs":"http://openbd.org/manual/?/function/imagesetantialiasing"} }, - "links": [ - - ], - "examples": [ + "links": [], + "examples": [ { "title": "Tag Syntax", "description": "This example shows how to turn off antialiasing for a ColdFusion image.", - "code": "< \r\n \r\n \r\n \r\n \r\n ", + "code": "\n\n\n\n\n", "result": "", "runnable":false }, { "title":"Using setAntialiasing member function", "description":"CF11+ Switch the antialiasing off", - "code":"imgObj = imageRead(\"http://cfdocs.org/apple-touch-icon.png\");\r\nimgObj.setAntialiasing('off');\r\ncfimage(action=\"writeToBrowser\", source=imgObj);", + "code":"imgObj = imageRead(\"https://cfdocs.org/apple-touch-icon.png\");\nimgObj.setAntialiasing('off');\ncfimage(action=\"writeToBrowser\", source=imgObj);", "result":"", "runnable":true } diff --git a/data/en/imagexordrawingmode.json b/data/en/imagexordrawingmode.json index b174c1ef9..1b9f24448 100644 --- a/data/en/imagexordrawingmode.json +++ b/data/en/imagexordrawingmode.json @@ -1,30 +1,27 @@ { "name":"imageXORDrawingMode", "type":"function", - "syntax":"imageXORDrawingMode(name, c1)", - "member":"someImage.xorDrawingMode(c1)", + "syntax":"imageXORDrawingMode(image, color)", + "member":"someImage.xorDrawingMode(color)", "returns":"void", "related":[], - "description":" Sets the paint mode of the image to alternate between the image's current color and the new specified color.", + "description":"Sets the paint mode of the image to alternate between the image's current color and the new specified color.", "params": [ - {"name":"name","description":"The image on which this operation is performed.","required":true,"default":"","type":"string","values":[]}, - {"name":"c1","description":"The color","required":true,"default":"black","type":"string","values":["Hexadecimal value of RGB color. For example, specify the color white as ##FFFFFF or FFFFFF.","String value of color (for example, 'black', 'red', 'green').","List of three numbers for (R,G,B) values. Each value must be in the range 0-255."]} - + {"name":"image","description":"The image on which this operation is performed.","required":true,"default":"","type":"string","values":[]}, + {"name":"color","description":"XOR alternation color. The values can be:\n- Hexadecimal value of the RGB color. For example, specify the color white as `##FFFFFF` or `FFFFFF`.\n- String value of color (for example, `black`, `red`, `green`).\n- List of three numbers for (R,G,B) values. Each value must be in the range 0-255.","required":true,"default":"black","type":"string","values":[]} ], "engines": { - "coldfusion": {"minimum_version":"", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-h-im/imagexordrawingmode.html"}, + "coldfusion": {"minimum_version":"8", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-h-im/imagexordrawingmode.html"}, "lucee": {"minimum_version":"", "notes":"", "docs":"https://docs.lucee.org/reference/functions/imagexordrawingmode.html"}, "railo": {"minimum_version":"", "notes":"", "docs":"http://railodocs.org/index.cfm/function/imagexordrawingmode"}, "openbd": {"minimum_version":"", "notes":"", "docs":"http://openbd.org/manual/?/function/imagexordrawingmode"} }, - "links": [ - - ], + "links": [], "examples": [ { "title":"Using xorDrawingMode member function", "description":"CF11+ Create a new image, set the xorDrawingMode to be the background color, draw a white rectangle, set drawing color to white, draw some points on the image. Where point pixels are the same as background color use XOR color", - "code":"imgObj = imageNew(\"\",152,152,\"rgb\",\"149c82\");\r\nimgObj.XORDrawingMode(\"149c82\");\r\nimgObj.setDrawingColor(\"white\");\r\nimgObj.drawRect(50,50,50,50,\"yes\");\r\nfor (i=1;i LTE 100;i=i+1) {\r\n x = randRange(0,152);\r\n y = randRange(0,152);\r\n imgObj.drawPoint(x,y);\r\n}\r\ncfimage(action=\"writeToBrowser\", source=imgObj);", + "code":"imgObj = imageNew(\"\",152,152,\"rgb\",\"149c82\");\nimgObj.xorDrawingMode(\"149c82\");\nimgObj.setDrawingColor(\"white\");\nimgObj.drawRect(50,50,50,50,\"yes\");\nfor (i=1;i LTE 100;i=i+1) {\n\tx = randRange(0,152);\n\ty = randRange(0,152);\n\timgObj.drawPoint(x,y);\n}\ncfimage(action=\"writeToBrowser\", source=imgObj);", "result":"", "runnable":true } diff --git a/data/en/isddx.json b/data/en/isddx.json index 5ca6a6dc6..1638602a7 100644 --- a/data/en/isddx.json +++ b/data/en/isddx.json @@ -3,17 +3,13 @@ "type":"function", "syntax":"isDDX(path)", "returns":"boolean", - "related":["IsPDFObject", "IsPDFFile", "cfpdf"], - "description":" Determines whether a DDX file exists and is valid, or if a string contains valid DDX instructions.", + "related":["isPDFObject", "isPDFFile", "cfpdf"], + "description":"Determines whether a DDX file exists and is valid, or if a string contains valid DDX instructions.", "params": [ {"name":"path","description":"Pathname to the DDX file or a string of DDX instructions.","required":true,"default":"","type":"string","values":[]} - ], "engines": { - "coldfusion": {"minimum_version":"", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-in-k/isddx.html"} + "coldfusion": {"minimum_version":"8", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-in-k/isddx.html"} }, - "links": [ - - ] - + "links": [] } diff --git a/data/en/isimage.json b/data/en/isimage.json index 6f5a34ea1..2c010b15b 100644 --- a/data/en/isimage.json +++ b/data/en/isimage.json @@ -1,16 +1,15 @@ { "name":"isImage", "type":"function", - "syntax":"isImage(name)", + "syntax":"isImage(value)", "returns":"boolean", - "related":["cfimage", "ImageGetBlob", "ImageInfo", "ImageNew"], - "description":" Determines whether a variable returns a ColdFusion image.", + "related":["cfimage", "imageGetBlob", "imageInfo", "imageNew"], + "description":"Determines whether a variable returns a ColdFusion image.", "params": [ - {"name":"name","description":"No Help Available","required":true,"default":"","type":"string","values":[]} - + {"name":"value","description":"The value that is checked.","required":true,"default":"","type":"any","values":[]} ], "engines": { - "coldfusion": {"minimum_version":"", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-in-k/isimage.html"}, + "coldfusion": {"minimum_version":"8", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-in-k/isimage.html"}, "lucee": {"minimum_version":"", "notes":"", "docs":"https://docs.lucee.org/reference/functions/isimage.html"}, "railo": {"minimum_version":"", "notes":"", "docs":"http://railodocs.org/index.cfm/function/isimage"}, "openbd": {"minimum_version":"", "notes":"", "docs":"http://openbd.org/manual/?/function/isimage"} @@ -18,13 +17,18 @@ "links": [], "examples": [ { - "title":"Simple Isimage Function", - "description":"Check the result is codfusion image or not", - "code":"\r\n\r\n\t\r\n", + "title":"Check local file image (Tag)", + "description":"If the local file is an image, write it to the browser", + "code":"\n\n\t\n", "result":"", "runnable":false + }, + { + "title":"Check online image (Script)", + "description":"Output whether the online file is an image", + "code":"isImage(imageRead(\"https://cfdocs.org/apple-touch-icon.png\");", + "result":true, + "runnable":true } - ] - } diff --git a/data/en/isimagefile.json b/data/en/isimagefile.json index c290561c7..1d6d96659 100644 --- a/data/en/isimagefile.json +++ b/data/en/isimagefile.json @@ -1,27 +1,33 @@ { "name":"isImageFile", "type":"function", - "syntax":"isImageFile(path)", + "syntax":"isImageFile(value)", "returns":"boolean", "related":["isPDFFile"], "description":"Verifies whether an image file is valid.", "params": [ - {"name":"path","description":"Pathname to an image file.","required":true,"default":"","type":"string","values":[]} + {"name":"value","description":"Pathname to an image file.","required":true,"default":"","type":"string","values":[]} ], "engines": { - "coldfusion": {"minimum_version":"", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-in-k/isimagefile.html"}, + "coldfusion": {"minimum_version":"8", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-in-k/isimagefile.html"}, "lucee": {"minimum_version":"", "notes":"", "docs":"https://docs.lucee.org/reference/functions/isimagefile.html"}, "railo": {"minimum_version":"", "notes":"", "docs":"http://railodocs.org/index.cfm/function/isimagefile"} }, "links": [], "examples": [ { - "title":"The simple isImageFile example", - "description":"Check the file is image or not.", - "code":"\r\n\r\n\t\r\n", + "title":"Check local file path (Tag)", + "description":"If the local file path is for an image, write the image to the browser", + "code":"\n\n\t\n", "result":"", "runnable":false + }, + { + "title":"Check URL (Script)", + "description":"Output whether the online file is an image", + "code":"isImageFile(\"https://cfdocs.org/apple-touch-icon.png\");", + "result":true, + "runnable":true } - ] } diff --git a/data/en/isinstanceof.json b/data/en/isinstanceof.json index 583d793b4..a838cf9aa 100644 --- a/data/en/isinstanceof.json +++ b/data/en/isinstanceof.json @@ -1,31 +1,28 @@ { "name":"isInstanceOf", "type":"function", - "syntax":"isInstanceOf(object, typename)", + "syntax":"isInstanceOf(value, type)", "returns":"boolean", - "related":["cfcomponent", "cfinterface", "cfobject"], - "description":" Determines whether an object is an instance of a ColdFusion interface or component, or of a Java class.", + "related":["cfcomponent","cfinterface","cfobject"], + "description":"Determines whether an object is an instance of a ColdFusion interface or component, or of a Java class.", "params": [ - {"name":"object","description":"The CFC instance or Java object that you are testing","required":true,"default":"","type":"any","values":[]}, - {"name":"typename","description":"The name of the interface, component, or Java class of which the object might be an instance","required":true,"default":"","type":"string","values":[]} - + {"name":"value","description":"The CFC instance or Java object that you are testing","required":true,"default":"","type":"any","values":[]}, + {"name":"type","description":"The name of the interface, component, or Java class of which the object might be an instance","required":true,"default":"","type":"string","values":[]} ], "engines": { - "coldfusion": {"minimum_version":"", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-in-k/isinstanceof.html"}, + "coldfusion": {"minimum_version":"8", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-in-k/isinstanceof.html"}, "lucee": {"minimum_version":"", "notes":"", "docs":"https://docs.lucee.org/reference/functions/isinstanceof.html"}, "railo": {"minimum_version":"", "notes":"", "docs":"http://railodocs.org/index.cfm/function/isinstanceof"}, "openbd": {"minimum_version":"", "notes":"", "docs":"http://openbd.org/manual/?/function/isinstanceof"} }, - "links": [ - - ], + "links": [], "examples": [ { "title":"Check if Date is instance of java.util.Date", "description":"Dates in CFML are instances of the java class: `java.util.Date`", - "code":"isInstanceOf(now(), \"java.util.Date\")", - "result":true + "code":"isInstanceOf(now(), \"java.util.Date\");", + "result":true, + "runnable":true } ] - } diff --git a/data/en/isipv6.json b/data/en/isipv6.json index 99c4b5f84..8e663ee48 100644 --- a/data/en/isipv6.json +++ b/data/en/isipv6.json @@ -1,25 +1,26 @@ { "name":"isIPV6", "type":"function", - "syntax":"isIPV6(IP)", + "syntax":"isIPV6(value)", "returns":"boolean", "related":["isIPInRange","getLocalhostIP"], - "description":" checks if given IP is of IPV6 format", + "description":"Checks if given IP is of IPV6 format", "params": [ - {"name":"IP","description":"ip address to check","required":true,"default":"","type":"string","values":[]} + {"name":"value","description":"IP address to check","required":true,"default":"","type":"string","values":[]} ], "engines": { - "coldfusion": {"minimum_version":"", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-in-k/isipv6.html"}, + "coldfusion": {"minimum_version":"9", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-in-k/isipv6.html"}, "lucee": {"minimum_version":"", "notes":"", "docs":"https://docs.lucee.org/reference/functions/isipv6.html"}, "railo": {"minimum_version":"", "notes":"", "docs":"http://railodocs.org/index.cfm/function/isipv6"} }, "links": [], "examples": [ { - "title": "isIPV6 Example", + "title":"isIPV6 Example", "description":"", - "code":" Address = \"127.0.0.1\";\r\n writeOutput(isIPV6(Address)) ;", - "result":"YES" + "code":"isIPV6(\"127.0.0.1\");", + "result":true, + "runnable":true } ] } diff --git a/data/en/isjson.json b/data/en/isjson.json index 1833ab4bf..143badd5a 100644 --- a/data/en/isjson.json +++ b/data/en/isjson.json @@ -1,15 +1,15 @@ { "name":"isJSON", "type":"function", - "syntax":"isJSON(var)", + "syntax":"isJSON(value)", "returns":"boolean", "related":["isXML","serializeJSON","deserializeJSON"], - "description":" Evaluates whether a string is in valid JSON (JavaScript Object Notation) data interchange format.", + "description":"Evaluates whether a string is in valid JSON (JavaScript Object Notation) data interchange format.", "params": [ - {"name":"var","description":"A string or variable that represents one.","required":true,"default":"","type":"string","values":[]} + {"name":"value","description":"A string or variable that represents one.","required":true,"default":"","type":"string","values":[]} ], "engines": { - "coldfusion": {"minimum_version":"", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-in-k/isjson.html"}, + "coldfusion": {"minimum_version":"8", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-in-k/isjson.html"}, "lucee": {"minimum_version":"", "notes":"", "docs":"https://docs.lucee.org/reference/functions/isjson.html"}, "railo": {"minimum_version":"", "notes":"", "docs":"http://railodocs.org/index.cfm/function/isjson"}, "openbd": {"minimum_version":"", "notes":"", "docs":"http://openbd.org/manual/?/function/isjson"} @@ -17,12 +17,12 @@ "links": [{ "title": "json.org — Introducing JSON", "description": "An overview about the JavaScript Object Notation", - "url": "http://json.org/" + "url": "https://www.json.org" }], "examples":[ { "title":"isJSON Example", - "description":"Returns true if the parameter is a valid JSON value. Returns False if the parameter is not a valid JSON data representation.", + "description":"Returns true when the argument is a valid JSON value.", "code":"isJSON(\"[1,2,3]\")", "result":true, "runnable":true diff --git a/data/en/islocalhost.json b/data/en/islocalhost.json index 2460b4a37..2f8f88f7f 100644 --- a/data/en/islocalhost.json +++ b/data/en/islocalhost.json @@ -1,16 +1,15 @@ { "name":"isLocalhost", "type":"function", - "syntax":"isLocalhost(ipaddress)", + "syntax":"isLocalhost(value)", "returns":"boolean", - "related":["GetLocalHostIP"], - "description":" Determines whether the specified IP address is the localhost.", + "related":["getLocalHostIP"], + "description":"Determines whether the specified value is the localhost.", "params": [ - {"name":"ipaddress","description":"Valid IP address.","required":true,"default":"","type":"string","values":[]} - + {"name":"value","description":"The value to check.","required":true,"default":"","type":"string","values":[]} ], "engines": { - "coldfusion": {"minimum_version":"", "notes":"7", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-in-k/islocalhost.html"}, + "coldfusion": {"minimum_version":"7.0.1", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-in-k/islocalhost.html"}, "lucee": {"minimum_version":"", "notes":"", "docs":"https://docs.lucee.org/reference/functions/islocalhost.html"}, "railo": {"minimum_version":"", "notes":"", "docs":"http://railodocs.org/index.cfm/function/islocalhost"}, "openbd": {"minimum_version":"", "notes":"", "docs":"http://openbd.org/manual/?/function/islocalhost"} @@ -46,12 +45,10 @@ }, { "title":"Is 8.8.8.8 localhost", - "description":"Not a localhost ip.", + "description":"Not a localhost IP.", "code":"isLocalHost(\"8.8.8.8\")", "result":false, "runnable":true } - ] - } diff --git a/data/en/isobject.json b/data/en/isobject.json index ba3bea7d8..55eaaac58 100644 --- a/data/en/isobject.json +++ b/data/en/isobject.json @@ -4,12 +4,12 @@ "syntax":"isObject(value)", "returns":"boolean", "related":["isStruct","isJSON","isSpreadsheetObject","isPDFObject"], - "description":" Determines whether a value is an object.\n True, if the value represents a CFML object. False if\n the value is any other type of data, such as an integer, string,\n date, or struct.", + "description":"Determines whether a value is an object.\nTrue, if the value represents a CFML object. False if the value is any other type of data, such as an integer, string, date, or struct.", "params": [ {"name":"value","description":"","required":true,"default":"","type":"any","values":[]} ], "engines": { - "coldfusion": {"minimum_version":"", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-in-k/isobject.html"}, + "coldfusion": {"minimum_version":"6", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-in-k/isobject.html"}, "lucee": {"minimum_version":"", "notes":"", "docs":"https://docs.lucee.org/reference/functions/isobject.html"}, "railo": {"minimum_version":"", "notes":"", "docs":"http://railodocs.org/index.cfm/function/isobject"}, "openbd": {"minimum_version":"", "notes":"", "docs":"http://openbd.org/manual/?/function/isobject"} @@ -19,14 +19,14 @@ { "title":"isObject Example", "description":"Returns true if the parameter is a CFML object. The CFML object here is a Java object.", - "code":"random = createObject( \"java\", \"java.security.SecureRandom\" ).getInstance( \"SHA1PRNG\" );\r\nwriteOutput( isObject( random ) );", + "code":"random = createObject( \"java\", \"java.security.SecureRandom\" ).getInstance( \"SHA1PRNG\" );\nwriteOutput( isObject( random ) );", "result":true, "runnable":true }, { "title":"isObject Example for Other Data Types", "description":"Returns false if the parameter is any data type other than a CFML object", - "code":"example = { 'name' = 'I am a struct' };\r\nwriteOutput( isObject( example ) );", + "code":"example = { 'name' = 'I am a struct' };\nwriteOutput( isObject( example ) );", "result":false, "runnable":true } diff --git a/data/en/ispdfobject.json b/data/en/ispdfobject.json index 4c4c8ce10..09626fc56 100644 --- a/data/en/ispdfobject.json +++ b/data/en/ispdfobject.json @@ -4,12 +4,12 @@ "syntax":"isPDFObject(value)", "returns":"boolean", "related":["isPDFFile","isSpreadsheetFile","isSpreadsheetObject"], - "description":" Determines whether a value is a PDF object.", + "description":"Determines whether a value is a PDF object.", "params": [ - {"name":"value","description":"A value, typically the PDF object stored as a variable name.","required":true,"default":"","type":"variableName","values":[]} + {"name":"value","description":"A value, typically the PDF object stored as a variable.","required":true,"default":"","type":"any","values":[]} ], "engines": { - "coldfusion": {"minimum_version":"", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-in-k/ispdfobject.html"}, + "coldfusion": {"minimum_version":"8", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-in-k/ispdfobject.html"}, "lucee": {"minimum_version":"", "notes":"", "docs":"https://docs.lucee.org/reference/functions/ispdfobject.html"}, "railo": {"minimum_version":"", "notes":"", "docs":"http://railodocs.org/index.cfm/function/ispdfobject"} }, diff --git a/data/en/issoaprequest.json b/data/en/issoaprequest.json index 5bf90cd28..9ef9d3283 100644 --- a/data/en/issoaprequest.json +++ b/data/en/issoaprequest.json @@ -3,18 +3,14 @@ "type":"function", "syntax":"isSOAPRequest()", "returns":"boolean", - "related":["AddSOAPRequestHeader", "AddSOAPResponseHeader", "GetSOAPRequest", "GetSOAPRequestHeader", "GetSOAPResponse"], - "description":" Determines whether a CFC is being called as a web service.", - "params": [ - ], + "related":["addSOAPRequestHeader","addSOAPResponseHeader","getSOAPRequest","getSOAPRequestHeader","getSOAPResponse"], + "description":"Determines whether a CFC is being called as a web service.", + "params": [], "engines": { - "coldfusion": {"minimum_version":"", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-in-k/issoaprequest.html"}, + "coldfusion": {"minimum_version":"7", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-in-k/issoaprequest.html"}, "lucee": {"minimum_version":"", "notes":"", "docs":"https://docs.lucee.org/reference/functions/issoaprequest.html"}, "railo": {"minimum_version":"", "notes":"", "docs":"http://railodocs.org/index.cfm/function/issoaprequest"}, "openbd": {"minimum_version":"", "notes":"", "docs":"http://openbd.org/manual/?/function/issoaprequest"} }, - "links": [ - - ] - + "links": [] } diff --git a/data/en/isspreadsheetfile.json b/data/en/isspreadsheetfile.json index dffa128a1..119932a28 100644 --- a/data/en/isspreadsheetfile.json +++ b/data/en/isspreadsheetfile.json @@ -1,22 +1,22 @@ { "name":"isSpreadsheetFile", "type":"function", - "syntax":"isSpreadsheetFile(file)", + "syntax":"isSpreadsheetFile(value)", "returns":"boolean", "related":["isPDFFile","isPDFObject","isSpreadsheetObject"], - "description":"Checks if given file is spreadsheet file or not", + "description":"Checks if the input is a spreadsheet file or not", "params": [ - {"name":"file","description":"Any file","required":true,"default":"","type":"string","values":[]} + {"name":"value","description":"A file path","required":true,"default":"","type":"string","values":[]} ], "engines": { - "coldfusion": {"minimum_version":"", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-in-k/isspreadsheetfile.html"} + "coldfusion": {"minimum_version":"9", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-in-k/isspreadsheetfile.html"} }, "links": [], "examples": [ { "title":"Simple isSpreadsheetFile example", - "description":"Here we have simple example to check the given file is spreadsheet or not.", - "code":"
\r\n\t\r\n\t\r\n
\r\n\r\n\r\n\t\r\n", + "description":"Here we have simple example to check if the given file is a spreadsheet or not.", + "code":"
\n\t\n\t\n
\n\n\t\n\t\t\n\t\n", "result":"", "runnable":false } diff --git a/data/en/isspreadsheetobject.json b/data/en/isspreadsheetobject.json index 5a4ce212a..750ffb054 100644 --- a/data/en/isspreadsheetobject.json +++ b/data/en/isspreadsheetobject.json @@ -1,15 +1,15 @@ { "name":"isSpreadsheetObject", "type":"function", - "syntax":"isSpreadsheetObject(object)", + "syntax":"isSpreadsheetObject(value)", "returns":"boolean", "related":["isPDFFile","isPDFObject","isSpreadsheetFile"], "description":"Checks if given object is spreadsheet object or not", "params": [ - {"name":"object","description":"Any Object","required":true,"default":"","type":"variableName","values":[]} + {"name":"value","description":"Any Object","required":true,"default":"","type":"any","values":[]} ], "engines": { - "coldfusion": {"minimum_version":"", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-in-k/isspreadsheetobject.html"}, + "coldfusion": {"minimum_version":"9", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-in-k/isspreadsheetobject.html"}, "openbd": {"minimum_version":"", "notes":"", "docs":"http://openbd.org/manual/?/function/isspreadsheetobject"} }, "links": [] diff --git a/data/en/isuserinanyrole.json b/data/en/isuserinanyrole.json index b000e515d..8eeac954d 100644 --- a/data/en/isuserinanyrole.json +++ b/data/en/isuserinanyrole.json @@ -1,15 +1,15 @@ { "name":"isUserInAnyRole", "type":"function", - "syntax":"isUserInAnyRole(roleList)", + "syntax":"isUserInAnyRole(value)", "returns":"boolean", "related":["getUserRoles","isUserInRole"], - "description":" Determines whether an authenticated user belongs to any role in a list of roles.", + "description":"Determines whether an authenticated user belongs to any role in a list of roles.", "params": [ - {"name":"roleList","description":"No Help Available","required":true,"default":"","type":"string","values":[]} + {"name":"value","description":"A comma-delimited list of one or more roles to be tested","required":true,"default":"","type":"string","values":[]} ], "engines": { - "coldfusion": {"minimum_version":"", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-in-k/isuserinanyrole.html"}, + "coldfusion": {"minimum_version":"8", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-in-k/isuserinanyrole.html"}, "lucee": {"minimum_version":"", "notes":"", "docs":"https://docs.lucee.org/reference/functions/isuserinanyrole.html"}, "railo": {"minimum_version":"", "notes":"", "docs":"http://railodocs.org/index.cfm/function/isuserinanyrole"} }, diff --git a/data/en/isuserinrole.json b/data/en/isuserinrole.json index 99f6de1c4..90badb9d8 100644 --- a/data/en/isuserinrole.json +++ b/data/en/isuserinrole.json @@ -1,15 +1,15 @@ { "name":"isUserInRole", "type":"function", - "syntax":"isUserInRole(role_name)", + "syntax":"isUserInRole(value)", "returns":"string", "related":["getUserRoles","isUserInAnyRole"], - "description":" Determines whether an authenticated user belongs to the\n specified Role.", + "description":"Determines whether an authenticated user belongs to the specified Role.", "params": [ - {"name":"role_name","description":"","required":true,"default":"","type":"string","values":[]} + {"name":"value","description":"Name of a security role","required":true,"default":"","type":"string","values":[]} ], "engines": { - "coldfusion": {"minimum_version":"", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-in-k/isuserinrole.html"}, + "coldfusion": {"minimum_version":"6", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-in-k/isuserinrole.html"}, "lucee": {"minimum_version":"", "notes":"", "docs":"https://docs.lucee.org/reference/functions/isuserinrole.html"}, "railo": {"minimum_version":"", "notes":"", "docs":"http://railodocs.org/index.cfm/function/isuserinrole"}, "openbd": {"minimum_version":"", "notes":"", "docs":"http://openbd.org/manual/?/function/isuserinrole"} diff --git a/data/en/isuserloggedin.json b/data/en/isuserloggedin.json index edae08429..88d44ba3e 100644 --- a/data/en/isuserloggedin.json +++ b/data/en/isuserloggedin.json @@ -3,18 +3,14 @@ "type":"function", "syntax":"isUserLoggedIn()", "returns":"boolean", - "related":["cflogin", "cfloginuser", "GetAuthUser", "GetUserRoles", "IsUserInAnyRole", "IsUserInRole"], - "description":" Determines whether a user is logged in.", - "params": [ - ], + "related":["cflogin","cfloginuser","getAuthUser","getUserRoles","isUserInAnyRole","isUserInRole"], + "description":"Determines whether a user is logged in.", + "params": [], "engines": { - "coldfusion": {"minimum_version":"", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-in-k/isuserloggedin.html"}, + "coldfusion": {"minimum_version":"8", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-in-k/isuserloggedin.html"}, "lucee": {"minimum_version":"", "notes":"", "docs":"https://docs.lucee.org/reference/functions/isuserloggedin.html"}, "railo": {"minimum_version":"", "notes":"", "docs":"http://railodocs.org/index.cfm/function/isuserloggedin"}, "openbd": {"minimum_version":"", "notes":"", "docs":"http://openbd.org/manual/?/function/isuserloggedin"} }, - "links": [ - - ] - + "links": [] } diff --git a/data/en/isxml.json b/data/en/isxml.json index c46f7723b..1d2eeb561 100644 --- a/data/en/isxml.json +++ b/data/en/isxml.json @@ -4,12 +4,13 @@ "syntax":"isXML(value)", "returns":"boolean", "related":["isJSON"], - "description":" Determines whether a string is well-formed XML text.", + "description":"Determines whether a string is well-formed XML text.", "params": [ - {"name":"value","description":"A string containing the XML document text.","required":true,"default":"","type":"string","values":[]} + {"name":"value","description":"A string containing the XML document text.","required":true,"default":"","type":"string","values":[]}, + {"name":"parserOptions","description":"XML parsing options. No documentation available on usage.","required":false,"default":"","type":"struct","values":[]} ], "engines": { - "coldfusion": {"minimum_version":"", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-in-k/isxml.html"}, + "coldfusion": {"minimum_version":"7", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-in-k/isxml.html"}, "lucee": {"minimum_version":"", "notes":"", "docs":"https://docs.lucee.org/reference/functions/isxml.html"}, "railo": {"minimum_version":"", "notes":"", "docs":"http://railodocs.org/index.cfm/function/isxml"}, "openbd": {"minimum_version":"", "notes":"", "docs":"http://openbd.org/manual/?/function/isxml"} @@ -19,14 +20,14 @@ { "title":"isXML Example", "description":"Returns true if the string is well-formed XML.", - "code":"example = '\r\n \r\n Adobe ColdFusion\r\n \r\n \r\n Lucee\r\n \r\n \r\n Railo\r\n \r\n \r\n Open BlueDragon\r\n \r\n';\r\nwriteOutput( isXml( example ) );", + "code":"example = '\n \n Adobe ColdFusion\n \n \n Lucee\n \n \n Railo\n \n \n Open BlueDragon\n \n';\nwriteOutput( isXml( example ) );", "result":true, "runnable":true }, { "title":"isXML Example for Invalid XML", "description":"Returns false if the string is not well-formed XML.", - "code":"example1 = '\r\n \r\n Adobe ColdFusion\r\n \r\n \r\n Lucee';\r\nwriteOutput( isXml( example1 ) );", + "code":"example1 = '\n \n Adobe ColdFusion\n \n \n Lucee';\nwriteOutput( isXml( example1 ) );", "result":false, "runnable":true } diff --git a/data/en/isxmlattribute.json b/data/en/isxmlattribute.json index 0bc0d3674..6f4b9981a 100644 --- a/data/en/isxmlattribute.json +++ b/data/en/isxmlattribute.json @@ -4,12 +4,12 @@ "syntax":"isXMLAttribute(value)", "returns":"boolean", "related":["isXMLNode","isXMLElement","isXML"], - "description":" Determines whether the function parameter is an\n XML Document Object Model (DOM) attribute node.", + "description":"Determines whether the function parameter is an XML Document Object Model (DOM) attribute node.", "params": [ {"name":"value","description":"Name of an XML attribute.","required":true,"default":"","type":"any","values":[]} ], "engines": { - "coldfusion": {"minimum_version":"", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-in-k/isxmlattribute.html"}, + "coldfusion": {"minimum_version":"7", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-in-k/isxmlattribute.html"}, "lucee": {"minimum_version":"", "notes":"", "docs":"https://docs.lucee.org/reference/functions/isxmlattribute.html"}, "railo": {"minimum_version":"", "notes":"", "docs":"http://railodocs.org/index.cfm/function/isxmlattribute"}, "openbd": {"minimum_version":"", "notes":"", "docs":"http://openbd.org/manual/?/function/isxmlattribute"} diff --git a/data/en/isxmldoc.json b/data/en/isxmldoc.json index 61ab744ae..bf828485d 100644 --- a/data/en/isxmldoc.json +++ b/data/en/isxmldoc.json @@ -4,12 +4,12 @@ "syntax":"isXMLDoc(value)", "returns":"boolean", "related":["isXML"], - "description":"Determines whether a function parameter is an Extended Markup\n language (XML) document object.", + "description":"Determines whether a function parameter is an Extended Markup language (XML) document object.", "params": [ {"name":"value","description":"XML document","required":true,"default":"","type":"any","values":[]} ], "engines": { - "coldfusion": {"minimum_version":"", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-in-k/isxmldoc.html"}, + "coldfusion": {"minimum_version":"6", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-in-k/isxmldoc.html"}, "lucee": {"minimum_version":"", "notes":"", "docs":"https://docs.lucee.org/reference/functions/isxmldoc.html"}, "railo": {"minimum_version":"", "notes":"", "docs":"http://railodocs.org/index.cfm/function/isxmldoc"}, "openbd": {"minimum_version":"", "notes":"", "docs":"http://openbd.org/manual/?/function/isxmldoc"} diff --git a/data/en/isxmlelem.json b/data/en/isxmlelem.json index 270247e30..4c22dcc6b 100644 --- a/data/en/isxmlelem.json +++ b/data/en/isxmlelem.json @@ -9,7 +9,7 @@ {"name":"value","description":"XML Element","required":true,"default":"","type":"any","values":[]} ], "engines": { - "coldfusion": {"minimum_version":"", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-in-k/isxmlelem.html"}, + "coldfusion": {"minimum_version":"6", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-in-k/isxmlelem.html"}, "lucee": {"minimum_version":"", "notes":"", "docs":"https://docs.lucee.org/reference/functions/isxmlelem.html"}, "railo": {"minimum_version":"", "notes":"", "docs":"http://railodocs.org/index.cfm/function/isxmlelem"}, "openbd": {"minimum_version":"", "notes":"", "docs":"http://openbd.org/manual/?/function/isxmlelem"} diff --git a/data/en/isxmlnode.json b/data/en/isxmlnode.json index 5e7a409bc..e9036d257 100644 --- a/data/en/isxmlnode.json +++ b/data/en/isxmlnode.json @@ -4,12 +4,12 @@ "syntax":"isXMLNode(value)", "returns":"boolean", "related":["isXML","isXMLDoc","isXMLElem"], - "description":" Determines whether the function parameter is\n an XML document object node.", + "description":"Determines whether the function parameter is an XML document object node.", "params": [ {"name":"value","description":"XML document object node.","required":true,"default":"","type":"any","values":[]} ], "engines": { - "coldfusion": {"minimum_version":"", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-in-k/isxmlnode.html"}, + "coldfusion": {"minimum_version":"7", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-in-k/isxmlnode.html"}, "lucee": {"minimum_version":"", "notes":"", "docs":"https://docs.lucee.org/reference/functions/isxmlnode.html"}, "railo": {"minimum_version":"", "notes":"", "docs":"http://railodocs.org/index.cfm/function/isxmlnode"}, "openbd": {"minimum_version":"", "notes":"", "docs":"http://openbd.org/manual/?/function/isxmlnode"} diff --git a/data/en/isxmlroot.json b/data/en/isxmlroot.json index cd44f3554..bc3987eb2 100644 --- a/data/en/isxmlroot.json +++ b/data/en/isxmlroot.json @@ -4,12 +4,12 @@ "syntax":"isXMLRoot(value)", "returns":"boolean", "related":["isXML","isXMLDoc","isXMLElem","isXMLNode"], - "description":" Determines whether a function parameter is the root element of\n an Extended Markup language (XML) document object.", + "description":"Determines whether a function parameter is the root element of an Extended Markup language (XML) document object.", "params": [ {"name":"value","description":"XML Element","required":true,"default":"","type":"any","values":[]} ], "engines": { - "coldfusion": {"minimum_version":"", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-in-k/isxmlroot.html"}, + "coldfusion": {"minimum_version":"6", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-in-k/isxmlroot.html"}, "lucee": {"minimum_version":"", "notes":"", "docs":"https://docs.lucee.org/reference/functions/isxmlroot.html"}, "railo": {"minimum_version":"", "notes":"", "docs":"http://railodocs.org/index.cfm/function/isxmlroot"}, "openbd": {"minimum_version":"", "notes":"", "docs":"http://openbd.org/manual/?/function/isxmlroot"} diff --git a/data/en/location.json b/data/en/location.json index f5183ce6b..32522a607 100644 --- a/data/en/location.json +++ b/data/en/location.json @@ -3,16 +3,15 @@ "type":"function", "syntax":"location(url [, addtoken] [, statuscode])", "returns":"void", - "related":["cfscript", "cflocation"], - "description":" Stops execution of the current page and opens a CFML page or HTML file.", + "related":["cfscript","cflocation"], + "description":"Stops execution of the current page and redirects to the given URL.", "params": [ - {"name":"url","description":"URL of HTML file or CFML page to open.","required":true,"default":"","type":"string","values":[]}, - {"name":"addtoken","description":"clientManagement must be enabled (see cfapplication).","required":false,"default":"","type":"boolean","values":[true,false]}, - {"name":"statuscode","description":"The HTTP status code","required":false,"default":"","type":"numeric","values":[]} - + {"name":"url","description":"URL of web page to open.","required":true,"default":"","type":"string","values":[]}, + {"name":"addtoken","description":"clientManagement must be enabled (see cfapplication).","required":false,"default":true,"type":"boolean","values":[]}, + {"name":"statuscode","description":"The HTTP status code","required":false,"default":302,"type":"numeric","values":[300,301,302,303,304,305,306,307]} ], "engines": { - "coldfusion": {"minimum_version":"", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-l/location.html"}, + "coldfusion": {"minimum_version":"9", "notes":"Implemented as both a function and an alias to the cflocation tag in script, so named parameters can be used prior to CF2018+. CF11+ `addtoken` default value is `false` when Secure Profile is enabled", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-l/location.html"}, "lucee": {"minimum_version":"", "notes":"", "docs":"https://docs.lucee.org/reference/functions/location.html"}, "railo": {"minimum_version":"", "notes":"", "docs":"http://railodocs.org/index.cfm/function/location"}, "openbd": {"minimum_version":"", "notes":"", "docs":"http://openbd.org/manual/?/function/location"} @@ -21,12 +20,9 @@ { "title": "Simple Example", "description": "Relocates to a different page if user is not logged in.", - "code": "if(!structKeyExists(session, \"userID\") {\n location(\"login.cfm\");\n}", + "code": "if (!structKeyExists(session, \"userID\") {\n\tlocation(\"login.cfm\");\n}", "result": "" } ], - "links": [ - - ] - + "links": [] } diff --git a/data/en/objectequals.json b/data/en/objectequals.json index 9d9db989b..cc54bdd8f 100644 --- a/data/en/objectequals.json +++ b/data/en/objectequals.json @@ -1,31 +1,27 @@ { "name":"objectEquals", "type":"function", - "syntax":"objectEquals(Param1, Param2)", + "syntax":"objectEquals(clientobject, originalobject)", "returns":"boolean", "related":[], - "description":" No Help Available", + "description":"Identifies any conflict between CFC instances on the client and the server.", "params": [ - {"name":"Param1","description":"New instance of the CFC on the client.","required":true,"default":"","type":"variableName","values":[]}, - {"name":"Param2","description":"Original instance of the CFC.","required":true,"default":"","type":"variableName","values":[]} - + {"name":"clientobject","description":"New instance of the CFC on the client.","required":true,"default":"","type":"any","values":[]}, + {"name":"originalobject","description":"Original instance of the CFC.","required":true,"default":"","type":"any","values":[]} ], "engines": { - "coldfusion": {"minimum_version":"", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-m-r/objectequals.html"}, + "coldfusion": {"minimum_version":"9", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-m-r/objectequals.html"}, "lucee": {"minimum_version":"", "notes":"", "docs":"https://docs.lucee.org/reference/functions/objectequals.html"}, "railo": {"minimum_version":"", "notes":"", "docs":"http://railodocs.org/index.cfm/function/objectequals"} }, - "links": [ - - ], + "links": [], "examples": [ { "title":"Tag Example", - "description":" ", - "code":" \r\n ", + "description":"", + "code":"\n", "result":"", "runnable":false } ] - } diff --git a/data/en/ormclearsession.json b/data/en/ormclearsession.json index ea7f79d20..467253275 100644 --- a/data/en/ormclearsession.json +++ b/data/en/ormclearsession.json @@ -6,16 +6,14 @@ "related":[], "description":"ORMClearSession removes all the entities that are loaded or created in the session. This clears the first level cache and removes the objects that are not yet saved to the database.", "params": [ - {"name":"datasource","description":"datasource used for the session, if nor defined the datasource defined in application.cfc/cfapplication is used.","required":false,"default":"","type":"string","values":[]} + {"name":"datasource","description":"Name of the data source used for the session. If not defined, the default datasource defined in Application.cfc/cfapplication is used.","required":false,"default":"","type":"string","values":[]} ], "engines": { - "coldfusion": {"minimum_version":"", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-m-r/ormclearsession.html"}, + "coldfusion": {"minimum_version":"9", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-m-r/ormclearsession.html"}, "lucee": {"minimum_version":"", "notes":"", "docs":"https://docs.lucee.org/reference/functions/ormclearsession.html"}, "railo": {"minimum_version":"", "notes":"", "docs":"http://railodocs.org/index.cfm/function/ormclearsession"} }, - "links": [ - - ], + "links": [], "examples": [ { "title": "Clears the Hibernate session associated with the datasource from the application.", @@ -25,5 +23,4 @@ "runnable": false } ] - } diff --git a/data/en/ormclosesession.json b/data/en/ormclosesession.json index c1a96bae6..124da513a 100644 --- a/data/en/ormclosesession.json +++ b/data/en/ormclosesession.json @@ -3,19 +3,17 @@ "type":"function", "syntax":"ormCloseSession([datasource])", "returns":"void", - "related":["ORMGetSession", "ORMClearSession", "ORMFlush", "ORMGetSessionFactory", "ORMCloseAllSession"], + "related":["ormGetSession","ormClearSession","ormFlush","ormGetSessionFactory","ormCloseAllSession"], "description":"Closes the current ORM session for the given datasource. When the datasource argument is not passed then it uses the default datasource defined in Application.cfc.", "params": [ {"name":"datasource","description":"Name of the datasource for the ORM session","required":false,"default":"","type":"string","values":[]} ], "engines": { - "coldfusion": {"minimum_version":"", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-m-r/ormclosesession.html"}, + "coldfusion": {"minimum_version":"9", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-m-r/ormclosesession.html"}, "lucee": {"minimum_version":"", "notes":"", "docs":"https://docs.lucee.org/reference/functions/ormclosesession.html"}, "railo": {"minimum_version":"", "notes":"", "docs":"http://railodocs.org/index.cfm/function/ormclosesession"} }, - "links": [ - - ], + "links": [], "examples": [ { "title": "Closes the Hibernate session associated with the datasource from the application.", @@ -25,5 +23,4 @@ "runnable": false } ] - } diff --git a/data/en/ormevictcollection.json b/data/en/ormevictcollection.json index 1a2677a8a..d9abd4ddb 100644 --- a/data/en/ormevictcollection.json +++ b/data/en/ormevictcollection.json @@ -1,32 +1,28 @@ { "name":"ormEvictCollection", "type":"function", - "syntax":"ormEvictCollection(componentName, relationName [, id])", + "syntax":"ormEvictCollection(entityName, collectionName [, primaryKey])", "returns":"void", - "related":["ORMEvictEntity", "ORMEvictQueries"], - "description":"This will remove all the entries with the specified relation/collection name in the specified component. \normEvictCollection(componentName,relationName,[id])", + "related":["ormEvictEntity","ormEvictQueries"], + "description":"This will remove all the entries with the specified relation/collection name in the specified component.", "params": [ - {"name":"componentName","description":"No Help Available","required":true,"default":"","type":"string","values":[]}, - {"name":"relationName","description":"No Help Available","required":true,"default":"","type":"string","values":[]}, - {"name":"id","description":"No Help Available","required":false,"default":"","type":"string","values":[]} - + {"name":"entityName","description":"Entity name of the persistent CFC","required":true,"default":"","type":"string","values":[]}, + {"name":"collectionName","description":"Name of the collection in the component","required":true,"default":"","type":"string","values":[]}, + {"name":"primaryKey","description":"Primary key of the collection or association data of the entity","required":false,"default":"","type":"string","values":[]} ], "engines": { - "coldfusion": {"minimum_version":"", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-m-r/ormevictcollection.html"}, + "coldfusion": {"minimum_version":"9", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-m-r/ormevictcollection.html"}, "lucee": {"minimum_version":"", "notes":"", "docs":"https://docs.lucee.org/reference/functions/ormevictcollection.html"}, "railo": {"minimum_version":"", "notes":"", "docs":"http://railodocs.org/index.cfm/function/ormevictcollection"} }, - "links": [ - - ], + "links": [], "examples": [ { "title":"Tag Example", - "description":"To evict all the association or collection data of collection arts belonging to the component CArtists: ", - "code":" ", + "description":"To evict all the association or collection data of collection `arts` belonging to the component `CArtists`", + "code":"", "result":"", "runnable":false } ] - } diff --git a/data/en/ormevictentity.json b/data/en/ormevictentity.json index 45a6a9638..22aeded23 100644 --- a/data/en/ormevictentity.json +++ b/data/en/ormevictentity.json @@ -1,38 +1,34 @@ { "name":"ormEvictEntity", "type":"function", - "syntax":"ormEvictEntity(componentName [, id])", + "syntax":"ormEvictEntity(entityName [, primaryKey])", "returns":"void", - "related":["ORMEvictCollection", "ORMEvictQueries"], - "description":" This will remove all the entries for the specified component name from the entity cache.\normEvictEntity(componentName,[id])", + "related":["ormEvictCollection","ormEvictQueries"], + "description":"This will remove all the entries for the specified component name from the entity cache.", "params": [ - {"name":"componentName","description":"No Help Available","required":true,"default":"","type":"string","values":[]}, - {"name":"id","description":"No Help Available","required":false,"default":"","type":"string","values":[]} - + {"name":"entityName","description":"Entity name of the persistent CFC","required":true,"default":"","type":"string","values":[]}, + {"name":"primaryKey","description":"Primary key value of the component","required":false,"default":"","type":"string","values":[]} ], "engines": { - "coldfusion": {"minimum_version":"", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-m-r/ormevictentity.html"}, + "coldfusion": {"minimum_version":"9", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-m-r/ormevictentity.html"}, "lucee": {"minimum_version":"", "notes":"", "docs":"https://docs.lucee.org/reference/functions/ormevictentity.html"}, "railo": {"minimum_version":"", "notes":"", "docs":"http://railodocs.org/index.cfm/function/ormevictentity"} }, - "links": [ - - ], + "links": [], "examples": [ { "title":"Tag Example", - "description":"To evict all the cache data of CArtist entity:", - "code":" ", + "description":"To evict all the cache data of CArtist entity", + "code":"", "result":"", "runnable":false }, { "title":"Tag Example", - "description":"To evict the cache data of CArtists entity whose primary key is 1:", - "code":" ", + "description":"To evict the cache data of CArtists entity whose primary key is 1", + "code":"", "result":"", "runnable":false } ] - } diff --git a/data/en/ormevictqueries.json b/data/en/ormevictqueries.json index 3e0c6c475..2252e4fbf 100644 --- a/data/en/ormevictqueries.json +++ b/data/en/ormevictqueries.json @@ -1,22 +1,20 @@ { "name":"ormEvictQueries", "type":"function", - "syntax":"ormEvictQueries([cacheName])", + "syntax":"ormEvictQueries([cacheName, datasource])", "returns":"void", - "related":["ORMEvictEntity", "ORMEvictCollection"], - "description":"This will remove all the queries from the named query cache. \nIf name is not specified, all queries from default cache will be removed.\normEvictQueries([cacheName])", + "related":["ormEvictEntity","ormEvictCollection"], + "description":"This will remove all the queries from the named query cache. If name is not specified, all queries from default cache will be removed.", "params": [ - {"name":"cacheName","description":"No Help Available","required":false,"default":"","type":"string","values":[]} - + {"name":"cacheName","description":"Name of the cache region that you want to evict. If you do not specify the cache, the default query cache is evicted.","required":false,"default":"","type":"string","values":[]}, + {"name":"datasource","description":"Name of the data source whose cache you want to evict.","required":false,"default":"","type":"string","values":[]} ], "engines": { - "coldfusion": {"minimum_version":"", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-m-r/ormevictqueries.html"}, + "coldfusion": {"minimum_version":"9", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-m-r/ormevictqueries.html"}, "lucee": {"minimum_version":"", "notes":"", "docs":"https://docs.lucee.org/reference/functions/ormevictqueries.html"}, "railo": {"minimum_version":"", "notes":"", "docs":"http://railodocs.org/index.cfm/function/ormevictqueries"} }, - "links": [ - - ], + "links": [], "examples": [ { "title": "Evicts all the Hibernate cached queries for the default cache.", @@ -26,5 +24,4 @@ "runnable": false } ] - } diff --git a/data/en/ormflush.json b/data/en/ormflush.json index 2e8c4388d..2b17830b6 100644 --- a/data/en/ormflush.json +++ b/data/en/ormflush.json @@ -4,19 +4,19 @@ "syntax":"ormFlush([datasource])", "returns":"void", "related":["ormFlushAll"], - "description":"Flushes the current ORM session. ORMFlush flushes all the pending CRUD operations in that request. Any changes made in the objects, in the current ORM session, are saved to the database.", + "description":"Flushes the current ORM session of all the pending CRUD operations in that request. Any changes made in the objects, in the current ORM session, are saved to the database.", "params": [ - {"name":"datasource","description":"datasource used for the session, if not defined the datasource defined in application.cfc/cfapplication is used.","required":false,"default":"","type":"string","values":[]} + {"name":"datasource","description":"Name of the data source used for the session. If not defined, the default datasource defined in Application.cfc/cfapplication is used.","required":false,"default":"","type":"string","values":[]} ], "engines": { - "coldfusion": {"minimum_version":"", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-m-r/ormflush.html"}, + "coldfusion": {"minimum_version":"9", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-m-r/ormflush.html"}, "lucee": {"minimum_version":"", "notes":"", "docs":"https://docs.lucee.org/reference/functions/ormflush.html"}, "railo": {"minimum_version":"", "notes":"", "docs":"http://railodocs.org/index.cfm/function/ormflush"} }, "links": [], "examples": [ { - "title": "Flush all pending CRUD operations for datasource defined in the application.cfc", + "title": "Flush all pending CRUD operations for datasource defined in the Application.cfc", "description": "", "code": "ormFlush();", "result": "", diff --git a/data/en/ormgetsession.json b/data/en/ormgetsession.json index 899e6e368..ac9ccdc34 100644 --- a/data/en/ormgetsession.json +++ b/data/en/ormgetsession.json @@ -1,20 +1,19 @@ { "name":"ormGetSession", "type":"function", - "syntax":"ormGetSession()", + "syntax":"ormGetSession([datasource])", "returns":"any", "related":[], "description":"Get the current ORM session object", "params": [ + {"name":"datasource","description":"Name of the data source used for the session. If not defined, the default datasource defined in Application.cfc/cfapplication is used.","required":false,"default":"","type":"string","values":[]} ], "engines": { - "coldfusion": {"minimum_version":"", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-m-r/ormgetsession.html"}, + "coldfusion": {"minimum_version":"9", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-m-r/ormgetsession.html"}, "lucee": {"minimum_version":"", "notes":"", "docs":"https://docs.lucee.org/reference/functions/ormgetsession.html"}, "railo": {"minimum_version":"", "notes":"", "docs":"http://railodocs.org/index.cfm/function/ormgetsession"} }, - "links": [ - - ], + "links": [], "examples": [ { "title": "Gets the Hibernate session object associated with the datasource from the application.", @@ -24,5 +23,4 @@ "runnable": false } ] - } diff --git a/data/en/ormgetsessionfactory.json b/data/en/ormgetsessionfactory.json index 5f92a4e4b..6e5b2f5a3 100644 --- a/data/en/ormgetsessionfactory.json +++ b/data/en/ormgetsessionfactory.json @@ -1,20 +1,19 @@ { "name":"ormGetSessionFactory", "type":"function", - "syntax":"ormGetSessionFactory()", + "syntax":"ormGetSessionFactory([datasource])", "returns":"any", "related":[], - "description":" Returns ORM session factory instance", + "description":"Returns ORM session factory instance", "params": [ + {"name":"datasource","description":"Name of the data source used for the session. If not defined, the default datasource defined in Application.cfc/cfapplication is used.","required":false,"default":"","type":"string","values":[]} ], "engines": { - "coldfusion": {"minimum_version":"", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-m-r/ormgetsessionfactory.html"}, + "coldfusion": {"minimum_version":"9", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-m-r/ormgetsessionfactory.html"}, "lucee": {"minimum_version":"", "notes":"", "docs":"https://docs.lucee.org/reference/functions/ormgetsessionfactory.html"}, "railo": {"minimum_version":"", "notes":"", "docs":"http://railodocs.org/index.cfm/function/ormgetsessionfactory"} }, - "links": [ - - ], + "links": [], "examples": [ { "title": "Gets the Hibernate session factory object associated with the datasource from the application.", @@ -24,5 +23,4 @@ "runnable": false } ] - } diff --git a/data/en/ormreload.json b/data/en/ormreload.json index 193b52ca3..afffb24b3 100644 --- a/data/en/ormreload.json +++ b/data/en/ormreload.json @@ -5,21 +5,18 @@ "returns":"void", "related":[], "description":"Reinitializes ORM for the application. If you make any change to the persistent metadata of the CFCs, then you might want to reload the ORM. Returns ORM session factory instance", - "params": [ - ], + "params": [], "engines": { - "coldfusion": {"minimum_version":"", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-m-r/ormreload.html"}, + "coldfusion": {"minimum_version":"9", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-m-r/ormreload.html"}, "lucee": {"minimum_version":"", "notes":"", "docs":"https://docs.lucee.org/reference/functions/ormreload.html"}, "railo": {"minimum_version":"", "notes":"", "docs":"http://railodocs.org/index.cfm/function/ormreload"} }, - "links": [ - - ], + "links": [], "examples": [ { "title": "Reload ORM by calling ormReload onRequestStart", - "description": "Reloads the ORM of an application when ?ORMReload is in the URL. This is recommended ONLY for development and should be removed from production.", - "code": "component { \r\n\tthis.name = hash(getCurrentTemplatePath()); \r\n\tthis.datasource = \"somedatasourceORM\"; \r\n\t// turn on ORM for this application\r\n\tthis.ormenabled = true; \r\n\tpublic boolean function onRequestStart(required string targetPage) {\r\n\t\t//if ormreload is in the URL, then reload ORM\r\n\t\tif (structKeyExists(url,\"ormreload\")){\r\n\t\t\tORMReload()\r\n\t\t}\r\n\t\treturn true;\r\n\t}\r\n}", + "description": "Reloads the ORM of an application when `?ormreload` is in the URL. This is recommended ONLY for development and should be removed from production.", + "code": "component {\n\tthis.name = hash(getCurrentTemplatePath());\n\tthis.datasource = \"somedatasourceORM\";\n\t// turn on ORM for this application\n\tthis.ormenabled = true;\n\tpublic boolean function onRequestStart(required string targetPage) {\n\t\t// if ormreload is in the URL, then reload ORM\n\t\tif (structKeyExists(url,\"ormreload\")) {\n\t\t\tormReload();\n\t\t}\n\t\treturn true;\n\t}\n}", "result": "string" } ] From 2f33882f17b08abf71cea0ffbaee338533ddd311 Mon Sep 17 00:00:00 2001 From: KamasamaK Date: Sat, 30 Mar 2024 21:55:33 -0400 Subject: [PATCH 2/3] Indexer and guide updates (A-O functions) --- data/en/cf2016.json | 2 +- data/en/cf6.json | 2 +- data/en/cf7.json | 2 +- data/en/cf8.json | 2 +- data/en/cf9.json | 2 +- guides/en/acf-only.md | 10 ++++++---- 6 files changed, 11 insertions(+), 9 deletions(-) diff --git a/data/en/cf2016.json b/data/en/cf2016.json index 0837cdd04..7f2b0cbb7 100644 --- a/data/en/cf2016.json +++ b/data/en/cf2016.json @@ -1,4 +1,4 @@ { - "related":["arrayContainsNoCase","arrayDeleteNoCase","arrayGetMetadata","arraySetMetadata","booleanFormat","encodeFor","floor","getCanonicalPath","isPDFArchive","queryEach","queryFilter","queryKeyExists","queryMap","queryReduce","querySort","replaceListNoCase","spreadsheetGetColumnCount","structGetMetadata","structSetMetadata","structToSorted","valueArray"], + "related":["arrayContainsNoCase","arrayDeleteNoCase","arrayGetMetadata","arraySetMetadata","booleanFormat","encodeFor","floor","getCanonicalPath","isDateObject","isPDFArchive","queryEach","queryFilter","queryKeyExists","queryMap","queryReduce","querySort","replaceListNoCase","spreadsheetGetColumnCount","structGetMetadata","structSetMetadata","structToSorted","valueArray"], "name":"ColdFusion 2016 New Functions and Tags","type":"listing","description":"List of tags and functions added in ColdFusion 2016" } \ No newline at end of file diff --git a/data/en/cf6.json b/data/en/cf6.json index fbd59654b..924a524b5 100644 --- a/data/en/cf6.json +++ b/data/en/cf6.json @@ -1,4 +1,4 @@ { - "related":["cfargument","cfchart","cfchartdata","cfchartseries","cfcomponent","cffunction","cfimport","cfinvoke","cfinvokeargument","cflogin","cfloginuser","cflogout","cfobjectcache","cfproperty","cfreturn","cftrace","cfxml","createDateTime","getPageContext","isK2ServerABroker","isK2ServerDocCountExceeded","isK2ServerOnline","xmlSearch"], + "related":["cfargument","cfchart","cfchartdata","cfchartseries","cfcomponent","cffunction","cfimport","cfinvoke","cfinvokeargument","cflogin","cfloginuser","cflogout","cfobjectcache","cfproperty","cfreturn","cftrace","cfxml","createDateTime","getAuthUser","getEncoding","getK2ServerDocCount","getK2ServerDocCountLimit","getMetadata","getPageContext","getProfileSections","isK2ServerABroker","isK2ServerDocCountExceeded","isK2ServerOnline","isObject","isUserInRole","isXMLDoc","isXMLElem","isXMLRoot","xmlSearch"], "name":"ColdFusion 6 New Functions and Tags","type":"listing","description":"List of tags and functions added in ColdFusion 6" } \ No newline at end of file diff --git a/data/en/cf7.json b/data/en/cf7.json index 8c4e8e0a3..e010c7198 100644 --- a/data/en/cf7.json +++ b/data/en/cf7.json @@ -1,4 +1,4 @@ { - "related":["Application.cfc","binaryDecode","binaryEncode","cfcalendar","cfdocument","cfdocumentitem","cfdocumentsection","cfformgroup","cfformitem","cfntauthenticate","cfreportparam","cftextarea","cftimer","charsetDecode","charsetEncode","generateSecretKey","isValid","onApplicationEnd","onApplicationStart","onError","onRequest","onRequestEnd","onRequestStart","onSessionEnd","onSessionStart"], + "related":["Application.cfc","addSOAPRequestHeader","addSOAPResponseHeader","binaryDecode","binaryEncode","cfcalendar","cfdocument","cfdocumentitem","cfdocumentsection","cfformgroup","cfformitem","cfntauthenticate","cfreportparam","cftextarea","cftimer","charsetDecode","charsetEncode","generateSecretKey","getContextRoot","getGatewayHelper","getLocaleDisplayName","getSOAPRequest","getSOAPRequestHeader","getSOAPResponse","getSOAPResponseHeader","isSOAPRequest","isValid","isXML","isXMLAttribute","isXMLNode","onApplicationEnd","onApplicationStart","onError","onRequest","onRequestEnd","onRequestStart","onSessionEnd","onSessionStart"], "name":"ColdFusion 7 New Functions and Tags","type":"listing","description":"List of tags and functions added in ColdFusion 7" } \ No newline at end of file diff --git a/data/en/cf8.json b/data/en/cf8.json index 8340d2a74..f8263a6f1 100644 --- a/data/en/cf8.json +++ b/data/en/cf8.json @@ -1,4 +1,4 @@ { - "related":["arrayIsDefined","cfajaximport","cfajaxproxy","cfdbinfo","cfdiv","cfexchangecalendar","cfexchangeconnection","cfexchangecontact","cfexchangefilter","cfexchangemail","cfexchangetask","cffeed","cfimage","cfinterface","cflayout","cflayoutarea","cfmenu","cfmenuitem","cfpdf","cfpdfform","cfpdfformparam","cfpdfparam","cfpdfsubform","cfpod","cfpresentation","cfpresentationslide","cfpresenter","cfprint","cfsprydataset","cfthread","cftooltip","cfwindow","cfzip","cfzipparam","deserializeJSON","dotnetToCFType","fileClose","fileCopy","fileDelete","fileIsEOF","fileMove","fileOpen","fileRead","fileReadBinary","fileReadLine","fileSetAccessMode","fileSetAttribute","fileSetLastModified","fileWrite","fileWriteLine","getFileInfo","imageAddBorder","imageBlur","imageClearRect","imageCopy","imageCrop","imageDrawArc","imageDrawBeveledRect","imageDrawCubicCurve","imageDrawLine","imageDrawLines","imageDrawOval","imageDrawPoint","imageDrawQuadraticCurve","imageDrawRect","imageDrawRoundRect","imageDrawText","imageFlip","imageGetBlob","imageGetBufferedImage","imageGetEXIFMetadata","imageGetEXIFTag","imageGetHeight","imageGetIPTCMetadata","imageGetIPTCtag","imageGetWidth","imageGrayScale","imageInfo","imageNegative","imageNew","imageOverlay","imagePaste","imageRead","imageReadBase64","imageResize","imageRotate","imageRotateDrawingAxis","imageScaleTofit","imageSetBackgroundColor","imageSetDrawingColor","imageSetDrawingStroke","imageSetDrawingTransparency","imageSharpen","imageShear","imageShearDrawingAxis","imageTranslate","imageTranslateDrawingAxis","imageWrite","imageWriteBase64","isPDFFile","onMissingMethod","onMissingTemplate","reMatch","reMatchNoCase","serializeJSON"], + "related":["ajaxLink","ajaxOnLoad","arrayIsDefined","cfajaximport","cfajaxproxy","cfdbinfo","cfdiv","cfexchangecalendar","cfexchangeconnection","cfexchangecontact","cfexchangefilter","cfexchangemail","cfexchangetask","cffeed","cfimage","cfinterface","cflayout","cflayoutarea","cfmenu","cfmenuitem","cfpdf","cfpdfform","cfpdfformparam","cfpdfparam","cfpdfsubform","cfpod","cfpresentation","cfpresentationslide","cfpresenter","cfprint","cfsprydataset","cfthread","cftooltip","cfwindow","cfzip","cfzipparam","deserializeJSON","dotnetToCFType","fileClose","fileCopy","fileDelete","fileIsEOF","fileMove","fileOpen","fileRead","fileReadBinary","fileReadLine","fileSetAccessMode","fileSetAttribute","fileSetLastModified","fileWrite","fileWriteLine","getComponentMetadata","getFileInfo","getPrinterInfo","getPrinterList","getReadableImageFormats","getUserRoles","getWriteableImageFormats","imageAddBorder","imageBlur","imageClearRect","imageCopy","imageCrop","imageDrawArc","imageDrawBeveledRect","imageDrawCubicCurve","imageDrawLine","imageDrawLines","imageDrawOval","imageDrawPoint","imageDrawQuadraticCurve","imageDrawRect","imageDrawRoundRect","imageDrawText","imageFlip","imageGetBlob","imageGetBufferedImage","imageGetEXIFMetadata","imageGetEXIFTag","imageGetHeight","imageGetIPTCMetadata","imageGetIPTCtag","imageGetWidth","imageGrayScale","imageInfo","imageNegative","imageNew","imageOverlay","imagePaste","imageRead","imageReadBase64","imageResize","imageRotate","imageRotateDrawingAxis","imageScaleTofit","imageSetAntialiasing","imageSetBackgroundColor","imageSetDrawingColor","imageSetDrawingStroke","imageSetDrawingTransparency","imageSharpen","imageShear","imageShearDrawingAxis","imageTranslate","imageTranslateDrawingAxis","imageWrite","imageWriteBase64","imageXORDrawingMode","isDDX","isImage","isImageFile","isInstanceOf","isJSON","isPDFFile","isPDFObject","isUserInAnyRole","isUserLoggedIn","onMissingMethod","onMissingTemplate","reMatch","reMatchNoCase","serializeJSON"], "name":"ColdFusion 8 New Functions and Tags","type":"listing","description":"List of tags and functions added in ColdFusion 8" } \ No newline at end of file diff --git a/data/en/cf9.json b/data/en/cf9.json index ed7d1e42b..915ca9e6f 100644 --- a/data/en/cf9.json +++ b/data/en/cf9.json @@ -1,4 +1,4 @@ { - "related":["applicationStop","arrayFind","arrayFindNoCase","cacheGet","cacheGetAllIds","cacheGetMetadata","cacheGetProperties","cachePut","cacheRemove","cacheSetProperties","cfcontinue","cffileupload","cffinally","cfimap","cfmap","cfmapitem","cfmediaplayer","cfmessagebox","cfprogressbar","cfsharepoint","cfspreadsheet","directoryCreate","directoryDelete","directoryList","directoryRename","entityDelete","entityLoad","entityLoadByExample","entityLoadByPK","entityNew","entityToQuery","fileSeek","fileSkipBytes","getFunctionCalledName","isNull","objectLoad","objectSave","onServerStart","ormExecuteQuery","spreadsheetAddRow","spreadsheetAddRows","spreadsheetFormatCell","spreadsheetFormatColumn","spreadsheetFormatColumns","spreadsheetFormatRow","spreadsheetFormatRows","spreadsheetNew","throw","trace","writeDump","writeLog"], + "related":["applicationStop","arrayContains","arrayFind","arrayFindNoCase","cacheGet","cacheGetAllIds","cacheGetMetadata","cacheGetProperties","cachePut","cacheRemove","cacheSetProperties","cfcontinue","cffileupload","cffinally","cfimap","cfmap","cfmapitem","cfmediaplayer","cfmessagebox","cfprogressbar","cfsharepoint","cfspreadsheet","directoryCreate","directoryDelete","directoryList","directoryRename","entityDelete","entityLoad","entityLoadByExample","entityLoadByPK","entityMerge","entityNew","entityReload","entitySave","entityToQuery","fileSeek","fileSkipBytes","getFunctionCalledName","getVFSMetadata","isIPV6","isNull","isSpreadsheetFile","isSpreadsheetObject","location","objectEquals","objectLoad","objectSave","onServerStart","ormClearSession","ormCloseSession","ormEvictCollection","ormEvictEntity","ormEvictQueries","ormExecuteQuery","ormFlush","ormGetSession","ormGetSessionFactory","ormReload","spreadsheetAddRow","spreadsheetAddRows","spreadsheetFormatCell","spreadsheetFormatColumn","spreadsheetFormatColumns","spreadsheetFormatRow","spreadsheetFormatRows","spreadsheetNew","throw","trace","writeDump","writeLog"], "name":"ColdFusion 9 New Functions and Tags","type":"listing","description":"List of tags and functions added in ColdFusion 9" } \ No newline at end of file diff --git a/guides/en/acf-only.md b/guides/en/acf-only.md index ffc7fc937..f916b5e65 100644 --- a/guides/en/acf-only.md +++ b/guides/en/acf-only.md @@ -140,11 +140,11 @@ `getException` -`getGatewayHelper` +`getGatewayHelper` - Minimum Version: 7 `getGraphQLClient` - Minimum Version: 2023 -`getPrinterInfo` +`getPrinterInfo` - Minimum Version: 8 `getSafeHTML` - Minimum Version: 11 @@ -160,7 +160,9 @@ `invalidateOauthAccesstoken` - Minimum Version: 11 -`isDDX` +`isDateObject` - Minimum Version: 2016.0.3 + +`isDDX` - Minimum Version: 8 `isFileObject` - Minimum Version: 11 @@ -170,7 +172,7 @@ `isSafeHTML` - Minimum Version: 11 -`isSpreadsheetFile` +`isSpreadsheetFile` - Minimum Version: 9 `isValidOauthAccesstoken` - Minimum Version: 11 From 9d999bd6ddb5397c13451545f895306ec7373412 Mon Sep 17 00:00:00 2001 From: KamasamaK Date: Tue, 2 Apr 2024 08:55:09 -0400 Subject: [PATCH 3/3] Added CF support for millisecond --- data/en/cf2021.json | 2 +- data/en/millisecond.json | 3 +- guides/en/member.md | 101 +++++++++++++++++++++------------------ 3 files changed, 57 insertions(+), 49 deletions(-) diff --git a/data/en/cf2021.json b/data/en/cf2021.json index 23e43f6cf..24e6fae8a 100644 --- a/data/en/cf2021.json +++ b/data/en/cf2021.json @@ -1,4 +1,4 @@ { - "related":["arrayPop","arrayPush","arrayReduceRight","arrayShift","arrayUnshift","cfjava","clearTimeZone","generateBCryptHash","generateSCryptHash","getTimeZone","listReduceRight","setTimeZone","stringEach","stringEvery","stringFilter","stringMap","stringReduce","stringReduceRight","stringSome","stringSort","structIsCaseSensitive","verifyBCryptHash","verifySCryptHash"], + "related":["arrayPop","arrayPush","arrayReduceRight","arrayShift","arrayUnshift","cfjava","clearTimeZone","generateBCryptHash","generateSCryptHash","getTimeZone","listReduceRight","millisecond","setTimeZone","stringEach","stringEvery","stringFilter","stringMap","stringReduce","stringReduceRight","stringSome","stringSort","structIsCaseSensitive","verifyBCryptHash","verifySCryptHash"], "name":"ColdFusion 2021 New Functions and Tags","type":"listing","description":"List of tags and functions added in ColdFusion 2021" } \ No newline at end of file diff --git a/data/en/millisecond.json b/data/en/millisecond.json index 1db99f6b3..8af718b9b 100644 --- a/data/en/millisecond.json +++ b/data/en/millisecond.json @@ -7,10 +7,11 @@ "related": [], "description": "Returns the milliseconds of the referenced date.", "params": [ - {"name": "date", "description": "date object; for example, now()", "required": true, "default": "", "type": "date", "values": []}, + {"name": "date", "description": "date object", "required": true, "default": "", "type": "date", "values": []}, {"name": "timezone", "description": "A datetime object is independent of a specific timezone; it is only an offset in milliseconds from 1970-1-1 00.00:00 UTC (Coordinated Universal Time).

The timezone only comes into play when you need specific information like hours in a day, minutes in a hour or which day it is as these calculations depend on the timezone.

A timezone must be specified in order to translate the date object to something else. If you do not provide the timezone in the function call, it will default to the timezone specified in the Lucee Administrator (Settings/Regional), or the timezone specified for the current request using the function setTimezone().

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)
", "required": false, "default": "", "type": "string", "values": []} ], "engines": { + "coldfusion": {"minimum_version":"2021", "notes":"", "docs":"https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-m-r/millisecond.html"}, "lucee": {"minimum_version": "", "notes": "", "docs": "https://docs.lucee.org/reference/functions/millisecond.html"} }, "examples": [], diff --git a/guides/en/member.md b/guides/en/member.md index cdbb60284..630d3c0f6 100644 --- a/guides/en/member.md +++ b/guides/en/member.md @@ -25,28 +25,40 @@ The following example depicts the new usage of member functions: myArray.sort("ASC"); // The member way - var myProductObject = createObject("java", "myJavaclass"); - myjavaList = myProductObject.getProductList(); - myjavaList.add("newProduct"); // Java API + var myProductObject = createObject("java", "myJavaClass"); + myJavaList = myProductObject.getProductList(); + myJavaList.add("newProduct"); // Java API - myjavaList.append("newProduct"); // CF API - myjavaList.sort("ASC"); + myJavaList.append("newProduct"); // CF API + myJavaList.sort("ASC"); + +Member Functions can also be chained (on Lucee or CF2018+), for example: + + s = "the"; + s = s.listAppend("quick brown fox", " ") + .listAppend("jumps over the lazy dog", " ") + .uCase() + .reverse(); + +result: `GOD YZAL EHT REVO SPMUJ XOF NWORB KCIUQ EHT` Member functions for the following data types are supported: -- Array -- String -- List -- Struct -- Date -- Spreadsheet -- XML -- Query -- Image +- [Array](#array-member-functions) +- [String](#string-member-functions) +- [List](#list-member-functions) +- [Struct](#struct-member-functions) +- [Date](#date-member-functions) +- [Image](#image-member-functions) +- [Spreadsheet](#spreadsheet-member-functions) +- [XML](#xml-member-functions) +- [Query](#query-member-functions) +- [Numeric](#numeric-member-functions) CF 2016 changed the return type for append member functions: -`anystruct.append()` returns the appended structure -`anyarray.append()` returns the appended array + +- `someArray.append()` now returns the appended array +- `someStruct.append()` now returns the appended structure ## Array member functions @@ -258,6 +270,7 @@ CF 2016 changed the return type for append member functions: - hour : `someVar.hour()` - lsDateFormat : `someVar.lsDateFormat()` - lsTimeFormat : `someVar.lsTimeFormat()` +- millisecond : `someVar.millisecond()` - minute : `someVar.minute()` - month : `someVar.month()` - quarter : `someVar.quarter()` @@ -416,50 +429,54 @@ When using Query.cfc, you get your results from the execution by using: - `someVar.getResult()` -## Display and Formatting member functions - -- booleanFormat : `someVal.booleanFormat()` -- yesNoFormat : `someVal.yesNoFormat()` - ## Numeric member functions - abs : `someVar.abs()` -- aCos : `someVar.aCos()` -- aSin : `someVar.aSin()` +- acos : `someVar.aCos()` +- asin : `someVar.aSin()` - atn : `someVar.atn()` -- bitAnd : `someVar.bitAnd(number2)` -- bitMaskClear : `someVar.bitMaskClear(start, length)` -- bitMaskRead : `someVar.bitMaskRead(start, length)` -- bitMaskSet : `someVar.bitMaskSet(mask, start, length)` +- bitAnd : `someVar.bitAnd()` +- bitMaskClear : `someVar.bitMaskClear()` +- bitMaskRead : `someVar.bitMaskRead()` +- bitMaskSet : `someVar.bitMaskSet()` - bitNOT : `someVar.bitNot()` -- bitOR : `someVar.bitOr(number2)` -- bitSHLN : `someVar.bitSHLN(count)` -- bitSHRN : `someVar.bitSHRN(count)` -- bitXOR : `someVar.bitXor(number2)` +- bitOR : `someVar.bitOr()` +- bitSHLN : `someVar.bitSHLN()` +- bitSHRN : `someVar.bitSHRN()` +- bitXOR : `someVar.bitXor()` - ceiling : `someVar.ceiling()` - cos : `someVar.cos()` - decrementValue : `someVar.decrementValue()` - exp : `someVar.exp()` - fix : `someVar.fix()` - floor : `someVar.floor()` -- formatBaseN : `someVar.formatBaseN(radix)` +- formatBaseN : `someVar.formatBaseN()` - incrementValue : `someVar.incrementValue()` - inputBaseN : `someVar.inputBaseN()` - log : `someVar.log()` - log10 : `someVar.log10()` -- max : `someVar.max(number2)` -- min : `someVar.min(number2)` +- max : `someVar.max()` +- min : `someVar.min()` - precisionEvaluate : `someVar.precisionEvaluate()` -- randomize : `someVar.randomize([algorithm])` -- randRange : `someVar.randRange(number2[, algorithm])` +- randomize : `someVar.randomize()` +- randRange : `someVar.randRange()` - round : `someVar.round()` - sgn : `someVar.sgn()` - sin : `someVar.sin()` - sqr : `someVar.sqr()` - tan : `someVar.tan()` +## Display and Formatting member functions + +- booleanFormat : `someVal.booleanFormat()` +- yesNoFormat : `someVal.yesNoFormat()` + ## Future member functions +These are exclusively member functions and have no headless equivalent. You use them on the Future returned by `runAsync`. + +### Standard Future member functions + - cancel : `FutureObject.cancel()` - error : `FutureObject.error(UDFMethod method)` - error : `FutureObject.then((UDFMethod method, long timeout)` @@ -471,7 +488,7 @@ When using Query.cfc, you get your results from the execution by using: - then : `FutureObject.then(UDFMethod method)` - then : `FutureObject.then((UDFMethod method, long timeout)` -## Empty Future member functions +### Empty Future member functions - cancel : `EmptyFutureObject.cancel()` - complete : `EmptyFutureObject.complete(Object val)` @@ -479,16 +496,6 @@ When using Query.cfc, you get your results from the execution by using: - isCancelled : `EmptyFutureObject.isCancelled()` - isDone : `EmptyFutureObject.isDone()` -Member Functions can also be chained (on Lucee or CF2018+), for example: - - s = "the"; - s = s.listAppend("quick brown fox", " ") - .listAppend("jumps over the lazy dog", " ") - .uCase() - .reverse(); - -result: `GOD YZAL EHT REVO SPMUJ XOF NWORB KCIUQ EHT` - ## Important Note on a potential Member Function Gotcha Some member functions [might fall into underlying Java methods][note] if the strict ColdFusion syntax is not followed.