core /src/legacy/Zikula/View.php

Language PHP Lines 2904
MD5 Hash 7bddd94170671b1d2b12f6143cb32464
Repository https://github.com/antoniom/core.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
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
<?php
/**
 * Copyright Zikula Foundation 2009 - Zikula Application Framework
 *
 * This work is contributed to the Zikula Foundation under one or more
 * Contributor Agreements and licensed to You under the following license:
 *
 * @license GNU/LGPLv3 (or at your option, any later version).
 * @package Zikula_View
 *
 * Please see the NOTICE file distributed with this source code for further
 * information regarding copyright and licensing.
 */

use Zikula\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\EventDispatcher\EventDispatcher;
use Zikula\Common\I18n\TranslatableInterface;
use Zikula\Core\Event\GenericEvent;

/**
 * Zikula_View class.
 */
class Zikula_View extends Smarty implements TranslatableInterface
{
    const CACHE_DISABLED = 0;
    const CACHE_ENABLED = 1;
    const CACHE_INDIVIDUAL = 2;

    /**
     * Translation domain of the calling module.
     *
     * @var string
     */
    public $domain;

    /**
     * Module info array, indexed by module name.
     *
     * @var array
     */
    public $module;

    /**
     * Module info.
     *
     * @var array
     */
    public $modinfo;

    /**
     * Top level module.
     *
     * @var string
     */
    public $toplevelmodule;

    /**
     * Type.
     *
     * @var integer
     */
    public $type;

    /**
     * Function.
     *
     * @var string
     */
    public $func;

    /**
     * Language.
     *
     * @var string
     */
    public $language;

    /**
     * Homepage flag.
     *
     * @var boolean
     */
    public $homepage;

    /**
     * Theme name.
     *
     * @var string
     */
    public $theme;

    /**
     * Theme info.
     *
     * @var array
     */
    public $themeinfo;

    /**
     * Base Url.
     *
     * @var string
     */
    public $baseurl;

    /**
     * Base Uri.
     *
     * @var string
     */
    public $baseuri;

    /**
     * The service manager instance.
     *
     * @var \Symfony\Component\DependencyInjection\ContainerBuilder
     */
    protected $container;

    /**
     * The event manager instance.
     *
     * @var EventDispatcher
     */
    protected $dispatcher;

    /**
     * Request object.
     *
     * @var \Symfony\Component\HttpFoundation\Request
     */
    protected $request;

    /**
     * Zikula controller.
     *
     * @var Zikula_AbstractController
     */
    protected $controller;

    /**
     * Cache Id.
     *
     * @var string
     */
    public $cache_id;

    /**
     * Whether or not to expose template.
     *
     * @var boolean
     */
    public $expose_template;

    /**
     * Template path (populated by fetch).
     *
     * @var string
     */
    protected $templatePath;

    /**
     * Templates.
     *
     * @var array
     */
    protected $templateCache = array();

    /**
     * Constructor.
     *
     * @param ContainerBuilder $container ServiceManager.
     * @param string           $moduleName     Module name ("zikula" for system plugins).
     * @param integer|null     $caching        Whether or not to cache (Zikula_View::CACHE_*) or use config variable (null).
     */
    public function __construct(ContainerBuilder $container, $moduleName = '', $caching = null)
    {
        $this->container = $container;
        $this->dispatcher = $this->container->get('event_dispatcher');
        $this->request = $this->container->get('request');

        // set the error reporting level
        $this->error_reporting = isset($container['error_reporting']) ? $container['error_reporting'] : E_ALL;
        $this->allow_php_tag = true;

        // get variables from input
        $module = $this->request->attributes->get('_module', null);
        $type   = $this->request->attributes->get('_controller', 'user');
        $func   = $this->request->attributes->get('_action', 'index');

        // set vars based on the module structures
        $this->homepage = empty($module) ? true : false;
        $this->type = strtolower(!$this->homepage ? $type : System::getVar('starttype'));
        $this->func = strtolower(!$this->homepage ? $func : System::getVar('startfunc'));

        // Initialize the module property with the name of
        // the topmost module. For Hooks, Blocks, API Functions and others
        // you need to set this property to the name of the respective module!
        $this->toplevelmodule = ModUtil::getName();

        if (!$moduleName) {
            $moduleName = $this->toplevelmodule;
        }
        $this->modinfo = ModUtil::getInfoFromName($moduleName);
        $this->module  = array($moduleName => $this->modinfo);

        // initialise environment vars
        $this->language = ZLanguage::getLanguageCode();
        $this->baseurl = System::getBaseUrl();
        $this->baseuri = System::getBaseUri();

        // system info
        $this->themeinfo = ThemeUtil::getInfo(ThemeUtil::getIDFromName(UserUtil::getTheme()));
        $this->theme = $this->themeinfo['directory'];

        //---- Plugins handling -----------------------------------------------
        // add plugin paths
        switch ($this->modinfo['type']) {
            case ModUtil::TYPE_MODULE :
                $mpluginPath = "modules/" . $this->modinfo['directory'] . "/Resources/views/plugins";
                break;
            case ModUtil::TYPE_SYSTEM :
                $mpluginPath = "system/" . $this->modinfo['directory'] . "/Rsources/views/plugins";
                break;
            default:
                $mpluginPath = "system/" . $this->modinfo['directory'] . "/Rsources/views/plugins";
        }

        // add standard plugin search path
        $this->plugins_dir = array();
        $this->addPluginDir('config/Resources/plugins'); // Official override
        $this->addPluginDir('config/plugins'); // Official override
        $this->addPluginDir(ZIKULA_ROOT.'/../src/legacy/viewplugins'); // Core plugins
        $this->addPluginDir("themes/$this->theme/Resources/views/plugins"); // Theme plugins
        $this->addPluginDir(SMARTY_DIR.'plugins'); // Smarty core plugins
        $this->addPluginDir($mpluginPath); // Plugins for current module

        // check if the 'type' parameter in the URL is admin and if yes,
        // include system/Admin/templates/plugins to the plugins_dir array
        if ($type === 'admin') {
            if (!$this instanceof Zikula_View_Theme) {
                $this->addPluginDir('system/AdminModule/Resources/views/plugins');
            } else {
                $this->load_filter('output', 'admintitle');
            }
        }

        //---- Cache handling -------------------------------------------------
        if ($caching && in_array((int)$caching, array(0, 1, 2))) {
            $this->caching = (int)$caching;
        } else {
            $this->caching = (int)ModUtil::getVar('Theme', 'render_cache');
        }

        $this->compile_id  = '';
        $this->cache_id    = '';

        // template compilation
        $this->compile_dir    = CacheUtil::getLocalDir('view_compiled');
        $this->compile_check  = ModUtil::getVar('Theme', 'render_compile_check');
        $this->force_compile  = ModUtil::getVar('Theme', 'render_force_compile');
        // template caching
        $this->cache_dir      = CacheUtil::getLocalDir('view_cache');
        $this->cache_lifetime = ModUtil::getVar('Theme', 'render_lifetime');

        $this->expose_template = (ModUtil::getVar('Theme', 'render_expose_template') == true) ? true : false;

        // register resource type 'z' this defines the way templates are searched
        // during {include file='my_template.tpl'} this enables us to store selected module
        // templates in the theme while others can be kept in the module itself.
        $this->register_resource('z', array('Zikula_View_Resource',
                                            'z_get_template',
                                            'z_get_timestamp',
                                            'z_get_secure',
                                            'z_get_trusted'));

        // set 'z' as default resource type
        $this->default_resource_type = 'z';

        // process some plugins specially when Render cache is enabled
        if (!$this instanceof Zikula_View_Theme && $this->caching) {
            $this->register_nocache_plugins();
        }

        // register the 'nocache' block to allow dynamic zones caching templates
        $this->register_block('nocache', array('Zikula_View_Resource', 'block_nocache'), false);

        // For ajax requests we use the short urls filter to 'fix' relative paths
        if (($this->container->get('zikula')->getStage() & \Zikula\Core\Core::STAGE_AJAX) && System::getVar('shorturls')) {
            $this->load_filter('output', 'shorturls');
        }

        // register prefilters
        $this->register_prefilter('z_prefilter_add_literal');

        $this->register_prefilter('z_prefilter_gettext_params');

        // assign some useful settings
        $this->assign('homepage', $this->homepage)
             ->assign('modinfo', $this->modinfo)
             ->assign('module', $moduleName)
             ->assign('toplevelmodule', $this->toplevelmodule)
             ->assign('type', $this->type)
             ->assign('func', $this->func)
             ->assign('lang', $this->language)
             ->assign('themeinfo', $this->themeinfo)
             ->assign('themepath', $this->baseurl . 'themes/' . $this->theme)
             ->assign('baseurl', $this->baseurl)
             ->assign('baseuri', $this->baseuri);

        // for {gt} template plugin to detect gettext domain
        if ($this->modinfo['type'] == ModUtil::TYPE_MODULE) {
            $this->domain = ZLanguage::getModuleDomain($this->modinfo['name']);
        }

        // make render object available to modifiers
        parent::assign('zikula_view', $this);

        // add ServiceManager, EventManager and others to all templates
        parent::assign('container', $this->container);
        parent::assign('dispatcher', $this->dispatcher);
        parent::assign('zikula_core', $this->container->get('zikula'));
        parent::assign('request', $this->request);
        parent::assign('modvars', ModUtil::getModvars()); // Get all modvars from any modules that have accessed their modvars at least once.

        $this->add_core_data();

        // metadata for SEO
        if (!isset($this->container['zikula_view.metatags'])) {
            $this->container['zikula_view.metatags'] = new ArrayObject(array());
        }

        parent::assign('metatags', $this->container['zikula_view.metatags']);

        $event = new GenericEvent($this);
        $this->dispatcher->dispatch('view.init', $event);
    }

