fluxcms /inc/patForms.php

Language PHP Lines 2820
MD5 Hash cb9862037ff4832c2e8b6578c1e06cc5
Repository https://github.com/chregu/fluxcms.git View Raw File View Project SPDX
   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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
<?php
/**
 * patForms form manager class - serialize form elements into any given output format
 * using element classes, and build the output via renderer classes.
 *
 * $Id$
 *
 * @package		patForms
 * @author		Sebastian Mordziol <argh@php-tools.net>
 * @author		gERD Schaufelberger <gerd@php-tools.net>
 * @author		Stephan Schmidt <schst@php-tools.net>
 * @copyright	2003-2004 PHP Application Tools
 * @license		LGPL
 * @link		http://www.php-tools.net
 */

/**
 * set the include path
 */
if( !defined( 'PATFORMS_INCLUDE_PATH' ) ) {
	define( 'PATFORMS_INCLUDE_PATH', dirname( __FILE__ ). '/patForms' );
}



/**
 * location of global javascripts
 */
define('PATFORMS_SCRIPT_PATH', PATFORMS_INCLUDE_PATH . '/Scripts');

/**
 * needs helper methods of patForms_Element
 */
include_once PATFORMS_INCLUDE_PATH . "/Element.php";
 
/**
 * error definition: renderer base class file (renderers/_base.php) could not 
 * be found.
 *
 * @see	patForms::_createModule()
 */									
define( "PATFORMS_ERROR_NO_MODULE_BASE_FILE", 1001 );

/**
 * error definition: the specified renderer could not be found.
 *
 * @see	patForms::_createModule()
 */									
define( "PATFORMS_ERROR_MODULE_NOT_FOUND", 1002 );

/**
 * error definition: the element added via the {@link patForms::addElement()}
 * is not an object. Use the {@link patForms::createElement()} method to
 * create an element object.
 *
 * @see	patForms::addElement()
 * @see	patForms::createElement()
 */									
define( "PATFORMS_ERROR_ELEMENT_IS_NO_OBJECT", 1003 );

/**
 * error definition: generic unexpected error.
 */									
define( "PATFORMS_ERROR_UNEXPECTED_ERROR", 1004 );

/**
 * element does not exist
 */									
define( "PATFORMS_ERROR_ELEMENT_NOT_FOUND", 1012 );

/**
 * renderer object has not been set - if you want to render the form, you have to
 * set a renderer object via the {@link patForms::setRenderer()} method. To create
 * a renderer, use the {@link patForms::createRenderer()} method.
 *
 * @see	patForms::setRenderer()
 * @see	patForms::createRenderer()
 */									
define( "PATFORMS_ERROR_NO_RENDERER_SET", 1013 );

/**
 * invalid renderer
 *
 * @see	createRenderer()
 */									
define( "PATFORMS_ERROR_INVALID_RENDERER", 1014 );

/**
 * invalid method
 *
 * @see	setMethod()
 */									
define( "PATFORMS_ERROR_INVALID_METHOD", 1015 );

/**
 * Given parameter is not a boolean value
 */									
define( "PATFORMS_ERROR_PARAMETER_NO_BOOL", 1016 );

/**
 * Given Static property does not exist
 */
define( "PATFORMS_ERROR_NO_STATIC_PROPERTY", 1017 );

/**
 * Unknown event
 */
define( "PATFORMS_ERROR_UNKNOWN_EVENT", 1018 );

/**
 * Invalid event handler
 */
define( "PATFORMS_ERROR_INVALID_HANDLER", 1019 );

/**
 * Event exists
 */
define( 'PATFORMS_NOTICE_EVENT_ALREADY_REGISTERED', 1020 );

/**
 * Invalid storage container
 */
define( 'PATFORMS_ERROR_INVALID_STORAGE', 1021 );

define( 'PATFORMS_NOTICE_ARRAY_EXPECTED', 1022 );

define( 'PATFORMS_NOTICE_ATTRIBUTE_NOT_SUPPORTED', 1023 );

define( 'PATFORMS_NOTICE_INVALID_OPTION', 1024 );

define( 'PATFORMS_ERROR_ATTRIBUTE_REQUIRED', 1025 );

define( 'PATFORMS_ERROR_CAN_NOT_VERIFY_FORMAT', 1026 );

define( 'PATFORMS_ERROR_METHOD_FOR_MODE_NOT_AVAILABLE', 1027 );


/**
 * errors apply on translating errors matching current locale settings
 */
define( 'PATFORMS_NOTICE_VALIDATOR_ERROR_LOCALE_UNDEFINED', 1028 );
define( 'PATFORMS_WARNING_VALIDATOR_ERROR_UNDEFINED', 1029 );

/**
 * Script file could not be loaded
 */
define( 'PATFORMS_WARNING_SCRIPTFILE_NOT_FOUND', 1040 );

/**
 * apply the rule before the built-in validation
 */
define( 'PATFORMS_RULE_BEFORE_VALIDATION', 1 );
 
/**
 * apply the rule after the built-in validation
 */
define( 'PATFORMS_RULE_AFTER_VALIDATION', 2 );

/**
 * apply the rule before AND after the built-in validation
 */
define( 'PATFORMS_RULE_BOTH', 3 );
    
/**
 * attach the observer to the elements
 */
define( 'PATFORMS_OBSERVER_ATTACH_TO_ELEMENTS', 1 );

/**
 * attach the observer to the form
 */
define( 'PATFORMS_OBSERVER_ATTACH_TO_FORM', 2 );

/**
 * attach the observer to the form and the elements
 */
define( 'PATFORMS_OBSERVER_ATTACH_TO_BOTH', 3 );

/**
 * group values should stay nested
 */
define('PATFORMS_VALUES_NESTED', 0);

/**
 * group values should be flattened
 */
define('PATFORMS_VALUES_FLATTENED', 1);

/**
 * group values should be prefixed
 */
define('PATFORMS_VALUES_PREFIXED', 2);

/**
 * Static patForms properties - used to emulate pre-PHP5 static properties.
 * 
 * @see	setStaticProperty()
 * @see	getStaticProperty()
 */
$GLOBALS['_patForms']	=	array(
	'format'			=>	'html',
	'locale'			=>	'C',
	'customLocales'		=>	array(),
	'autoFinalize'		=>	true,
	'defaultAttributes'	=>	array(),
	'elementCounter'	=>	0,
);

/**
 * patForms form manager class - serialize form elements into any given output format
 * using element classes, and build the output via renderer classes.
 *
 * @package		patForms
 * @author		Sebastian Mordziol <argh@php-tools.net>
 * @author		gERD Schaufelberger <gerd@php-tools.net>
 * @author		Stephan Schmidt <schst@php-tools.net>
 * @copyright	2003-2004 PHP Application Tools
 * @license		LGPL
 * @link		http://www.php-tools.net
 * @version		1.0
 * @todo		check the clientside functionality, as that can lead to broken pages
 */
class patForms
{
   /**
	* javascript that will displayed only once
	*
	* @access	private
	* @var		array
	*/
	var $globalJavascript	=	array();

   /**
	* javascript that will be displayed once per instance
	*
	* @access	private
	* @var		array
	*/
	var $instanceJavascript	=	array();

   /**
	* stores the mode for the form. It defaults to 'default', and is only overwritten if
	* set specifically. It is passed on to any elements you create.
	*
	* @access	private
	* @see		setMode()
	*/
	var $mode	=	'default';
	
   /**
	* XML entities
	*
	* @access	private
	* @see		toXML()
	* @todo		This is redundant to the Element's xmlEntities property - find a way to keep this in one place
	*/
	var $xmlEntities = array(
		"<"	=>	"&lt;",
		">"	=>	"&gt;",
		"&"	=>	"&amp;",
		"'"	=>	"&apos;",
		'"'	=>	"&quot;"
	);

   /**
	* stores the format for the element. It defaults to 'html', and is only overwritten if
	* set specifically. It is passed on to any elements you create.
	*
	* @access	private
	* @see		setFormat()
	*/
	var $format	=	'html';
	
   /**
	* stores the flag telling the form whether it has been submitted - this is passed on to any
	* elements you create.
	*
	* @access	private
	* @see		setSubmitted()
	*/
	var $submitted	=	false;

   /**
	* stores the element objects of this form.
	* @access	private
	* @see		addElement()
	*/
	var $elements	=	array();
	
   /**
	* stores a renderer
	* @access	private
	* @see		setRenderer(), renderForm()
	*/
	var $renderer		=	null;
	
   /**
	* stores the locale to use when adding validation errors for the whole form.
	*
	* @access	private
	* @var		string	$locale
	* @see		setLocale()
	*/
	var	$locale		=	'C';
	
   /**
	* stores custom locale
	*
	* @access	private
	* @var		array
	* @see		setLocale()
	*/
	var	$customLocales = array();

   /**
	* stores the element name
	* @access	private
	* @see		getElementName()
	*/
	var $elementName = 'Form';
	
   /**
	* flag to indicate, whether form should be validated automatically
	* by renderForm()
	*
	* @access	private
	* @var		string
	* @see		setAutoValidate(), renderForm()
	*/
	var	$autoValidate	=	false;
	
   /**
	* name of the variable that indicates, whether the form has
	* been submitted.
	*
	* @access	private
	* @var		string
	* @see		setAutoValidate()
	*/
	var	$submitVar	=	null;
	
