-
Notifications
You must be signed in to change notification settings - Fork 3
/
elementindex_FrameworkOnFramework-Controller.html
1060 lines (1058 loc) · 57.3 KB
/
elementindex_FrameworkOnFramework-Controller.html
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 html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<!-- template designed by Marco Von Ballmoos -->
<title></title>
<link rel="stylesheet" href="media/stylesheet.css" />
</head>
<body>
<a name="top"></a>
<h2>[FrameworkOnFramework-Controller] element index</h2>
<h3>Package indexes</h3>
<ul>
<li><a href="elementindex_Joomla-Administrator.html">Joomla-Administrator</a></li>
<li><a href="elementindex_default.html">default</a></li>
<li><a href="elementindex_Joomla-Site.html">Joomla-Site</a></li>
<li><a href="elementindex_Joomla-Libraries.html">Joomla-Libraries</a></li>
<li><a href="elementindex_akeebabackup.html">akeebabackup</a></li>
<li><a href="elementindex_Joomla-Language.html">Joomla-Language</a></li>
<li><a href="elementindex_Joomla-Platform.html">Joomla-Platform</a></li>
<li><a href="elementindex_Joomla-Cli.html">Joomla-Cli</a></li>
<li><a href="elementindex_Joomla-CLI.html">Joomla-CLI</a></li>
<li><a href="elementindex_Joomla-Cms.html">Joomla-Cms</a></li>
<li><a href="elementindex_Joomla-Installation.html">Joomla-Installation</a></li>
<li><a href="elementindex_Joomla-CMS.html">Joomla-CMS</a></li>
<li><a href="elementindex_Joomla-Legacy.html">Joomla-Legacy</a></li>
<li><a href="elementindex_Joomla-Compat.html">Joomla-Compat</a></li>
<li><a href="elementindex_FrameworkOnFramework.html">FrameworkOnFramework</a></li>
<li><a href="elementindex_FrameworkOnFramework-Dispatcher.html">FrameworkOnFramework-Dispatcher</a></li>
<li><a href="elementindex_IDNA.html">IDNA</a></li>
<li><a href="elementindex_phlyMail.html">phlyMail</a></li>
<li><a href="elementindex_PHPMailer.html">PHPMailer</a></li>
<li><a href="elementindex_utf8.html">utf8</a></li>
<li><a href="elementindex_SimplePie.html">SimplePie</a></li>
<li><a href="elementindex_Joomla-Plugin.html">Joomla-Plugin</a></li>
</ul>
<a href="elementindex.html">All elements</a>
<br />
<div class="index-letter-menu">
<a class="index-letter" href="elementindex_FrameworkOnFramework-Controller.html#a">a</a>
<a class="index-letter" href="elementindex_FrameworkOnFramework-Controller.html#b">b</a>
<a class="index-letter" href="elementindex_FrameworkOnFramework-Controller.html#c">c</a>
<a class="index-letter" href="elementindex_FrameworkOnFramework-Controller.html#d">d</a>
<a class="index-letter" href="elementindex_FrameworkOnFramework-Controller.html#e">e</a>
<a class="index-letter" href="elementindex_FrameworkOnFramework-Controller.html#f">f</a>
<a class="index-letter" href="elementindex_FrameworkOnFramework-Controller.html#g">g</a>
<a class="index-letter" href="elementindex_FrameworkOnFramework-Controller.html#h">h</a>
<a class="index-letter" href="elementindex_FrameworkOnFramework-Controller.html#i">i</a>
<a class="index-letter" href="elementindex_FrameworkOnFramework-Controller.html#l">l</a>
<a class="index-letter" href="elementindex_FrameworkOnFramework-Controller.html#m">m</a>
<a class="index-letter" href="elementindex_FrameworkOnFramework-Controller.html#n">n</a>
<a class="index-letter" href="elementindex_FrameworkOnFramework-Controller.html#o">o</a>
<a class="index-letter" href="elementindex_FrameworkOnFramework-Controller.html#p">p</a>
<a class="index-letter" href="elementindex_FrameworkOnFramework-Controller.html#r">r</a>
<a class="index-letter" href="elementindex_FrameworkOnFramework-Controller.html#s">s</a>
<a class="index-letter" href="elementindex_FrameworkOnFramework-Controller.html#t">t</a>
<a class="index-letter" href="elementindex_FrameworkOnFramework-Controller.html#u">u</a>
<a class="index-letter" href="elementindex_FrameworkOnFramework-Controller.html#v">v</a>
<a class="index-letter" href="elementindex_FrameworkOnFramework-Controller.html#_">_</a>
</div>
<a name="_"></a>
<div class="index-letter-section">
<div style="float: left" class="index-letter-title">_</div>
<div style="float: right"><a href="#top">top</a></div>
<div style="clear: both"></div>
</div>
<dl>
<dt class="field">
<img src="media/images/Method.png" alt="Method" title="Method" />
<span class="method-title">_createModel</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#method_createModel">FOFController::_createModel()</a> in controller.php</div>
<div class="index-item-description">Method to load and return a model object.</div>
</dd>
<dt class="field">
<img src="media/images/Method.png" alt="Method" title="Method" />
<span class="method-title">_createView</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#method_createView">FOFController::_createView()</a> in controller.php</div>
<div class="index-item-description">Deprecated function to create a View object instance</div>
</dd>
<dt class="field">
<img src="media/images/Method.png" alt="Method" title="Method" />
<span class="method-title">_csrfProtection</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#method_csrfProtection">FOFController::_csrfProtection()</a> in controller.php</div>
<div class="index-item-description">Applies CSRF protection by means of a standard Joomla! token (nonce) check.</div>
</dd>
<dt class="field">
<img src="media/images/Constructor.png" alt="Method" title="Method" />
<span class="method-title">__construct</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#method__construct">FOFController::__construct()</a> in controller.php</div>
<div class="index-item-description">Public constructor of the Controller class</div>
</dd>
</dl>
<a name="a"></a>
<div class="index-letter-section">
<div style="float: left" class="index-letter-title">a</div>
<div style="float: right"><a href="#top">top</a></div>
<div style="clear: both"></div>
</div>
<dl>
<dt class="field">
<img src="media/images/Variable.png" alt="Variable" title="Variable" />
<span class="var-title">$autoRouting</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#var$autoRouting">FOFController::$autoRouting</a> in controller.php</div>
</dd>
<dt class="field">
<img src="media/images/Method.png" alt="Method" title="Method" />
<span class="method-title">accesspublic</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#methodaccesspublic">FOFController::accesspublic()</a> in controller.php</div>
<div class="index-item-description">Sets the access to public. Joomla! 1.5 compatibility.</div>
</dd>
<dt class="field">
<img src="media/images/Method.png" alt="Method" title="Method" />
<span class="method-title">accessregistered</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#methodaccessregistered">FOFController::accessregistered()</a> in controller.php</div>
<div class="index-item-description">Sets the access to registered. Joomla! 1.5 compatibility.</div>
</dd>
<dt class="field">
<img src="media/images/Method.png" alt="Method" title="Method" />
<span class="method-title">accessspecial</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#methodaccessspecial">FOFController::accessspecial()</a> in controller.php</div>
<div class="index-item-description">Sets the access to special. Joomla! 1.5 compatibility.</div>
</dd>
<dt class="field">
<img src="media/images/Method.png" alt="Method" title="Method" />
<span class="method-title">add</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#methodadd">FOFController::add()</a> in controller.php</div>
<div class="index-item-description">Single record add. The form layout is used to present a blank page.</div>
</dd>
<dt class="field">
<img src="media/images/Method.png" alt="Method" title="Method" />
<span class="method-title">addModelPath</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#methodaddModelPath">FOFController::addModelPath()</a> in controller.php</div>
<div class="index-item-description">Adds to the stack of model paths in LIFO order.</div>
</dd>
<dt class="field">
<img src="media/images/Method.png" alt="Method" title="Method" />
<span class="method-title">addPath</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#methodaddPath">FOFController::addPath()</a> in controller.php</div>
<div class="index-item-description">Adds to the search path for templates and resources.</div>
</dd>
<dt class="field">
<img src="media/images/Method.png" alt="Method" title="Method" />
<span class="method-title">addViewPath</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#methodaddViewPath">FOFController::addViewPath()</a> in controller.php</div>
<div class="index-item-description">Add one or more view paths to the controller's stack, in LIFO order.</div>
</dd>
<dt class="field">
<img src="media/images/Method.png" alt="Method" title="Method" />
<span class="method-title">apply</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#methodapply">FOFController::apply()</a> in controller.php</div>
<div class="index-item-description">Save the incoming data and then return to the Edit task</div>
</dd>
<dt class="field">
<img src="media/images/Method.png" alt="Method" title="Method" />
<span class="method-title">applySave</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#methodapplySave">FOFController::applySave()</a> in controller.php</div>
<div class="index-item-description">Common method to handle apply and save tasks</div>
</dd>
<dt class="field">
<img src="media/images/Method.png" alt="Method" title="Method" />
<span class="method-title">archive</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#methodarchive">FOFController::archive()</a> in controller.php</div>
<div class="index-item-description">Archive (set enabled = 2) an item.</div>
</dd>
<dt class="field">
<img src="media/images/Method.png" alt="Method" title="Method" />
<span class="method-title">authorise</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#methodauthorise">FOFController::authorise()</a> in controller.php</div>
<div class="index-item-description">Authorisation check</div>
</dd>
</dl>
<a name="b"></a>
<div class="index-letter-section">
<div style="float: left" class="index-letter-title">b</div>
<div style="float: right"><a href="#top">top</a></div>
<div style="clear: both"></div>
</div>
<dl>
<dt class="field">
<img src="media/images/Variable.png" alt="Variable" title="Variable" />
<span class="var-title">$bareComponent</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#var$bareComponent">FOFController::$bareComponent</a> in controller.php</div>
<div class="index-item-description">The current component's name without the com_ prefix</div>
</dd>
<dt class="field">
<img src="media/images/Variable.png" alt="Variable" title="Variable" />
<span class="var-title">$basePath</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#var$basePath">FOFController::$basePath</a> in controller.php</div>
<div class="index-item-description">The base path of the controller</div>
</dd>
<dt class="field">
<img src="media/images/Method.png" alt="Method" title="Method" />
<span class="method-title">browse</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#methodbrowse">FOFController::browse()</a> in controller.php</div>
<div class="index-item-description">Implements a default browse task, i.e. read a bunch of records and send them to the browser.</div>
</dd>
</dl>
<a name="c"></a>
<div class="index-letter-section">
<div style="float: left" class="index-letter-title">c</div>
<div style="float: right"><a href="#top">top</a></div>
<div style="clear: both"></div>
</div>
<dl>
<dt class="field">
<img src="media/images/Variable.png" alt="Variable" title="Variable" />
<span class="var-title">$cacheableTasks</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#var$cacheableTasks">FOFController::$cacheableTasks</a> in controller.php</div>
<div class="index-item-description">The tasks for which caching should be enabled by default</div>
</dd>
<dt class="field">
<img src="media/images/Variable.png" alt="Variable" title="Variable" />
<span class="var-title">$component</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#var$component">FOFController::$component</a> in controller.php</div>
<div class="index-item-description">The current component's name; you can override it in the configuration</div>
</dd>
<dt class="field">
<img src="media/images/Variable.png" alt="Variable" title="Variable" />
<span class="var-title">$config</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#var$config">FOFController::$config</a> in controller.php</div>
<div class="index-item-description">A cached copy of the class configuration parameter passed during initialisation</div>
</dd>
<dt class="field">
<img src="media/images/Variable.png" alt="Variable" title="Variable" />
<span class="var-title">$configProvider</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#var$configProvider">FOFController::$configProvider</a> in controller.php</div>
<div class="index-item-description">An instance of FOFConfigProvider to provision configuration overrides</div>
</dd>
<dt class="field">
<img src="media/images/Variable.png" alt="Variable" title="Variable" />
<span class="var-title">$csrfProtection</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#var$csrfProtection">FOFController::$csrfProtection</a> in controller.php</div>
<div class="index-item-description">Set to true to enable CSRF protection on selected tasks. The possible</div>
</dd>
<dt class="field">
<img src="media/images/Method.png" alt="Method" title="Method" />
<span class="method-title">cancel</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#methodcancel">FOFController::cancel()</a> in controller.php</div>
<div class="index-item-description">Cancel the edit, check in the record and return to the Browse task</div>
</dd>
<dt class="field">
<img src="media/images/Method.png" alt="Method" title="Method" />
<span class="method-title">checkACL</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#methodcheckACL">FOFController::checkACL()</a> in controller.php</div>
<div class="index-item-description">Checks if the current user has enough privileges for the requested ACL area.</div>
</dd>
<dt class="field">
<img src="media/images/Method.png" alt="Method" title="Method" />
<span class="method-title">copy</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#methodcopy">FOFController::copy()</a> in controller.php</div>
<div class="index-item-description">Duplicates selected items</div>
</dd>
<dt class="field">
<img src="media/images/Method.png" alt="Method" title="Method" />
<span class="method-title">createFileName</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#methodcreateFileName">FOFController::createFileName()</a> in controller.php</div>
<div class="index-item-description">Create the filename for a resource.</div>
</dd>
<dt class="field">
<img src="media/images/Method.png" alt="Method" title="Method" />
<span class="method-title">createModel</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#methodcreateModel">FOFController::createModel()</a> in controller.php</div>
<div class="index-item-description">Creates a new model object</div>
</dd>
<dt class="field">
<img src="media/images/Method.png" alt="Method" title="Method" />
<span class="method-title">createView</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#methodcreateView">FOFController::createView()</a> in controller.php</div>
<div class="index-item-description">Creates a View object instance and returns it</div>
</dd>
</dl>
<a name="d"></a>
<div class="index-letter-section">
<div style="float: left" class="index-letter-title">d</div>
<div style="float: right"><a href="#top">top</a></div>
<div style="clear: both"></div>
</div>
<dl>
<dt class="field">
<img src="media/images/Variable.png" alt="Variable" title="Variable" />
<span class="var-title">$default_view</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#var$default_view">FOFController::$default_view</a> in controller.php</div>
<div class="index-item-description">The default view for the display method.</div>
</dd>
<dt class="field">
<img src="media/images/Variable.png" alt="Variable" title="Variable" />
<span class="var-title">$doTask</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#var$doTask">FOFController::$doTask</a> in controller.php</div>
<div class="index-item-description">The mapped task that was performed.</div>
</dd>
<dt class="field">
<img src="media/images/Method.png" alt="Method" title="Method" />
<span class="method-title">display</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#methoddisplay">FOFController::display()</a> in controller.php</div>
<div class="index-item-description">Default task. Assigns a model to the view and asks the view to render itself.</div>
</dd>
</dl>
<a name="e"></a>
<div class="index-letter-section">
<div style="float: left" class="index-letter-title">e</div>
<div style="float: right"><a href="#top">top</a></div>
<div style="clear: both"></div>
</div>
<dl>
<dt class="field">
<img src="media/images/Method.png" alt="Method" title="Method" />
<span class="method-title">edit</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#methodedit">FOFController::edit()</a> in controller.php</div>
<div class="index-item-description">Single record edit. The ID set in the request is passed to the model, then the form layout is used to edit the result.</div>
</dd>
<dt class="field">
<img src="media/images/Method.png" alt="Method" title="Method" />
<span class="method-title">execute</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#methodexecute">FOFController::execute()</a> in controller.php</div>
<div class="index-item-description">Executes a given controller task. The onBefore<task> and onAfter<task> methods are called automatically if they exist.</div>
</dd>
</dl>
<a name="f"></a>
<div class="index-letter-section">
<div style="float: left" class="index-letter-title">f</div>
<div style="float: right"><a href="#top">top</a></div>
<div style="clear: both"></div>
</div>
<dl>
<dt class="field">
<img src="media/images/Class.png" alt="Class" title="Class" />
FOFController
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html">FOFController</a> in controller.php</div>
<div class="index-item-description">FrameworkOnFramework controller class. FOF is based on the thin controller paradigm, where the controller is mainly used to set up the model state and spawn the view.</div>
</dd>
</dl>
<a name="g"></a>
<div class="index-letter-section">
<div style="float: left" class="index-letter-title">g</div>
<div style="float: right"><a href="#top">top</a></div>
<div style="clear: both"></div>
</div>
<dl>
<dt class="field">
<img src="media/images/Method.png" alt="Method" title="Method" />
<span class="method-title">getAnInstance</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#methodgetAnInstance">FOFController::getAnInstance()</a> in controller.php</div>
<div class="index-item-description">Gets a static (Singleton) instance of a controller class. It loads the relevant controller file from the component's directory or, if it doesn't exist, creates a new controller object out of thin air.</div>
</dd>
<dt class="field">
<img src="media/images/Method.png" alt="Method" title="Method" />
<span class="method-title">getModel</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#methodgetModel">FOFController::getModel()</a> in controller.php</div>
<div class="index-item-description">Method to get a model object, loading it if required.</div>
</dd>
<dt class="field">
<img src="media/images/Method.png" alt="Method" title="Method" />
<span class="method-title">getName</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#methodgetName">FOFController::getName()</a> in controller.php</div>
<div class="index-item-description">Method to get the controller name</div>
</dd>
<dt class="field">
<img src="media/images/Method.png" alt="Method" title="Method" />
<span class="method-title">getTask</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#methodgetTask">FOFController::getTask()</a> in controller.php</div>
<div class="index-item-description">Get the last task that is being performed or was most recently performed.</div>
</dd>
<dt class="field">
<img src="media/images/Method.png" alt="Method" title="Method" />
<span class="method-title">getTasks</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#methodgetTasks">FOFController::getTasks()</a> in controller.php</div>
<div class="index-item-description">Gets the available tasks in the controller.</div>
</dd>
<dt class="field">
<img src="media/images/Method.png" alt="Method" title="Method" />
<span class="method-title">getThisModel</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#methodgetThisModel">FOFController::getThisModel()</a> in controller.php</div>
<div class="index-item-description">Returns the default model associated with the current view</div>
</dd>
<dt class="field">
<img src="media/images/Method.png" alt="Method" title="Method" />
<span class="method-title">getThisView</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#methodgetThisView">FOFController::getThisView()</a> in controller.php</div>
<div class="index-item-description">Returns current view object</div>
</dd>
<dt class="field">
<img src="media/images/Method.png" alt="Method" title="Method" />
<span class="method-title">getTmpInstance</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#methodgetTmpInstance">FOFController::getTmpInstance()</a> in controller.php</div>
<div class="index-item-description">Gets a temporary instance of a controller object. A temporary instance is not a Singleton and can be disposed off after use.</div>
</dd>
<dt class="field">
<img src="media/images/Method.png" alt="Method" title="Method" />
<span class="method-title">getView</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#methodgetView">FOFController::getView()</a> in controller.php</div>
<div class="index-item-description">Method to get a reference to the current view and load it if necessary.</div>
</dd>
</dl>
<a name="h"></a>
<div class="index-letter-section">
<div style="float: left" class="index-letter-title">h</div>
<div style="float: right"><a href="#top">top</a></div>
<div style="clear: both"></div>
</div>
<dl>
<dt class="field">
<img src="media/images/Variable.png" alt="Variable" title="Variable" />
<span class="var-title">$hasForm</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#var$hasForm">FOFController::$hasForm</a> in controller.php</div>
<div class="index-item-description">Does this tried have a FOFForm which will be used to render it?</div>
</dd>
<dt class="field">
<img src="media/images/Method.png" alt="Method" title="Method" />
<span class="method-title">hasRedirect</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#methodhasRedirect">FOFController::hasRedirect()</a> in controller.php</div>
<div class="index-item-description">Returns true if there is a redirect set in the controller</div>
</dd>
</dl>
<a name="i"></a>
<div class="index-letter-section">
<div style="float: left" class="index-letter-title">i</div>
<div style="float: right"><a href="#top">top</a></div>
<div style="clear: both"></div>
</div>
<dl>
<dt class="field">
<img src="media/images/Variable.png" alt="Variable" title="Variable" />
<span class="var-title">$input</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#var$input">FOFController::$input</a> in controller.php</div>
<div class="index-item-description">The input object for this MVC triad; you can override it in the configuration</div>
</dd>
</dl>
<a name="l"></a>
<div class="index-letter-section">
<div style="float: left" class="index-letter-title">l</div>
<div style="float: right"><a href="#top">top</a></div>
<div style="clear: both"></div>
</div>
<dl>
<dt class="field">
<img src="media/images/Variable.png" alt="Variable" title="Variable" />
<span class="var-title">$layout</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#var$layout">FOFController::$layout</a> in controller.php</div>
<div class="index-item-description">The current layout; you can override it in the configuration</div>
</dd>
</dl>
<a name="m"></a>
<div class="index-letter-section">
<div style="float: left" class="index-letter-title">m</div>
<div style="float: right"><a href="#top">top</a></div>
<div style="clear: both"></div>
</div>
<dl>
<dt class="field">
<img src="media/images/Variable.png" alt="Variable" title="Variable" />
<span class="var-title">$message</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#var$message">FOFController::$message</a> in controller.php</div>
<div class="index-item-description">Redirect message.</div>
</dd>
<dt class="field">
<img src="media/images/Variable.png" alt="Variable" title="Variable" />
<span class="var-title">$messageType</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#var$messageType">FOFController::$messageType</a> in controller.php</div>
<div class="index-item-description">Redirect message type.</div>
</dd>
<dt class="field">
<img src="media/images/Variable.png" alt="Variable" title="Variable" />
<span class="var-title">$methods</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#var$methods">FOFController::$methods</a> in controller.php</div>
<div class="index-item-description">Array of class methods</div>
</dd>
<dt class="field">
<img src="media/images/Variable.png" alt="Variable" title="Variable" />
<span class="var-title">$modelName</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#var$modelName">FOFController::$modelName</a> in controller.php</div>
<div class="index-item-description">Overrides the name of the view's default model</div>
</dd>
<dt class="field">
<img src="media/images/Variable.png" alt="Variable" title="Variable" />
<span class="var-title">$model_prefix</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#var$model_prefix">FOFController::$model_prefix</a> in controller.php</div>
<div class="index-item-description">The prefix of the models</div>
</dd>
</dl>
<a name="n"></a>
<div class="index-letter-section">
<div style="float: left" class="index-letter-title">n</div>
<div style="float: right"><a href="#top">top</a></div>
<div style="clear: both"></div>
</div>
<dl>
<dt class="field">
<img src="media/images/Variable.png" alt="Variable" title="Variable" />
<span class="var-title">$name</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#var$name">FOFController::$name</a> in controller.php</div>
<div class="index-item-description">The name of the controller</div>
</dd>
</dl>
<a name="o"></a>
<div class="index-letter-section">
<div style="float: left" class="index-letter-title">o</div>
<div style="float: right"><a href="#top">top</a></div>
<div style="clear: both"></div>
</div>
<dl>
<dt class="field">
<img src="media/images/Method.png" alt="Method" title="Method" />
<span class="method-title">onAfterApplySave</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#methodonAfterApplySave">FOFController::onAfterApplySave()</a> in controller.php</div>
<div class="index-item-description">Execute something after applySave has run.</div>
</dd>
<dt class="field">
<img src="media/images/Method.png" alt="Method" title="Method" />
<span class="method-title">onBeforeAccesspublic</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#methodonBeforeAccesspublic">FOFController::onBeforeAccesspublic()</a> in controller.php</div>
<div class="index-item-description">ACL check before changing the access level; override to customise</div>
</dd>
<dt class="field">
<img src="media/images/Method.png" alt="Method" title="Method" />
<span class="method-title">onBeforeAccessregistered</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#methodonBeforeAccessregistered">FOFController::onBeforeAccessregistered()</a> in controller.php</div>
<div class="index-item-description">ACL check before changing the access level; override to customise</div>
</dd>
<dt class="field">
<img src="media/images/Method.png" alt="Method" title="Method" />
<span class="method-title">onBeforeAccessspecial</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#methodonBeforeAccessspecial">FOFController::onBeforeAccessspecial()</a> in controller.php</div>
<div class="index-item-description">ACL check before changing the access level; override to customise</div>
</dd>
<dt class="field">
<img src="media/images/Method.png" alt="Method" title="Method" />
<span class="method-title">onBeforeAdd</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#methodonBeforeAdd">FOFController::onBeforeAdd()</a> in controller.php</div>
<div class="index-item-description">ACL check before adding a new record; override to customise</div>
</dd>
<dt class="field">
<img src="media/images/Method.png" alt="Method" title="Method" />
<span class="method-title">onBeforeApply</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#methodonBeforeApply">FOFController::onBeforeApply()</a> in controller.php</div>
<div class="index-item-description">ACL check before saving a new/modified record; override to customise</div>
</dd>
<dt class="field">
<img src="media/images/Method.png" alt="Method" title="Method" />
<span class="method-title">onBeforeApplySave</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#methodonBeforeApplySave">FOFController::onBeforeApplySave()</a> in controller.php</div>
<div class="index-item-description">Execute something before applySave is called. Return false to prevent applySave from executing.</div>
</dd>
<dt class="field">
<img src="media/images/Method.png" alt="Method" title="Method" />
<span class="method-title">onBeforeBrowse</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#methodonBeforeBrowse">FOFController::onBeforeBrowse()</a> in controller.php</div>
<div class="index-item-description">ACL check before allowing someone to browse</div>
</dd>
<dt class="field">
<img src="media/images/Method.png" alt="Method" title="Method" />
<span class="method-title">onBeforeCancel</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#methodonBeforeCancel">FOFController::onBeforeCancel()</a> in controller.php</div>
<div class="index-item-description">ACL check before cancelling an edit</div>
</dd>
<dt class="field">
<img src="media/images/Method.png" alt="Method" title="Method" />
<span class="method-title">onBeforeEdit</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#methodonBeforeEdit">FOFController::onBeforeEdit()</a> in controller.php</div>
<div class="index-item-description">ACL check before editing a record; override to customise</div>
</dd>
<dt class="field">
<img src="media/images/Method.png" alt="Method" title="Method" />
<span class="method-title">onBeforeGenericTask</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#methodonBeforeGenericTask">FOFController::onBeforeGenericTask()</a> in controller.php</div>
<div class="index-item-description">A catch-all method for all tasks without a corresponding onBefore method. Applies the ACL preferences defined in fof.xml.</div>
</dd>
<dt class="field">
<img src="media/images/Method.png" alt="Method" title="Method" />
<span class="method-title">onBeforeOrderdown</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#methodonBeforeOrderdown">FOFController::onBeforeOrderdown()</a> in controller.php</div>
<div class="index-item-description">ACL check before changing the ordering of a record; override to customise</div>
</dd>
<dt class="field">
<img src="media/images/Method.png" alt="Method" title="Method" />
<span class="method-title">onBeforeOrderup</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#methodonBeforeOrderup">FOFController::onBeforeOrderup()</a> in controller.php</div>
<div class="index-item-description">ACL check before changing the ordering of a record; override to customise</div>
</dd>
<dt class="field">
<img src="media/images/Method.png" alt="Method" title="Method" />
<span class="method-title">onBeforePublish</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#methodonBeforePublish">FOFController::onBeforePublish()</a> in controller.php</div>
<div class="index-item-description">ACL check before changing the publish status of a record; override to customise</div>
</dd>
<dt class="field">
<img src="media/images/Method.png" alt="Method" title="Method" />
<span class="method-title">onBeforeRemove</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#methodonBeforeRemove">FOFController::onBeforeRemove()</a> in controller.php</div>
<div class="index-item-description">ACL check before removing a record; override to customise</div>
</dd>
<dt class="field">
<img src="media/images/Method.png" alt="Method" title="Method" />
<span class="method-title">onBeforeSave</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#methodonBeforeSave">FOFController::onBeforeSave()</a> in controller.php</div>
<div class="index-item-description">ACL check before saving a new/modified record; override to customise</div>
</dd>
<dt class="field">
<img src="media/images/Method.png" alt="Method" title="Method" />
<span class="method-title">onBeforeSavenew</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#methodonBeforeSavenew">FOFController::onBeforeSavenew()</a> in controller.php</div>
<div class="index-item-description">ACL check before saving a new/modified record; override to customise</div>
</dd>
<dt class="field">
<img src="media/images/Method.png" alt="Method" title="Method" />
<span class="method-title">onBeforeSaveorder</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#methodonBeforeSaveorder">FOFController::onBeforeSaveorder()</a> in controller.php</div>
<div class="index-item-description">ACL check before changing the ordering of a record; override to customise</div>
</dd>
<dt class="field">
<img src="media/images/Method.png" alt="Method" title="Method" />
<span class="method-title">onBeforeUnpublish</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#methodonBeforeUnpublish">FOFController::onBeforeUnpublish()</a> in controller.php</div>
<div class="index-item-description">ACL check before changing the publish status of a record; override to customise</div>
</dd>
<dt class="field">
<img src="media/images/Method.png" alt="Method" title="Method" />
<span class="method-title">orderdown</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#methodorderdown">FOFController::orderdown()</a> in controller.php</div>
<div class="index-item-description">Moves selected items one position down the ordering list</div>
</dd>
<dt class="field">
<img src="media/images/Method.png" alt="Method" title="Method" />
<span class="method-title">orderup</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#methodorderup">FOFController::orderup()</a> in controller.php</div>
<div class="index-item-description">Moves selected items one position up the ordering list</div>
</dd>
</dl>
<a name="p"></a>
<div class="index-letter-section">
<div style="float: left" class="index-letter-title">p</div>
<div style="float: right"><a href="#top">top</a></div>
<div style="clear: both"></div>
</div>
<dl>
<dt class="field">
<img src="media/images/Variable.png" alt="Variable" title="Variable" />
<span class="var-title">$paths</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#var$paths">FOFController::$paths</a> in controller.php</div>
<div class="index-item-description">The set of search directories for resources (views).</div>
</dd>
<dt class="field">
<img src="media/images/Method.png" alt="Method" title="Method" />
<span class="method-title">publish</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#methodpublish">FOFController::publish()</a> in controller.php</div>
<div class="index-item-description">Publish (set enabled = 1) an item.</div>
</dd>
</dl>
<a name="r"></a>
<div class="index-letter-section">
<div style="float: left" class="index-letter-title">r</div>
<div style="float: right"><a href="#top">top</a></div>
<div style="clear: both"></div>
</div>
<dl>
<dt class="field">
<img src="media/images/Variable.png" alt="Variable" title="Variable" />
<span class="var-title">$redirect</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#var$redirect">FOFController::$redirect</a> in controller.php</div>
<div class="index-item-description">URL for redirection.</div>
</dd>
<dt class="field">
<img src="media/images/Method.png" alt="Method" title="Method" />
<span class="method-title">read</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#methodread">FOFController::read()</a> in controller.php</div>
<div class="index-item-description">Single record read. The id set in the request is passed to the model and then the item layout is used to render the result.</div>
</dd>
<dt class="field">
<img src="media/images/Method.png" alt="Method" title="Method" />
<span class="method-title">redirect</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#methodredirect">FOFController::redirect()</a> in controller.php</div>
<div class="index-item-description">Redirects the browser or returns false if no redirect is set.</div>
</dd>
<dt class="field">
<img src="media/images/Method.png" alt="Method" title="Method" />
<span class="method-title">registerDefaultTask</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#methodregisterDefaultTask">FOFController::registerDefaultTask()</a> in controller.php</div>
<div class="index-item-description">Register the default task to perform if a mapping is not found.</div>
</dd>
<dt class="field">
<img src="media/images/Method.png" alt="Method" title="Method" />
<span class="method-title">registerTask</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#methodregisterTask">FOFController::registerTask()</a> in controller.php</div>
<div class="index-item-description">Register (map) a task to a method in the class.</div>
</dd>
<dt class="field">
<img src="media/images/Method.png" alt="Method" title="Method" />
<span class="method-title">remove</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#methodremove">FOFController::remove()</a> in controller.php</div>
<div class="index-item-description">Delete selected item(s)</div>
</dd>
</dl>
<a name="s"></a>
<div class="index-letter-section">
<div style="float: left" class="index-letter-title">s</div>
<div style="float: right"><a href="#top">top</a></div>
<div style="clear: both"></div>
</div>
<dl>
<dt class="field">
<img src="media/images/Method.png" alt="Method" title="Method" />
<span class="method-title">save</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#methodsave">FOFController::save()</a> in controller.php</div>
<div class="index-item-description">Save the incoming data and then return to the Browse task</div>
</dd>
<dt class="field">
<img src="media/images/Method.png" alt="Method" title="Method" />
<span class="method-title">savenew</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#methodsavenew">FOFController::savenew()</a> in controller.php</div>
<div class="index-item-description">Save the incoming data and then return to the Add task</div>
</dd>
<dt class="field">
<img src="media/images/Method.png" alt="Method" title="Method" />
<span class="method-title">saveorder</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#methodsaveorder">FOFController::saveorder()</a> in controller.php</div>
<div class="index-item-description">Saves the order of the items</div>
</dd>
<dt class="field">
<img src="media/images/Method.png" alt="Method" title="Method" />
<span class="method-title">setaccess</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#methodsetaccess">FOFController::setaccess()</a> in controller.php</div>
<div class="index-item-description">Sets the access level of the selected item(s).</div>
</dd>
<dt class="field">
<img src="media/images/Method.png" alt="Method" title="Method" />
<span class="method-title">setMessage</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#methodsetMessage">FOFController::setMessage()</a> in controller.php</div>
<div class="index-item-description">Sets the internal message that is passed with a redirect</div>
</dd>
<dt class="field">
<img src="media/images/Method.png" alt="Method" title="Method" />
<span class="method-title">setPath</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#methodsetPath">FOFController::setPath()</a> in controller.php</div>
<div class="index-item-description">Sets an entire array of search paths for resources.</div>
</dd>
<dt class="field">
<img src="media/images/Method.png" alt="Method" title="Method" />
<span class="method-title">setRedirect</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#methodsetRedirect">FOFController::setRedirect()</a> in controller.php</div>
<div class="index-item-description">Registers a redirection with an optional message. The redirection is carried out when you use the redirect method.</div>
</dd>
<dt class="field">
<img src="media/images/Method.png" alt="Method" title="Method" />
<span class="method-title">setstate</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#methodsetstate">FOFController::setstate()</a> in controller.php</div>
<div class="index-item-description">Sets the published state (the enabled field) of the selected item(s)</div>
</dd>
<dt class="field">
<img src="media/images/Method.png" alt="Method" title="Method" />
<span class="method-title">setThisModelName</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#methodsetThisModelName">FOFController::setThisModelName()</a> in controller.php</div>
<div class="index-item-description">Set the name of the model to be used by this Controller</div>
</dd>
<dt class="field">
<img src="media/images/Method.png" alt="Method" title="Method" />
<span class="method-title">setThisViewName</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#methodsetThisViewName">FOFController::setThisViewName()</a> in controller.php</div>
<div class="index-item-description">Set the name of the view to be used by this Controller</div>
</dd>
</dl>
<a name="t"></a>
<div class="index-letter-section">
<div style="float: left" class="index-letter-title">t</div>
<div style="float: right"><a href="#top">top</a></div>
<div style="clear: both"></div>
</div>
<dl>
<dt class="field">
<img src="media/images/Variable.png" alt="Variable" title="Variable" />
<span class="var-title">$task</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#var$task">FOFController::$task</a> in controller.php</div>
<div class="index-item-description">Current or most recently performed task.</div>
</dd>
<dt class="field">
<img src="media/images/Variable.png" alt="Variable" title="Variable" />
<span class="var-title">$taskMap</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#var$taskMap">FOFController::$taskMap</a> in controller.php</div>
<div class="index-item-description">Array of class methods to call for a given task.</div>
</dd>
<dt class="field">
<img src="media/images/Method.png" alt="Method" title="Method" />
<span class="method-title">trash</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#methodtrash">FOFController::trash()</a> in controller.php</div>
<div class="index-item-description">Trash (set enabled = -2) an item.</div>
</dd>
</dl>
<a name="u"></a>
<div class="index-letter-section">
<div style="float: left" class="index-letter-title">u</div>
<div style="float: right"><a href="#top">top</a></div>
<div style="clear: both"></div>
</div>
<dl>
<dt class="field">
<img src="media/images/Method.png" alt="Method" title="Method" />
<span class="method-title">unpublish</span>
</dt>
<dd class="index-item-body">
<div class="index-item-details"><a href="FrameworkOnFramework-Controller/FOFController.html#methodunpublish">FOFController::unpublish()</a> in controller.php</div>
<div class="index-item-description">Unpublish (set enabled = 0) an item.</div>
</dd>
<dt class="field">
<img src="media/images/Method.png" alt="Method" title="Method" />
<span class="method-title">unregisterTask</span>
</dt>
<dd class="index-item-body">