    /**
     * Setup the current instance of the Zikula_View class and return it back to the module.
     *
     * @param string       $module   Module name.
     * @param integer|null $caching  Whether or not to cache (Zikula_View::CACHE_*) or use config variable (null).
     * @param string       $cache_id Cache Id.
     *
     * @return Zikula_View This instance.
     */
    public static function getInstance($module = null, $caching = null, $cache_id = null)
    {
        if (is_null($module)) {
            $module = ModUtil::getName();
        }

        $module = preg_match('/\w+Module$/', $module) ? $module : $module.'Module';

        $container = ServiceUtil::getManager();
        $serviceId = strtolower(sprintf('zikula.view.%s', $module));
        if (!$container->has($serviceId)) {
            $view = new self($container, $module, $caching);
            $container->set($serviceId, $view);
        } else {
            $view = $container->get($serviceId);
        }

        if (!is_null($caching)) {
            $view->caching = (int)$caching;
        }

        if (!is_null($cache_id)) {
            $view->cache_id = $cache_id;
        }

        if (!$module) {
            $module = $view->toplevelmodule;
        }

//        if (!array_key_exists($module, $view->module)) {
            $view->module[$module] = ModUtil::getInfoFromName($module);
            $view->_add_plugins_dir($module);
//        }

        // for {gt} template plugin to detect gettext domain
        if ($view->module[$module]['type'] == ModUtil::TYPE_MODULE) {
            $view->domain = ZLanguage::getModuleDomain($view->module[$module]['name']);
        }

        return $view;
    }

    /**
     * Get module plugin Zikula_View_Plugin instance.
     *
     * @param string       $modName    Module name.
     * @param string       $pluginName Plugin name.
     * @param integer|null $caching    Whether or not to cache (Zikula_View::CACHE_*) or use config variable (null).
     * @param string       $cache_id   Cache Id.
     *
     * @return Zikula_View_Plugin The plugin instance.
     */
    public static function getModulePluginInstance($modName, $pluginName, $caching = null, $cache_id = null)
    {
        return Zikula_View_Plugin::getInstance($modName, $pluginName, $caching, $cache_id);
    }

    /**
     * Get system plugin Zikula_View_Plugin instance.
     *
     * @param string       $pluginName Plugin name.
     * @param integer|null $caching    Whether or not to cache (Zikula_View::CACHE_*) or use config variable (null).
     * @param string       $cache_id   Cache Id.
     *
     * @return Zikula_View_Plugin The plugin instance.
     */
    public static function getSystemPluginInstance($pluginName, $caching = null, $cache_id = null)
    {
        $modName = 'zikula';

        return Zikula_View_Plugin::getPluginInstance($modName, $pluginName, $caching, $cache_id);
    }

    /**
     * Internal registration of Zikula core's plugins sensible to cache.
     *
     * Basically the user-based ones and those that has relation with the theme/pagevars.
     *
     * @return void
     */
    protected function register_nocache_plugins()
    {
        // disables the cache for them and do not load them yet
        // that happens later when required
        $delayed_load = true;
        $cacheable    = false;

        //// blocks
        // checkgroup
        Zikula_View_Resource::register($this, 'block', 'checkgroup', $delayed_load, $cacheable, array('gid'));
        // checkpermissionblock
        Zikula_View_Resource::register($this, 'block', 'checkpermissionblock', $delayed_load, $cacheable, array('component', 'instance'));
        // pageaddvarblock
        Zikula_View_Resource::register($this, 'block', 'pageaddvarblock', $delayed_load, $cacheable, array('name'));

        //// plugins
        // ajaxheader
        Zikula_View_Resource::register($this, 'function', 'ajaxheader', $delayed_load, $cacheable, array('modname', 'filename', 'noscriptaculous', 'validation', 'lightbox', 'imageviewer', 'assign'));
        // assign_cache
        Zikula_View_Resource::register($this, 'function', 'assign_cache', $delayed_load, $cacheable, array('var', 'value'));
        // checkpermission
        Zikula_View_Resource::register($this, 'function', 'checkpermission', $delayed_load, $cacheable, array('component', 'instance', 'level', 'assign'));
        // formutil_getfieldmarker
        Zikula_View_Resource::register($this, 'function', 'formutil_getfieldmarker', $delayed_load, $cacheable, array('objectType', 'validation', 'field', 'assign'));
        // formutil_getpassedvalue
        Zikula_View_Resource::register($this, 'function', 'formutil_getpassedvalue', $delayed_load, $cacheable, array('assign', 'html', 'key', 'name', 'default', 'source', 'noprocess'));
        // formutil_getvalidationerror
        Zikula_View_Resource::register($this, 'function', 'formutil_getvalidationerror', $delayed_load, $cacheable, array('objectType', 'field', 'assign'));
        // notifydisplayhooks
        Zikula_View_Resource::register($this, 'function', 'notifydisplayhooks', $delayed_load, $cacheable, array('eventname', 'id', 'urlobject', 'assign'));
        // notifyevent
        Zikula_View_Resource::register($this, 'function', 'notifyevent', $delayed_load, $cacheable, array('eventname', 'eventsubject', 'eventdata', 'assign'));
        // pageaddvar
        Zikula_View_Resource::register($this, 'function', 'pageaddvar', $delayed_load, $cacheable, array('name', 'value'));
        // pagegetvar
        Zikula_View_Resource::register($this, 'function', 'pagegetvar', $delayed_load, $cacheable, array('name', 'html', 'assign'));
        // pager
        Zikula_View_Resource::register($this, 'function', 'pager', $delayed_load, $cacheable, array('modname', 'type', 'func', 'rowcount', 'limit', 'posvar', 'owner', 'template', 'includeStylesheet', 'anchorText', 'maxpages', 'display', 'class', 'processDetailLinks', 'processUrls', 'optimize'));
        // pageregistervar
        Zikula_View_Resource::register($this, 'function', 'pageregistervar', $delayed_load, $cacheable, array('name'));
        // pagesetvar
        Zikula_View_Resource::register($this, 'function', 'pagesetvar', $delayed_load, $cacheable, array('name', 'value'));
        // servergetvar
        Zikula_View_Resource::register($this, 'function', 'servergetvar', $delayed_load, $cacheable, array('name', 'default', 'assign'));
        // sessiondelvar
        Zikula_View_Resource::register($this, 'function', 'sessiondelvar', $delayed_load, $cacheable, array('name', 'path', 'assign'));
        // sessiongetvar
        Zikula_View_Resource::register($this, 'function', 'sessiongetvar', $delayed_load, $cacheable, array('name', 'assign', 'default', 'path'));
        // sessionsetvar
        Zikula_View_Resource::register($this, 'function', 'sessionsetvar', $delayed_load, $cacheable, array('name', 'value', 'path', 'assign'));
        // setmetatag
        Zikula_View_Resource::register($this, 'function', 'setmetatag', $delayed_load, $cacheable, array('name', 'value'));
        // themegetvar
        Zikula_View_Resource::register($this, 'function', 'themegetvar', $delayed_load, $cacheable, array('name', 'default', 'assign'));
        // themesetvar
        Zikula_View_Resource::register($this, 'function', 'themesetvar', $delayed_load, $cacheable, array('name', 'value'));
        // user
        Zikula_View_Resource::register($this, 'function', 'user', $delayed_load, $cacheable);
        // useravatar - without uid caching
        Zikula_View_Resource::register($this, 'function', 'useravatar', $delayed_load, $cacheable);
        // usergetvar
        Zikula_View_Resource::register($this, 'function', 'usergetvar', $delayed_load, $cacheable, array('assign', 'default', 'name', 'uid'));
        // userlinks
        Zikula_View_Resource::register($this, 'function', 'userlinks', $delayed_load, $cacheable, array('start', 'end', 'seperator'));
        // userloggedin
        Zikula_View_Resource::register($this, 'function', 'userloggedin', $delayed_load, $cacheable, array('assign'));
        // userwelcome
        Zikula_View_Resource::register($this, 'function', 'userwelcome', $delayed_load, $cacheable);
        // zdebug
        Zikula_View_Resource::register($this, 'function', 'zdebug', $delayed_load, $cacheable);
    }

    /**
     * Checks whether requested template exists.
     *
     * @param string $template Template name.
     *
     * @return boolean
     */
    public function template_exists($template)
    {
        return (bool)$this->get_template_path($template);
    }

    /**
     * Checks which path to use for required template.
     *
     * @param string $template Template name.
     *
     * @return string Template path.
     */
    public function get_template_path($template)
    {
        if (isset($this->templateCache[$template])) {
            return $this->templateCache[$template];
        }

        // the current module
        $modname = ModUtil::getName();

        foreach ($this->module as $module => $modinfo) {
            // prepare the values for OS
            $module = $modinfo['name'];

            $os_module = DataUtil::formatForOS($module);
            $os_dir = $modinfo['type'] == ModUtil::TYPE_MODULE ? 'modules' : 'system';

            $ostemplate = DataUtil::formatForOS($template);

            if (is_dir("$os_dir/$os_module/Resources/views")) {
                $relativepath = "$os_dir/$os_module/Resources/views";
            }

            $templatefile = "$relativepath/$ostemplate";
            $override = self::getTemplateOverride($templatefile);
            if ($override === false) {
                // no override present
                if (is_readable($templatefile)) {
                    $this->templateCache[$template] = $relativepath;
                    return $relativepath;
                } else {
                    return false;
                }
            } else {
                if (is_readable($override)) {
                    $path = substr($override, 0, strrpos($override, $ostemplate));
                    $this->templateCache[$template] = $path;

                    return $path;
                }
            }
        }

        // when we arrive here, no path was found
        return false;
    }