   /**
	* event handlers
	*
	* @access	private
	* @var		array
	* @see		registerEventHandler()
	* @see		registerEvent()
	*/
	var	$_eventHandler	=	array();
	
   /**
	* events that can be triggered
	*
	* @access	private
	* @var		array
	* @see		registerEventHandler()
	* @see		triggerEvent()
	* @see		registerEvent()
	*/
	var	$_validEvents	=	array( 'onInit', 'onSubmit', 'onError', 'onSuccess' );
	
   /**
	* Stores whether the current form has been validated
	*
	* @access	private
	*/
	var $validated	=	false;
	
   /**
	* Stores whether the current form is valid or not (after the 
	* validation process)
	*
	* @access	private
	*/
	var $valid	=	null;
	
   /**
	* Stores the names of all static properties that patForms will use as defaults
	* for the properties with the same name on startup.
	*
	* @access	private
	*/
	var $staticProperties	=	array(
		'format'		=>	'setFormat',
		'autoFinalize'	=>	'setAutoFinalize',
		'locale'		=>	'setLocale',
	);
	
   /**
	* Stores the flag for the autoFinalize feature
	*
	* @access	private
	*/
	var $autoFinalize	=	true;

   /**
	* custom validation rules
	* 
	* @access	private
	* @var		array
	*/
	var $_rules			=	array();
	
   /**
	* define error codes an messages for the form
	*
	* Will be set by validation rules that have been
	* added to the form.
	*
	* @access private
	* @var	array	$validatorErrorCodes
	*/
	var	$validatorErrorCodes  =   array();

   /**
	* stores any validation errors that can occurr during the
	* form's validation process.
	*
	* @access	private
	* @var		array	$validationErrors
	*/
	var	$validationErrors  =   array();
	
   /**
	* next error offset for rules
	* @access	private
	* @var		integer
	*/
	var $nextErrorOffset	=	1000;

   /**
	* Attributes of the form - needed to generate the form tag
	*
	* @access	private
	* @var		array	$attributes
	* @see		setAttribute()
	*/
	var	$attributes	=	array();
	
   /**
	* Attribute definition for the form - defines which attribute the form
	* itself supports.
	*
	* @access	public
	*/
	var	$attributeDefinition	=	array(	
			
		'id' =>	array(	
			'required'		=>	false,
			'format'		=>	'string',
			'outputFormats'	=>	array( 'html' ),
		),
		
		'name' => array(	
			'required'		=>	true,
			'format'		=>	'string',
			'outputFormats'	=>	array( 'html' ),
		),
		
		'method' => array(	
			'required'		=>	true,
			'format'		=>	'string',
			'default'		=>	'post',
			'outputFormats'	=>	array( 'html' ),
		),

		'action' => array(	
			'required'		=>	true,
			'format'		=>	'string',
			'outputFormats'	=>	array( 'html' ),
		),

		'accept' => array(	
			'required'		=>	false,
			'format'		=>	'string',
			'outputFormats'	=>	array( 'html' ),
		),

		'accept-charset' => array(	
			'required'		=>	false,
			'format'		=>	'string',
			'outputFormats'	=>	array( 'html' ),
		),

		'enctype' => array(	
			'required'		=>	false,
			'format'		=>	'string',
			'outputFormats'	=>	array( 'html' ),
		),

		'onreset' => array(	
			'required'		=>	false,
			'format'		=>	'string',
			'outputFormats'	=>	array( 'html' ),
		),

		'onsubmit' => array(	
			'required'		=>	false,
			'format'		=>	'string',
			'outputFormats'	=>	array( 'html' ),
		),

		'target' => array(	
			'required'		=>	false,
			'format'		=>	'string',
			'outputFormats'	=>	array( 'html' ),
		),
	);
	
   /**
	* Stores all available patForms options - these are inherited by all elements
	* and their dependencies, like rules.
	*
	* Short option overview:
	*
	* - scripts: enable client script integration
	*
	* @access	public
	*/
	var $options	=	array(

		'scripts'	=>	array(
			'enabled'	=>	false,
			'params'	=>	array(
									'folder'    => PATFORMS_SCRIPT_PATH,
									'jsInclude' => false
								),
		),

	);
	
   /**
	* observers of the form
	*
	* @access	private
	* @var		array
	*/
	var	$observers = array();

   /**
	* Sets the default attributes that will be inherited by any elements you add to the form.
	*
	* <b>Note:</b> You have to call this method statically before creating a new form if you use 
	* patForm's automatic element creation feature via the {@link createForm()} method, as the
	* default attributes cannot be set after an element has been created.
	*
	* @static
	* @access	public
	* @param	array	$attributes	The list of attributes to set with key => value pairs.
	*/
	function setDefaultAttributes( $attributes )
	{
		patForms::setStaticProperty( 'defaultAttributes', $attributes );
	}
	
   /**
	* sets the locale (language) to use for the validation error messages of all elements
	* in the form.
	*
	* @access	public
	* @param	string		language code
	* @param	string		optional language file
	* @return	bool		True on success
	*/
	function setLocale( $locale, $languageFile = null )
	{
		if (!is_null($languageFile)) {
			$languageData   = patForms::parseLocaleFile($languageFile);

			$customLocales = patForms::getStaticProperty('customLocales');
			$customLocales[$locale] = $languageData;
			patForms::setStaticProperty('customLocales', $customLocales);
		}

		if( isset( $this ) && is_a( $this, 'patForms' ) ) {
			$this->locale = $locale;
		
			if( !empty( $this->elements ) ) {
				$cnt	=	count( $this->elements );
				for( $i=0; $i < $cnt; $i++ ) {
					$this->elements[$i]->setLocale( $locale );
				}
			}
		} else {
			patForms::setStaticProperty('locale', $locale);
		}
		
		return true;
	}

   /**
	* checks, whether a locale is a custom locale
	*
	* @static
	* @access	public
	* @param	string		locale name
	* @return	boolean
	*/
	function isCustomLocale($locale)
	{
		$customLocales = patForms::getStaticProperty('customLocales');
		if (isset($customLocales[$locale])) {
			return true;
		}
		return false;
	}

   /**
	* get the custom locale for an element or a rule
	*
	* @static
	* @access	public
	* @param	string		locale
	* @param	string		key
	* @return	array
	*/
	function getCustomLocale($locale, $key)
	{
		$customLocales = patForms::getStaticProperty('customLocales');
		if (!isset($customLocales[$locale])) {
			return false;
		}
		if (!isset($customLocales[$locale][$key])) {
			return false;
		}
		return $customLocales[$locale][$key];
	}
	
   /**
	* parses a locale file
	*
	* @access	private
	* @param	string		filename
	* @return	array		locale information
	* @todo		add some file checks
	*/
	function parseLocaleFile($filename)
	{
		return parse_ini_file($filename, true);
	}
	
   /**
	* sets the format of the element - this will be passed on to any elements you create. If you
	* have already added some elements when you call this method, it will be passed on to them too.
	*
	* @access	public
	* @param	string	$format	The name of the format you have implemented in your element(s).
	* @return	bool	$result	True on success
	* @see		setMode()
	* @see		format
	* @see		serialize()
	*/
	function setFormat( $format )
	{
		if( isset( $this ) && is_a( $this, 'patForms' ) )
		{
			$this->format	=	strtolower( $format );
			
			if( !empty( $this->elements ) )
			{
				$cnt	=	count( $this->elements );
				for( $i=0; $i < $cnt; $i++ )
				{
					$this->elements[$i]->setFormat( $format );
				}
			}
		}
		else
		{
			patForms::setStaticProperty( 'format', $format );
		}
		
		return true;
	}
	
   /**
	* sets the mode of the form - If you have already added some elements when you call this 
	* method, it will be passed on to them too.
	*
	* @access	public
	* @param	string	$mode	The mode to set the form to: default|readonly or any other mode you have implemented in your element class(es). Default is 'default'.
	* @see		setMode()
	* @see		mode
	* @see		serialize()
	*/
	function setMode( $mode )
	{
		$this->mode	=	strtolower( $mode );

		if( !empty( $this->elements ) )
		{
			$cnt	=	count( $this->elements );
			for( $i=0; $i < $cnt; $i++ )
			{
				$this->elements[$i]->setMode( $mode );
			}
		}
	}

   /**
	* sets the current submitted state of the form. Set this to true if you want the form
	* to pick up its submitted data. It will pass on this information to all elements that 
	* have been added so far, and new ones inherit it too.
	*
	* @access	public
	* @param	bool	$state	True if it has been submitted, false otherwise (default).
	* @see		isSubmitted()
	* @see		submitted
	*/
	function setSubmitted( $state )
	{
		if( $state == true )
		{
			$eventState	=	$this->triggerEvent( 'Submit' );
			if( $eventState === false )
				return	false;
		}

		$this->submitted	=	$state;

		if( !empty( $this->elements ) )
		{
			$cnt	=	count( $this->elements );
			for( $i=0; $i < $cnt; $i++ )
			{
				$this->elements[$i]->setSubmitted( $state );
			}
		}
		
		return $state;
	}

