/
core-cfml.fld
executable file
·2570 lines (2456 loc) · 90.3 KB
/
core-cfml.fld
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE func-lib PUBLIC "-//Lucee//DTD CFML Function Library 1.0//EN"
"dtd/web-cfmfunctionlibrary_1_0.dtd">
<func-lib>
<flib-version>1.00</flib-version>
<short-name>fbase</short-name>
<uri>http://www.lucee.org/cf-fld-3-1</uri>
<display-name>Lucee Core Function Library</display-name>
<description>All build in Functions of Lucee</description>
<!-- AjaxLink -->
<function>
<name>AjaxLink</name>
<class>lucee.runtime.functions.displayFormatting.AjaxLink</class>
<status>unimplemented</status>
<keywords>ajax</keywords>
<description>Causes an HTML href attribute to display link results in the current Ajax container.</description>
<argument>
<name>url</name>
<type>string</type>
<required>Yes</required>
<description>The URL of the link.</description>
</argument>
<return>
<type>string</type>
</return>
</function>
<!-- AjaxOnLoad -->
<function>
<name>AjaxOnLoad</name>
<class>lucee.runtime.functions.displayFormatting.AjaxOnLoad</class>
<keywords>ajax</keywords>
<status>unimplemented</status>
<description>Causes the specified JavaScript function to run when the page loads.</description>
<argument>
<name>functionName</name>
<type>string</type>
<required>Yes</required>
<description>The name of the function to run when the page loads. The specified function does not take a parameter.</description>
</argument>
<return>
<type>void</type>
</return>
</function>
<!-- array -->
<function>
<name>array</name>
<class>lucee.runtime.functions.arrays.Array_</class>
<keywords>array</keywords>
<description>Creates a new array</description>
<argument-type>dynamic</argument-type>
<return>
<type>array</type>
</return>
</function>
<!-- ArrayIsDefined -->
<function>
<name>ArrayIsDefined</name>
<class>lucee.runtime.functions.arrays.ArrayIsDefined</class>
<member-name>isDefined</member-name>
<keywords>array,decision</keywords>
<description>Returns whether there exists an item in the array at the selected index.</description>
<argument>
<name>array</name>
<type>array</type>
<required>Yes</required>
<description>The array to search</description>
</argument>
<argument>
<name>index</name>
<type>number</type>
<required>Yes</required>
<description>The index which to check</description>
</argument>
<return>
<type>boolean</type>
</return>
</function>
<!-- arrayNew -->
<function>
<name>arrayNew</name>
<class>lucee.runtime.functions.arrays.ArrayNew</class>
<keywords>array</keywords>
<description>create a new array</description>
<argument>
<name>dimension</name>
<type>number</type>
<required>no</required>
<default>1</default>
<description>Number of dimensions in new array: 1, 2, or 3</description>
</argument>
<argument>
<name>type</name>
<type>string</type>
<required>no</required>
<default></default>
<description>type of the array created, if set the array does not have any specific type.</description>
</argument>
<argument>
<name>synchronized</name>
<type>boolean</type>
<required>no</required>
<default>false</default>
<description>is the array synchronized or not</description>
</argument>
<return>
<type>array</type>
</return>
</function>
<!-- beat -->
<function>
<name>beat</name>
<class>lucee.runtime.functions.dateTime.Beat</class>
<description>
Outputs the current swatch time.
It is a new system of time developed by Swatch, the Swiss watch maker.
It involves setting the current day into 1000 "beats" instead of 24 hours.
Internet Time eliminates the need for geographical time zones, perfect for the internet.
</description>
<argument>
<name>time</name>
<type>any</type>
<required>No</required>
<description>
the local time to geat beat time from
</description>
</argument>
<return>
<type>number</type>
</return>
</function>
<!-- CacheSetProperties -->
<function>
<name>CacheSetProperties</name>
<class>lucee.runtime.functions.cache.CacheSetProperties</class>
<description>
This function is not supported by Lucee, because we see this as a security risk, you can modifie cache configuration without a password,
you can use tag cfadmin instead. we will add support for this function in a future release, but then you can enable,disable this function in admin for every single cache instance.</description>
<argument>
<name>propsSruct</name>
<alias>properties,props</alias>
<type>struct</type>
<required>yes</required>
<description>A structure specifying the cache properties plus identifying information</description>
</argument>
<return>
<type>void</type>
</return>
</function>
<!-- componentInfo -->
<function>
<name>componentInfo</name>
<class>lucee.runtime.functions.component.ComponentInfo</class>
<status>deprecated</status>
<description>this function is deprecated, use function getMetadata instead.</description>
<argument>
<name>component</name>
<type>component</type>
<required>Yes</required>
<description>component to return info for it</description>
</argument>
<return>
<type>struct</type>
</return>
</function>
<!-- componentCacheClear -->
<function>
<name>componentCacheClear</name>
<class>lucee.runtime.functions.component.ComponentCacheClear</class>
<description>flush the component path cache</description>
<return>
<type>void</type>
</return>
</function>
<!-- componentCacheList -->
<function>
<name>componentCacheList</name>
<class>lucee.runtime.functions.component.ComponentCacheList</class>
<description>list elements in the component path cache</description>
<return>
<type>struct</type>
</return>
</function>
<!-- createObject -->
<function>
<name>createObject</name>
<!-- <status>deprecated</status> -->
<class>lucee.runtime.functions.other.CreateObject</class>
<modified>5.0.0.0</modified>
<description>
The CreateObject function takes different arguments depending on the value of the first argument:
CreateObject('com', class, context, serverName)
CreateObject('component', component-name)
CreateObject('java', class, ...)
CreateObject('webservice', urltowsdl, [, portname])</description>
<argument>
<name>type</name>
<alias>componentType</alias>
<type>string</type>
<required>Yes</required>
<description>one of the following:
- java: for loading a java object
- webservice: for loading a remote webservice
- component: for loading a Component (this functions does not call the init method of the component)
- com: for loading a com Object</description>
</argument>
<argument>
<name>classname</name>
<alias>component,class</alias>
<type>string</type>
<required>no</required>
<description>
the usage of this argument depend on type defined with argument "type":
- java: java class to load
- webservice: WSDL url to call
- component: The CFC name; corresponds to the name of the file that defines the component
- com: Component ProgID for the object to invoke.
</description>
</argument>
<argument>
<name>context</name>
<alias>bundleName,name,webservice,Assembly,WSPortName,thirdarg</alias>
<type>object</type>
<required>No</required>
<description>
the usage of this argument depend on type defined with argument "type":
- com: not used (ignored)
- java: "classpath" or "bundleName" used to load the defined class,
this can be a list of multiple paths (directories containing class files or jar files) as string list or array or a name of an OSGi bundle (Lucee can download OSGi bundles automatically if necessary)
- webservice: a struct containing the following optional keys (username,password,proxyServer,proxyPort,proxyUser,proxyPassword)
- component: not used (ignored)
</description>
</argument>
<argument>
<name>delimiterOrVersion</name>
<alias>delimiter,version,bundleVersion</alias>
<type>object</type>
<required>No</required>
<description>
the usage of this argument depend on type defined with argument "type":
- java: delimiter used for the classpath (default comma) or bundle version when the previous argument was a bundle name
- webservice: not used (ignored)
- component: not used (ignored)
- com: not used (ignored)</description>
</argument>
<return>
<type>any</type>
</return>
</function>
<!-- createODBCDate -->
<function>
<name>createODBCDate</name>
<class>lucee.runtime.functions.dateTime.CreateODBCDate</class>
<status>deprecated</status>
<description>Creates an ODBC date object.</description>
<argument>
<name>date</name>
<type>datetime</type>
<required>Yes</required>
<description>date object</description>
</argument>
<argument>
<name>timezone</name>
<type>timezone</type>
<required>no</required>
<description>timezone to use</description>
</argument>
<return>
<type>datetime</type>
</return>
</function>
<!-- createODBCDateTime -->
<function>
<name>createODBCDateTime</name>
<class>lucee.runtime.functions.dateTime.CreateODBCDateTime</class>
<status>deprecated</status>
<description>Creates an ODBC date-time object.</description>
<argument>
<name>date</name>
<type>datetime</type>
<required>Yes</required>
<description>date object</description>
</argument>
<return>
<type>datetime</type>
</return>
</function>
<!-- createODBCTime -->
<function>
<name>createODBCTime</name>
<class>lucee.runtime.functions.dateTime.CreateODBCTime</class>
<description>Creates an ODBC time object.</description>
<argument>
<name>date</name>
<type>datetime</type>
<required>Yes</required>
<description>date object</description>
</argument>
<return>
<type>datetime</type>
</return>
</function>
<!-- dateFormat -->
<function>
<name>dateFormat</name>
<member-name>dateFormat</member-name>
<member-type>date</member-type>
<class>lucee.runtime.functions.displayFormatting.DateFormat</class>
<keywords>date,string,formatting</keywords>
<description>Formats a date string to a given output</description>
<argument>
<name>date</name>
<type>any</type>
<required>Yes</required>
<description>Date object</description>
</argument>
<argument>
<name>mask</name>
<type>string</type>
<required>No</required>
<default>dd-mmm-yy</default>
<description>
Characters that show how Lucee displays a date:
- d: Day of the month as digits; no leading zero for single-digit days.
- dd: Day of the month as digits; leading zero for single-digit days.
- ddd: Day of the week as a three-letter abbreviation.
- dddd: Day of the week as its full name.
- m: Month as digits; no leading zero for single-digit months.
- mm: Month as digits; leading zero for single-digit months.
- mmm: Month as a three-letter abbreviation.
- mmmm: Month as its full name.
- yy: Year as last two digits; leading zero for years less than 10.
- yyyy: Year represented by four digits.
- gg: Period/era string. Ignored. Reserved. The following masks tell how to format the full date and cannot be combined with other masks:
- z: Time zone in literal format, for example, IST
- Z: Time zone in hours of offset (RFC 822 TimeZone), for example, +0530
- X: Time zone in hours of offset in ISO 8601 format. The following are the three ways of using 'X':
X: +05
XX: +0530
XXX: +5:30
- short: equivalent to m/d/y
- medium: equivalent to mmm d, yyyy
- long: equivalent to mmmm d, yyyy
- full: equivalent to dddd, mmmm d, yyyy</description>
</argument>
<argument>
<name>timezone</name>
<type>timezone</type>
<required>No</required>
<description>
A datetime object is independent of a specific timezone, it is only a offset in milliseconds from 1970-1-1 00.00:00 UTC (Coordinated Universal Time).
This means that 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 since those calculations depend on the timezone.
For these calculations, 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:
- AGT (for time in Argentina)
- Europe/Zurich (for time in Zurich/Switzerland)
- HST (Hawaiian Standard Time in the USA)
</description>
</argument>
<return>
<type>string</type>
</return>
</function>
<!-- dateTimeFormat -->
<function>
<name>dateTimeFormat</name>
<class>lucee.runtime.functions.displayFormatting.DateTimeFormat</class>
<member-name>dateTimeFormat, format</member-name>
<member-type>date</member-type>
<keywords>date,string,formatting</keywords>
<description>Formats a date/time string to a given output</description>
<argument>
<name>datetime</name>
<alias>date</alias>
<type>any</type>
<required>Yes</required>
<description>Datetime object</description>
</argument>
<argument>
<name>mask</name>
<type>string</type>
<required>No</required>
<default>dd-MMM-yyyy HH:nn:ss</default>
<description>
Mask that has to be used for formatting.
the following characters are pattern letters (case sensitive) representing the components of a datetime string. All other characters are not interpreted
- a,..,aaaa: AM/PM marker (see also "t" and "tt"; Example:AM)
- d: Day in month, no leading zero for single-digit days (Example:3)
- dd: Day in month, leading zero for single-digit days (Example:03)
- D: Day in year, no leading zero for single-digit days (Example:4)
- DD: Day in month, leading zero for single-digit days (Example:04)
- DDD: Day in month, 2 leading zero for single-digit days (Example:004)
- E,EE,EEE: Day of week as a three-letter abbreviation (Example:Tue)
- EEEE: Day of week as its full name (Example:Tuesday)
- F: Day of week in month, no leading zero for single-digit days (Example:4)
- FF: Day of week in month, leading zero for single-digit days (Example:04)
- G,GG: Era designator (Example:AD)
- h: Hour in am/pm (1-12), no leading zero for single-digit hours (Example:3)
- hh: Hour in am/pm (1-12), leading zero for single-digit hours (Example:03)
- H: Hour in day (0-23), no leading zero for single-digit hours (Example:14)
- HH: Hour in day (00-23), leading zero for single-digit hours (Example:14)
- k: Hour in day (1-24), no leading zero for single-digit hours (Example:15)
- kk: Hour in day (1-24), leading zero for single-digit hours (Example:15)
- K: Hour in am/pm (0-11), no leading zero for single-digit hours (Example:2)
- KK: Hour in am/pm (0-11), leading zero for single-digit hours (Example:02)
- l,L: milliseconds, with no leading zeros (Example:3)
- ll,LL: milliseconds, leading zero for single-digit days (Example:03)
- lll,LLL: milliseconds, 2 leading zero for single-digit days (Example:003)
- m,M: Month as digits, no leading zero for single-digit months (Example:6)
- mm,MM: Month as digits, leading zero for single-digit months (Example:06)
- mmm,MMM: Month as a three-letter abbreviation (Example:Jun)
- mmmm,MMMM: Month as its full name (Example:June)
- n,N: minutes in hour, no leading zero for single-digit minutes (Example:3)
- nn,NN: minutes in hour, leading zero for single-digit minutes (Example:03)
- s,S: seconds in minute, no leading zero for single-digit seconds (Example:3)
- ss,SS: seconds in minute, leading zero for single-digit seconds (Example:03)
- t,T: one-character time marker string (Example:P)
- tt,TT: multiple-character time marker string (Example:PM)
- w: Week in year, no leading zero for single-digit hours (Example:27)
- ww: Week in year, leading zero for single-digit hours (Example:27)
- W: Week in month, no leading zero for single-digit hours (Example:2)
- WW: Week in month, leading zero for single-digit hours (Example:02)
- y,yy,yyy: Year as last two digits, leading zero for single-digit (Example:09)
- yyyy: Year represented by four digits (Example:2009)
- z,zz,zzz: General time zone as a 3 to 4 letter abbreviation (Example:PST)
- zzzz: General time zone as its full name (Example:Pacific Standard Time)
- Z,..,ZZZZ: RFC 822 time zone (Example:-0800)
The following masks can be used to format the full date and time and may not be combined with other masks:
- short: equivalent to "m/d/y h:mm tt"
- medium: equivalent to "mmm d, yyyy h:mm:ss tt"
- long: medium followed by three-letter time zone; i.e. "mmmm d, yyyy h:mm:ss tt zzz"
- full: equivalent to "dddd, mmmm d, yyyy h:mm:ss tt zz"
- ISO8601: equivalent to "yyyy-mm-dd'T'HH:nn:ss'Z'Z"
The function follows Java date time mask. For details, see the section Date and Time Patterns at http://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html
</description>
</argument>
<argument>
<name>timezone</name>
<type>timezone</type>
<required>No</required>
<description>
A datetime object is independent of a specific timezone, it is only a offset in milliseconds from 1970-1-1 00.00:00 UTC (Coordinated Universal Time).
This means that 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 since those calculations depend on the timezone.
For these calculations, 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:
- AGT (for time in Argentina)
- Europe/Zurich (for time in Zurich/Switzerland)
- HST (Hawaiian Standard Time in the USA)
</description>
</argument>
<return>
<type>string</type>
</return>
</function>
<!-- datePart -->
<function>
<name>datePart</name>
<class>lucee.runtime.functions.dateTime.DatePart</class>
<member-name>part</member-name>
<member-position>2</member-position>
<description>Extracts the given date part from the date object</description>
<argument>
<name>datepart</name>
<alias>part</alias>
<type>string</type>
<required>Yes</required>
<description>one of the following:
- yyyy: Year
- q: Quarter
- m: Month
- y: Day of year
- d: Day
- w: Weekday
- ww: Week
- h: Hour
- n: Minute
- s: Second
- l: Millisecond
</description>
</argument>
<argument>
<name>date</name>
<type>datetime</type>
<required>Yes</required>
<description>dateobject the get part from</description>
</argument>
<argument>
<name>timezone</name>
<type>timezone</type>
<required>No</required>
<description>
A datetime object is independent of a specific timezone, it is only a offset in milliseconds from 1970-1-1 00.00:00 UTC (Coordinated Universal Time).
This means that 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 since those calculations depend on the timezone.
For these calculations, 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:
- AGT (for time in Argentina)
- Europe/Zurich (for time in Zurich/Switzerland)
- HST (Hawaiian Standard Time in the USA)
</description>
</argument>
<return>
<type>number</type>
</return>
</function>
<!-- dayOfWeek -->
<function>
<name>dayOfWeek</name>
<class>lucee.runtime.functions.dateTime.DayOfWeek</class>
<member-name>dayOfWeek</member-name>
<description>Determines the day of the week, in a date.</description>
<argument>
<name>date</name>
<type>datetime</type>
<required>Yes</required>
<description>Date/time object</description>
</argument>
<argument>
<name>timezone</name>
<type>timezone</type>
<required>no</required>
<description>
A datetime object is independent of a specific timezone, it is only a offset in milliseconds from 1970-1-1 00.00:00 UTC (Coordinated Universal Time).
This means that 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 since those calculations depend on the timezone.
For these calculations, 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:
- AGT (for time in Argentina)
- Europe/Zurich (for time in Zurich/Switzerland)
- HST (Hawaiian Standard Time in the USA)
</description>
</argument>
<return>
<type>number</type>
</return>
</function>
<!-- lsdayOfWeek -->
<function>
<name>lsdayOfWeek</name>
<class>lucee.runtime.functions.international.LSDayOfWeek</class>
<member-name>lsDayOfWeek</member-name>
<description>Returns the day of the week the date represents in locale format</description>
<argument>
<name>date</name>
<type>datetime</type>
<required>Yes</required>
<description>datetime object</description>
</argument>
<argument>
<name>locale</name>
<type>locale</type>
<required>no</required>
<description>Locale to use instead of the locale of the page when processing the function</description>
</argument>
<argument>
<name>timezone</name>
<type>timezone</type>
<required>no</required>
<description>
A datetime object is independent of a specific timezone, it is only a offset in milliseconds from 1970-1-1 00.00:00 UTC (Coordinated Universal Time).
This means that 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 since those calculations depend on the timezone.
For these calculations, 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:
- AGT (for time in Argentina)
- Europe/Zurich (for time in Zurich/Switzerland)
- HST (Hawaiian Standard Time in the USA)
</description>
</argument>
<return>
<type>number</type>
</return>
</function>
<!-- dayOfYear -->
<function>
<name>dayOfYear</name>
<class>lucee.runtime.functions.dateTime.DayOfYear</class>
<member-name>dayOfYear</member-name>
<description>Determines the day of the year, in a date.</description>
<argument>
<name>date</name>
<type>datetime</type>
<required>Yes</required>
<description>Date/time object</description>
</argument>
<argument>
<name>timezone</name>
<type>timezone</type>
<required>no</required>
<description>
A datetime object is independent of a specific timezone, it is only a offset in milliseconds from 1970-1-1 00.00:00 UTC (Coordinated Universal Time).
This means that 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 since those calculations depend on the timezone.
For these calculations, 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:
- AGT (for time in Argentina)
- Europe/Zurich (for time in Zurich/Switzerland)
- HST (Hawaiian Standard Time in the USA)
</description>
</argument>
<return>
<type>number</type>
</return>
</function>
<!-- dE -->
<function>
<name>dE</name>
<class>lucee.runtime.functions.dynamicEvaluation.DE</class>
<description>Postpones evaluation of a string as an expression, when it is
passed as a parameter to the IIf or Evaluate functions. Escapes
any double quotation marks in the parameter and wraps the
result in double quotation marks.</description>
<argument>
<name>string</name>
<type>string</type>
<required>Yes</required>
<description>String to evaluate, after delay</description>
</argument>
<return>
<type>string</type>
</return>
</function>
<!-- decimalFormat -->
<function>
<name>decimalFormat</name>
<class>lucee.runtime.functions.displayFormatting.DecimalFormat</class>
<keywords>number,string,formatting</keywords>
<description>Converts a number to a decimal-formatted string.</description>
<argument>
<name>number</name>
<type>any</type>
<required>Yes</required>
<description>Number to format</description>
</argument>
<return>
<type>string</type>
</return>
</function>
<!-- decrementValue -->
<function>
<name>decrementValue</name>
<member-name>decrementValue</member-name>
<class>lucee.runtime.functions.math.DecrementValue</class>
<status>deprecated</status>
<description>this function is deprecated, use instead the -- operator;Decrements the current number by one</description>
<argument>
<name>number</name>
<type>number</type>
<required>Yes</required>
<description>Number to decrement</description>
</argument>
<return>
<type>number</type>
</return>
</function>
<!-- dollarFormat -->
<function>
<name>dollarFormat</name>
<class>lucee.runtime.functions.displayFormatting.DollarFormat</class>
<keywords>currency,string,formatting</keywords>
<description>Formats a string in U.S. format. (For other currencies, use
LSCurrencyFormat)</description>
<argument>
<name>number</name>
<type>string</type>
<required>Yes</required>
<description>Number to format</description>
</argument>
<return>
<type>string</type>
</return>
</function>
<!-- cfusion_encrypt -->
<function>
<name>cfusion_encrypt</name>
<class>lucee.runtime.functions.other.CFusionEncrypt</class>
<description>Encrypts the given string, alias for function call encrypt(string,key,"cfmx_compat","hex")</description>
<argument>
<name>string</name>
<type>string</type>
<required>Yes</required>
<description>string to encrypt</description>
</argument>
<argument>
<name>key</name>
<type>string</type>
<required>yes</required>
<description>key to use for encryption</description>
</argument>
<return>
<type>string</type>
</return>
</function>
<!-- cfusion_decrypt -->
<function>
<name>cfusion_decrypt</name>
<class>lucee.runtime.functions.other.CFusionDecrypt</class>
<description>Decrypts the given string, alias for function call decrypt(string,key,"cfmx_compat","hex")</description>
<argument>
<name>string</name>
<type>string</type>
<required>Yes</required>
<description>string to decrypt</description>
</argument>
<argument>
<name>key</name>
<type>string</type>
<required>yes</required>
<description>key to use for decryption</description>
</argument>
<return>
<type>string</type>
</return>
</function>
<!-- GetApplicationMetadata -->
<function>
<name>GetApplicationMetadata</name>
<class>lucee.runtime.functions.system.GetApplicationMetadata</class>
<description>return all data from this scope, when using a application.cfc or all setting defined in tag cfapplication</description>
<return>
<type>struct</type>
</return>
</function>
<!-- GetPrinterList -->
<function>
<name>GetPrinterList</name>
<class>lucee.runtime.functions.system.GetPrinterList</class>
<description>Gets a string list of available printers.</description>
<argument>
<name>delimiters</name>
<alias>delimiter</alias>
<type>string</type>
<required>No</required>
<default>,</default>
<description>Characters that separate list elements. The default value is comma.</description>
</argument>
<return>
<type>string</type>
</return>
</function>
<!-- GetUserRoles -->
<function>
<name>GetUserRoles</name>
<class>lucee.runtime.functions.system.GetUserRoles</class>
<description>Retrieves the list of roles for the current user.</description>
<return>
<type>string</type>
</return>
</function>
<!-- getK2ServerDocCount (Deprecated) -->
<function>
<name>getK2ServerDocCount</name>
<class>lucee.runtime.functions.other.GetK2ServerDocCount</class>
<status>deprecated</status>
<description>This function is deprecated. </description>
<return>
<type>number</type>
</return>
</function>
<!-- getK2ServerDocCountLimit (Deprecated) -->
<function>
<name>getK2ServerDocCountLimit</name>
<class>lucee.runtime.functions.other.GetK2ServerDocCountLimit</class>
<status>deprecated</status>
<description>This function is deprecated.</description>
<return>
<type>number</type>
</return>
</function>
<!-- hash40 -->
<function>
<name>hash40</name>
<class>lucee.runtime.functions.string.Hash40</class>
<description>This function only exists for backward compatibility to Lucee 4.0 or older version that has produced a incorrect result for non us-ascii characters,
Only use this function for backward compatibility.
Converts a variable-length string to a 32-byte, hexadecimal
string, using the MD5 algorithm. (It is not possible to convert
the hash result back to the source string.)
32-byte, hexadecimal string</description>
<argument>
<name>input</name>
<type>any</type>
<required>Yes</required>
<description>String to hash.</description>
</argument>
<argument>
<name>algorithm</name>
<type>string</type>
<required>No</required>
<description>The algorithm to use to hash the string. Supported are the following algorithms:
- CFMX_COMPAT: generating a hash string using classic CFML algorithm.
- MD5: (default) Generates a 32-character, hexadecimal string, using the MD5 algorithm.
- SHA: Generates a 28-character string using the Secure Hash Standard SHA-1 algorithm specified by Nation Institute of Standards and Technology (NIST) FIPS-180-2.
- SHA-256: Generates a 44-character string using the SHA-256 algorithm specified by FIPS-180-2.
- SHA-384: Generates a 64-character string using the SHA-384 algorithm specified by FIPS-180-2.
- SHA-512: Generates an 88-character string using the SHA-1 algorithm specified by FIPS-180-2.</description>
</argument>
<argument>
<name>encoding</name>
<type>string</type>
<required>No</required>
<description>A string specifying the encoding to use when converting
the string to byte data used by the hash algorithm.</description>
</argument>
<argument>
<name>numIterations</name>
<type>number</type>
<required>No</required>
<description>number of iterations; default is 1.</description>
</argument>
<return>
<type>string</type>
</return>
</function>
<!-- iIf -->
<function>
<name>iIf</name>
<class>lucee.runtime.functions.dynamicEvaluation.IIf</class>
<description>Evaluates a Boolean conditional dynamic expression. Depending
on whether the expression is true or false, dynamically
evaluates one of two string expressions and returns the result.</description>
<argument>
<name>condition</name>
<type>boolean</type>
<required>Yes</required>
<description>An expression that can be evaluated as a Boolean.</description>
</argument>
<argument>
<name>string_expression1</name>
<alias>expression1</alias>
<type>string</type>
<required>Yes</required>
<description>Expression to evaluate and return if condition is true.</description>
</argument>
<argument>
<name>string_expression2</name>
<alias>expression2</alias>
<type>string</type>
<required>Yes</required>
<description>Expression to evaluate and return if condition is false.</description>
</argument>
<return>
<type>any</type>
</return>
</function>
<!-- Invoke -->
<function>
<name>Invoke</name>
<class>lucee.runtime.functions.dynamicEvaluation.Invoke</class>
<description>invokes a function/operation of the given object and if given object is a string, Lucee tries to load as component.</description>
<argument>
<name>object</name>
<alias>cfcinstance,obj,value,variable</alias>
<type>any</type>
<required>Yes</required>
<description>a component, struct or scope that holds a function, can also be the name of a component, in this case the component get loaded.</description>
</argument>
<argument>
<name>name</name>
<alias>methodname,method,functionname,function</alias>
<type>string</type>
<required>Yes</required>
<description>name of the function/operation</description>
</argument>
<argument>
<name>arguments</name>
<alias>params,args,argumentcollection</alias>
<type>any</type>
<required>no</required>
<description>arguments to pass to the function/operation</description>
</argument>
<return>
<type>object</type>
</return>
</function>
<!-- isDefined -->
<function>
<name>isDefined</name>
<class>lucee.runtime.functions.decision.IsDefined</class>
<tte-class>lucee.transformer.cfml.evaluator.func.impl.IsDefined</tte-class>
<keywords>decision</keywords>
<status>deprecated</status>
<description>Evaluates a string value to determine whether the variable
named in it exists.</description>
<argument>
<name>value</name>
<alias>variable</alias>
<type>string</type>
<required>Yes</required>
<description>String, enclosed in quotation marks. Name of variable to test for.</description>
</argument>
<return>
<type>boolean</type>
</return>
</function>
<!-- incrementValue -->
<function>
<name>incrementValue</name>
<member-name>incrementValue</member-name>
<class>lucee.runtime.functions.math.IncrementValue</class>
<status>deprecated</status>
<description>this function is deprecated, use instead the ++ operator;Increments the current number by one</description>
<argument>
<name>number</name>
<type>number</type>
<required>Yes</required>
<description>Number to increment</description>
</argument>
<return>
<type>number</type>
</return>
</function>
<!-- isDate -->
<function>
<name>isDate</name>
<class>lucee.runtime.functions.decision.IsDate</class>
<keywords>decision,date</keywords>
<description>Determines whether a string or Java object can be converted
to a date/time value.</description>
<argument>
<name>value</name>
<alias>string</alias>
<type>any</type>
<required>Yes</required>
<description>A string or a variable that contains one. </description>
</argument>
<return>
<type>boolean</type>
</return>
</function>
<!-- isK2ServerABroker (Deprecated) -->
<function>
<name>isK2ServerABroker</name>
<class>lucee.runtime.functions.decision.IsK2ServerABroker</class>
<status>hidden</status>
<description>This function is deprecated. </description>
<return>
<type>boolean</type>
</return>
</function>
<!-- isK2ServerDocCountExceeded (Deprecated)-->
<function>
<name>isK2ServerDocCountExceeded</name>
<class>lucee.runtime.functions.decision.IsK2ServerDocCountExceeded</class>
<status>hidden</status>
<description>This function is deprecated. </description>
<return>
<type>boolean</type>
</return>
</function>
<!-- isK2ServerOnline (Deprecated) -->
<function>
<name>isK2ServerOnline</name>
<class>lucee.runtime.functions.decision.IsK2ServerOnline</class>
<status>hidden</status>
<description>This function is deprecated.</description>