    /**
     * Add core data to the template.
     *
     * This function adds some basic data to the template depending on the
     * current user and the Zikula settings.  There is no need to call this as it's
     * invoked automatically on instanciation.
     *
     * @return Zikula_View
     */
    public function add_core_data()
    {
        if (!isset($this->container['zikula_view.coredata'])) {
            $this->container['zikula_view.coredata'] = new ArrayObject(array());
        }

        $core = $this->container['zikula_view.coredata'];
        $core['version_num'] = \Zikula\Core\Core::VERSION_NUM;
        $core['version_id'] = \Zikula\Core\Core::VERSION_ID;
        $core['version_sub'] = \Zikula\Core\Core::VERSION_SUB;
        $core['logged_in'] = UserUtil::isLoggedIn();
        $core['language'] = $this->language;

        // add userdata
        $core['user']   = UserUtil::getVars($this->request->getSession()->get('uid'));

        // Module vars
        parent::assign('coredata', $core);

        return $this;
    }

    /**
     * Executes & returns the template results.
     *
     * This returns the template output instead of displaying it.
     * Supply a valid template name.
     * As an optional second parameter, you can pass a cache id.
     * As an optional third parameter, you can pass a compile id.
     *
     * @param string  $template   The name of the template.
     * @param string  $cache_id   The cache ID (optional).
     * @param string  $compile_id The compile ID (optional).
     * @param boolean $display    Whether or not to display directly (optional).
     * @param boolean $reset      Reset singleton defaults (optional). deprecated.
     *
     * @return string The template output.
     */
    public function fetch($template, $cache_id = null, $compile_id = null, $display = false, $reset = true)
    {
        $this->_setup_template($template);

        if (is_null($cache_id)) {
            $cache_id = $this->cache_id;
        }

        if (is_null($compile_id)) {
            $compile_id = $this->compile_id;
        }

        $this->template = $this->template_dir . '/' . $template;
        $output = $this->_fetch($template, $cache_id, $compile_id, $display);

        if ($this->expose_template == true) {
            $template = DataUtil::formatForDisplay($template);
            $output = "\n<!-- Start " . $this->template_dir . "/$template -->\n" . $output . "\n<!-- End " . $this->template_dir . "/$template -->\n";
        }

        $event = new GenericEvent($this, array('template' => $template), $output);
        try {
            $this->dispatcher->dispatch('view.postfetch', $event);
            $data = $event->getData();
        } catch (Exception $e) {
            var_dump($e->getMessage());
        }
        return $data;
    }

    /**
     * Executes & displays the template results.
     *
     * This displays the template.
     * Supply a valid template name.
     * As an optional second parameter, you can pass a cache id.
     * As an optional third parameter, you can pass a compile id.
     *
     * @param string $template   The name of the template.
     * @param string $cache_id   The cache ID (optional).
     * @param string $compile_id The compile ID (optional).
     *
     * @return boolean
     */
    public function display($template, $cache_id = null, $compile_id = null)
    {
        echo $this->fetch($template, $cache_id, $compile_id);

        return true;
    }

    /**
     * Returns an auto_id for auto-file-functions.
     *
     * @param string $cache_id   The cache ID (optional).
     * @param string $compile_id The compile ID (optional).
     *
     * @return string|null The auto_id, or null if neither $cache_id nor $compile_id are set.
     */
    public function _get_auto_id($cache_id=null, $compile_id=null)
    {
        if (!empty($cache_id)) {
            $this->_filter_auto_id($cache_id);
        }
        if (!empty($compile_id)) {
            $this->_filter_auto_id($compile_id);
        }

        $auto_id = $cache_id . (!empty($compile_id) ? '/'.$compile_id  : '');

        $auto_id = trim($auto_id, '/');

        return $auto_id;
    }

    /**
     * utility method to filter the IDs of not desired chars.
     *
     * @param string &$id Cache or compile ID to filter.
     *
     * @return void
     */
    protected function _filter_auto_id(&$id)
    {
        // convert some chars used as separators
        $id = str_replace(array(':', '=', ','), '_', $id);
        // convert the "Smarty cache groups" | to paths
        $id = str_replace('|', '/', $id);
        // and remove anything outside the acceptable range
        $id = preg_replace('#[^a-zA-Z0-9-_/]+#', '', $id);
    }

    /**
     * Get a concrete filename for automagically created content.
     *
     * @param string $path        The base path.
     * @param string $auto_source The file name (optional).
     * @param string $auto_id     The ID (optional).
     *
     * @return string The concrete path and file name to the content.
     */
    public function _get_auto_filename($path, $auto_source = null, $auto_id = null, $themedir = null)
    {
        // enables a flags to detect when is treating compiled templates
        $tocompile = ($path == $this->compile_dir) ? true : false;

        // format auto_source for os to make sure that id does not contain 'ugly' characters
        $auto_source = DataUtil::formatForOS($auto_source);

        // build a hierarchical directory path
        $path .= '/' . $this->modinfo['directory'];

        if ($this instanceof Zikula_View_Plugin) {
            $path .= '_' . $this->pluginName;
        }

        // add the cache_id path if set
        $path .= !empty($auto_id) ? '/' . $auto_id : '';

        // takes in account the source subdirectory
        $path .= strpos($auto_source, '/') !== false ? '/' . dirname($auto_source) : '';

        // make sure the path exists to write the compiled/cached template there
        if (!file_exists($path)) {
            mkdir($path, $this->container['system.chmod_dir'], true);
        }

        // if there's a explicit source, it
        if ($auto_source) {
            $path .= '/';

            $extension = FileUtil::getExtension($auto_source);

            // isolates the filename on the source path passed
            $path .= FileUtil::getFilebase($auto_source);

            // add theme and language to our path
            if (empty($themedir)) $themedir = $this->themeinfo['directory'];
            $path .= '--t_'.$themedir.'-l_' . $this->language;

            // if we are not compiling, end with a suffix
            if (!$tocompile) {
                $path .= ($extension ? ".$extension" : '');
            }
        }

        return $path;
    }

    /**
     * Finds out if a template is already cached.
     *
     * This returns true if there is a valid cache for this template.
     *
     * @param string $template   The name of the template.
     * @param string $cache_id   The cache ID (optional).
     * @param string $compile_id The compile ID (optional).
     *
     * @return boolean
     */
    public function is_cached($template, $cache_id = null, $compile_id = null)
    {
        if (is_null($cache_id)) {
            $cache_id = $this->cache_id;
        }

        if (is_null($compile_id)) {
            $compile_id = $this->compile_id;
        }

        return parent::is_cached($template, $cache_id, $compile_id);
    }

    /**
     * Internal function to delete cache of templates.
     *
     * @param string  $tplpath  Relative template path.
     * @param string  $template Template partial filename.
     * @param integer $expire   Expire limit of the cached templates.
     *
     * @return boolean True on success, false otherwise
     */
    protected function rmtpl($tplpath, $template, $expire = null)
    {
       if (!$template || !is_dir($tplpath) || !is_readable($tplpath)) {
           return false;
       }

       $filebase = FileUtil::getFilebase($template);

       $dh = opendir($tplpath);
       while (($entry = readdir($dh)) !== false) {
           if ($entry != '.' && $entry != '..') {
               $path = $tplpath . DIRECTORY_SEPARATOR . $entry;

               if (is_dir($path)) {
                   // search recusively
                   $this->rmtpl($path, $template, $expire);
               } elseif (strpos($entry, $filebase) === 0) {
                   // delete the files that matches the template base filename
                   $this->_unlink($path, $expire);
               }
           }
       }
       closedir($dh);

       return true;
    }

    /**
     * Internal function to delete cache directories and files.
     *
     * @param string  $dirname Relative cache directory path.
     * @param integer $expire  Expire limit of the cached templates.
     * @param boolean $rmbase  Remove the passed directory too (default: true).
     *
     * @return boolean True on success, false otherwise.
     */
    protected function rmdir($dirname, $expire = null, $rmbase = true)
    {
       if (!is_dir($dirname) || !is_readable($dirname)) {
           return false;
       }

       $dh = opendir($dirname);
       while (($entry = readdir($dh)) !== false) {
           if ($entry != '.' && $entry != '..' && $entry != 'index.html') {
               $path = $dirname . DIRECTORY_SEPARATOR . $entry;

               if (is_dir($path)) {
                   // remove recursively
                   $this->rmdir($path, $expire, true);
               } elseif ($expire !== false) {
                   // check expiration time of cached templates
                   $this->_unlink($path, $expire);
               } else {
                   // delete compiled templates directly
                   unlink($path);
               }
           }
       }
       closedir($dh);

       if ($rmbase) {
           return rmdir($dirname);
       }

       return true;
    }

    /**
     * Clears a temporary folder for a auto_id and/or template.
     *
     * This returns true if the operation was successful.
     *
     * @param string $tmpdir   Name of the temporary folder to clear.
     * @param string $auto_id  The cache and compile ID.
     * @param string $template The name of the template.
     * @param string $expire   Minimum age in sec. the cache file must be before it will get cleared (optional).
     *
     * @return boolean
     */
    protected function clear_folder($tmpdir, $auto_id = null, $template = null, $expire = null, $themedir = null)
    {
        if (!$auto_id && !$template) {
            $result = $this->rmdir($tmpdir, $expire, false);

        } else {
            $autofolder = $this->_get_auto_filename($tmpdir, null, $auto_id, $themedir);

            if ($template) {
                $result = $this->rmtpl($autofolder, $template, $expire);
            } else {
                $result = $this->rmdir($autofolder, $expire);
            }
        }

        return $result;
    }

    /**
     * Clears the cache for a specific template or cache_id.
     *
     * @param string $template   The name of the template.
     * @param string $cache_id   The cache ID (optional).
     * @param string $compile_id The compile ID (optional).
     * @param string $expire     Minimum age in sec. the cache file must be before it will get cleared (optional).
     *
     * @return boolean True on success, false otherwise.
     */
    public function clear_cache($template = null, $cache_id = null, $compile_id = null, $expire = null, $themedir = null)
    {
        if (is_null($compile_id) && $template) {
            $compile_id = $this->compile_id;
        }

        $auto_id = $this->_get_auto_id($cache_id, $compile_id);

        return $this->clear_folder($this->cache_dir, $auto_id, $template, $expire, $themedir);
    }