   /**
	* sets the method for the request
	*
	* @access	public
	* @param	string	$method		GET or POST
	* @see		method
	* @uses		setAttribute()
	*/
	function setMethod( $method )
	{
		$method	=	strtolower( $method );

		if( $method != 'get' && $method != 'post' )
		{
			return patErrorManager::raiseError( 
				PATFORMS_ERROR_INVALID_METHOD, 
				'Unknown method "'.$method.'". Currently only GET and POST are supported as patForms methods.'
			);
		}
		$this->setAttribute( 'method', $method );
		return	true;
	}
	
   /**
	* sets the action for the form
	*
	* This is a only a wrapper for setAttribute()
	*
	* @access	public
	* @param	string	$action
	* @see		setAttribute()
	*/
	function setAction( $action )
	{
		return $this->setAttribute( 'action', $action );
	}

   /**
	* Sets the AutoFinalize mode for the form. The AutoFinalize mode will tell patForms to
	* finalize all elements after the form has been validated successfully.
	*
	* @access	public
	* @param	boolean	$mode		Whether to activate the AutoFinalize mode (true) or not (false).
	* @return	boolean	$success	True if okay, a patError object otherwise.
	* @see		finalizeForm()
	*/
	function setAutoFinalize( $mode )
	{
		if( !is_bool( $mode ) )
		{
			return patErrorManager::raiseError(
				PATFORMS_ERROR_PARAMETER_NO_BOOL,
				'The setAutoFinalize() method requires a boolean value ( true or false ) as parameter.'
			);
		}
	
		if( isset( $this ) && is_a( $this, 'patForms' ) )
		{
			$this->autoFinalize	=	$mode;
		}
		else
		{
			patForms::setStaticProperty( 'autoFinalize', $mode );
		}

		return true;
	}
	
   /**
	* Wrapper method that adds a filter to all elements
	* of the form at once instead of having to do it for
	* each element.
	*
	* @access	public
	* @param	object	&$filter	The filter object to apply
	* @see		patForms_Element::applyFilter()
	* @todo		add error management and docs once the element's applyFilter method has too
	*/
	function applyFilter( &$filter )
	{
		if( empty( $this->elements ) )
			return true;
			
		$cnt = count( $this->elements );

		for( $i = 0; $i < $cnt; $i++ )
		{
			$this->elements[$i]->applyFilter( $filter );
		}
	}
	
   /**
	* creates a new patForms object and returns it; this method is made to be called statically
	* to be able to create a new patForms object from anywhere.
	*
	* @access	public
	* @param	array	$formDefinition		Optional form definition for elements that will be added to the form
	* @param	array	$attributes			The attributes to set for the form itself
	* @return	object patForms	$form	The new patForms object.
	* @todo		it should be possible to pass Rule definitions, so they can be loaded and added	automatically.
	*/
	function &createForm( $formDefinition = null, $attributes = null )
	{
		$form	=	&new patForms();
		
		if( $attributes != null )
		{
			$form->setAttributes( $attributes );
		}
		
		if( $formDefinition === null )
			return	$form;

		foreach( $formDefinition as $name => $element )
		{
			if( !isset( $element["filters"] ) )
			{
				$element["filters"]	=	null;
			}
			if( !isset( $element["children"] ) )
			{
				$element["children"]	=	null;
			}
			
			$el	= &$form->createElement( $name, $element["type"], $element["attributes"], $element["filters"], $element["children"] );
			
			if( isset( $element["renderer"] ) ) {
				$el->setRenderer( $element["renderer"] );
			}
			
			$result		=	$form->addElement( $el );
			if (patErrorManager::isError( $result )) {
				return	$result;
			}
		}
		return $form;
	}

   /**
	* add a custom validation rule
	*
	* @access	public
	* @param	object patForms_Rule	validation rule
	* @param	integer					time to apply rule (before or after built-in validation)
	* @param	boolean					apply the rule, even if the form is invalid
	* @param	boolean					should form get revalidated (not implemented yet)
	* @return	boolean					currently always true
	*/
	function addRule( &$rule, $time = PATFORMS_RULE_AFTER_VALIDATION, $invalid = false, $revalidate = false )
	{
		$rule->prepareRule( $this );

		$this->_rules[]	=	 array(
									'rule'			=>	&$rule,
									'time'			=>	$time,
									'invalid'		=>	$invalid,
									'revalidate'	=>	$revalidate
								 );
	}
	
   /**
	* patForms PHP5 constructor - processes some intitialization tasks like merging the currently
	* set static properties with the internal properties.
	*
	* @access	public
	*/
	function __construct()
	{
		foreach( $this->staticProperties as $staticProperty => $setMethod )
		{
			$propValue	=	patForms::getStaticProperty( $staticProperty );
			if( patErrorManager::isError( $propValue ) )
				continue;
			
			$this->$setMethod( $propValue );
		}
		
		// initialize patForms internal attribute collection
		$this->loadAttributeDefaults();
	}
	
   /**
	* patForms pre-PHP5 constructor - does nothing for the moment except being a wrapper
	* for the PHP5 contructor for older PHP versions support.
	*
	* @access	public
	*/
	function patForms()
	{
		patForms::__construct();
	}

   /**
    * sets a renderer object that will be used to render
	* the form.
	*
	* @access	public
	* @param	object		&$renderer	The renderer object
	* @return	mixed		$success	True on success, patError object otherwise.
	* @see		createRenderer()
	* @see		renderForm()
	*/
	function setRenderer( &$renderer, $args = array() )
	{
		if( !is_object( $renderer ) )
		{
			return patErrorManager::raiseError( 
				PATFORMS_ERROR_INVALID_RENDERER, 
				'You can only set a patForms_Renderer object with the setRenderer() method, "'.gettype( $renderer ).'" given.'
			);
		}

		$this->renderer	=	&$renderer;
		
		if( isset( $args['includeElements'] ) && $args['includeElements'] === true )
		{
			// check all elements - there may be some that need
			// renderers too, so we give them the same renderer if
			// they don't already have one.
			$cnt = count( $this->elements );
			for( $i = 0; $i < $cnt; $i++ )
			{
				if( $this->elements[$i]->usesRenderer && !is_object( $this->elements[$i]->renderer ) )
				{
					$this->elements[$i]->setRenderer( $renderer );
				}
			}
		}
		
		return true;
	}
	
   /**
    * sets a storage container object that will be used to store data
	*
	* @access	public
	* @param	object patForms_Storage
	* @see		createStorage()
	*/
	function setStorage( &$storage )
	{
		if( !is_object( $storage ) )
		{
			return patErrorManager::raiseError( 
				PATFORMS_ERROR_INVALID_STORAGE, 
				'You can only set a patForms_Storage object with the setStorage() method, "'.gettype( $storage ).'" given.'
			);
		}

		$this->registerEventHandlerObject( $storage,
											array(
													'onInit'	=>	'loadEntry',
													'onSuccess'	=>	'storeEntry'
												)
										);
	}

   /**
	* renders the form with the renderer that was set via the {@link setRenderer()}
	* method.
	*
	* WARNING: This is still in alpha state!
	*
	* Should this method return a reference??
	* The return value could contain large blocks of HTML or large arrays!
	* Do we want to copy these?
	*
	* @access	public
	* @param	mixed	$args		arguments that will be passed to the renderer
	* @return	mixed	$form		The rendered form, or false if failed.
	*/
	function renderForm( $args = null )
	{
		if( $this->renderer === null )
		{
			return patErrorManager::raiseError( 
				PATFORMS_ERROR_NO_RENDERER_SET, 
				'Form cannot be rendered, you have to set a renderer first via the setRenderer() method.'
			);
		}

		// form is not submitted, or auto-validation is disabled => render it
		if( !$this->isSubmitted() || $this->autoValidate !== true )
		{
			$this->triggerEvent( 'Init' );
			return $this->renderer->render( $this, $args );
		}

		$this->validateForm();

		return $this->renderer->render( $this, $args );
	}
	
   /**
	* Validates all elements of the form.
	*
	* @access	public
    * @param    boolean     Flag to indicate, whether form should be validated again, if it already has been validated.
	* @return	boolean	    True if all elements could be validated, false otherwise.
	* @see		finishForm()
	*/
	function validateForm( $revalidate = false )
	{
		if( $this->validated && !$revalidate )
			return $this->valid;

		$valid	=	true;
	
		/**
		 * validate custom rules
		 */
		if( !$this->_applyRules( PATFORMS_RULE_BEFORE_VALIDATION ) )
		{
			$valid	=	false;
		}

		/**
		 * validate elements
		 */
		if( $valid === true )
		{
			$cnt	=	count( $this->elements );
			for( $i = 0; $i < $cnt; ++$i )
			{
				if( !$this->elements[$i]->validate() )
				{
					$valid	=	false;
				}
			}
		}

		/**
		 * validate custom rules
		 */
		if( !$this->_applyRules( PATFORMS_RULE_AFTER_VALIDATION, $valid ) )
		{
			$valid	=	false;
		}
		
		if( $valid === true && $this->autoFinalize === true )
			$this->finalizeForm();
		
		$this->valid	=	$valid;
		
		$this->validated = true;

		if( $valid === true )
		{
			$this->_announce( 'status', 'validated' );
			$event	=	'Success';
		}
		else
		{
			$this->_announce( 'status', 'error' );
			$event	=	'Error';
		}

		$this->triggerEvent( $event );
		
		return $this->valid;
	}

