-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathcfwheels.xml
More file actions
5596 lines (5596 loc) · 248 KB
/
cfwheels.xml
File metadata and controls
5596 lines (5596 loc) · 248 KB
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="UTF-8"?>
<!--
Author : Russ Johnson (russ@angry-fly.com)
Date : 1/12/2010
Description :
This is the Eclipse Dictionary for CFWheels version 1.1.x
-->
<dictionary>
<functions>
<function name="accessibleProperties" returns="void">
<help><![CDATA[
Use this method to specify which properties can be set through mass assignment.
]]></help>
<parameter name="properties" type="string" required="0">
<help><![CDATA[
Property name (or list of property names) that are allowed to be altered through mass assignment.
]]></help>
</parameter>
</function>
<function name="addDefaultRoutes" returns="void">
<help><![CDATA[
Adds the default Wheels routes (for example, `[controller]/[action]/[key]`, etc.) to your application. Only use this method if you have set `loadDefaultRoutes` to `false` and want to control exactly where in the route order you want to place the default routes.
]]></help>
</function>
<function name="addError" returns="void">
<help><![CDATA[
Adds an error on a specific property.
]]></help>
<parameter name="property" type="string" required="1">
<help><![CDATA[
The name of the property you want to add an error on.
]]></help>
</parameter>
<parameter name="message" type="string" required="1">
<help><![CDATA[
The error message (such as "Please enter a correct name in the form field" for example).
]]></help>
</parameter>
<parameter name="name" type="string" required="0">
<help><![CDATA[
A name to identify the error by (useful when you need to distinguish one error from another one set on the same object and you don't want to use the error message itself for that).
]]></help>
</parameter>
</function>
<function name="addErrorToBase" returns="void">
<help><![CDATA[
Adds an error on the object as a whole (not related to any specific property).
]]></help>
<parameter name="message" type="string" required="1">
<help><![CDATA[
The error message (such as "Please enter a correct name in the form field" for example).
]]></help>
</parameter>
<parameter name="name" type="string" required="0">
<help><![CDATA[
A name to identify the error by (useful when you need to distinguish one error from another one set on the same object and you don't want to use the error message itself for that).
]]></help>
</parameter>
</function>
<function name="addFormat" returns="void">
<help><![CDATA[
Adds a new MIME format to your Wheels application for use with responding to multiple formats.
]]></help>
<parameter name="extension" type="string" required="1">
<help><![CDATA[
File extension to add.
]]></help>
</parameter>
<parameter name="mimeType" type="string" required="1">
<help><![CDATA[
Matching MIME type to associate with the file extension.
]]></help>
</parameter>
</function>
<function name="addRoute" returns="void">
<help><![CDATA[
Adds a new route to your application.
]]></help>
<parameter name="name" type="string" required="0">
<help><![CDATA[
Name for the route. This is referenced as the `name` argument in functions based on @URLFor like @linkTo, @startFormTag, etc.
]]></help>
</parameter>
<parameter name="pattern" type="string" required="1">
<help><![CDATA[
The URL pattern that the route will match.
]]></help>
</parameter>
<parameter name="controller" type="string" required="0">
<help><![CDATA[
Controller to call when route matches (unless the controller name exists in the pattern).
]]></help>
</parameter>
<parameter name="action" type="string" required="0">
<help><![CDATA[
Action to call when route matches (unless the action name exists in the pattern).
]]></help>
</parameter>
</function>
<function name="afterCreate" returns="void">
<help><![CDATA[
Registers method(s) that should be called after a new object is created.
]]></help>
<parameter name="methods" type="string" required="0">
<help><![CDATA[
Method name or list of method names that should be called when this callback event occurs in an object's life cycle (can also be called with the `method` argument).
]]></help>
</parameter>
</function>
<function name="afterDelete" returns="void">
<help><![CDATA[
Registers method(s) that should be called after an object is deleted.
]]></help>
<parameter name="methods" type="string" required="0">
<help><![CDATA[
Method name or list of method names that should be called when this callback event occurs in an object's life cycle (can also be called with the `method` argument).
]]></help>
</parameter>
</function>
<function name="afterFind" returns="void">
<help><![CDATA[
Registers method(s) that should be called after an existing object has been initialized (which is usually done with the @findByKey or @findOne method).
]]></help>
<parameter name="methods" type="string" required="0">
<help><![CDATA[
Method name or list of method names that should be called when this callback event occurs in an object's life cycle (can also be called with the `method` argument).
]]></help>
</parameter>
</function>
<function name="afterInitialization" returns="void">
<help><![CDATA[
Registers method(s) that should be called after an object has been initialized.
]]></help>
<parameter name="methods" type="string" required="0">
<help><![CDATA[
Method name or list of method names that should be called when this callback event occurs in an object's life cycle (can also be called with the `method` argument).
]]></help>
</parameter>
</function>
<function name="afterNew" returns="void">
<help><![CDATA[
Registers method(s) that should be called after a new object has been initialized (which is usually done with the @new method).
]]></help>
<parameter name="methods" type="string" required="0">
<help><![CDATA[
Method name or list of method names that should be called when this callback event occurs in an object's life cycle (can also be called with the `method` argument).
]]></help>
</parameter>
</function>
<function name="afterSave" returns="void">
<help><![CDATA[
Registers method(s) that should be called after an object is saved.
]]></help>
<parameter name="methods" type="string" required="0">
<help><![CDATA[
Method name or list of method names that should be called when this callback event occurs in an object's life cycle (can also be called with the `method` argument).
]]></help>
</parameter>
</function>
<function name="afterUpdate" returns="void">
<help><![CDATA[
Registers method(s) that should be called after an existing object is updated.
]]></help>
<parameter name="methods" type="string" required="0">
<help><![CDATA[
Method name or list of method names that should be called when this callback event occurs in an object's life cycle (can also be called with the `method` argument).
]]></help>
</parameter>
</function>
<function name="afterValidation" returns="void">
<help><![CDATA[
Registers method(s) that should be called after an object is validated.
]]></help>
<parameter name="methods" type="string" required="0">
<help><![CDATA[
Method name or list of method names that should be called when this callback event occurs in an object's life cycle (can also be called with the `method` argument).
]]></help>
</parameter>
</function>
<function name="afterValidationOnCreate" returns="void">
<help><![CDATA[
Registers method(s) that should be called after a new object is validated.
]]></help>
<parameter name="methods" type="string" required="0">
<help><![CDATA[
Method name or list of method names that should be called when this callback event occurs in an object's life cycle (can also be called with the `method` argument).
]]></help>
</parameter>
</function>
<function name="afterValidationOnUpdate" returns="void">
<help><![CDATA[
Registers method(s) that should be called after an existing object is validated.
]]></help>
<parameter name="methods" type="string" required="0">
<help><![CDATA[
Method name or list of method names that should be called when this callback event occurs in an object's life cycle (can also be called with the `method` argument).
]]></help>
</parameter>
</function>
<function name="allChanges" returns="struct">
<help><![CDATA[
Returns a struct detailing all changes that have been made on the object but not yet saved to the database.
]]></help>
</function>
<function name="allErrors" returns="array">
<help><![CDATA[
Returns an array of all the errors on the object.
]]></help>
</function>
<function name="autoLink" returns="string">
<help><![CDATA[
Turns all URLs and email addresses into hyperlinks.
]]></help>
<parameter name="text" type="string" required="1">
<help><![CDATA[
The text to create links in.
]]></help>
</parameter>
<parameter name="link" type="string" required="0">
<help><![CDATA[
Whether to link URLs, email addresses or both. Possible values are: `all` (default), `URLs` and `emailAddresses`.
]]></help>
</parameter>
</function>
<function name="automaticValidations" returns="void">
<help><![CDATA[
Whether or not to enable default validations for this model.
]]></help>
</function>
<function name="average" returns="any">
<help><![CDATA[
Calculates the average value for a given property. Uses the SQL function `AVG`. If no records can be found to perform the calculation on you can use the `ifNull` argument to decide what should be returned.
]]></help>
<parameter name="property" type="string" required="1">
<help><![CDATA[
Name of the property to calculate the average for.
]]></help>
</parameter>
<parameter name="where" type="string" required="0">
<help><![CDATA[
This argument maps to the `WHERE` clause of the query. The following operators are supported: `=`, `!=`, `<>`, `<`, `<=`, `>`, `>=`, `LIKE`, `NOT LIKE`, `IN`, `NOT IN`, `IS NULL`, `IS NOT NULL`, `AND`, and `OR`. (Note that the key words need to be written in upper case.) You can also use parentheses to group statements. You do not need to specify the table name(s); Wheels will do that for you.
]]></help>
</parameter>
<parameter name="include" type="string" required="0">
<help><![CDATA[
Associations that should be included in the query using `INNER` or `LEFT OUTER` joins (which join type that is used depends on how the association has been set up in your model). If all included associations are set on the current model, you can specify them in a list (e.g. `department,addresses,emails`). You can build more complex `include` strings by using parentheses when the association is set on an included model, like `album(artist(genre))`, for example. These complex `include` strings only work when `returnAs` is set to `query` though.
]]></help>
</parameter>
<parameter name="distinct" type="boolean" required="0">
<help><![CDATA[
When `true`, `AVG` will be performed only on each unique instance of a value, regardless of how many times the value occurs.
]]></help>
</parameter>
<parameter name="parameterize" type="any" required="0">
<help><![CDATA[
Set to `true` to use `cfqueryparam` on all columns, or pass in a list of property names to use `cfqueryparam` on those only.
]]></help>
</parameter>
<parameter name="ifNull" type="any" required="0">
<help><![CDATA[
The value returned if no records are found. Common usage is to set this to `0` to make sure a numeric value is always returned instead of a blank string.
]]></help>
</parameter>
<parameter name="includeSoftDeletes" type="boolean" required="0">
<help><![CDATA[
You can set this argument to `true` to include soft-deleted records in the results.
]]></help>
</parameter>
</function>
<function name="beforeCreate" returns="void">
<help><![CDATA[
Registers method(s) that should be called before a new object is created.
]]></help>
<parameter name="methods" type="string" required="0">
<help><![CDATA[
Method name or list of method names that should be called when this callback event occurs in an object's life cycle (can also be called with the `method` argument).
]]></help>
</parameter>
</function>
<function name="beforeDelete" returns="void">
<help><![CDATA[
Registers method(s) that should be called before an object is deleted.
]]></help>
<parameter name="methods" type="string" required="0">
<help><![CDATA[
Method name or list of method names that should be called when this callback event occurs in an object's life cycle (can also be called with the `method` argument).
]]></help>
</parameter>
</function>
<function name="beforeSave" returns="void">
<help><![CDATA[
Registers method(s) that should be called before an object is saved.
]]></help>
<parameter name="methods" type="string" required="0">
<help><![CDATA[
Method name or list of method names that should be called when this callback event occurs in an object's life cycle (can also be called with the `method` argument).
]]></help>
</parameter>
</function>
<function name="beforeUpdate" returns="void">
<help><![CDATA[
Registers method(s) that should be called before an existing object is updated.
]]></help>
<parameter name="methods" type="string" required="0">
<help><![CDATA[
Method name or list of method names that should be called when this callback event occurs in an object's life cycle (can also be called with the `method` argument).
]]></help>
</parameter>
</function>
<function name="beforeValidation" returns="void">
<help><![CDATA[
Registers method(s) that should be called before an object is validated.
]]></help>
<parameter name="methods" type="string" required="0">
<help><![CDATA[
Method name or list of method names that should be called when this callback event occurs in an object's life cycle (can also be called with the `method` argument).
]]></help>
</parameter>
</function>
<function name="beforeValidationOnCreate" returns="void">
<help><![CDATA[
Registers method(s) that should be called before a new object is validated.
]]></help>
<parameter name="methods" type="string" required="0">
<help><![CDATA[
Method name or list of method names that should be called when this callback event occurs in an object's life cycle (can also be called with the `method` argument).
]]></help>
</parameter>
</function>
<function name="beforeValidationOnUpdate" returns="void">
<help><![CDATA[
Registers method(s) that should be called before an existing object is validated.
]]></help>
<parameter name="methods" type="string" required="0">
<help><![CDATA[
Method name or list of method names that should be called when this callback event occurs in an object's life cycle (can also be called with the `method` argument).
]]></help>
</parameter>
</function>
<function name="belongsTo" returns="void">
<help><![CDATA[
Sets up a `belongsTo` association between this model and the specified one. Use this association when this model contains a foreign key referencing another model.
]]></help>
<parameter name="name" type="string" required="1">
<help><![CDATA[
Gives the association a name that you refer to when working with the association (in the `include` argument to @findAll, to name one example).
]]></help>
</parameter>
<parameter name="modelName" type="string" required="0">
<help><![CDATA[
Name of associated model (usually not needed if you follow Wheels conventions because the model name will be deduced from the `name` argument).
]]></help>
</parameter>
<parameter name="foreignKey" type="string" required="0">
<help><![CDATA[
Foreign key property name (usually not needed if you follow Wheels conventions since the foreign key name will be deduced from the `name` argument).
]]></help>
</parameter>
<parameter name="joinType" type="string" required="0">
<help><![CDATA[
Use to set the join type when joining associated tables. Possible values are `inner` (for `INNER JOIN`) and `outer` (for `LEFT OUTER JOIN`).
]]></help>
</parameter>
</function>
<function name="buttonTag" returns="string">
<help><![CDATA[
Builds and returns a string containing a button `form` control.
]]></help>
<parameter name="content" type="string" required="0">
<help><![CDATA[
Content to display inside the button.
]]></help>
</parameter>
<parameter name="type" type="string" required="0">
<help><![CDATA[
The type for the button: `button`, `reset`, or `submit`.
]]></help>
</parameter>
<parameter name="image" type="string" required="0">
<help><![CDATA[
File name of the image file to use in the button form control.
]]></help>
</parameter>
<parameter name="value" type="string" required="0">
<help><![CDATA[
The value of the button when submitted.
]]></help>
</parameter>
<parameter name="disable" type="any" required="0">
<help><![CDATA[
Whether or not to disable the button upon clicking. (Prevents double-clicking.)
]]></help>
</parameter>
</function>
<function name="buttonTo" returns="string">
<help><![CDATA[
Creates a form containing a single button that submits to the URL. The URL is built the same way as the @linkTo function.
]]></help>
<parameter name="text" type="string" required="0">
<help><![CDATA[
The text content of the button.
]]></help>
</parameter>
<parameter name="confirm" type="string" required="0">
<help><![CDATA[
Pass a message here to cause a JavaScript confirmation dialog box to pop up containing the message.
]]></help>
</parameter>
<parameter name="image" type="string" required="0">
<help><![CDATA[
If you want to use an image for the button pass in the link to it here (relative from the `images` folder).
]]></help>
</parameter>
<parameter name="disable" type="any" required="0">
<help><![CDATA[
Pass in `true` if you want the button to be disabled when clicked (can help prevent multiple clicks), or pass in a string if you want the button disabled and the text on the button updated (to "please wait...", for example).
]]></help>
</parameter>
<parameter name="route" type="string" required="0">
<help><![CDATA[
Name of a route that you have configured in `config/routes.cfm`.
]]></help>
</parameter>
<parameter name="controller" type="string" required="0">
<help><![CDATA[
Name of the controller to include in the URL.
]]></help>
</parameter>
<parameter name="action" type="string" required="0">
<help><![CDATA[
Name of the action to include in the URL.
]]></help>
</parameter>
<parameter name="key" type="any" required="0">
<help><![CDATA[
Key(s) to include in the URL.
]]></help>
</parameter>
<parameter name="params" type="string" required="0">
<help><![CDATA[
Any additional params to be set in the query string.
]]></help>
</parameter>
<parameter name="anchor" type="string" required="0">
<help><![CDATA[
Sets an anchor name to be appended to the path.
]]></help>
</parameter>
<parameter name="onlyPath" type="boolean" required="0">
<help><![CDATA[
If `true`, returns only the relative URL (no protocol, host name or port).
]]></help>
</parameter>
<parameter name="host" type="string" required="0">
<help><![CDATA[
Set this to override the current host.
]]></help>
</parameter>
<parameter name="protocol" type="string" required="0">
<help><![CDATA[
Set this to override the current protocol.
]]></help>
</parameter>
<parameter name="port" type="numeric" required="0">
<help><![CDATA[
Set this to override the current port number.
]]></help>
</parameter>
</function>
<function name="caches" returns="void">
<help><![CDATA[
Tells Wheels to cache one or more actions.
]]></help>
<parameter name="action" type="string" required="0">
<help><![CDATA[
Action(s) to cache. This argument is also aliased as `actions`.
]]></help>
</parameter>
<parameter name="time" type="numeric" required="0">
<help><![CDATA[
Minutes to cache the action(s) for.
]]></help>
</parameter>
<parameter name="static" type="boolean" required="0">
<help><![CDATA[
Set to `true` to tell Wheels that this is a static page and that it can skip running the controller filters (before and after filters set on actions) and application events (onSessionStart, onRequestStart etc).
]]></help>
</parameter>
</function>
<function name="capitalize" returns="string">
<help><![CDATA[
Returns the text with the first character converted to uppercase.
]]></help>
<parameter name="text" type="string" required="1">
<help><![CDATA[
Text to capitalize.
]]></help>
</parameter>
</function>
<function name="changedFrom" returns="string">
<help><![CDATA[
Returns the previous value of a property that has changed. Returns an empty string if no previous value exists. Wheels will keep a note of the previous property value until the object is saved to the database.
]]></help>
<parameter name="property" type="string" required="1">
<help><![CDATA[
Name of property to get the previous value for.
]]></help>
</parameter>
</function>
<function name="changedProperties" returns="string">
<help><![CDATA[
Returns a list of the object properties that have been changed but not yet saved to the database.
]]></help>
</function>
<function name="checkBox" returns="string">
<help><![CDATA[
Builds and returns a string containing a check box form control based on the supplied `objectName` and `property`. In most cases, this function generates a form field that should represent a `boolean` style field in your data. Use @checkBoxTag or @hasManyCheckBox to generate check boxes for selecting multiple values. Note: Pass any additional arguments like `class`, `rel`, and `id`, and the generated tag will also include those values as HTML attributes.
]]></help>
<parameter name="objectName" type="any" required="1">
<help><![CDATA[
The variable name of the object to build the form control for.
]]></help>
</parameter>
<parameter name="property" type="string" required="1">
<help><![CDATA[
The name of the property to use in the form control.
]]></help>
</parameter>
<parameter name="association" type="string" required="0">
<help><![CDATA[
The name of the association that the property is located on. Used for building nested forms that work with nested properties. If you are building a form with deep nesting, simply pass in a list to the nested object, and Wheels will figure it out.
]]></help>
</parameter>
<parameter name="position" type="string" required="0">
<help><![CDATA[
The position used when referencing a `hasMany` relationship in the `association` argument. Used for building nested forms that work with nested properties. If you are building a form with deep nestings, simply pass in a list of positions, and Wheels will figure it out.
]]></help>
</parameter>
<parameter name="checkedValue" type="string" required="0">
<help><![CDATA[
The value of the check box when it's in the `checked` state.
]]></help>
</parameter>
<parameter name="uncheckedValue" type="string" required="0">
<help><![CDATA[
The value of the check box when it's in the `unchecked` state.
]]></help>
</parameter>
<parameter name="label" type="string" required="0">
<help><![CDATA[
The label text to use in the form control.
]]></help>
</parameter>
<parameter name="labelPlacement" type="string" required="0">
<help><![CDATA[
Whether to place the label `before`, `after`, or wrapped `around` the form control.
]]></help>
</parameter>
<parameter name="prepend" type="string" required="0">
<help><![CDATA[
String to prepend to the form control. Useful to wrap the form control with HTML tags.
]]></help>
</parameter>
<parameter name="append" type="string" required="0">
<help><![CDATA[
String to append to the form control. Useful to wrap the form control with HTML tags.
]]></help>
</parameter>
<parameter name="prependToLabel" type="string" required="0">
<help><![CDATA[
String to prepend to the form control's `label`. Useful to wrap the form control with HTML tags.
]]></help>
</parameter>
<parameter name="appendToLabel" type="string" required="0">
<help><![CDATA[
String to append to the form control's `label`. Useful to wrap the form control with HTML tags.
]]></help>
</parameter>
<parameter name="errorElement" type="string" required="0">
<help><![CDATA[
HTML tag to wrap the form control with when the object contains errors.
]]></help>
</parameter>
<parameter name="errorClass" type="string" required="0">
<help><![CDATA[
The class name of the HTML tag that wraps the form control when there are errors.
]]></help>
</parameter>
</function>
<function name="checkBoxTag" returns="string">
<help><![CDATA[
Builds and returns a string containing a check box form control based on the supplied `name`. Note: Pass any additional arguments like `class`, `rel`, and `id`, and the generated tag will also include those values as HTML attributes.
]]></help>
<parameter name="name" type="string" required="1">
<help><![CDATA[
Name to populate in tag's `name` attribute.
]]></help>
</parameter>
<parameter name="checked" type="boolean" required="0">
<help><![CDATA[
Whether or not the check box should be checked by default.
]]></help>
</parameter>
<parameter name="value" type="string" required="0">
<help><![CDATA[
Value of check box in its `checked` state.
]]></help>
</parameter>
<parameter name="uncheckedValue" type="string" required="0">
<help><![CDATA[
The value of the check box when it's on the `unchecked` state.
]]></help>
</parameter>
<parameter name="label" type="string" required="0">
<help><![CDATA[
The label text to use in the form control.
]]></help>
</parameter>
<parameter name="labelPlacement" type="string" required="0">
<help><![CDATA[
Whether to place the label `before`, `after`, or wrapped `around` the form control.
]]></help>
</parameter>
<parameter name="prepend" type="string" required="0">
<help><![CDATA[
String to prepend to the form control. Useful to wrap the form control with HTML tags.
]]></help>
</parameter>
<parameter name="append" type="string" required="0">
<help><![CDATA[
String to append to the form control. Useful to wrap the form control with HTML tags.
]]></help>
</parameter>
<parameter name="prependToLabel" type="string" required="0">
<help><![CDATA[
String to prepend to the form control's `label`. Useful to wrap the form control with HTML tags.
]]></help>
</parameter>
<parameter name="appendToLabel" type="string" required="0">
<help><![CDATA[
String to append to the form control's `label`. Useful to wrap the form control with HTML tags.
]]></help>
</parameter>
</function>
<function name="clearErrors" returns="void">
<help><![CDATA[
Clears out all errors set on the object or only the ones set for a specific property or name.
]]></help>
<parameter name="property" type="string" required="0">
<help><![CDATA[
Specify a property name here if you want to clear all errors set on that property.
]]></help>
</parameter>
<parameter name="name" type="string" required="0">
<help><![CDATA[
Specify an error name here if you want to clear all errors set with that error name.
]]></help>
</parameter>
</function>
<function name="columnDataForProperty" returns="any">
<help><![CDATA[
Returns a struct with data for the named property.
]]></help>
<parameter name="property" type="string" required="1">
<help><![CDATA[
Name of column to retrieve data for.
]]></help>
</parameter>
</function>
<function name="columnForProperty" returns="any">
<help><![CDATA[
Returns the column name mapped for the named model property.
]]></help>
<parameter name="property" type="string" required="1">
<help><![CDATA[
Name of property to inspect.
]]></help>
</parameter>
</function>
<function name="columnNames" returns="string">
<help><![CDATA[
Returns a list of column names in the table mapped to this model. The list is ordered according to the columns' ordinal positions in the database table.
]]></help>
</function>
<function name="columns" returns="array">
<help><![CDATA[
Returns an array of columns names for the table associated with this class. Does not include calculated properties that will be generated by the Wheels ORM.
]]></help>
</function>
<function name="compareTo" returns="boolean">
<help><![CDATA[
Pass in another Wheels model object to see if the two objects are the same.
]]></help>
</function>
<function name="contentFor" returns="void">
<help><![CDATA[
Used to store a section's output for rendering within a layout. This content store acts as a stack, so you can store multiple pieces of content for a given section.
]]></help>
<parameter name="position" type="any" required="0">
<help><![CDATA[
The position in the section's stack where you want the content placed. Valid values are `first`, `last`, or the numeric position.
]]></help>
</parameter>
<parameter name="overwrite" type="any" required="0">
<help><![CDATA[
Whether or not to overwrite any of the content. Valid values are `false`, `true`, or `all`.
]]></help>
</parameter>
</function>
<function name="contentForLayout" returns="string">
<help><![CDATA[
Includes content for the `body` section, which equates to the output generated by the view template run by the request.
]]></help>
</function>
<function name="controller" returns="any">
<help><![CDATA[
Creates and returns a controller object with your own custom `name` and `params`. Used primarily for testing purposes.
]]></help>
<parameter name="name" type="string" required="1">
<help><![CDATA[
Name of the controller to create.
]]></help>
</parameter>
<parameter name="params" type="struct" required="0">
<help><![CDATA[
The params struct (combination of `form` and `URL` variables).
]]></help>
</parameter>
</function>
<function name="count" returns="numeric">
<help><![CDATA[
Returns the number of rows that match the arguments (or all rows if no arguments are passed in). Uses the SQL function `COUNT`. If no records can be found to perform the calculation on, `0` is returned.
]]></help>
<parameter name="where" type="string" required="0">
<help><![CDATA[
This argument maps to the `WHERE` clause of the query. The following operators are supported: `=`, `!=`, `<>`, `<`, `<=`, `>`, `>=`, `LIKE`, `NOT LIKE`, `IN`, `NOT IN`, `IS NULL`, `IS NOT NULL`, `AND`, and `OR`. (Note that the key words need to be written in upper case.) You can also use parentheses to group statements. You do not need to specify the table name(s); Wheels will do that for you.
]]></help>
</parameter>
<parameter name="include" type="string" required="0">
<help><![CDATA[
Associations that should be included in the query using `INNER` or `LEFT OUTER` joins (which join type that is used depends on how the association has been set up in your model). If all included associations are set on the current model, you can specify them in a list (e.g. `department,addresses,emails`). You can build more complex `include` strings by using parentheses when the association is set on an included model, like `album(artist(genre))`, for example. These complex `include` strings only work when `returnAs` is set to `query` though.
]]></help>
</parameter>
<parameter name="parameterize" type="any" required="0">
<help><![CDATA[
Set to `true` to use `cfqueryparam` on all columns, or pass in a list of property names to use `cfqueryparam` on those only.
]]></help>
</parameter>
<parameter name="includeSoftDeletes" type="boolean" required="0">
<help><![CDATA[
You can set this argument to `true` to include soft-deleted records in the results.
]]></help>
</parameter>
</function>
<function name="create" returns="any">
<help><![CDATA[
Creates a new object, saves it to the database (if the validation permits it), and returns it. If the validation fails, the unsaved object (with errors added to it) is still returned. Property names and values can be passed in either using named arguments or as a struct to the `properties` argument.
]]></help>
<parameter name="properties" type="struct" required="0">
<help><![CDATA[
The properties you want to set on the object (can also be passed in as named arguments).
]]></help>
</parameter>
<parameter name="parameterize" type="any" required="0">
<help><![CDATA[
Set to `true` to use `cfqueryparam` on all columns, or pass in a list of property names to use `cfqueryparam` on those only.
]]></help>
</parameter>
<parameter name="reload" type="boolean" required="0">
<help><![CDATA[
Set to `true` to reload the object from the database once an insert/update has completed.
]]></help>
</parameter>
<parameter name="transaction" type="string" required="0">
<help><![CDATA[
Set this to `commit` to update the database when the save has completed, `rollback` to run all the database queries but not commit them, or `none` to skip transaction handling altogether.
]]></help>
</parameter>
<parameter name="callbacks" type="boolean" required="0">
<help><![CDATA[
Set to `false` to disable callbacks for this operation.
]]></help>
</parameter>
</function>
<function name="cycle" returns="string">
<help><![CDATA[
Cycles through list values every time it is called.
]]></help>
<parameter name="values" type="string" required="1">
<help><![CDATA[
List of values to cycle through.
]]></help>
</parameter>
<parameter name="name" type="string" required="0">
<help><![CDATA[
Name to give the cycle. Useful when you use multiple cycles on a page.
]]></help>
</parameter>
</function>
<function name="dataSource" returns="void">
<help><![CDATA[
Use this method to override the data source connection information for this model.
]]></help>
<parameter name="datasource" type="string" required="1">
<help><![CDATA[
The data source name to connect to.
]]></help>
</parameter>
<parameter name="username" type="string" required="0">
<help><![CDATA[
The username for the data source.
]]></help>
</parameter>
<parameter name="password" type="string" required="0">
<help><![CDATA[
The password for the data source.
]]></help>
</parameter>
</function>
<function name="dateSelect" returns="string">
<help><![CDATA[
Builds and returns a string containing three select form controls for month, day, and year based on the supplied `objectName` and `property`.
]]></help>
<parameter name="objectName" type="any" required="0">
<help><![CDATA[
The variable name of the object to build the form control for.
]]></help>
</parameter>
<parameter name="property" type="string" required="0">
<help><![CDATA[
The name of the property to use in the form control.
]]></help>
</parameter>
<parameter name="association" type="string" required="0">
<help><![CDATA[
The name of the association that the property is located on. Used for building nested forms that work with nested properties. If you are building a form with deep nesting, simply pass in a list to the nested object, and Wheels will figure it out.
]]></help>
</parameter>
<parameter name="position" type="string" required="0">
<help><![CDATA[
The position used when referencing a `hasMany` relationship in the `association` argument. Used for building nested forms that work with nested properties. If you are building a form with deep nestings, simply pass in a list of positions, and Wheels will figure it out.
]]></help>
</parameter>
<parameter name="order" type="string" required="0">
<help><![CDATA[
Use to change the order of or exclude date select tags.
]]></help>
</parameter>
<parameter name="separator" type="string" required="0">
<help><![CDATA[
Use to change the character that is displayed between the date select tags.
]]></help>
</parameter>
<parameter name="startYear" type="numeric" required="0">
<help><![CDATA[
First year in select list.
]]></help>
</parameter>
<parameter name="endYear" type="numeric" required="0">
<help><![CDATA[
Last year in select list.
]]></help>
</parameter>
<parameter name="monthDisplay" type="string" required="0">
<help><![CDATA[
Pass in `names`, `numbers`, or `abbreviations` to control display.
]]></help>
</parameter>
<parameter name="includeBlank" type="any" required="0">
<help><![CDATA[
Whether to include a blank option in the select form control. Pass `true` to include a blank line or a string that should represent what display text should appear for the empty value (for example, "- Select One -").
]]></help>
</parameter>
<parameter name="label" type="string" required="0">
<help><![CDATA[
The label text to use in the form control. The label will be applied to all `select` tags, but you can pass in a list to cutomize each one individually.
]]></help>
</parameter>
<parameter name="labelPlacement" type="string" required="0">
<help><![CDATA[
Whether to place the label `before`, `after`, or wrapped `around` the form control.
]]></help>
</parameter>
<parameter name="prepend" type="string" required="0">
<help><![CDATA[
String to prepend to the form control. Useful to wrap the form control with HTML tags.
]]></help>
</parameter>
<parameter name="append" type="string" required="0">
<help><![CDATA[
String to append to the form control. Useful to wrap the form control with HTML tags.
]]></help>
</parameter>
<parameter name="prependToLabel" type="string" required="0">
<help><![CDATA[
String to prepend to the form control's `label`. Useful to wrap the form control with HTML tags.
]]></help>
</parameter>
<parameter name="appendToLabel" type="string" required="0">
<help><![CDATA[
String to append to the form control's `label`. Useful to wrap the form control with HTML tags.
]]></help>
</parameter>
<parameter name="errorElement" type="string" required="0">
<help><![CDATA[
HTML tag to wrap the form control with when the object contains errors.
]]></help>
</parameter>
<parameter name="errorClass" type="string" required="0">
<help><![CDATA[
The class name of the HTML tag that wraps the form control when there are errors.
]]></help>
</parameter>
<parameter name="combine" type="boolean" required="0">
<help><![CDATA[
Set to `false` to not combine the select parts into a single `DateTime` object.
]]></help>
</parameter>
</function>
<function name="dateSelectTags" returns="string">
<help><![CDATA[
Builds and returns a string containing three select form controls (month, day, and year) based on a `name` and `value`.
]]></help>
<parameter name="name" type="string" required="1">
<help><![CDATA[
Name to populate in tag's `name` attribute.
]]></help>
</parameter>
<parameter name="selected" type="string" required="0">
<help><![CDATA[
Value of option that should be selected by default.
]]></help>
</parameter>
<parameter name="order" type="string" required="0">
<help><![CDATA[
Use to change the order of or exclude date select tags.
]]></help>
</parameter>
<parameter name="separator" type="string" required="0">
<help><![CDATA[
Use to change the character that is displayed between the date select tags.
]]></help>
</parameter>
<parameter name="startYear" type="numeric" required="0">
<help><![CDATA[
First year in select list.
]]></help>
</parameter>
<parameter name="endYear" type="numeric" required="0">
<help><![CDATA[
Last year in select list.
]]></help>
</parameter>
<parameter name="monthDisplay" type="string" required="0">
<help><![CDATA[
Pass in `names`, `numbers`, or `abbreviations` to control display.
]]></help>
</parameter>
<parameter name="includeBlank" type="any" required="0">
<help><![CDATA[
Whether to include a blank option in the select form control. Pass `true` to include a blank line or a string that should represent what display text should appear for the empty value (for example, "- Select One -").
]]></help>
</parameter>
<parameter name="label" type="string" required="0">
<help><![CDATA[
The label text to use in the form control. The label will be applied to all `select` tags, but you can pass in a list to cutomize each one individually.
]]></help>
</parameter>
<parameter name="labelPlacement" type="string" required="0">
<help><![CDATA[
Whether to place the label `before`, `after`, or wrapped `around` the form control.
]]></help>
</parameter>
<parameter name="prepend" type="string" required="0">
<help><![CDATA[
String to prepend to the form control. Useful to wrap the form control with HTML tags.
]]></help>
</parameter>
<parameter name="append" type="string" required="0">
<help><![CDATA[
String to append to the form control. Useful to wrap the form control with HTML tags.
]]></help>
</parameter>
<parameter name="prependToLabel" type="string" required="0">
<help><![CDATA[
String to prepend to the form control's `label`. Useful to wrap the form control with HTML tags.
]]></help>
</parameter>
<parameter name="appendToLabel" type="string" required="0">
<help><![CDATA[
String to append to the form control's `label`. Useful to wrap the form control with HTML tags.
]]></help>
</parameter>
<parameter name="combine" type="boolean" required="0">
<help><![CDATA[
Set to `false` to not combine the select parts into a single `DateTime` object.
]]></help>
</parameter>
</function>
<function name="dateTimeSelect" returns="string">