    /**
     * Clears all view cache for a module.
     *
     * @return boolean True on success, false otherwise.
     */
    public function clear_cache_module($moduledir = null)
    {
        if (is_null($moduledir)) {
            $moduledir = $this->modinfo['directory'];
        }

        return $this->clear_folder($this->cache_dir .'/'. $moduledir);
    }

    /**
     * Clear all compiled templates.
     *
     * Needs to clear the cache too as non cached plugins information will need regeneration too.
     *
     * @return boolean True if success, false otherwise.
     */
    public function clear_compiled()
    {
        if ($this->clear_folder($this->compile_dir, null, null, false)) {
            return $this->clear_all_cache();
        }

        return false;
    }

    /**
     * Clear all cached templates.
     *
     * @param string $expire Expire time.
     *
     * @return boolean Results of clear_cache with null parameters.
     */
    public function clear_all_cache($expire = null)
    {
        return $this->clear_cache(null, null, null, $expire);
    }

    /**
     * Set up paths for the template.
     *
     * This function sets the template and the config path according
     * to where the template is found (Theme or Module directory)
     *
     * @param string $template The template name.
     *
     * @return void
     */
    public function _setup_template($template)
    {
        // default directory for templates
        $this->template_dir = $this->get_template_path($template);
        $this->templatePath = $this->template_dir . '/' . $template;
        $this->config_dir   = $this->template_dir . '/config';
    }

    /**
     * Add a plugin dir to the search path.
     *
     * Avoids adding duplicates.
     *
     * @param string  $dir  The directory to add.
     * @param boolean $push Whether to push the new dir to the bottom of the stack (default: true).
     *
     * @return Zikula_View This instance.
     */
    public function addPluginDir($dir, $push=true)
    {
        if (in_array($dir, $this->plugins_dir) || !@is_dir($dir)) {
            return $this;
        }

        if ($push) {
            array_push($this->plugins_dir, $dir);
        } else {
            $this->plugins_dir = array_merge(array($dir), $this->plugins_dir);
        }

        return $this;
    }

    /**
     * add a plugins dir to _plugin_dir array
     *
     * This function takes  module name and adds two path two the plugins_dir array
     * when existing
     *
     * @param string $module Well known module name.
     *
     * @return void
     */
    protected function _add_plugins_dir($module)
    {
        if (empty($module)) {
            return;
        }

        $modinfo = ModUtil::getInfoFromName($module);
        if (!$modinfo) {
            return;
        }

        $modpath = ($modinfo['type'] == ModUtil::TYPE_SYSTEM) ? 'system' : 'modules';
        if (is_dir("$modpath/$modinfo[directory]/Resources/views/plugins")) {
            $this->addPluginDir("$modpath/$modinfo[directory]/Resources/views/plugins");
        }
    }

    /**
     * Execute a template override event.
     *
     * @param string $template Path to template.
     *
     * @throws InvalidArgumentException If event handler returns a non-existent template.
     *
     * @return mixed String if found, false if no override present.
     */
    public static function getTemplateOverride($template)
    {
        $event = new GenericEvent(null, array(), $template);
        EventUtil::getManager()->dispatch('zikula_view.template_override', $event);

        if ($event->isPropagationStopped()) {
            $ostemplate = DataUtil::formatForOS($event->getData());
            if (is_readable($ostemplate)) {
                return $ostemplate;
            } else {
                throw new InvalidArgumentException(__f('zikula_view.template_override returned a non-existent template path %s', $ostemplate));
            }
        }

        return false;
    }

    /**
     * Assign variable to template.
     *
     * @param string $key   Variable name.
     * @param mixed  $value Value.
     *
     * @return Zikula_View
     */
    public function assign($key, $value = null)
    {
        $this->_assign_check($key);
        parent::assign($key, $value);

        return $this;
    }

    /**
     * Assign variable to template by reference.
     *
     * @param string $key Variable name.
     * @param mixed  &$value Value.
     *
     * @return Zikula_View
     */
    public function assign_by_ref($key, &$value)
    {
        $this->_assign_check($key);
        parent::assign_by_ref($key, $value);

        return $this;
    }

    /**
     * Prevent certain variables from being overwritten.
     *
     * @param string $key The protected variable key.
     *
     * @return void
     */
    protected function _assign_check($key)
    {
        if (is_array($key)) {
            foreach ($key as $v) {
                self::_assign_check($v);
            }

            return;
        }

        if (is_string($key)) {
            switch (strtolower($key)) {
                case 'zikula_view':
                case 'zikula_core':
                case 'modvars':
                case 'metatags':
                case 'coredata':
                case 'servicemanager':
                case 'eventmanager':
                    $this->trigger_error(__f('%s is a protected template variable and may not be assigned', $key));
                    break;
            }
        }
    }

    /**
     * Translate.
     *
     * @param string $msgid String to be translated.
     *
     * @return string The $msgid translated by gettext.
     */
    public function __($msgid)
    {
        return __($msgid, $this->domain);
    }

    /**
     * Translate with sprintf().
     *
     * @param string       $msgid  String to be translated.
     * @param string|array $params Args for sprintf().
     *
     * @return string The $msgid translated by gettext.
     */
    public function __f($msgid, $params)
    {
        return __f($msgid, $params, $this->domain);
    }

    /**
     * Translate plural string.
     *
     * @param string $singular Singular instance.
     * @param string $plural   Plural instance.
     * @param string $count    Object count.
     *
     * @return string Translated string.
     */
    public function _n($singular, $plural, $count)
    {
        return _n($singular, $plural, $count, $this->domain);
    }

    /**
     * Translate plural string with sprintf().
     *
     * @param string       $sin    Singular instance.
     * @param string       $plu    Plural instance.
     * @param string       $n      Object count.
     * @param string|array $params Sprintf() arguments.
     *
     * @return string The $sin or $plu translated by gettext, based on $n.
     */
    public function _fn($sin, $plu, $n, $params)
    {
        return _fn($sin, $plu, $n, $params, $this->domain);
    }

    /**
     * Retrieves the gettext domain for the module, as {@link ZLanguage::getModuleDomain()}.
     *
     * If the module is a system module this is not set.
     *
     * @return string The gettext domain for the module, or null for system modules.
     */
    public function getDomain()
    {
        return $this->domain;
    }

    /**
     * Retrieve an array of module information, indexed by module name.
     *
     * @return array An array containing the module info, indexed by module name.
     */
    public function getModule()
    {
        return $this->module;
    }

    /**
     * Retrieve the module info array for the top-level module (or the module specified in the constructor).
     *
     * @return array The module info array.
     */
    public function getModInfo()
    {
        return $this->modinfo;
    }

    /**
     * Retrieve the name of the top-level module.
     *
     * @return string The name of the top-level module.
     */
    public function getTopLevelModule()
    {
        return $this->toplevelmodule;
    }

    /**
     * Retrieve module name.
     *
     * @return string Module name.
     */
    public function getModuleName()
    {
        return $this->toplevelmodule;
    }

    /**
     * Retrive the name of the controller type.
     *
     * @return string The name of the controller type.
     */
    public function getType()
    {
        return $this->type;
    }

    /**
     * Retrive the name of the controller function.
     *
     * @return string The name of the controller function.
     */
    public function getFunc()
    {
        return $this->func;
    }

    /**
     * Retrieve the current language code.
     *
     * @return string The current language code.
     */
    public function getLanguage()
    {
        return $this->language;
    }

    /**
     * Retrieve the name of the current theme.
     *
     * @return string The name of the current theme.
     */
    public function getTheme()
    {
        return $this->theme;
    }

    /**
     * Retrieve the theme info array for the current theme.
     *
     * @param string $key Field to retrieve of the theme info.
     *
     * @return array The theme info array.
     */
    public function getThemeInfo($key=null)
    {
        if ($key && array_key_exists($key, $this->themeinfo)) {
            return $this->themeinfo[$key];
        }

        return $this->themeinfo;
    }

    /**
     * Set a value or all the theme info array.
     *
     * @param mixed  $value Value to assign.
     * @param string $key   Field to set on the theme info.
     *
     * @return void
     */
    public function setThemeInfo($value, $key=null)
    {
        if ($key) {
            $this->themeinfo[$key] = $value;
        }

        $this->themeinfo = $value;
    }

    /**
     * Retrieve the site's base URL.
     *
     * The value returned is the same as {@link System::getBaseUrl()}.
     *
     * @return string The base URL.
     */
    public function getBaseUrl()
    {
        return $this->baseurl;
    }

    /**
     * Retrieve the site's base URI.
     *
     * The value returned is the same as {@link System::getBaseUri()}.
     *
     * @return string The base URI.
     */
    public function getBaseUri()
    {
        return $this->baseuri;
    }

    /**
     * Gets DependencyInjection container.
     *
     * @return ContainerBuilder The service manager.
     */
    public function getContainer()
    {
        return $this->container;
    }

    /**
     * Get EventDispatcher.
     *
     * @return EventDispatcher The event manager.
     */
    public function getDispatcher()
    {
        return $this->dispatcher;
    }

    /**
     * Get the request.
     *
     * @return \Symfony\Component\HttpFoundation\Request
     */
    public function getRequest()
    {
        return $this->request;
    }

    /**
     * Get the Zikula controller.
     *
     * @return \Zikula\Framework\Controller\AbstractController
     */
    public function getController()
    {
        return $this->controller;
    }

    /**
     * Set the controller property.
     *
     * @param \Zikula\Framework\Controller\AbstractController $controller Controller to set.
     *
     * @return void
     */
    public function setController(\Zikula\Framework\Controller\AbstractController $controller)
    {
        $this->controller = $controller;
    }

    /**
     * Retrieve the current setting for the 'render_expose_template' Theme module variable.
     *
     * @return boolean True if The 'render_expose_template' Theme module template is true.
     */
    public function getExposeTemplate()
    {
        return $this->expose_template;
    }