   /**
	* apply rules
	*
	* @access	private
	* @param	integer		time of validation
	* @param	boolean		form is valid
	* @return	boolean		rules are valid or not
	* @todo		add documentation
	*/
	function _applyRules( $time, $isValid = true )
	{
		$valid = true;
		
		$cnt = count( $this->_rules );
		for ($i = 0; $i < $cnt; $i++) {
			
			// wrong time
			if (( $this->_rules[$i]['time'] & $time ) != $time) {
				continue;
			}
			if (!$isValid && !$this->_rules[$i]['invalid']) {
				continue;
			}

			$result	=	$this->_rules[$i]['rule']->applyRule( $this, PATFORMS_RULE_AFTER_VALIDATION );
			if( $result === false ) {
				$valid	=	false;
			}
		}
		return	$valid;
	}
	
   /**
	* Finalizes the form by telling each fom element to finalize - finalizing means to
	* process any tasks that need to be done after the form has been validated, like
	* deleting any temporary files or whatever an element needs to do at that point.
	*
	* @access	public
	* @return	bool	$success	Wether all elements could be finalized
	* @see		validateForm()
	*/
	function finalizeForm()
	{
		$success	=	true;
	
		$cnt	=	count( $this->elements );
		for( $i = 0; $i < $cnt; ++$i )
		{
			if( !$this->elements[$i]->finalize() )
			{
				patErrorManager::raiseWarning(
					PATFORMS_ERROR_ELEMENT_NOT_FINALIZED,
					'Element "'.$this->elements[$i]->elementName.'" could not be finalized. See the element error messages for more details.'
				);
				
				$success	=	false;
			}
		}
		
		return $success;
	}
	
   /**
	* creates a new renderer from the patForms renderer collection and returns it.
	*
	* @access	public
	* @param	string						The name of the renderer to create - have a look at the Renderer/ subfolder for a list of available renderers.
	* @return	object patForms_Renderer	The renderer object, or error object
	*/
	function &createRenderer( $name )
	{
		return	patForms::_createModule( 'Renderer', $name );
	}

   /**
	* creates a new storage container and returns it.
	*
	* @access	public
	* @param	string						The name of the storage to create - have a look at the Storage/ subfolder for a list of available storage containers.
	* @return	object patForms_Storage		The storage container, or error object
	*/
	function &createStorage( $name )
	{
		return	patForms::_createModule( 'Storage', $name );
	}

   /**
	* Creates a new filter and returns it.
	*
	* You may pass an array as second parameter that contains
	* parameters for the filter. patForms will check for setter methods
	* for all keys and set the corresponding values.
	*
	* This eases the creating of simple filter objects.
	*
	* @access	public
	* @param	string						The name of the filter to create - have a look at the Filter/ subfolder for a list of available filters.
	* @param	array						Optional parameters for the filter, if you provide a parameter, make sure the filter implements a set[Paramname]() method.
	*										This will be automated with interceptors in the PHP5 version of patForms
	* @return	object patForms_Filter		The filter, or error object
	*/
	function &createFilter( $name, $params = null )
	{
		$filter	=	&patForms::_createModule( 'Filter', $name );
		
		if( !is_array( $params ) )
		{
			return	$filter;
		}
		
		foreach( $params as $param => $value )
		{
			$setter		=	'set' . ucfirst( $param );
			if( method_exists( $filter, $setter ) )
			{
				$filter->$setter( $value );
			}
		}
		return	$filter;
	}

   /**
	* creates a new rule from the patForms rule collection and returns it.
	*
	* If your rules are not located in patForms/Rule you have to load and
	* instantiate them on your own.
	*
	* @access	public
	* @param	string					The name of the rule to create - have a look at the Rule/ subfolder for a list of available rules.
	* @param	string					The id of the rule, needed if the rule uses client side actions.
	* @return	object patForms_Rule	The rule object, or error object
	*/
	static function &createRule( $name, $id = null )
	{
		$rule	=	&patForms::_createModule( 'Rule', $name );
		if( $id != null )
		{
			$rule->setId( $id );
		}
		return $rule;
	}

   /**
	* creates a new observer from the patForms observer collection and returns it.
	*
	* If your observers are not located in patForms/Observer you have to load and
	* instantiate them on your own.
	*
	* @access	public
	* @param	string						The name of the observer to create - have a look at the Observer/ subfolder for a list of available observers.
	* @return	object patForms_Observer	The observer object, or error object
	*/
	function &createObserver( $name )
	{
		$observer = &patForms::_createModule( 'Observer', $name );

		return $observer;
	}

   /**
	* creates a new module for patForms
	*
	* @access	private
	* @param	string	$type		type of the module. Possible values are 'Renderer', 'Rule'
	* @param	string	$name		The name of the renderer to create - have a look at the renderers/ subfolder for a list of available renderers.
	* @return	object	$module		The module object, or an error object
	*/
	function &_createModule( $type, $name )
	{
		$baseFile		=	PATFORMS_INCLUDE_PATH . '/'.$type.'.php';
		$baseClass	=	'patForms_'.$type;

		// if there is an underscore in the module name, we want
		// to load the module from a subfolder, so we transform
		// all underscores to slashes.
		$pathName	=	$name;
		if( strstr( $pathName, '_' ) )
		{
			$pathName	=	str_replace( '_', '/', $name );
		}
		
		$moduleFile		=	PATFORMS_INCLUDE_PATH . '/'.$type.'/'.$pathName.'.php';
		$moduleClass	=	'patForms_'.$type.'_'.$name;
        if( !class_exists( $baseClass, FALSE ) )
		{
			if( !file_exists( $baseFile ) )
			{
				return patErrorManager::raiseError( 
					PATFORMS_ERROR_NO_MODULE_BASE_FILE, 
					$type .' base file could not be found',
					'Tried to load base file in path "'.$baseFile.'"' 
				);
			}
			
			include_once $baseFile;
		}
		
		if( !class_exists( $moduleClass, true ) )
		{
			if( !file_exists( $moduleFile ) )
			{
				if (defined('PATFORMS_LOCAL_INCLUDE_PATH')) {
                    $localModuleClass = PATFORMS_LOCAL_INCLUDE_PATH."/".$type."/".$pathName.".php";   
                    if (file_exists($localModuleClass)) {
                        include_once $localModuleClass;    
                        $module = new $moduleClass();
                        return $module;
                    }
                }
                
                return patErrorManager::raiseError( 
					PATFORMS_ERROR_MODULE_NOT_FOUND, 
					$type.' "'.$name.'" file "'.$moduleFile. '" could not be found.'
				);
			}
			include_once $moduleFile;
		}

		$module	= new $moduleClass();
		
		return $module;
	}

   /**
	* adds an element to the form - has to be a patForms_Element object. Use the {@link createElement()}
	* method to create a new element object. Also takes care of passing on the form's configuration
	* including the mode, format and submitted flags to the element.
	*
	* @access	public
	* @param	object	&$element	The patForms_Element object to add to this form.
	* @return	bool	$success	True if everything went well, false otherwise.
	* @see		patForms_Element
	* @see		createElement()
	*/
	function addElement( &$element )
	{
		if( !is_object( $element ) )
		{
			return patErrorManager::raiseError( 
				PATFORMS_ERROR_ELEMENT_IS_NO_OBJECT, 
				'The addElement() method expects an element object, "'.gettype( $element ).'" given.'
			);
		}
		
		if( patErrorManager::isError( $element ) )
		{
			return patErrorManager::raiseError( 
				PATFORMS_ERROR_UNEXPECTED_ERROR, 
				'The element you are trying to add is a patError object, and not a patForms element object.'
			);
		}

		if( !$element->getId() ) {
			$element->setId( $this->getElementId() );
		}
		$element->setMode( $this->getMode() );
		$element->setFormat( $this->getFormat() );
		$element->setSubmitted( $this->isSubmitted() );
		$element->setLocale( $this->getLocale() );

		$this->elements[]	=&	$element;		
		
		return true;
	}

   /**
	* replaces an element in the form
	*
	* @access	public
	* @param	object	$element	The patForms_Element object to be replaced
	* @param	object	&$replace	The element that will replace the old element
	* @return	bool	$success	True if everything went well, false otherwise.
	* @see		patForms_Element
	* @see		addElement()
	*/
	function replaceElement( $element, &$replace )
	{
		if( !is_object( $replace ) ) {
			return patErrorManager::raiseError( 
				PATFORMS_ERROR_ELEMENT_IS_NO_OBJECT, 
				'The addElement() method expects an element object, "'.gettype( $replace ).'" given.'
			);
		}
		
		if( patErrorManager::isError( $replace ) ) {
			return patErrorManager::raiseError( 
				PATFORMS_ERROR_UNEXPECTED_ERROR, 
				'The element you are trying to add is a patError object, and not a patForms element object.'
			);
		}
		
		if (is_object($element)) {
			$element = $element->getId();
		}
		
		$cnt = count($this->elements);
		for ($i = 0; $i < $cnt; $i++) {
			if ($this->elements[$i]->getId() === $element) {

				if( !$replace->getId() ) {
					$replace->setId( $this->getElementId() );
				}
				$replace->setMode( $this->getMode() );
				$replace->setFormat( $this->getFormat() );
				$replace->setSubmitted( $this->isSubmitted() );
				$replace->setLocale( $this->getLocale() );
	
				$this->elements[$i] = &$replace;
				return true;
			}
			
			// the current element is a container
			if (method_exists($this->elements[$i], 'replaceElement')) {
				$result = $this->elements[$i]->replaceElement($element, $replace);
				if ($result === true) {
					return $result;
				}
			}
		}
		
		return false;
	}

   /**
	* Get an element by its name.
	*
	* @access	public
	* @param	string	$name	name of the element
	* @return	object			patForms element
	* @deprecated	please use patForms::getElementByName() instead
	*/
	function &getElement( $name )
	{
		return $this->getElementByName( $name );
	}

   /**
	* Get an element by its name.
	*
	* @access	public
	* @param	string	$name	name of the element
	* @return	mixed			either a patForms element or an array containing patForms elements
	* @see		getElementById()
	*/
	function &getElementByName( $name )
	{
		if( $name == '__form' ) {
			return $this;
		}
		
		$elements = array();
		$cnt      = count( $this->elements );
		for ($i = 0; $i < $cnt; $i++) {
			if ($this->elements[$i]->getName() == $name) {
				$elements[]	= &$this->elements[$i];
				continue;
			}
			if (method_exists($this->elements[$i], 'getElementById')) {
				patErrorManager::pushExpect(PATFORMS_ERROR_ELEMENT_NOT_FOUND);
				$result = &$this->elements[$i]->getElementByName($name);
				patErrorManager::popExpect();
				if (!patErrorManager::isError($result)) {
					if (is_array($result)) {
						$cnt2 = count( $result );
						for ($j = 0; $j < $cnt2; $j++) {
							$elements[]	= &$result[$j];
						}
					} else {
						$elements[]	= &$result;
					}
				}
			}
		}
		
		switch( count( $elements ) )
		{
			case	0:
                $r = patErrorManager::raiseError( 
					PATFORMS_ERROR_ELEMENT_NOT_FOUND, 
					'Element '.$name.' could not be found.'
				);
				return $r; 
				break;
			case	1:
				return	$elements[0];
				break;
			default:
				return	$elements;
				break;
		}
	}

   /**
	* Get an element by its id.
	*
	* @access	public
	* @param	string	$id		id of the element
	* @return	object			patForms element
	*/
	function &getElementById( $id )
	{
		$cnt	=	count( $this->elements );
		for( $i = 0; $i < $cnt; $i++ )
		{
			if( $this->elements[$i]->getId() == $id ) {
				return $this->elements[$i];
			}
			if (method_exists($this->elements[$i], 'getElementById')) {
				patErrorManager::pushExpect(PATFORMS_ERROR_ELEMENT_NOT_FOUND);
				$result = &$this->elements[$i]->getElementById($id);
				patErrorManager::popExpect();
				if (!patErrorManager::isError($result)) {
					return $result;
				}
			}
		}
		return patErrorManager::raiseError( 
			PATFORMS_ERROR_ELEMENT_NOT_FOUND, 
			'Element '.$name.' could not be found.'
		);
	}

   /**
	* Get all elements of the form
	*
	* @access	public
	* @return	array	all elements of the form
	*/
	function &getElements()
	{
		return	$this->elements;
	}

   /**
	* Creates a new form element and returns a reference to it.
	*
	* The optional $filters array has to be in the following format:
	*
	* <pre>
	* array(
	*       array(
	*              'filter' => 'Multiplier',
	*              'params' => array( 'multiplier' => 6 )
	*            )
	*	   )
	* </pre>
	*
	* @access	public
	* @param	string	$name		The name of the element
	* @param	string	$type		The type of the element; for a list of possible elements, have a look at the elements/ subfolder of the patForms package.
	* @param	array	$attributes	Attributes for the element
	* @param	array	$filters	Optional filters that will be applied
	* @return	object patForms_Element	$element	The element object, or patError if failed.
	*/
	function &createElement( $name, $type, $attributes, $filters = null, $children = null )
	{
		$element =& patForms::_createModule( 'Element', $type );
		if( patErrorManager::isError( $element ) )
		{
			return	$element;
		}

		$attributes['name']	=	$name;
		if( !isset( $attributes['id'] ) ) {
			$attributes['id'] = patForms::getElementId();
		}
		
		// add default attributes - do this the 'silent' way be checking whether
		// the element supports the given attribute, as the element throws a notice
		// if it does not support it - this is not expected from default attributes.
		foreach( patForms::getStaticProperty( 'defaultAttributes' ) as $attributeName => $attributeValue ) 
		{
			if( !$element->hasAttribute( $attributeName ) )
			{
				continue;
			}
			
			$element->setAttribute( $attributeName, $attributeValue );
		}
	
		// set the given attributes normally
		$success = $element->setAttributes( $attributes );
		if( patErrorManager::isError( $success ) )
		{
			return $success;
		}

		if (is_array($children)) {
			foreach ($children as $child) {
				$childName = $child['attributes']['name'];
				
				$childEl = &patForms::createElement($childName, $child['type'], $child['attributes']);
				if( isset( $child["renderer"] ) ) {
					$childEl->setRenderer( $child["renderer"] );
				}
				
				$element->addElement($childEl);
			}
		}
		
		$success = $element->_init();
		if( patErrorManager::isError( $success ) ) {
			return $success;
		}
		
		// if we don't have any filters to add, we're done
		if( !is_array( $filters ) )
		{
			return $element;
		}
		
		$cnt	=	count( $filters );
		for( $i = 0; $i < $cnt; $i++ )
		{
			$params =	isset( $filters[$i]['params'] ) ? $filters[$i]['params'] : null;
			$filter	=	&patForms::createFilter( $filters[$i]['filter'], $params );
			if( patErrorManager::isError( $filter ) )
			{
				continue;
			}
			$element->applyFilter( $filter );
		}
		
		return $element;
	}
	
   /**
	* retrieves the validation errors from all elements in the form. Use this if the validateForm()
	* method returned false.
	*
	* @access	public
	* q
	* @return	array	$errors	Array containing an array with validation errors for each element in the form.
	* @todo		replace	__form with the name of the form, once attributes are implemented
	*/
	function getValidationErrors($withElements = true)
	{
		$found	=	false;
		$errors	=	array();
		
		if( !empty( $this->validationErrors ) )
		{
			$errors['__form']	=	$this->validationErrors;
			$found = true;
		}
		
		if ($withElements === false) {
			return $errors;
		}
		
		$cnt = count( $this->elements );
		for( $i = 0; $i < $cnt; ++$i )
		{
			$name	=	$this->elements[$i]->getAttribute( 'name' );
			if( $name === false )
			{
				continue;
			}
			
			$elementErrors = $this->elements[$i]->getValidationErrors();
			
			if( empty( $elementErrors ) )
				continue;
				
			$errors[$name]	=	$elementErrors;
			$found = true;
		}
		
		if( $found )
			return $errors;
			
		return false;
	}
	
   /**
	* retrieves the values for all elements in the form.
	*
	* @access	public
	* @param	array		desired fields
	* @param	integer		Mode that should be used to return values in groups
	* @return	array		The values for all elements, as elementname => elementvalue.
	*
	* @todo		remove the ugly Group check and replace with something better
	* @todo		implement something similar for getValidation errors
	*/
	function getValues( $fields = null, $type = PATFORMS_VALUES_NESTED )
	{
		$values	=	array();
		
		$cnt = count( $this->elements );
		for( $i = 0; $i < $cnt; ++$i )
		{
			$name	=	$this->elements[$i]->getAttribute( 'name' );
			if( $name === false ) {
				continue;
			}
			
			if( is_array( $fields ) && !in_array( $name, $fields ) ) {
				continue;
			}

			$tmpVal = $this->elements[$i]->getValue();
			if (!is_array($tmpVal) || $this->elements[$i]->elementName != 'Group') {
				$values[$name] = $tmpVal;
				continue;			
			}
			
			switch ($type) {
				case PATFORMS_VALUES_FLATTENED:
					$values = array_merge($values, $tmpVal);
					break;
				case PATFORMS_VALUES_PREFIXED:
					foreach ($tmpVal as $key => $val) {
						$values[$name.'_'.$key] = $val;
					}
					break;
				case PATFORMS_VALUES_NESTED:
				default:
					$values[$name] = $tmpVal;
					break;

			}
		}
		return $values;
	}
	
   /**
	* sets the values for all elements in the form. Use this to fill your form with external
	* data, like a db query. Caution: if you do this and set the form to submitted, the values
	* will be overwritten by any values present in the $_GET or $_POST variables.
	*
	* @access	public
	* @param	array	$values	The values for all elements, as elementname => elementvalue.
	*/
	function setValues( $values, $overrideUserInput = false )
	{
		patErrorManager::pushExpect(PATFORMS_ERROR_ELEMENT_NOT_FOUND);
        if(is_array($values)) {
            foreach ($values as $elName => $value) {
                $el = &$this->getElementByName($elName);
                if (patErrorManager::isError($el)) {
                    continue;
                }
                if ($overrideUserInput === true) {
                    $el->setValue($value);
                } else {
                    $el->setDefaultValue($value);
                }
            }
        }
		patErrorManager::popExpect();
		return true;
	}
	
   /**
	* retrieves the current mode of the form
	*
	* @access	public
	* @return	string	$mode	The current form mode
	* @see		setMode()
	* @see		$mode
	*/
	function getMode()
	{
		return $this->mode;
	}
	