    /**
     * Get template path.
     *
     * This is calculated by _setup_template() invoked during fetch().
     *
     * @return string
     */
    public function getTemplatePath()
    {
        return $this->templatePath;
    }

    /**
     * Retrieve the name of the directory where templates are located.
     *
     * @return string The directory name.
     */
    public function getTemplateDir()
    {
        return $this->template_dir;
    }

    /**
     * Retrieve the template variables array ({@link Smarty::$_tpl_vars}).
     *
     * @return array The template variables array.
     */
    public function getTplVars()
    {
        return $this->_tpl_vars;
    }

    /**
     * Get a template variable.
     *
     * @param string $key Key of assigned template variable.
     *
     * @return mixed
     */
    public function getTplVar($key)
    {
        if (!array_key_exists($key, $this->_tpl_vars)) {
            return null;
        }

        return $this->_tpl_vars[$key];
    }

    /**
     * Retrieve the compile ID used to compile different sets of compiled files for the same templates.
     *
     * @return string|null The compile id, or null if none.
     */
    public function getCompileId()
    {
        return $this->compile_id;
    }

    /**
     * Set this if you want different sets of compiled files for the same templates.
     *
     * This is useful for things like different languages.
     * Instead of creating separate sets of templates per language, you
     * set different compile_ids like 'en' and 'de'.
     *
     * @param string|null $compile_id The compile id, or null.
     *
     * @return $this
     */
    public function setCompileId($compile_id)
    {
        $this->compile_id = $compile_id;

        return $this;
    }

    /**
     * Retrieve the directory where compiled templates are located.
     *
     * @return string The directory name.
     */
    public function getCompileDir()
    {
        return $this->compile_dir;
    }

    /**
     * Set the directory where compiled templates are located.
     *
     * @param string $compile_dir The directory name.
     *
     * @return $this
     */
    public function setCompileDir($compile_dir)
    {
        $this->compile_dir = $compile_dir;

        return $this;
    }

    /**
     * Retrieve the flag that controls whether to check for recompiling or not.
     *
     * Recompiling does not need to happen unless a template or config file is changed.
     * Typically you enable this during development, and disable for production.
     *
     * @return boolean True if checked, otherwise false.
     */
    public function getCompileCheck()
    {
        return $this->compile_check;
    }

    /**
     * Set compile check.
     *
     * @param boolean $doCompileCheck If true, checks for compile will be performed.
     *
     * @return $this
     */
    public function setCompileCheck($doCompileCheck)
    {
        $this->compile_check = $doCompileCheck;

        return $this;
    }

    /**
     * Retrieve whether templates are forced to be compiled.
     *
     * @return boolean True if templates are forced to be compiled, otherwise false.
     */
    public function getForceCompile()
    {
        return $this->force_compile;
    }

    /**
     * Set whether templates are forced to be compiled.
     *
     * @param boolean $force_compile True to force compilation, otherwise false.
     *
     * @return $this
     */
    public function setForceCompile($force_compile)
    {
        $this->force_compile = $force_compile;

        return $this;
    }

    /**
     * Retrieve whether caching is enabled.
     *
     * @return integer A code indicating whether caching is enabled.
     */
    public function getCaching()
    {
        return $this->caching;
    }

    /**
     * Set Caching.
     *
     * Possible value:
     * <ul>
     *  <li>0 = no caching</li>
     *  <li>1 = use class cache_lifetime value</li>
     *  <li>2 = use cache_lifetime in cache file</li>
     * </ul>
     *
     * @param integer $caching Cache value to set.
     *
     * @return $this
     */
    public function setCaching($caching)
    {
        $this->caching = (int)$caching;

        return $this;
    }

    /**
     * Retrieve the current cache ID.
     *
     * @return string The current cache ID.
     */
    public function getCacheId()
    {
        return $this->cache_id;
    }

    /**
     * Set cache ID.
     *
     * @param string $id Cache ID.
     *
     * @return $this
     */
    public function setCacheId($id)
    {
        $this->cache_id = $id;

        return $this;
    }

    /**
     * Retrieve the number of seconds cached content will persist.
     *
     * Special values:
     * <ul>
     *  <li>0 = always regenerate cache</li>
     *  <li>-1 = never expires</li>
     * </ul>
     *
     * @return integer The number of seconds cached content will persist.
     */
    public function getCacheLifetime()
    {
        return $this->cache_lifetime;
    }

    /**
     * Set cache lifetime.
     *
     * @param integer $time Lifetime in seconds.
     *
     * @return $this
     */
    public function setCacheLifetime($time)
    {
        $this->cache_lifetime = $time;

        return $this;
    }

    /**
     * Retrieve the name of the directory for cache files.
     *
     * @return string The name of the cache file directory.
     */
    public function getCacheDir()
    {
        return $this->cache_dir;
    }

    /**
     * Set the name of the directory for cache files.
     *
     * @param string $cache_dir The name of the cache file directory.
     *
     * @return $this
     */
    public function setCacheDir($cache_dir)
    {
        $this->cache_dir = $cache_dir;

        return $this;
    }

    /**
     * Retrieve whether If-Modified-Since headers are respected.
     *
     * Only used when caching is enabled (see (@link setCaching())). If true, then If-Modified-Since headers
     * are respected with cached content, and appropriate HTTP headers are sent.
     * This way repeated hits to a cached page do not send the entire page to the
     * client every time.
     *
     * @return boolean True if If-Modified-Since headers are respected, otherwise false.
     */
    public function getCacheModifiedCheck()
    {
        return $this->cache_modified_check;
    }

    /**
     * Set whether If-Modified-Since headers are respected.
     *
     * Only used when caching is enabled (see (@link setCaching())). If true, then If-Modified-Since headers
     * are respected with cached content, and appropriate HTTP headers are sent.
     * This way repeated hits to a cached page do not send the entire page to the
     * client every time.
     *
     * @param boolean $cache_modified_check True to respect If-Modified-Since headers, otherwise false.
     *
     * @return $this
     */
    public function setCacheModifiedCheck($cache_modified_check)
    {
        $this->cache_modified_check = $cache_modified_check;

        return $this;
    }

    /**
     * Retrieve the directgory where config files are located.
     *
     * @return string The directory name.
     */
    public function getConfigDir()
    {
        return $this->config_dir;
    }

    /**
     * Set the directgory where config files are located.
     *
     * @param string $config_dir The directory name.
     *
     * @return $this
     */
    public function setConfigDir($config_dir)
    {
        $this->config_dir = $config_dir;

        return $this;
    }

    /**
     * Retrieve the directories that are searched for plugins.
     *
     * @return array An array of directory names.
     */
    public function getPluginsDir()
    {
        return $this->plugins_dir;
    }

    /**
     * Set an array of directories that are searched for plugins.
     *
     * @param array $plugins_dir An array of directory names.
     *
     * @return $this
     */
    public function setPluginsDir($plugins_dir)
    {
        $this->plugins_dir = $plugins_dir;

        return $this;
    }

    /**
     * Retrieve whether debugging mode is enabled or disabled.
     *
     * @return boolean True if enabled, otherwise false.
     */
    public function getDebugging()
    {
        return $this->debugging;
    }

    /**
     * Enable or disable debugging mode.
     *
     * If debugging is enabled, a debug console window will display when the page loads (make sure your browser
     * allows unrequested popup windows)
     *
     * @param boolean $debugging True to enable, otherwise false.
     *
     * @return $this
     */
    public function setDebugging($debugging)
    {
        $this->debugging = $debugging;

        return $this;
    }

    /**
     * Retrieve the PHP error reporting level to be used within this class.
     *
     * @see    error_reporting()
     *
     * @return integer The PHP error reporting level.
     */
    public function getErrorReporting()
    {
        return $this->error_reporting;
    }

    /**
     * Set the PHP error reporting level to be used for this class.
     *
     * @param integer $error_reporting The PHP error reporting level.
     *
     * @see    error_reporting()
     *
     * @return $this
     */
    public function setErrorReporting($error_reporting)
    {
        $this->error_reporting = $error_reporting;

        return $this;
    }

    /**
     * Retrieve the custom path to the debug console template.
     *
     * If empty, the default template is used.
     *
     * @return string The custom path to the debug console template.
     */
    public function getDebugTpl()
    {
        return $this->debug_tpl;
    }

    /**
     * Set a custom path to the debug console template.
     *
     * If empty, the default template is used.
     *
     * @param string $debug_tpl The custom path to the debug console template.
     *
     * @return $this
     */
    public function setDebugTpl($debug_tpl)
    {
        $this->debug_tpl = $debug_tpl;

        return $this;
    }

    /**
     * Retrieve whether debugging is enable-able from the browser.
     *
     * Values:
     * <ul>
     *  <li>NONE => no debugging control allowed</li>
     *  <li>URL => enable debugging when SMARTY_DEBUG is found in the URL.</li>
     * </ul>
     *
     * @return string Either 'NONE' or 'URL'.
     */
    public function getDebuggingCtrl()
    {
        return $this->debugging_ctrl;
    }

    /**
     * Set whether debugging is enable-able from the browser.
     *
     * Values:
     * <ul>
     *  <li>NONE => no debugging control allowed</li>
     *  <li>URL => enable debugging when SMARTY_DEBUG is found in the URL.</li>
     * </ul>
     *
     * http://www.example.com/index.php?SMARTY_DEBUG
     *
     * @param string $debugging_ctrl Either 'NONE' or 'URL'.
     *
     * @return $this
     */
    public function setDebuggingCtrl($debugging_ctrl)
    {
        $this->debugging_ctrl = $debugging_ctrl;

        return $this;
    }