   /**
	* returns the locale that is currently set for the form.
	*
	* @access	public
	* @return	string	$locale	The locale.
	* @see		setLocale()
	* @see		$locale
	*/
	function getLocale()
	{
		return $this->locale;
	}
	
   /**
	* retrieves the current format of the form
	*
	* @access	public
	* @return	string	$format	The current form format
	* @see		setFormat()
	* @see		format
	*/
	function getFormat()
	{
		return $this->format;
	}
	
   /**
	* retrieves the current method of the form
	*
	* @access	public
	* @return	string	$method	The request method
	* @see		setMethod()
	*/
	function getMethod()
	{
		return $this->getAttribute( 'method' );
	}
	
   /**
	* retrieves the current action of the form
	*
	* @access	public
	* @return	string	$action		Action of the form
	* @see		setAction()
	*/
	function getAction()
	{
		$action = $this->getAttribute( 'action' );
		if( !empty( $action ) )
			return $action;
		return	$_SERVER['PHP_SELF'];
	}
	
   /**
	* adds an atribute to the form's attribute collection. If the attribute
	* already exists, it is overwritten.
	*
	* @access	public
	* @param	string	$attributeName	The name of the attribute to add
	* @param	string	$atributeValue	The value of the attribute
	*/
	function setAttribute( $attributeName, $attributeValue )
	{
		if( !isset( $this->attributeDefinition[$attributeName] ) )
		{
			patErrorManager::raiseNotice( 
				PATFORMS_NOTICE_ATTRIBUTE_NOT_SUPPORTED, 
				"The attribute '".$attributeName."' is not supported by the form, skipped it. [".get_class( $this )."]" 
			);
			return true;
		}
		
		$this->attributes[$attributeName]	=	$attributeValue;
		
		return true;
	}
	
   /**
	* adds several attributes at once to the form's attribute collection.
	* Any existing attributes will be overwritten.
	*
	* @access	public
	* @param	array	$attributes	The attributes to add
	* @see		setAttribute()
	*/
	function setAttributes( $attributes )
	{
		if( !is_array( $attributes ) )
		{
			return patErrorManager::raiseError( 
				PATFORMS_NOTICE_ARRAY_EXPECTED, 
				"setAttributes: array expected"
			);
		}
	
		foreach( $attributes as $attributeName => $attributeValue )
		{
			$this->setAttribute( $attributeName, $attributeValue );
		}
		
		return true;
	}

   /**
	* retrieves the value of a form attribute.
	*
	* @access	public
	* @param	string	$attribute	The name of the attribute to retrieve
	* @return	mixed	$attributeValue	The value of the attribute, or false if it does not exist in the attributes collection.
	* @see		setAttribute()
	*/
	function getAttribute( $attribute )
	{
		if( !isset( $this->attributes[$attribute] ) )
		{
			return false;
		}
		
		return $this->attributes[$attribute];
	}
	
   /**
	* retrieves all attributes of the form, or only the specified attributes.
	*
	* @access	public
	* @param	array	$attributes	Optional: The names of the attributes to retrieve. Only the attributes that exist will be returned.
	* @return	array	$result		The attributes
	* @see		getAttribute()
	*/
	function getAttributes( $attributes = array() )
	{
		if( empty( $attributes ) )
		{
			return $this->attributes;
		}
		
		$result	=	array();
		foreach( $attributes as $attribute )
		{
			if( $attributeValue = $this->getAttribute( $attribute ) )
			{
				$result[$attribute]	=	$attributeValue;
			}
		}
		
		return $result;
	}
	
   /**
	* Loads the default attribute values into the attributes collection. Done directly
	* on startup (in the consructor).
	*
	* The action defaults to the path of the current script, with session
	* ID appended automatically, if SID has been defined.
	*
	* @access	public
	* @return	bool	$success	Always returns true.
	* @see		$attributeDefaults
	*/
	function loadAttributeDefaults()
	{
		foreach( $this->attributeDefinition as $attributeName => $attributeDef )
		{
			if( isset( $attributeDef['default'] ) )
			{
				$this->attributes[$attributeName]	=	$attributeDef['default'];
			}
			
			if( $attributeName == 'action' )
			{
				$this->attributes[$attributeName]	=	$_SERVER['PHP_SELF'];
				/**
				 * session has been started, append session ID
				 */
				if( defined( 'SID' ) )
					$this->attributes[$attributeName] .= '?' . SID;
			}
		}
		
		return true;
	}

   /**
	* retrieves the form's current submitted state.
	*
	* If autoValidate is used, it will check for the submitVar and
	* set the submitted flag accordingly
	*
	* @access	public
	* @return	bool	$state	True if it has been submitted, false otherwise.
	* @see		setSubmitted(), setAutoValidate()
	* @see		submitted
	*/
	function isSubmitted()
	{
		if( $this->submitted === true )
		{
			return true;
		}
		
		if( !isset( $this->submitVar ) )
		{
			return	false;
		}

		if( !$this->autoValidate )
		{
			return	false;
		} 

		if( isset( $_GET[$this->submitVar] ) || isset( $_POST[$this->submitVar] ) )
		{
			$this->setSubmitted( true );
		}
		
		return $this->submitted;
	}
	
   /**
	* Creates a new patForms_Creator object
	*
	* @static
	* @access	public
	* @return	object	$creator	The creator object, or a patError object on failure
	*/
	function createCreator( $type )
	{
		return patForms::_createModule( 'Creator', $type );
	}
	
   /**
	* get the element name of the form
	*
	* @access	public
	* @return	string	name of the form
	*/
	function getElementName()
	{
		return $this->elementName;
	}

   /**
	* get next error offset
	*
	* @access	public
	* @return	integer
	*/
	function getErrorOffset( $requiredCodes = 100 )
	{
		$offset					=	$this->nextErrorOffset;
		$this->nextErrorOffset	=	$this->nextErrorOffset + $requiredCodes;
		return	 $offset;
	}
	
   /**
	* add error codes and messages for validator method
	*
	* @access	public
	* @param	array	defintions
	* @param	integer	offset for the error codes
	*/
	function addValidatorErrorCodes( $defs, $offset = 1000 )
	{
		foreach( $defs as $lang => $codes )
		{
			if( !isset( $this->validatorErrorCodes[$lang] ) )
			{
				$this->validatorErrorCodes[$lang]	=	array();
			}
			
			foreach( $codes as $code => $message )
			{
				$this->validatorErrorCodes[$lang][($offset+$code)]	=	$message;
			}
		}
	}

   /**
	* add a validation error to the whole form
	*
	* This can be achieved by adding a validation rule to the form.
	*
	* @access	public
	* @param	integer	$code
	* @param	array	$vars	fill named placeholder with values
	* @return 	boolean $result	true on success
	* @see		addRule()
	*/
    function addValidationError( $code, $vars = array() )
    {
		$error		=	false;
		$lang		=	$this->locale;
		$element	=	$this->getElementName();
		
		// find error message for selected language
		while( true )
		{
			// error message matches language code
			if( isset( $this->validatorErrorCodes[$lang][$code] ) )
			{
				$error	=	array( "element" => $element, "code" => $code, "message" => $this->validatorErrorCodes[$lang][$code] );
				break;
			}
			// no message found and no fallback-langauage available
			else if ( $lang == "C" )
			{
				break;
			}
			
			$lang_old	=	$lang;
			
			// look for other languages
			if( strlen( $lang ) > 5 )
			{
				list( $lang, $trash	) =	explode( ".", $lang );
			}
			else if( strlen( $lang ) > 2 )
			{
				list( $lang, $trash	) =	explode( "_", $lang );
			}
			else
			{
				$lang	=	"C";
			}
			
			// inform developer about missing language 
			patErrorManager::raiseNotice(
				PATFORMS_NOTICE_VALIDATOR_ERROR_LOCALE_UNDEFINED, 
				"Required Validation Error-Code for language: $lang_old not available. Now trying language: $lang",
				"Add language definition in used element or choose other language"
			);

		}
		
		// get default Error!
		if( !$error )
		{
	 		patErrorManager::raiseWarning(
				PATFORMS_WARNING_VALIDATOR_ERROR_UNDEFINED, 
				"No Error Message for this validation Error was defined", 
				"Review the error-definition for validation-errors in your element '$element'." 
			);
			$error	=	array( "element" => $element, "code" => 0, "message" => "Unknown validation Error" );
		}
		
		// insert values to placeholders
		if( !empty( $vars ) )
		{
			foreach( $vars as $key => $value )
			{
				$error["message"]	=	str_replace( "[". strtoupper( $key ) ."]", $value, $error["message"] );
			}
		}

		array_push( $this->validationErrors, $error );
		$this->valid	=	false;
        return  true;
    }

   /**
	* Retrieves a new element id, used to give each added element a unique id for this
	* form (id can be overwritten by setting the id attribute specifically).
	*
	* @static
	* @access	public
	* @return	int	$elementId	The new element id.
	*/
	function getElementId()
	{
		$GLOBALS['_patForms']['elementCounter']++;
		return 'pfo'.$GLOBALS['_patForms']['elementCounter'];
	}