    /**
     * Retrieve how "<?php ... ?>" tags in templates are handled.
     *
     * Possible values:
     * <ul>
     *  <li>SMARTY_PHP_PASSTHRU -> print tags as plain text</li>
     *  <li>SMARTY_PHP_QUOTE    -> escape tags as entities</li>
     *  <li>SMARTY_PHP_REMOVE   -> remove php tags</li>
     *  <li>SMARTY_PHP_ALLOW    -> execute php tags</li>
     * </ul>
     *
     * @return integer A code indicating how php tags in templates are handled.
     */
    public function getPhpHandling()
    {
        return $this->php_handling;
    }

    /**
     * Set how "<?php ... ?>" tags in templates are handled.
     *
     * Possible values:
     * <ul>
     *  <li>SMARTY_PHP_PASSTHRU -> print tags as plain text</li>
     *  <li>SMARTY_PHP_QUOTE    -> escape tags as entities</li>
     *  <li>SMARTY_PHP_REMOVE   -> remove php tags</li>
     *  <li>SMARTY_PHP_ALLOW    -> execute php tags</li>
     * </ul>
     *
     * @param integer $php_handling A code indicating how php tags in templates are to be handled.
     *
     * @return $this
     */
    public function setPhpHandling($php_handling)
    {
        $this->php_handling = $php_handling;

        return $this;
    }

    /**
     * Retrieve whether template security is enabled or disabled.
     *
     * When enabled, many things are restricted in the templates that normally would go unchecked. This is useful when
     * untrusted parties are editing templates and you want a reasonable level of security.
     * (no direct execution of PHP in templates for example)
     *
     * @return boolean True if enabled, otherwise false.
     */
    public function getSecurity()
    {
        return $this->security;
    }

    /**
     * Enable or disable template security.
     *
     * When enabled, many things are restricted in the templates that normally would go unchecked. This is useful when
     * untrusted parties are editing templates and you want a reasonable level of security.
     * (no direct execution of PHP in templates for example)
     *
     * @param boolean $security True to enable, otherwise false.
     *
     * @return $this
     */
    public function setSecurity($security)
    {
        $this->security = $security;

        return $this;
    }

    /**
     * Retrieve the list of template directories that are considered secure.
     *
     * @return array An array of secure template directories.
     */
    public function getSecureDir()
    {
        return $this->secure_dir;
    }

    /**
     * Set the list of template directories that are considered secure.
     *
     * This is used only if template security enabled (see {@link setSecurity()}). One directory per array
     * element.  The template directory (see {@link setTemplateDir()}) is in this list implicitly.
     *
     * @param array $secure_dir An array of secure template directories.
     *
     * @return $this
     */
    public function setSecureDir($secure_dir)
    {
        $this->secure_dir = $secure_dir;

        return $this;
    }

    /**
     * Retrieve an array of security settings, only used if template security is enabled (see {@link setSecurity()).
     *
     * @return array An array of security settings.
     */
    public function getSecuritySettings()
    {
        return $this->security_settings;
    }

    /**
     * Set an array of security settings, only used if template security is enabled (see {@link setSecurity()).
     *
     * @param array $security_settings An array of security settings.
     *
     * @return $this
     */
    public function setSecuritySettings($security_settings)
    {
        $this->security_settings = $security_settings;

        return $this;
    }

    /**
     * Retrieve an array of directories where trusted php scripts reside.
     *
     * @return array An array of trusted directories.
     */
    public function getTrustedDir()
    {
        return $this->trusted_dir;
    }

    /**
     * Set an array of directories where trusted php scripts reside.
     *
     * Template security (see {@link setSecurity()) is disabled during their inclusion/execution.
     *
     * @param array $trusted_dir An array of trusted directories.
     *
     * @return $this
     */
    public function setTrustedDir($trusted_dir)
    {
        $this->trusted_dir = $trusted_dir;

        return $this;
    }

    /**
     * Retrieve the left delimiter used for template tags.
     *
     * @return string The delimiter.
     */
    public function getLeftDelimiter()
    {
        return $this->left_delimiter;
    }

    /**
     * Set the left delimiter used for template tags.
     *
     * @param string $left_delimiter The delimiter.
     *
     * @return $this
     */
    public function setLeftDelimiter($left_delimiter)
    {
        $this->left_delimiter = $left_delimiter;

        return $this;
    }

    /**
     * Retrieve the right delimiter used for template tags.
     *
     * @return string The delimiter.
     */
    public function getRightDelimiter()
    {
        return $this->right_delimiter;
    }

    /**
     * Set the right delimiter used for template tags.
     *
     * @param string $right_delimiter The delimiter.
     *
     * @return $this
     */
    public function setRightDelimiter($right_delimiter)
    {
        $this->right_delimiter = $right_delimiter;

        return $this;
    }

    /**
     * Retrieve the order in which request variables are registered, similar to variables_order in php.ini.
     *
     * E = Environment, G = GET, P = POST, C = Cookies, S = Server
     *
     * @return string The string indicating the order, e.g., 'EGPCS'.
     */
    public function getRequestVarsOrder()
    {
        return $this->request_vars_order;
    }

    /**
     * Set the order in which request variables are registered, similar to variables_order in php.ini.
     *
     * E = Environment, G = GET, P = POST, C = Cookies, S = Server
     *
     * @param string $request_vars_order A string indicating the order, e.g., 'EGPCS'.
     *
     * @return $this
     */
    public function setRequestVarsOrder($request_vars_order)
    {
        $this->request_vars_order = $request_vars_order;

        return $this;
    }

    /**
     * Retrieve whether $HTTP_*_VARS[] (request_use_auto_globals=false) are used as request-vars or $_*[]-vars.
     *
     * @return boolean True if auto globals are used, otherwise false.
     */
    public function getRequestUseAutoGlobals()
    {
        return $this->request_use_auto_globals;
    }

    /**
     * Set whether $HTTP_*_VARS[] (request_use_auto_globals=false) are used as request-vars or $_*[]-vars.
     *
     * Note: if request_use_auto_globals is true, then $request_vars_order has
     * no effect, but the php-ini-value "gpc_order"
     *
     * @param boolean $request_use_auto_globals True to use auto globals, otherwise false.
     *
     * @return $this
     */
    public function setRequestUseAutoGlobals($request_use_auto_globals)
    {
        $this->request_use_auto_globals = $request_use_auto_globals;

        return $this;
    }

    /**
     * Retrieve whether or not sub dirs in the cache/ and templates_c/ directories are used.
     *
     * @return boolean True if sub dirs are used, otherwise false.
     */
    public function getUseSubDirs()
    {
        return $this->use_sub_dirs;
    }

    /**
     * Set whether or not to use sub dirs in the cache/ and templates_c/ directories.
     *
     * Sub directories better organized, but may not work well with PHP safe mode enabled.
     *
     * @param boolean $use_sub_dirs True to use sub dirs, otherwise false.
     *
     * @return $this
     */
    public function setUseSubDirs($use_sub_dirs)
    {
        $this->use_sub_dirs = $use_sub_dirs;

        return $this;
    }

    /**
     * Retrieve a list of the modifiers applied to all template variables.
     *
     * @return array An array of default modifiers.
     */
    public function getDefaultModifiers()
    {
        return $this->default_modifiers;
    }

    /**
     * Set a list of the modifiers to apply to all template variables.
     *
     * Put each modifier in a separate array element in the order you want
     * them applied. example: <code>array('escape:"htmlall"');</code>
     *
     * @param array $default_modifiers An array of default modifiers.
     *
     * @return $this
     */
    public function setDefaultModifiers($default_modifiers)
    {
        $this->default_modifiers = $default_modifiers;

        return $this;
    }

    /**
     * Retrieve the resource type used when not specified at the beginning of the resource path (see {@link Smarty::$default_resource_type}).
     *
     * @return string The resource type used.
     */
    public function getDefaultResourceType()
    {
        return $this->default_resource_type;
    }

    /**
     * Set the resource type to be used when not specified at the beginning of the resource path (see {@link Smarty::$default_resource_type}).
     *
     * @param string $default_resource_type The resource type to use.
     *
     * @return $this
     */
    public function setDefaultResourceType($default_resource_type)
    {
        $this->default_resource_type = $default_resource_type;

        return $this;
    }

    /**
     * Retrieve the name of the function used for cache file handling.
     *
     * If not set, built-in caching is used.
     *
     * @return string|null The name of the function, or null if built-in caching is used.
     */
    public function getCacheHandlerFunc()
    {
        return $this->cache_handler_func;
    }

    /**
     * Set the name of the function used for cache file handling.
     *
     * If not set, built-in caching is used.
     *
     * @param string|null $cache_handler_func The name of the function, or null to use built-in caching.
     *
     * @return $this
     */
    public function setCacheHandlerFunc($cache_handler_func)
    {
        $this->cache_handler_func = $cache_handler_func;

        return $this;
    }

    /**
     * Retrieve whether filters are automatically loaded or not.
     *
     * @return boolean True if automatically loaded, otherwise false.
     */
    public function getAutoloadFilters()
    {
        return $this->autoload_filters;
    }

    /**
     * Set whether filters are automatically loaded or not.
     *
     * @param boolean $autoload_filters True to automatically load, otherwise false.
     *
     * @return $this
     */
    public function setAutoloadFilters($autoload_filters)
    {
        $this->autoload_filters = $autoload_filters;

        return $this;
    }

    /**
     * Retrieve if config file vars of the same name overwrite each other or not.
     *
     * @return boolean True if overwritten, otherwise false.
     */
    public function getConfigOverwrite()
    {
        return $this->config_overwrite;
    }

    /**
     * Set if config file vars of the same name overwrite each other or not.
     *
     * If disabled, same name variables are accumulated in an array.
     *
     * @param boolean $config_overwrite True to overwrite, otherwise false.
     *
     * @return $this
     */
    public function setConfigOverwrite($config_overwrite)
    {
        $this->config_overwrite = $config_overwrite;

        return $this;
    }

    /**
     * Retrieve whether or not to automatically booleanize config file variables.
     *
     * If enabled, then the strings "on", "true", and "yes" are treated as boolean
     * true, and "off", "false" and "no" are treated as boolean false.
     *
     * @return boolean True if config variables are booleanized, otherwise false.
     */
    public function getConfigBooleanize()
    {
        return $this->config_booleanize;
    }