   /**
	* attach an observer
	*
	* @access	public
	* @param	object	patForms_Observer
	* @see		createObserver()
	* @uses		patForms_Element::createObserver()
	*/
	function attachObserver( &$observer, $where = PATFORMS_OBSERVER_ATTACH_TO_ELEMENTS )
	{
		/**
		 * attach the observer to all elements
		 */
		if( ( $where & PATFORMS_OBSERVER_ATTACH_TO_ELEMENTS ) == PATFORMS_OBSERVER_ATTACH_TO_ELEMENTS )
		{
			$cnt	=	count( $this->elements );
			for( $i = 0; $i < $cnt; ++$i )
			{
				$this->elements[$i]->attachObserver( $observer );
			}
		}

		/**
		 * attach the observer to the form
		 */
		if( ( $where & PATFORMS_OBSERVER_ATTACH_TO_FORM ) == PATFORMS_OBSERVER_ATTACH_TO_FORM )
		{
			$this->observers[] = &$observer;
		}
		return true;
	}

   /**
 	* Retrieve the content for the start of the form, including any 
	* additional content, e.g. global scripts if the scripts option 
	* is enabled.
	*
	* @access	public
	* @return	string	$formStart	The form start content
	* @todo		use format to build a dynamic method
	*/
	function serializeStart()
	{
		$methodName	=	"serializeStart".ucfirst( $this->getFormat() ).ucfirst( $this->getMode() );
		
		if( !method_exists( $this, $methodName ) )
		{
			return patErrorManager::raiseError( 
				PATFORMS_ERROR_METHOD_FOR_MODE_NOT_AVAILABLE, 
				"Method for patForms mode '".$this->getMode()."' (".$methodName.") is not available." 
			);
		}
		
		return	$this->$methodName();
	}
	
   /**
	* Serializes the form's start element for html format, in default mode.
	*
	* @access	private
	* @return	mixed	$formStart	The serialized start content, or a patError object.
	*/
	function serializeStartHtmlDefault()
	{
		$attributes	= $this->getAttributesFor( $this->format );
		if( patErrorManager::isError( $attributes ) )
		{
			return $attributes;
		}

		$content = patForms_Element::createTag( 'form', 'opening', $attributes );
		
		if ($this->optionEnabled( 'scripts' )) {
			$content .= $this->getScripts();
		}
		
		return $content;
	}
	
   /**
	* Serializes the form's start element for html format, in readonly mode.
	*
	* @access	private
	* @return	mixed	$formStart	The serialized start content, or a patError object.
	*/
	function serializeStartHtmlReadonly()
	{
		$attributes	= $this->getAttributesFor( $this->format );
		if( patErrorManager::isError( $attributes ) )
		{
			return $attributes;
		}

		return patForms_Element::createTag( 'form', 'opening', $attributes );
	}

   /**
 	* Retrieve the content for the end of the form.
	*
	* @access	public
	* @return	string	$formEnd	The form end content
	*/
	function serializeEnd()
	{
		$methodName	=	"serializeEnd".ucfirst( $this->getFormat() ).ucfirst( $this->getMode() );
		
		if( !method_exists( $this, $methodName ) )
		{
			return patErrorManager::raiseError( 
				PATFORMS_ERROR_METHOD_FOR_MODE_NOT_AVAILABLE, 
				"Method for patForms mode '".$this->getMode()."' (".$methodName.") is not available." 
			);
		}
		
		return	$this->$methodName();
	}
	
   /**
	* Retrieves the content for the end of the form for html format,
	* in default mode.
	*
	* @access	private
	* @return	string	$formEnd	The form end content	
	*/
	function serializeEndHtmlDefault()
	{
		return	patForms_Element::createTag( 'form', 'closing' );
	}

   /**
	* Retrieves the content for the end of the form for html format,
	* in readonly mode.
	*
	* @access	private
	* @return	string	$formEnd	The form end content	
	*/
	function serializeEndHtmlReadonly()
	{
		return	$this->serializeEndHtmlDefault();
	}

   /**
	* validates the current attribute collection according to the attributes definition
	* and the given output format, and returns the list of valid attributes.
	*
	* @access	private
	* @param	string	$format		The output format to retrieve the attributes for.
	* @return	mixed	$attributes	The list of attributes, or false if failed.
	*/
	function getAttributesFor( $format )
	{
		$attributes	=	array();

		foreach( $this->attributeDefinition as $attributeName => $attributeDef )
		{
			if( !isset( $this->attributes[$attributeName] ) )
			{
				if( $attributeDef["required"] )
				{
					return patErrorManager::raiseError( 
						PATFORMS_ERROR_ATTRIBUTE_REQUIRED, 
						'patForms needs the attribute "'.$attributeName.'" to be set.',
						'See the patForms attribute definition of patForms for a complete attribute reference.'
					);
				}
				
				continue;
			}
			
			$attributeValue	=	$this->attributes[$attributeName];
			
			if( !in_array( $format, $attributeDef["outputFormats"] ) )
			{
				continue;
			}
			
			if( isset( $attributeDef["format"] ) )
			{
				if( !$this->_checkAttributeFormat( $attributeValue, $attributeDef["format"] ) )
				{
					return patErrorManager::raiseError( 
						PATFORMS_ERROR_CAN_NOT_VERIFY_FORMAT, 
						"Format '".$attributeDef["format"]."' could not be verified for patForms attribute '".$attributeName."' => '".$attributeValue."'" 
					);
				}
			}
			
			$attributes[$attributeName]	=	$attributeValue;
		}
		
		return $attributes;
	}
	
   /**
	* checks the format of an attribute value according to the given format.
	*
	* @access	private
	* @param	mixed	$attributeValue	The attribute value to check
	* @param	string	$format			The format to check the attribute value against
	* @return	bool	$result			True if format check succeeded, false otherwise.
	* @see		createAttributes()
	* @todo		Implement this method sometime
	*/
	function _checkAttributeFormat( $attributeValue, $format )
	{
		return true;
	}

   /**
	* Enables a patForms option.
	* 
	* See the {@link $options} property for an exhaustive list of available options.
	*
	* @access	public
	* @param	string	$option		The option to enable
	* @param	array	$params		Optional parameters for the option
	* @return	mixed	$result		True on success, patError object otherwise.
	* @see		disableOption()
	* @see		optionEnabled()
	* @see		$options
	*/
	function enableOption( $option, $params = array() )
	{
		if( !in_array( $option, array_keys( $this->options ) ) )
		{
			return patErrorManager::raiseNotice(
				PATFORMS_NOTICE_INVALID_OPTION,
				'The option "'.$option.'" is not a valid patForms option.'
			);
		}
		
		$this->options[$option]['enabled'] = true;
		$this->options[$option]['params']  = array_merge($this->options[$option]['params'], $params);
		
		// now update all available elements too
		$cnt = count( $this->elements );
		for( $i=0; $i < $cnt; $i++ )
		{
			$this->elements[$i]->enableOption( $option, $params );
		}
		
		return true;
	}
	
   /**
	* Disables a patForms option
	* 
	* See the {@link $options} property for an exhaustive list of available options.
	*
	* @access	public
	* @param	string	$option	The option to disable
	* @return	mixed	$result	True on success, patError object otherwise.
	* @see		enableOption()
	* @see		optionEnabled()
	* @see		$options
	*/
	function disableOption( $option )
	{
		if( !in_array( $option, array_keys( $this->options ) ) )
		{
			return patErrorManager::raiseNotice(
				PATFORMS_NOTICE_INVALID_OPTION,
				'The option "'.$option.'" is not a valid patForms option.'
			);
		}
		
		$this->options[$option]['enabled']	=	false;
		
		// now update all available elements too
		$cnt = count( $this->elements );
		for( $i=0; $i < $cnt; $i++ )
		{
			$this->elements[$i]->disableOption( $option );
		}

		return true;
	}
	
   /**
	* Checks whether the given option is enabled.
	*
	* @access	public
	* @param	string	$option		The option to check
	* @return	bool	$enabled	True if enabled, false otherwise.
	* @see		enableOption()
	* @see		disableOption()
	* @see		getOptionParameters()
	* @see		$options
	*/
	function optionEnabled( $option )
	{
		if( !isset( $this->options[$option] ) )
			return false;
			
		return $this->options[$option]['enabled'];
	}

   /**
	* returns the parameters that have been supplied for an option
	*
	* @access	public
	* @param	string	$option		The option to check
	* @return	array
	* @see		enableOption()
	* @see		disableOption()
	* @see		optionEnabled()
	* @see		$options
	*/
	function getOptionParameters( $option )
	{
		if( !isset( $this->options[$option] ) )
			return false;

		return $this->options[$option]['params'];
	}

   /**
	* Set the form to auto validate
	*
	* If you use this method, patForms will check the _GET and _POST variables
	* for the variable you specified. If it is set, patForms assumes, that
	* the form has been submitted.
	*
	* When creating a start tag for the form, the value will be inserted automatically.
	*
	* @access	public
	* @param	string	$submitVar
	*/
	function setAutoValidate( $submitVar )
	{
		$this->autoValidate	=	true;
		$this->submitVar	=	$submitVar;
	}