    /**
     * Set whether or not to automatically booleanize config file variables.
     *
     * If enabled, then the strings "on", "true", and "yes" are treated as boolean
     * true, and "off", "false" and "no" are treated as boolean false.
     *
     * @param boolean $config_booleanize True to booleanize, otherwise false.
     *
     * @return $this
     */
    public function setConfigBooleanize($config_booleanize)
    {
        $this->config_booleanize = $config_booleanize;

        return $this;
    }

    /**
     * Retrieve whether hidden sections [.foobar] in config files are readable from the tempalates or not.
     *
     * @return boolean True if hidden sections readable, otherwise false.
     */
    public function getConfigReadHidden()
    {
        return $this->config_read_hidden;
    }

    /**
     * Set whether hidden sections [.foobar] in config files are readable from the tempalates or not.
     *
     * Normally you would never allow this since that is the point behind hidden sections: the application can access
     * them, but the templates cannot.
     *
     * @param boolean $config_read_hidden True to make hidden sections readable, otherwise false.
     *
     * @return $this
     */
    public function setConfigReadHidden($config_read_hidden)
    {
        $this->config_read_hidden = $config_read_hidden;

        return $this;
    }

    /**
     * Retrieve the flag that indicates whether newlines are automatically corrected in config files.
     *
     * This indicates whether or not automatically fix newlines in config files.
     * It basically converts \r (mac) or \r\n (dos) to \n
     *
     * @return boolean True if automatically fixed, otherwise false.
     */
    public function getConfigFixNewlines()
    {
        return $this->config_fix_newlines;
    }

    /**
     * Set the flag that corrects newlines automatically in config files.
     *
     * This indicates whether or not automatically fix newlines in config files.
     * It basically converts \r (mac) or \r\n (dos) to \n
     *
     * @param boolean $config_fix_newlines True to automatically fix, otherwise false.
     *
     * @return $this
     */
    public function setConfigFixNewlines($config_fix_newlines)
    {
        $this->config_fix_newlines = $config_fix_newlines;

        return $this;
    }

    /**
     * Retrieve the name of the PHP function that will be called if a template cannot be found.
     *
     * @return string The name of the PHP function called if a template cannot be found.
     */
    public function getDefaultTemplateHandlerFunc()
    {
        return $this->default_template_handler_func;
    }

    /**
     * Set the name of the PHP function that will be called if a template cannot be found.
     *
     * @param string $default_template_handler_func The name of the PHP function to call if a template cannot be found.
     *
     * @return $this
     */
    public function setDefaultTemplateHandlerFunc($default_template_handler_func)
    {
        $this->default_template_handler_func = $default_template_handler_func;

        return $this;
    }

    /**
     * Retrieve the name of the file that contains the compiler class.
     *
     * This could be a full pathname, or relative to the php_include path.
     *
     * @see    Smarty::$compiler_file
     * @see    setCompilerClass()
     *
     * @return string The name of the file that contains the compiler class.
     */
    public function getCompilerFile()
    {
        return $this->compiler_file;
    }

    /**
     * Set the name of the file that contains the compiler class.
     *
     * This can a full pathname, or relative to the php_include path.
     *
     * @param string $compiler_file The name of the file that contains the compiler class.
     *
     * @see    Smarty::$compiler_file
     * @see    setCompilerClass()
     *
     * @return $this
     */
    public function setCompilerFile($compiler_file)
    {
        $this->compiler_file = $compiler_file;

        return $this;
    }

    /**
     * Retrieve the name of the class used to compile templates.
     *
     * @return string The name of the class used to compile templates.
     */
    public function getCompilerClass()
    {
        return $this->compiler_class;
    }

    /**
     * Set the name of the class that will be used to compile templates.
     *
     * @param string $compiler_class The name of the class used to compile templates.
     *
     * @return $this
     */
    public function setCompilerClass($compiler_class)
    {
        $this->compiler_class = $compiler_class;

        return $this;
    }

    /**
     * Retrieve the info that makes up a cache file ({@link Smarty::$_cache_info}).
     *
     * @return array Array of info that makes up a cache file.
     */
    public function getCacheInfo()
    {
        return $this->_cache_info;
    }

    /**
     * Set the info that makes up a cache file ({@link Smarty::$_cache_info}).
     *
     * @param array $_cache_info Array of info that makes up a cache file.
     *
     * @return $this
     */
    public function setCacheInfo($_cache_info)
    {
        $this->_cache_info = $_cache_info;

        return $this;
    }

    /**
     * Retrieve the file permissions ({@link Smarty::$_file_perms}).
     *
     * @return int File permissions.
     */
    public function getFilePerms()
    {
        return $this->_file_perms;
    }

    /**
     * Set the file permissions ({@link Smarty::$_file_perms}).
     *
     * @param int $_file_perms File permissions; use an octal number, e.g. set_file_perms(0664).
     *
     * @return $this
     */
    public function setFilePerms($_file_perms)
    {
        $this->_file_perms = $_file_perms;

        return $this;
    }

    /**
     * Retrieve the directory permissions ({@link Smarty::$_dir_perms}).
     *
     * @return int Directory permissions.
     */
    public function getDirPerms()
    {
        return $this->_dir_perms;
    }

    /**
     * Set the directory permissions ({@link Smarty::$_dir_perms}).
     *
     * @param int $_dir_perms Directory permissions; use an octal number, e.g. set_dir_perms(0771).
     *
     * @return $this
     */
    public function setDirPerms($_dir_perms)
    {
        $this->_dir_perms = $_dir_perms;

        return $this;
    }

    /**
     * Retrieve the {@link Smarty::$_reg_objects} registered objects.
     *
     * @return array Registered objects array.
     */
    public function getRegObjects()
    {
        return $this->_reg_objects;
    }

    /**
     * Set the {@link Smarty::$_reg_objects} registered objects.
     *
     * @param array $_reg_objects Registered objects.
     *
     * @return $this
     */
    public function setRegObjects($_reg_objects)
    {
        $this->_reg_objects = $_reg_objects;

        return $this;
    }

    /**
     * Retrieve the array keeping track of plugins (see {@link Smarty::$_plugins}.
     *
     * @return array An array of plugins by type.
     */
    public function getPlugins()
    {
        return $this->_plugins;
    }

    /**
     * Set the array keeping track of plugins (see {@link Smarty::$_plugins}.
     *
     * @param array $_plugins An array of plugins by type.
     *
     * @return $this
     */
    public function setPlugins($_plugins)
    {
        $this->_plugins = $_plugins;

        return $this;
    }

    /**
     * Retrieve the value of {@link Smarty::$_cache_serials}.
     *
     * @return array Cache serials.
     */
    public function getCacheSerials()
    {
        return $this->_cache_serials;
    }

    /**
     * Setter for {@link Smarty::$_cache_serials}
     *
     * @param array $_cache_serials Cache serials.
     *
     * @return $this
     */
    public function setCacheSerials($_cache_serials)
    {
        $this->_cache_serials = $_cache_serials;

        return $this;
    }

    /**
     * Retrieve the value of {@link Smarty::$_cache_include}.
     *
     * @return string Name of optional cache include file.
     */
    public function getCacheInclude()
    {
        return $this->_cache_include;
    }

    /**
     * Setter for {@link Smarty::$_cache_include}.
     *
     * @param string $_cache_include Name of optional cache include file.
     *
     * @return $this
     */
    public function setCacheInclude($_cache_include)
    {
        $this->_cache_include = $_cache_include;

        return $this;
    }

    /**
     * Retrieve the value of {@link Smarty::$_cache_including}.
     *
     * @return boolean True if the current code is used in a compiled include, otherwise false.
     */
    public function getCacheIncluding()
    {
        return $this->_cache_including;
    }

    /**
     * Setter for {@link Smarty::$_cache_including}.
     *
     * @param boolean $_cache_including Indicate if the current code is used in a compiled include.
     *
     * @return $this
     */
    public function setCacheIncluding($_cache_including)
    {
        $this->_cache_including = $_cache_including;

        return $this;
    }

    /**
     * Disable or enable add the module wrapper.
     *
     * @param boolean $wrap False to disable wrapper, true to enable it.
     *
     * @return $this
     */
    public function setWrapper($wrap)
    {
        if ($this->modinfo['name'] == $this->toplevelmodule) {
            Zikula_View_Theme::getInstance()->themeinfo['system'] = !$wrap;
        }

        return $this;
    }