   /**
	* register a new event
	*
	* After registering an event, you may register one or more
	* event handlers for this event an then trigger the event.
	*
	* This lets you extend the functionality of patForms.
	*
	* @access	public
	* @param	string	event name
	* @return	boolean	true, if event could be registered
	* @see		registerEventHandler()
	* @see		triggerEvent()
	*/
	function registerEvent( $name )
	{
		$event	=	'on' . $name;
		if( in_array( $event, $this->_validEvents ) )
		{
			return patErrorManager::raiseNotice(
												PATFORMS_NOTICE_EVENT_ALREADY_REGISTERED,
												'Event "'.$event.'" already has been registered or is built-in event'
												);
		}
		array_push( $this->_validEvents, $event );
		return true;
	}
	
   /**
	* Register an event handler
	*
	* An event handler can be any valid PHP callback. You may pass
	* one of the following values:
	* - string functionname to call a globally declared function 
	* - array( string classname, string methodname) to call a static method
	* - array( object obj, string methodname) to call a method of an object
	*
	* When the handler is called, two parameters will be passed:
	* - object form  : a patForms object
	* - string event : the name of the event has should be handled.
	*
	* An event handler should always return true. If false is returned,
	* the event will be cancelled.
	* 
	* Currently handlers for the following events can be registered:
	* - onSubmit
	* - onSuccess
	* - onError
	*
	* @access	public
	* @param	string	event name
	* @param	mixed	event handler
	* @return	boolean	true, if the handler could be registered
	* @see		triggerEvent()
	* @see		$_validEvents
	*/
	function registerEventHandler( $event, $handler )
	{
		if( !in_array( $event, $this->_validEvents ) )
		{
			return patErrorManager::raiseError(
												PATFORMS_ERROR_UNKNOWN_EVENT,
												'Cannot register event handler for unknown event "' . $event .'".'
												);
		}
		
		if( !is_callable( $handler ) )
		{
			return patErrorManager::raiseError(
												PATFORMS_ERROR_INVALID_HANDLER,
												'Event handler is not callable.'
												);
		}
		
		if( !isset( $this->_eventHandler[$event] ) )
		{
			$this->_eventHandler[$event]	=	array();
		}
		
		$this->_eventHandler[$event][]	=	&$handler;
		return true;
	}

   /**
	* set event handler object.
	*
	* An event handler object is used to handle all
	* registered events. The object has to provide methods
	* for all events it should handle, the names of the methods
	* have to be the same as the names of the events.
	*
	* @access	public
	* @param	object	event handler object
	* @param	array	method names, used to change the names of the methods
	* @return	boolean
	*/
	function registerEventHandlerObject( &$obj, $methods = array() )
	{
		if( empty( $methods ) )
		{
			foreach( $this->_validEvents as $event )
			{
				if( !method_exists( $obj, $event ) )
					continue;
				
				$methods[$event]	=	$event;
			}
		}

		foreach( $methods as $event => $method )
		{
			if( !isset( $this->_eventHandler[$event] ) )
			{
				$this->_eventHandler[$event]	=	array();
			}

			$this->_eventHandler[$event][]	=	array( &$obj, $method );
		}

		return	true;
	}
	
   /**
	* Trigger an event
	*
	* In most cases there's no need to call this event
	* from outside the class. The method is declared public
	* to allow you to trigger custom events.
	*
	* @access	public
	* @param	string	Event name. The event name must not contain 'on', as this will be
	*					prefixed automatically.
	*/
	function triggerEvent( $event )
	{
		$handlerName	=	'on' . $event;

		if( !isset( $this->_eventHandler[$handlerName] ) || empty( $this->_eventHandler[$handlerName] ) )
		{
			return true;
		}

		$cnt	=	count( $this->_eventHandler[$handlerName] );
		for( $i = 0; $i < $cnt; $i++ )
		{
			$result	=	call_user_func( $this->_eventHandler[$handlerName][$i], $this, $event );
			if( $result == false )
			{
				return $result;
			}
		}
		return true;
	}
	
   /**
	* Serializes the entire form to XML, all elements included
	* 
	* @access	public
	* @param	string	$namespace	Optional namespace to use for the tags
	* @return	string	$xml		The XML representation of the form
	* @see		patForms_Element::toXML()
	* @todo		needs patForms_Element, maybe switch to PEAR::XML_Util
	*/
	function toXML( $namespace = null )
	{
		$tagName = 'Form';

		// prepend Namespace
		if( $namespace != null )
		{
			$tagName	=	$namespace.':'.$tagName;
		}
		
		// get all attributes
		$attributes	=	$this->getAttributes();

		// create valid XML attributes
		foreach( $attributes as $key => $value )
		{
			$attributes[$key]	=	strtr( $value, $this->xmlEntities );
		}
		
		$elements = '';
		for( $i = 0; $i < $this->elementCounter; $i++ )
		{
			$elements .= $this->elements[$i]->toXML( $namespace );
		}
		
		return	patForms_Element::createTag( $tagName, "full", $attributes, $elements );
	}
	
   /**
	* Set a static property.
	*
	* Static properties are stored in an array in a global variable,
	* until PHP5 is ready to use.
	*
	* @static
	* @param	string	property name
	* @param	mixed	property value
	* @see		getStaticProperty()
	*/
	function setStaticProperty( $property, &$value )
	{
		$GLOBALS["_patForms"][$property]	=	&$value;
	}

   /**
	* Get a static property.
	*
	* Static properties are stored in an array in a global variable,
	* until PHP5 is ready to use.
	*
	* @static
	* @param	string	property name
	* @return	mixed	property value
	* @see		setStaticProperty()
	*/
	function &getStaticProperty( $property )
	{
		if( isset( $GLOBALS["_patForms"][$property] ) )
		{
			return	$GLOBALS["_patForms"][$property];
		}
		return	patErrorManager::raiseWarning(
			PATFORMS_ERROR_NO_STATIC_PROPERTY, 
			'Static property "'.$property.'" could not be retreived, it does not exist.'
		);
	}
	
   /**
	* Retrieves the form's name
	*
	* If no name is set, it will use 'patForms' as name.
	*
	* @access	public
	* @return	string	$name	The name of the form.
	*/
	function getName()
	{
		if( isset( $this->attributes['name'] ) )
			return $this->attributes['name'];
		return 'patForms';
	}

   /**
	* get the javascript for the form
	*
	* This is still in alpha state. It will later
	* allow client side validation if the element
	* provides this feature.
	*
	* @access	public
	* @return	string	javascript needed by the form
	* @todo		make this dependent on the format
	* @todo		add changeable linebreaks
	* @todo		store included javascripts in some kind of static property
	*/	
	function getScripts()
	{
		$displayedTypes   = array();
		$globalJavascript = array();
		$instances = '';
		
		$cnt = count( $this->elements );
		for ($i = 0; $i < $cnt; ++$i) {
			$instances .= $this->elements[$i]->getInstanceJavascript();

			$type = $this->elements[$i]->getElementName();
			if (in_array($type, $displayedTypes)) {
				continue;
			}

			array_push( $displayedTypes, $type );
			$globalScript = $this->elements[$i]->getGlobalJavascript();
			if (!empty($globalScript)) {
				array_push($globalJavascript, $globalScript);
			}
		}
		
		$cnt = count( $this->_rules );
		for( $i = 0; $i < $cnt; ++$i )
		{
			$instances .= $this->_rules[$i]['rule']->getInstanceJavascript();

			$type = $this->_rules[$i]['rule']->getRuleName();
			if (in_array($type, $displayedTypes)) {
				continue;
			}

			array_push( $displayedTypes, $type );
			$globalScript = $this->_rules[$i]['rule']->getGlobalJavascript();
			if (!empty($globalScript)) {
				array_push($globalJavascript, $globalScript);
			}
		}

		$optionParams = $this->getOptionParameters('scripts');
		$scriptFolder = $optionParams['folder'];

		if ($optionParams['jsInclude'] === true) {
			$script = "\n";
			foreach ($globalJavascript as $scriptFile) {
				$fullPath = $scriptFolder . '/' . $scriptFile;
				if (!file_exists($fullPath)) {
					patErrorManager::raiseWarning(PATFORMS_WARNING_SCRIPTFILE_NOT_FOUND, 'Could not script file.', $fullPath);
					continue;
				}
				$script .= '<script type="text/javascript" language="Javascript1.3" src="'.$fullPath.'"></script>' . "\n";
			}
			$script .= '<script type="text/javascript" language="Javascript1.3">' . "\n";
			$script .= $instances;
			$script .= '</script>';
		} else {
			$script = "\n".'<script type="text/javascript" language="Javascript1.3">' . "\n";
			foreach ($globalJavascript as $scriptFile) {
				$fullPath = $scriptFolder . '/' . $scriptFile;
				if (!file_exists($fullPath)) {
					patErrorManager::raiseWarning(PATFORMS_WARNING_SCRIPTFILE_NOT_FOUND, 'Could not script file.', $fullPath);
					continue;
				}
				$script .= file_get_contents($fullPath);
			}
			$script .= "\n\n";
			$script .= $instances;
			$script .= "\n";
			$script .= '</script>';
		}
		
		return $script;
	}
	
   /**
	* anounce a change in the element to all observers
	*
	* @access	private
	* @param	string		property that changed
	* @param	mixed		new value of the property
	*/
	function _announce( $property, $value )
	{
		$cnt = count( $this->observers );
		for( $i = 0; $i < $cnt; $i++ )
		{
			$this->observers[$i]->notify( $this, $property, $value );
		}
		return true;
	}
}
?>
Back to Top