    /**
     * Smarty override to customize the core.process_cached_inserts
     *
     * @param string  $template   The name of the template.
     * @param string  $cache_id   The cache ID (optional).
     * @param string  $compile_id The compile ID (optional).
     * @param boolean $display    Whether or not to display directly (optional).
     *
     * @return string The template output.
     */
    public function _fetch($resource_name, $cache_id = null, $compile_id = null, $display = false)
    {
        static $_cache_info = array();

        $_smarty_old_error_level = $this->debugging ? error_reporting() : error_reporting(isset($this->error_reporting)
               ? $this->error_reporting : error_reporting() & ~E_NOTICE);

        if (!$this->debugging && $this->debugging_ctrl == 'URL') {
            $_query_string = $this->request_use_auto_globals ? $_SERVER['QUERY_STRING'] : $GLOBALS['HTTP_SERVER_VARS']['QUERY_STRING'];
            if (@strstr($_query_string, $this->_smarty_debug_id)) {
                if (@strstr($_query_string, $this->_smarty_debug_id . '=on')) {
                    // enable debugging for this browser session
                    @setcookie('SMARTY_DEBUG', true);
                    $this->debugging = true;
                } elseif (@strstr($_query_string, $this->_smarty_debug_id . '=off')) {
                    // disable debugging for this browser session
                    @setcookie('SMARTY_DEBUG', false);
                    $this->debugging = false;
                } else {
                    // enable debugging for this page
                    $this->debugging = true;
                }
            } else {
                $this->debugging = (bool)($this->request_use_auto_globals ? @$_COOKIE['SMARTY_DEBUG'] : @$GLOBALS['HTTP_COOKIE_VARS']['SMARTY_DEBUG']);
            }
        }

        if ($this->debugging) {
            // capture time for debugging info
            $_params = array();
            require_once(SMARTY_CORE_DIR . 'core.get_microtime.php');
            $_debug_start_time = smarty_core_get_microtime($_params, $this);
            $this->_smarty_debug_info[] = array('type'      => 'template',
                                                'filename'  => $resource_name,
                                                'depth'     => 0);
            $_included_tpls_idx = count($this->_smarty_debug_info) - 1;
        }

        if (!isset($compile_id)) {
            $compile_id = $this->compile_id;
        }

        $this->_compile_id = $compile_id;
        $this->_inclusion_depth = 0;

        if ($this->caching) {
            // save old cache_info, initialize cache_info
            array_push($_cache_info, $this->_cache_info);
            $this->_cache_info = array();
            $_params = array(
                'tpl_file' => $resource_name,
                'cache_id' => $cache_id,
                'compile_id' => $compile_id,
                'results' => null
            );
            require_once(SMARTY_CORE_DIR . 'core.read_cache_file.php');
            if (smarty_core_read_cache_file($_params, $this)) {
                $_smarty_results = $_params['results'];
                if (!empty($this->_cache_info['insert_tags'])) {
                    $_params = array('plugins' => $this->_cache_info['insert_tags']);
                    require_once(SMARTY_CORE_DIR . 'core.load_plugins.php');
                    smarty_core_load_plugins($_params, $this);
                    $_params = array('results' => $_smarty_results);
                    // ZIKULA OVERRIDE
                    require_once('lib/viewplugins/zikula.process_cached_inserts.php');
                    $_smarty_results = smarty_core_process_cached_inserts($_params, $this);
                }
                if (!empty($this->_cache_info['cache_serials'])) {
                    $_params = array('results' => $_smarty_results);
                    require_once(SMARTY_CORE_DIR . 'core.process_compiled_include.php');
                    $_smarty_results = smarty_core_process_compiled_include($_params, $this);
                }


                if ($display) {
                    if ($this->debugging) {
                        // capture time for debugging info
                        $_params = array();
                        require_once(SMARTY_CORE_DIR . 'core.get_microtime.php');
                        $this->_smarty_debug_info[$_included_tpls_idx]['exec_time'] = smarty_core_get_microtime($_params, $this) - $_debug_start_time;
                        require_once(SMARTY_CORE_DIR . 'core.display_debug_console.php');
                        $_smarty_results .= smarty_core_display_debug_console($_params, $this);
                    }
                    if ($this->cache_modified_check) {
                        $_server_vars = ($this->request_use_auto_globals) ? $_SERVER : $GLOBALS['HTTP_SERVER_VARS'];
                        $_last_modified_date = @substr($_server_vars['HTTP_IF_MODIFIED_SINCE'], 0, strpos($_server_vars['HTTP_IF_MODIFIED_SINCE'], 'GMT') + 3);
                        $_gmt_mtime = gmdate('D, d M Y H:i:s', $this->_cache_info['timestamp']).' GMT';
                        if (@count($this->_cache_info['insert_tags']) == 0
                            && !$this->_cache_serials
                            && $_gmt_mtime == $_last_modified_date) {
                            if (php_sapi_name()=='cgi')
                                header('Status: 304 Not Modified');
                            else
                                header('HTTP/1.1 304 Not Modified');

                        } else {
                            header('Last-Modified: '.$_gmt_mtime);
                            echo $_smarty_results;
                        }
                    } else {
                            echo $_smarty_results;
                    }
                    error_reporting($_smarty_old_error_level);
                    // restore initial cache_info
                    $this->_cache_info = array_pop($_cache_info);

                    return true;
                } else {
                    error_reporting($_smarty_old_error_level);
                    // restore initial cache_info
                    $this->_cache_info = array_pop($_cache_info);

                    return $_smarty_results;
                }
            } else {
                $this->_cache_info['template'][$resource_name] = true;
                if ($this->cache_modified_check && $display) {
                    header('Last-Modified: '.gmdate('D, d M Y H:i:s', time()).' GMT');
                }
            }
        }

        // load filters that are marked as autoload
        if (count($this->autoload_filters)) {
            foreach ($this->autoload_filters as $_filter_type => $_filters) {
                foreach ($_filters as $_filter) {
                    $this->load_filter($_filter_type, $_filter);
                }
            }
        }

        $_smarty_compile_path = $this->_get_compile_path($resource_name);

        // if we just need to display the results, don't perform output
        // buffering - for speed
        $_cache_including = $this->_cache_including;
        $this->_cache_including = false;
        if ($display && !$this->caching && count($this->_plugins['outputfilter']) == 0) {
            if ($this->_is_compiled($resource_name, $_smarty_compile_path) || $this->_compile_resource($resource_name, $_smarty_compile_path)) {
                include($_smarty_compile_path);
            }
        } else {
            ob_start();
            if ($this->_is_compiled($resource_name, $_smarty_compile_path) || $this->_compile_resource($resource_name, $_smarty_compile_path)) {
                include($_smarty_compile_path);
            }
            $_smarty_results = ob_get_contents();
            ob_end_clean();

            foreach ((array)$this->_plugins['outputfilter'] as $_output_filter) {
                $_smarty_results = call_user_func_array($_output_filter[0], array($_smarty_results, &$this));
            }
        }

        if ($this->caching) {
            $_params = array('tpl_file' => $resource_name,
                        'cache_id' => $cache_id,
                        'compile_id' => $compile_id,
                        'results' => $_smarty_results);
            require_once(SMARTY_CORE_DIR . 'core.write_cache_file.php');
            smarty_core_write_cache_file($_params, $this);
            // ZIKULA OVERRIDE
            require_once('lib/viewplugins/zikula.process_cached_inserts.php');
            $_smarty_results = smarty_core_process_cached_inserts($_params, $this);

            if ($this->_cache_serials) {
                // strip nocache-tags from output
                $_smarty_results = preg_replace('!(\{/?nocache\:[0-9a-f]{32}#\d+\})!s'
                                                ,''
                                                ,$_smarty_results);
            }
            // restore initial cache_info
            $this->_cache_info = array_pop($_cache_info);
        }
        $this->_cache_including = $_cache_including;

        if ($display) {
            if (isset($_smarty_results)) {
                echo $_smarty_results;
            }
            if ($this->debugging) {
                // capture time for debugging info
                $_params = array();
                require_once(SMARTY_CORE_DIR . 'core.get_microtime.php');
                $this->_smarty_debug_info[$_included_tpls_idx]['exec_time'] = (smarty_core_get_microtime($_params, $this) - $_debug_start_time);
                require_once(SMARTY_CORE_DIR . 'core.display_debug_console.php');
                echo smarty_core_display_debug_console($_params, $this);
            }
            error_reporting($_smarty_old_error_level);

            return;
        } else {
            error_reporting($_smarty_old_error_level);
            if (isset($_smarty_results)) {
                return $_smarty_results;
            }
        }
    }
}

/**
 * Callback function for preg_replace_callback.
 *
 * Allows the use of {{ and }} as delimiters within certain tags,
 * even if they use { and } as block delimiters.
 *
 * @param array $matches The $matches array from preg_replace_callback, containing the matched groups.
 *
 * @return string The replacement string for the match.
 */
function z_prefilter_add_literal_callback($matches)
{
    $tagOpen = $matches[1];
    $script = $matches[3];
    $tagClose = $matches[4];

    $script = str_replace('{{', '{/literal}{', str_replace('}}', '}{literal}', $script));

    return $tagOpen . '{literal}' . $script . '{/literal}' . $tagClose;
}

/**
 * Prefilter for tags that might contain { or } as block delimiters.
 *
 * Such as <script> or <style>. Allows the use of {{ and }} as smarty delimiters,
 * even if the language uses { and } as block delimters. Adds {literal} and
 * {/literal} to the specified opening and closing tags, and converts
 * {{ and }} to {/literal}{ and }{literal}.
 *
 * Tags affected: <script> and <style>.
 *
 * @param string      $tpl_source The template's source prior to prefiltering.
 * @param Zikula_View $view       A reference to the Zikula_View object.
 *
 * @return string The prefiltered template contents.
 */
function z_prefilter_add_literal($tpl_source, $view)
{
    return preg_replace_callback('`(<(script|style)[^>]*>)(.*?)(</\2>)`s', 'z_prefilter_add_literal_callback', $tpl_source);
}

/**
 * Prefilter for gettext parameters.
 *
 * @param string      $tpl_source The template's source prior to prefiltering.
 * @param Zikula_View $view       A reference to the Zikula_View object.
 *
 * @return string The prefiltered template contents.
 */
function z_prefilter_gettext_params($tpl_source, $view)
{
    return preg_replace('#((?:(?<!\{)\{(?!\{)(?:\s*)|\G)(?:.+?))__([a-zA-Z0-9][a-zA-Z_0-9]*=([\'"])(?:\\\\?+.)*?\3)#', '$1$2|gt:\$zikula_view', $tpl_source);
}


///**
// * Prefilter for hookable filters.
// *
// * @param string      $tpl_source The template's source prior to prefiltering.
// * @param Zikula_View $view       A reference to the Zikula_View object.
// *
// * @return string The prefiltered template contents.
// */
//function z_prefilter_notifyfilters($tpl_source, $view)
//{
//    return preg_replace('#((?:(?<!\{)\{(?!\{)(?:\s*)|\G)(?:.*?))(\|notifyfilters(?:([\'"])(?:\\\\?+.)*?\3|[^\s|}])*)#', '$1$2:\$zikula_view', $tpl_source);
//}
Back to Top