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
|
<?xml version="1.0" encoding="UTF-8"?>
<!-- EN-Revision: 24249 -->
<!-- Reviewed: no -->
<sect3 id="zend.view.helpers.initial.navigation">
<title>Navigations Helfer</title>
<para>
Die Navigations Helfer werden von
<link linkend="zend.navigation.containers">Zend_Navigation_Container</link> für die
Darstellung von Navigations Elementen verwendet.
</para>
<para>
Es gibt 2 eingebaute Helfer:
</para>
<itemizedlist>
<listitem>
<para>
<link
linkend="zend.view.helpers.initial.navigation.breadcrumbs">Breadcrumbs</link>,
wird für die Darstellung des Pfades der aktuell aktiven Seite verwendet.
</para>
</listitem>
<listitem>
<para>
<link linkend="zend.view.helpers.initial.navigation.links">Links</link>,
wird für die Darstellung von Navigations Header Links (z.B.
<command><link rel="next" href="..." /></command>) verwendet.
</para>
</listitem>
<listitem>
<para>
<link linkend="zend.view.helpers.initial.navigation.menu">Menu</link>,
wird für die Darstellung von Menüs verwendet.
</para>
</listitem>
<listitem>
<para>
<link linkend="zend.view.helpers.initial.navigation.sitemap">Sitemap</link>,
wird für die Darstellung von Sitemaps verwendet die dem
<ulink url="http://www.sitemaps.org/protocol.php">Sitemaps <acronym>XML</acronym>
Format</ulink> entsprechen.
</para>
</listitem>
<listitem>
<para>
<link
linkend="zend.view.helpers.initial.navigation.navigation">Navigation</link>,
wird für die Weiterleitung von Aufrufen zu anderen Navigations Helfern
verwendet.
</para>
</listitem>
</itemizedlist>
<para>
Alle eingebauten Helfer erweitern
<classname>Zend_View_Helper_Navigation_HelperAbstract</classname>, welches die Integration
von <link linkend="zend.acl">ACL</link> und <link
linkend="zend.translate">Übersetzung</link> hinzufügt. Die abstrakte Klasse
implementiert das Interface <classname>Zend_View_Helper_Navigation_Helper</classname>
welches die folgenden Methoden definiert:
</para>
<itemizedlist>
<listitem>
<para>
<methodname>getContainer()</methodname> und <methodname>setContainer()</methodname>
empfängt/setzt den Navigations Container mit dem der Helfer standardmäßig arbeiten
soll, und <methodname>hasContainer()</methodname> prüft ob der Helfer Container
registriert hat.
</para>
</listitem>
<listitem>
<para>
<methodname>getTranslator()</methodname> und
<methodname>setTranslator()</methodname> empfängt und setzt den Übersetzer der für
die Übersetzung von Überschriften und Titelm verwendet wird, und
<methodname>getUseTranslator()</methodname> sowie
<methodname>setUseTranslator()</methodname> kontrollieren ob der Übersetzer
aktiviert werden soll. Die Methode <methodname>hasTranslator()</methodname> prüft ob
der Helfer einen Übersetzer registriert hat.
</para>
</listitem>
<listitem>
<para>
<methodname>getAcl()</methodname>, <methodname>setAcl()</methodname>,
<methodname>getRole()</methodname> und <methodname>setRole()</methodname>
empfangen und setzen <acronym>ACL</acronym> (<classname>Zend_Acl</classname>)
Instanzen und Rollen (<type>String</type> oder
<classname>Zend_Acl_Role_Interface</classname>) die bei der Darstellung für das
Filtern von Seiten verwendet werden. <methodname>getUseAcl()</methodname> und
<methodname>setUseAcl()</methodname> kontrolliert ob <acronym>ACL</acronym>
aktiviert werden soll. Die Methoden <methodname>hasAcl()</methodname> und
<methodname>hasRole()</methodname> prüfen ob der Helfer eine <acronym>ACL</acronym>
Instanz oder Rolle registriert hat.
</para>
</listitem>
<listitem>
<para>
<methodname>__toString()</methodname>, die magische Methode stellt sicher das
der Helfer, durch die direkte Ausgabe an der Instanz des Helfers, dargestellt
werden kann.
</para>
</listitem>
<listitem>
<para>
<methodname>render()</methodname>, muß von konkreten Helfern implementiert
werden um die Darstellung durchzuführen.
</para>
</listitem>
</itemizedlist>
<para>
Zusätzlich zu den Methoden die vom Interface kommen, implementiert die abstrakte Klasse
die folgenden Methoden:
</para>
<itemizedlist>
<listitem>
<para>
<methodname>getIndent()</methodname> und <methodname>setIndent()</methodname>
empfängt und setzt die Einrückung. Der Setzer akzeptiert einen <type>String</type>
oder ein <type>Integer</type>. Im Fall eines <type>Integer</type>'s verwendet der
Helfer die angegebene Zahl als Leerzeichen für die Einrückung. Z.B. bedeutet
<methodname>setIndent(4)</methodname> eine Einrückung von initial 4 Leerzeichen.
Die Einrückung kann für alle Helfer außer dem Sitemap Helfer spezifiziert
werden.
</para>
</listitem>
<listitem>
<para>
<methodname>getMinDepth()</methodname> und <methodname>setMinDepth()</methodname>
empfängt und setzt die minimale Tiefe die eine Seite haben muß um vom Helfer
eingefügt zu werden. Das Setzen von <constant>NULL</constant> bedeutet keine
minimale Tiefe.
</para>
</listitem>
<listitem>
<para>
<methodname>getMaxDepth()</methodname> und <methodname>setMaxDepth()</methodname>
empfängt und setzt die maximale Tiefe die eine Seite haben muß um vom Helfer
eingefügt zu werden. Das Setzen von <constant>NULL</constant> bedeutet keine
maximale Tiefe.
</para>
</listitem>
<listitem>
<para>
<methodname>getRenderInvisible()</methodname> und
<methodname>setRenderInvisible()</methodname> empfängt und setzt ob Elemente die
als unsichtbar markiert sind, dargestellt werden oder nicht.
</para>
</listitem>
<listitem>
<para>
<methodname>__call()</methodname> wird verwendet um Aufrufe zum Container, der
im Helfer registriert ist, weiterzuleiten, was bedeutet das man Methoden in
einem Helfer aufrufen kann wie wenn Sie im Container wären. Siehe das folgende
<link
linkend="zend.view.helpers.initial.navigation.proxy.example">Beispiel</link>.
</para>
</listitem>
<listitem>
<para>
<methodname>findActive($container, $minDepth, $maxDepth)</methodname> wird
verwendet um die tiefste aktive Seite im angegebenen Container zu finden. Wenn
keine Tiefe angegeben wird, verwendet diese Methode die Werte die sie von
<methodname>getMinDepth()</methodname> und
<methodname>getMaxDepth()</methodname> erhält. Die tiefste aktive Seite muß
zwischen <varname>$minDepth</varname> und <varname>$maxDepth</varname> inklusive
liegen. Gibt ein Array zurück das Referenzen zu der gefundenen Instanz der Seite
enthält, und die Tiefe bei der die Seite gefunden wurde.
</para>
</listitem>
<listitem>
<para>
<methodname>htmlify()</methodname> stellt ein <emphasis>'a'</emphasis>
<acronym>HTML</acronym> Element von einer
<classname>Zend_Navigation_Page</classname> Instanz dar.
</para>
</listitem>
<listitem>
<para>
<methodname>accept()</methodname> wird verwendet um zu erkennen ub eine Seite
akzeptiert werden soll wenn durch Container iteriert wird. Diese Methode prüft
die Sichtbarkeit der Seite und verifiziert das die Rolle des Helfers auf die
Ressourcen und Privilegien der Seite zugreifen darf.
</para>
</listitem>
<listitem>
<para>
Die statische Methode <methodname>setDefaultAcl()</methodname> wird für das Setzen
des standardmäßigen <acronym>ACL</acronym> Objekts verwendet, das dann von Helfern
verwendet wird.
</para>
</listitem>
<listitem>
<para>
Die statische Methode <methodname>setDefaultRole()</methodname> wird für das Setzen
der standardmäßigen <acronym>ACL</acronym> verwendet, die dann von Helfern verwendet
wird.
</para>
</listitem>
</itemizedlist>
<para>
Wenn ein Navigations Container nicht explizit in einem Helfer durch Verwendung von
<command>$helper->setContainer($nav)</command> gesetzt ist, schaut der Helfer in
<link linkend="zend.registry">der Registry</link> nach einer Container Instanz mit dem
Schlüssel <classname>Zend_Navigation</classname>. Wenn ein Container nicht explizit gesetzt
wurde, oder nicht in der Registry gefunden wird, erstellt der Helfer einen leeren
<classname>Zend_Navigation</classname> Container wenn
<command>$helper->getContainer()</command> aufgerufen wird.
</para>
<example id="zend.view.helpers.initial.navigation.proxy.example">
<title>Aufrufe an den Navigations Container weiterleiten</title>
<para>
Navigations View Helfer verwenden die magisch <methodname>__call()</methodname> Methode
um Methodenaufrufe an den Navigationscontainer weiterzuleiten der im View Helfer
registriert ist.
</para>
<programlisting language="php"><![CDATA[
$this->navigation()->addPage(array(
'type' => 'uri',
'label' => 'New page'));
]]></programlisting>
<para>
Der obige Aufruf fügt eine Seite zum Container im <classname>Navigation</classname>
Helfer hinzu.
</para>
</example>
<sect4 id="zend.view.helpers.initial.navigation.i18n">
<title>Übersetzung von Labels und Titeln</title>
<para>
Der Navigations Helfer unterstützt die Übersetzung von SeitenLabels und Überschriften.
Man kann einen Übersetzer vom Typ <classname>Zend_Translate</classname> oder
<classname>Zend_Translate_Adapter</classname> im Helfer setzen indem
<command>$helper->setTranslator($translator)</command> verwendet wird, oder wie in allen
anderen I18n-fähigen Komponenten; durch das Hinzufügen des Übersetzers in
<link linkend="zend.registry">die Registry</link> indem der Schlüssel
<classname>Zend_Translate</classname> verwendet wird.
</para>
<para>
Wenn man die Übersetzung ausschalten will, sollte man
<command>$helper->setUseTranslator(false)</command> verwenden.
</para>
<para>
Der <link linkend="zend.view.helpers.initial.navigation.navigation">Proxy Helfer</link>
injiziert seinen eigenen Übersetzer in den Helfer auf den er weiterleitet wenn der
weitergeleitete Helfer nicht bereits einen Übersetzer hat.
</para>
<note>
<para>
Es gibt keinen Übersetzer im Sitemap Helfer, da keine SeitenLabels oder
Überschriften in einer <acronym>XML</acronym> Sitemap enthalten sind.
</para>
</note>
</sect4>
<sect4 id="zend.view.helpers.initial.navigation.acl">
<title>Integration mit ACL</title>
<para>
Alle navigatorischen View Helfer unterstützen <acronym>ACL</acronym> abgeleitet von der
<classname>Zend_View_Helper_Navigation_HelperAbstract</classname> Klasse. Ein
<classname>Zend_Acl</classname> Objekt kann einer Instanz eines Helfers mit
<code>$helper->setAcl($acl)</code> hinzugefügt werden, und eine Rolle mit
<code>$helper->setRole('member')</code> oder
<code>$helper->setRole(new Zend_Acl_Role('member'))</code>. Wenn <acronym>ACL</acronym>
im Helfer verwendet wird, muß es der Rolle im Helfer vom <acronym>ACL</acronym> erlaubt
sein auf die <code>Ressourcen</code> zuzugreifen und/oder das die
<code>Privilegien</code> für diese Seite bei der Darstellung eingefügt werden dürfen.
</para>
<para>
Wenn eine Seite vom <acronym>ACL</acronym> nicht akzeptiert ist, wird auch jede
untergeordnete Seite von der Darstellung ausgenommen sein.
</para>
<para>
Der <link linkend="zend.view.helpers.initial.navigation.navigation">Proxy Helfer</link>
injiziert seine eigene <acronym>ACL</acronym> und Rolle in den Helfer zu dem er
weiterleitet wenn der weitergeleitete Helfer nicht bereits einen hat.
</para>
<para>
Das Beispiel von unten zeigt wie <acronym>ACL</acronym> die Darstellung beeinflusst.
</para>
</sect4>
<sect4 id="zend.view.helpers.initial.navigation.setup">
<title>Setup der Navigation das in Beispielen verwendet wird</title>
<para>
Dieses Beispiel zeigt das Setup eines Navigations Container für eine fiktive Software
Firma.
</para>
<para>
Notizen zum Setup:
</para>
<itemizedlist>
<listitem>
<para>
Die Domain der Site ist <code>www.example.com</code>.
</para>
</listitem>
<listitem>
<para>
Interessante Eigenschaften der Seite sind mit einem Kommentar markiert.
</para>
</listitem>
<listitem>
<para>
Solange im Beispiel nicht anders erwähnt, fragt der Benutzer nach der
<acronym>URL</acronym> <code>http://www.example.com/products/server/faq/</code>,
welche auf die Seite mit dem Label <constant>FAQ</constant> unter
<code>Foo Server</code> übersetzt wird.
</para>
</listitem>
<listitem>
<para>
Das angenommene <acronym>ACL</acronym> und Route Setup wird unter dem Container
Setup gezeigt.
</para>
</listitem>
</itemizedlist>
<programlisting language="php"><![CDATA[
/*
* Navigations Container (config/array)
* Jedes Element im Array wird an Zend_Navigation_Page::factory()
* übergeben wenn der unten angezeigt Navigations Container
* erstellt wird.
*/
$pages = array(
array(
'label' => 'Home',
'title' => 'Geh zu Home',
'module' => 'default',
'controller' => 'index',
'action' => 'index',
'order' => -100 // Sicherstellen das Home die erste Seite ist
),
array(
'label' => 'Spezielles Angebot nur diese Woche!',
'module' => 'store',
'controller' => 'offer',
'action' => 'amazing',
'visible' => false // nicht sichtbar
),
array(
'label' => 'Produkte',
'module' => 'products',
'controller' => 'index',
'action' => 'index',
'pages' => array(
array(
'label' => 'Foo Server',
'module' => 'products',
'controller' => 'server',
'action' => 'index',
'pages' => array(
array(
'label' => 'FAQ',
'module' => 'products',
'controller' => 'server',
'action' => 'faq',
'rel' => array(
'canonical' => 'http://www.example.com/?page=faq',
'alternate' => array(
'module' => 'products',
'controller' => 'server',
'action' => 'faq',
'params' => array('format' => 'xml')
)
)
),
array(
'label' => 'Editionen',
'module' => 'products',
'controller' => 'server',
'action' => 'editions'
),
array(
'label' => 'System Anforderungen',
'module' => 'products',
'controller' => 'server',
'action' => 'requirements'
)
)
),
array(
'label' => 'Foo Studio',
'module' => 'products',
'controller' => 'studio',
'action' => 'index',
'pages' => array(
array(
'label' => 'Kunden Stories',
'module' => 'products',
'controller' => 'studio',
'action' => 'customers'
),
array(
'label' => 'Support',
'module' => 'prodcts',
'controller' => 'studio',
'action' => 'support'
)
)
)
)
),
array(
'label' => 'Firma',
'title' => 'Über uns',
'module' => 'company',
'controller' => 'about',
'action' => 'index',
'pages' => array(
array(
'label' => 'Investor Relations',
'module' => 'company',
'controller' => 'about',
'action' => 'investors'
),
array(
'label' => 'News',
'class' => 'rss', // Klasse
'module' => 'company',
'controller' => 'news',
'action' => 'index',
'pages' => array(
array(
'label' => 'Für die Presse',
'module' => 'company',
'controller' => 'news',
'action' => 'press'
),
array(
'label' => 'Archiv',
'route' => 'archive', // Route
'module' => 'company',
'controller' => 'news',
'action' => 'archive'
)
)
)
)
),
array(
'label' => 'Community',
'module' => 'community',
'controller' => 'index',
'action' => 'index',
'pages' => array(
array(
'label' => 'Mein Account',
'module' => 'community',
'controller' => 'account',
'action' => 'index',
'resource' => 'mvc:community.account' // Ressource
),
array(
'label' => 'Forum',
'uri' => 'http://forums.example.com/',
'class' => 'external' // Klasse
)
)
),
array(
'label' => 'Administration',
'module' => 'admin',
'controller' => 'index',
'action' => 'index',
'resource' => 'mvc:admin', // Ressource
'pages' => array(
array(
'label' => 'Neuen Artikel schreiben',
'module' => 'admin',
'controller' => 'post',
'aciton' => 'write'
)
)
)
);
// Container von einem Array erstellen
$container = new Zend_Navigation($pages);
// Den Container im Proxy Helfer speichern
$view->getHelper('navigation')->setContainer($container);
// ...oder einfach:
$view->navigation($container);
// ...oder ihn einfach in der Registry speichern:
Zend_Registry::set('Zend_Navigation', $container);
]]></programlisting>
<para>
Zusätzlich zum obigen Container, wird das folgende Setup angenommen:
</para>
<programlisting language="php"><![CDATA[
// Router Setup (Standardrouten und 'archive' Route):
$front = Zend_Controller_Front::getInstance();
$router = $front->getRouter();
$router->addDefaultRoutes();
$router->addRoute(
'archive',
new Zend_Controller_Router_Route(
'/archive/:year',
array(
'module' => 'company',
'controller' => 'news',
'action' => 'archive',
'year' => (int) date('Y') - 1
),
array('year' => '\d+')
)
);
// ACL Setup:
$acl = new Zend_Acl();
$acl->addRole(new Zend_Acl_Role('member'));
$acl->addRole(new Zend_Acl_Role('admin'));
$acl->add(new Zend_Acl_Resource('mvc:admin'));
$acl->add(new Zend_Acl_Resource('mvc:community.account'));
$acl->allow('member', 'mvc:community.account');
$acl->allow('admin', null);
// ACL und Rolle im Proxy Helfer speichern:
$view->navigation()->setAcl($acl)->setRole('member');
// ...oder ein standard ACL und Rolle statisch setzen:
Zend_View_Helper_Navigation_HelperAbstract::setDefaultAcl($acl);
Zend_View_Helper_Navigation_HelperAbstract::setDefaultRole('member');
]]></programlisting>
</sect4>
<sect4 id="zend.view.helpers.initial.navigation.breadcrumbs">
<title>Breadcrumbs Helfer</title>
<para>
Breadcrumbs werden verwendet um anzuzeigen wo in einer Sitemap ein Benutzer aktuell
browst, und werden typischerweise wie folgt angezeigt: "Du bist hier: Home > Produkte
> FantastischesProdukt 1.0". Der BreakCrumbs Helfer folgt den Richtlinien von <ulink
url="http://developer.yahoo.com/ypatterns/pattern.php?pattern=breadcrumbs">Breadcrumbs
Pattern - Yahoo! Design Pattern Library</ulink>, und erlaubt eine einfache Anpassung
(Minimale/Maximale Tiefe, Einrückung, Trennzeichen, und ob das letzte Element verlinkt
sein soll), oder die Darstellung durch Verwendung eines partiellen View Skripts.
</para>
<para>
Der Breabcrumbs Helfer funktioniert wie folgt; er findet die tiefste aktive Seite in
einem Navigations Container, und stellt den aufwärtsgerichteten Pfad zum Root dar.
Für <acronym>MVC</acronym> Seiten wird die "Aktivität" einer Seite erkannt indem das
Anfrage Objekt angeschaut wird, wie im Kapitel
<link linkend="zend.navigation.pages.mvc">Zend_Navigation_Page_Mvc</link> beschrieben.
</para>
<para>
Der Helfer setzt die Eigenschaft <code>minDepth</code> standardmäßig auf 1, was
bedeutet das Breadcrumbs nicht dargestellt werden wenn die tiefste aktive Seite eine
Root Seite ist. Wenn <code>maxDepth</code> spezifiziert ist, beendet der Helfer die
Darstellung bei der spezifizierten Tiefe (z.B. stopp bei Level 2 selbst wenn die
tiefste aktive Seite auf Level 3 ist).
</para>
<para>
Methoden im Breakcrumbs Helfer sind:
</para>
<itemizedlist>
<listitem>
<para>
<code>{get|set}Separator()</code> empfängt/setzt das Trennzeichen das zwischen
Breakcrumbs verwendet wird. Der Standardwert ist <code>' &gt; '</code>.
</para>
</listitem>
<listitem>
<para>
<code>{get|set}LinkLast()</code> empfängt/setzt ob der letzte Breabcrumb
als Anker dargestellt werden soll oder nicht. Der Standardwert ist
<constant>FALSE</constant>.
</para>
</listitem>
<listitem>
<para>
<code>{get|set}Partial()</code> empfängt/setzt ein partielles View Skript das
für die Darstellung von Breadcrumbs verwendet werden soll. Wenn ein partielles
View Skript gesetzt ist, verwendet die <methodname>render()</methodname> Methode
des Helfers die <methodname>renderPartial()</methodname> Methode. Wenn kein
partielles gesetzt ist, wird die <methodname>renderStraight()</methodname>
Methode verwendet. Der Helfer erwartet das der partielle ein <type>String</type>
oder ein <type>Array</type> mit zwei Elementen ist. Wen der Partielle ein
<type>String</type> ist, benennt er den Namen des partiellen Skripts das zu
verwenden ist. Wenn er ein <type>Array</type> ist, wird das erste Element als
Name des partiellen View Skripts verwendet, und das zweite Element ist das Modul
in dem das Skript zu finden ist.
</para>
</listitem>
<listitem>
<para>
<methodname>renderStraight()</methodname> ist die standardmäßige render Methode.
</para>
</listitem>
<listitem>
<para>
<methodname>renderPartial()</methodname> wird für die Darstellung verwendet wenn
ein partielles View Skript verwendet wird.
</para>
</listitem>
</itemizedlist>
<example id="zend.view.helpers.initial.navigation.breadcrumbs.example1">
<title>Darstellung von Breadcrumbs</title>
<para>
Dieses Beispiel zeigt wie Breadcrumbs mit Standardsettings dargestellt werden.
</para>
<programlisting language="php"><![CDATA[
In einem View Skript oder Layout:
<?php echo $this->navigation()->breadcrumbs(); ?>
Die zwei obigen Aufrufe verwenden die magische __toString() Methode,
und sind identisch mit:
<?php echo $this->navigation()->breadcrumbs()->render(); ?>
Ausgabe:
<a href="/products">Produkte</a> > <a href="/products/server">Foo Server</a> > FAQ
]]></programlisting>
</example>
<example id="zend.view.helpers.initial.navigation.breadcrumbs.example2">
<title>Einrückung spezifizieren</title>
<para>
Dieses Beispiel zeigt wie Breadcrumbs mit anfänglicher Einrückung dargestellt
werden können.
</para>
<programlisting language="php"><![CDATA[
Darstellung mit 8 Leerzeichen Einrückung:
<?php echo $this->navigation()->breadcrumbs()->setIndent(8); ?>
Ausgabe:
<a href="/products">Products</a> > <a href="/products/server">Foo Server</a> > FAQ
]]></programlisting>
</example>
<example id="zend.view.helpers.initial.navigation.breadcrumbs.example3">
<title>Eigene Ausgabe für Breakcrumbs</title>
<para>
Dieses Beispiel zeigt wie man eine eigene Breadcrumbs Ausgabe durch die
Spezifizierung diverser Optionen erstellt.
</para>
<programlisting language="php"><![CDATA[
In einem View Skript oder Layout:
<?php
echo $this->navigation()
->breadcrumbs()
->setLinkLast(true) // Letzte Seite verlinken
->setMaxDepth(1) // Bei Level 1 stoppen
->setSeparator(' ▶' . PHP_EOL); // Cooler Seperator mit Umbruch
?>
Output:
<a href="/products">Produkte</a> ▶
<a href="/products/server">Foo Server</a>
/////////////////////////////////////////////////////
Minimale notwendige Tiefe für die Darstellung von Breadcrumbs setzen:
<?php
$this->navigation()->breadcrumbs()->setMinDepth(10);
echo $this->navigation()->breadcrumbs();
?>
Ausgabe:
Nichts, weil die tiefste aktive Seite nicht auf Level 10 oder tiefer ist.
]]></programlisting>
</example>
<example id="zend.view.helpers.initial.navigation.breadcrumbs.example4">
<title>Darstellung von Breadcrumbs mit Verwendung eines partiellen View Skripts</title>
<para>
Dieses Beispiel zeigt wir eigene Breakcrumbs durch Verwendung eines partiellen
View Skripts dargestellt werden können. Durch den Aufruf von
<methodname>setPartial()</methodname> kann man ein partielles View Skript
spezifizieren das verwendet wird wenn die <methodname>render()</methodname>
Methode aufgerufen wird. Wenn ein partielles spezifiziert ist wird die Methode
<methodname>renderPartial()</methodname> aufgerufen. Diese Methode findest die
tiefste aktive Seite und übergibt ein Array von Seiten die zur aktiven Seite des
partiellen View Skripts weiterleitet.
</para>
<para>
Im Layout:
</para>
<programlisting language="php"><![CDATA[
$partial = ;
echo $this->navigation()->breadcrumbs()
->setPartial(array('breadcrumbs.phtml', 'default'));
]]></programlisting>
<para>
Inhalt von
<code>application/modules/default/views/breadcrumbs.phtml</code>:
</para>
<programlisting language="php"><![CDATA[
echo implode(', ', array_map(
create_function('$a', 'return $a->getLabel();'),
$this->pages));
]]></programlisting>
<para>
Ausgabe:
</para>
<programlisting language="php"><![CDATA[
Produkte, Foo Server, FAQ
]]></programlisting>
</example>
</sect4>
<sect4 id="zend.view.helpers.initial.navigation.links">
<title>Link Helfer</title>
<para>
Der Link Helfer wird für die Darstellung von <acronym>HTML</acronym>
<constant>LINK</constant> Elementen verwendet. Links werden für die Beschreibung von
Dokument-Beziehungen der aktuell aktiven Seite verwendet. Mehr über Links und Linktypen
kann unter <ulink
url="http://www.w3.org/TR/html4/struct/links.html#h-12.3">Dokument-Beziehung: Das
LINK Element (HTML4 W3C Rec.)</ulink> und <ulink
url="http://www.w3.org/TR/html4/types.html#h-6.12">Link Typen (HTML4 W3C
Rec.)</ulink> in der <acronym>HTML</acronym>4 W3C Empfehlung nachgelesen werden.
</para>
<para>
Es gibt zwei Typen von Beziehungen; vorwärts und rückwärts, angezeigt durch die
Schlüsselwörter <code>'rel'</code> und <code>'rev'</code>. Die meisten Methoden im
Helfer nehmen einen <varname>$rel</varname> Parameter entgegen, welcher entweder
<code>'rel'</code> oder <code>'rev'</code> sein muß. Die meisten Methoden nehmen auch
einen <varname>$type</varname> Parameter entgegen welcher für die Spezifikation des
Linktyps (z.B. alternate, start, next, prev, chapter, usw.) verwendet wird.
</para>
<para>
Beziehungen können dem Seitenobjekt manuell hinzugefügt werden, oder werden durch
das Durchlaufen des Containers, der im Helfer registriert ist, gefunden. Die Methode
<methodname>findRelation($page, $rel, $type)</methodname> versucht zuerst den gegebenen
<varname>$rel</varname> von <varname>$type</varname> von der <varname>$page</varname>
durch den Aufruf von <code>$page->findRel($type)</code> oder
<code>$page->findRel($type)</code> zu finden. Wenn <varname>$page</varname> eine
Beziehung hat die zu der Instanz einer Seite konvertiert werden kann, wird diese
Beziehung verwendet. Wenn die Instanz von <varname>$page</varname> keinen
<varname>$type</varname> spezifiziert hat, schaut der Helfer nach einer Methode im
Helfer die <code>search$rel$type</code> heißt (z.B.
<methodname>searchRelNext()</methodname> oder
<methodname>searchRevAlternate()</methodname>). Wenn so eine Methode existiert, wird Sie
für die Erkennung der Beziehung der <varname>$page</varname> verwendet indem der
Container durchlaufen wird.
</para>
<para>
Nicht alle Beziehungen können durch das Durchlaufen des Containers erkannt werden.
Das sind die Beziehungen die durch eine Suche gefunden werden können:
</para>
<itemizedlist>
<listitem>
<para>
<methodname>searchRelStart()</methodname>, Vorwärts Beziehung 'start': Die
erste Seite im Container.
</para>
</listitem>
<listitem>
<para>
<methodname>searchRelNext()</methodname>, Vorwärts Beziehung 'next'; findet
die nächste Seite im Container, z.B. die Seite nach der aktiven Seite.
</para>
</listitem>
<listitem>
<para>
<methodname>searchRelPrev()</methodname>, Vorwärts Beziehung 'prev'; findet
die vorhergehende Seite, z.B. die Seite vor der aktiven Seite.
</para>
</listitem>
<listitem>
<para>
<methodname>searchRelChapter()</methodname>, Vorwärts Beziehung 'chapter';
findet alle Seiten auf Level 0 ausser der 'start' Beziehung oder der aktiven
Seite wenn diese auf Level 0 ist.
</para>
</listitem>
<listitem>
<para>
<methodname>searchRelSection()</methodname>, Vorwärts Beziehung 'section';
findet alle Kind-Seiten der aktiven Seite wenn die aktive Seite auf Level 0
ist (ein 'chapter').
</para>
</listitem>
<listitem>
<para>
<methodname>searchRelSubsection()</methodname>, Vorwärts Beziehung
'subsection'; findet alle Kind-Seiten der aktiven Seite wenn die aktive
Seite auf Level 1 sind (ein 'section').
</para>
</listitem>
<listitem>
<para>
<methodname>searchRevSection()</methodname>, Rückwärts Beziehung 'section';
findet den Elternteil der aktiven Seite wenn die aktive Seite auf Level 1
ist (ein 'section').
</para>
</listitem>
<listitem>
<para>
<methodname>searchRevSubsection()</methodname>, Rückwärts Beziehung
'subsection'; findet den Elternteil der aktiven Seite wenn die aktive Seite
auf Level 2 ist (ein 'subsection').
</para>
</listitem>
</itemizedlist>
<note>
<para>
Wenn in der Instanz der Seite nach Beziehungen gesehen wird (
(<code>$page->getRel($type)</code> oder <code>$page->getRev($type)</code>),
akzeptiert der Helfer Wert vom Typ <type>String</type>, <type>Array</type>,
<classname>Zend_Config</classname>, oder
<classname>Zend_Navigation_Page</classname>. Wenn ein String gefunden wird, wird
dieser zu einer <classname>Zend_Navigation_Page_Uri</classname> konvertiert. Wenn
ein Array oder eine Config gefunden wird, wird diese in ein oder mehrere
Seiteninstanzen konvertiert, und jedes Element wird an die
<link linkend="zend.navigation.pages.factory">Seiten Factory</link> übergeben.
Wenn der erste Schlüssel nicht nummerische ist, wird das Array/Config direkt an die
Seiten Factory übergeben, und eine einzelne Seite wird retourniert.
</para>
</note>
<para>
Der Helfer unterstützt auch magische Methoden für das Finden von Beziehungen. Um z.B.
alternative vorwärts Beziehungen zu finden muß
<code>$helper->findRelAlternate($page)</code> aufgerufen werden, und um rückwärts
gerichtete Kapitel Beziehungen zu finden <code>$helper->findRevSection($page)</code>.
Diese Aufrufe korrespondieren mit <code>$helper->findRelation($page, 'rel',
'alternate');</code> und <code>$helper->findRelation($page, 'rev', 'section');</code>.
</para>
<para>
Um zu Steuern welche Beziehung dargestellt werden soll, verwendet der Helfer ein render
Flag. Das render Flag ist ein Integer Wert, und kann in
<ulink url="http://php.net/manual/en/language.operators.bitwise.php">binären
<code>und</code> (<code>&</code>) Operationen</ulink> mit den render Konstanten des
Helfers verwendet werden um festzustellen ob die Beziehung zu der die render Konstante
gehört, dargestellt werden soll.
</para>
<para>
Siehe das <link linkend="zend.view.helpers.initial.navigation.links.example3">folgende
Beispiel</link> für weitere Informationen.
</para>
<itemizedlist>
<listitem>
<para>
<constant>Zend_View_Helper_Navigation_Links::RENDER_ALTERNATE</constant>
</para>
</listitem>
<listitem>
<para>
<constant>Zend_View_Helper_Navigation_Links::RENDER_STYLESHEET</constant>
</para>
</listitem>
<listitem>
<para>
<constant>Zend_View_Helper_Navigation_Links::RENDER_START</constant>
</para>
</listitem>
<listitem>
<para>
<constant>Zend_View_Helper_Navigation_Links::RENDER_NEXT</constant>
</para>
</listitem>
<listitem>
<para>
<constant>Zend_View_Helper_Navigation_Links::RENDER_PREV</constant>
</para>
</listitem>
<listitem>
<para>
<constant>Zend_View_Helper_Navigation_Links::RENDER_CONTENTS</constant>
</para>
</listitem>
<listitem>
<para>
<constant>Zend_View_Helper_Navigation_Links::RENDER_INDEX</constant>
</para>
</listitem>
<listitem>
<para>
<constant>Zend_View_Helper_Navigation_Links::RENDER_GLOSSARY</constant>
</para>
</listitem>
<listitem>
<para>
<constant>Zend_View_Helper_Navigation_Links::RENDER_COPYRIGHT</constant>
</para>
</listitem>
<listitem>
<para>
<constant>Zend_View_Helper_Navigation_Links::RENDER_CHAPTER</constant>
</para>
</listitem>
<listitem>
<para>
<constant>Zend_View_Helper_Navigation_Links::RENDER_SECTION</constant>
</para>
</listitem>
<listitem>
<para>
<constant>Zend_View_Helper_Navigation_Links::RENDER_SUBSECTION</constant>
</para>
</listitem>
<listitem>
<para>
<constant>Zend_View_Helper_Navigation_Links::RENDER_APPENDIX</constant>
</para>
</listitem>
<listitem>
<para>
<constant>Zend_View_Helper_Navigation_Links::RENDER_HELP</constant>
</para>
</listitem>
<listitem>
<para>
<constant>Zend_View_Helper_Navigation_Links::RENDER_BOOKMARK</constant>
</para>
</listitem>
<listitem>
<para>
<constant>Zend_View_Helper_Navigation_Links::RENDER_CUSTOM</constant>
</para>
</listitem>
<listitem>
<para>
<constant>Zend_View_Helper_Navigation_Links::RENDER_ALL</constant>
</para>
</listitem>
</itemizedlist>
<para>
Die Konstanten von <constant>RENDER_ALTERNATE</constant> bis
<constant>RENDER_BOOKMARK</constant> stellen standardmäßige <acronym>HTML</acronym>
Linktypen dar. <constant>RENDER_CUSTOM</constant> stellt eine nicht-standardmäßige
Beziehung dar die in der Seite spezifiziert ist. <constant>RENDER_ALL</constant> stellt
standardmäßige und nicht-standardmäßige Beziehungen dar.
</para>
<para>
Methoden im Link Helfer:
</para>
<itemizedlist>
<listitem>
<para>
<code>{get|set}RenderFlag()</code> empfängt/setzt das render Flag.
Standardwert ist <constant>RENDER_ALL</constant>. Siehe das folgende Beispiel
dafür wie das render Flag zu setzen ist.
</para>
</listitem>
<listitem>
<para>
<methodname>findAllRelations()</methodname> findet alle Beziehungen von allen
Typen einer angegebenen Seite.
</para>
</listitem>
<listitem>
<para>
<methodname>findRelation()</methodname> findet alle Beziehungen eines
angegebenen Typs einer angegebenen Seite.
</para>
</listitem>
<listitem>
<para>
<code>searchRel{Start|Next|Prev|Chapter|Section|Subsection}()</code>
durchsucht einen Container um vorwärtsgerichtete Beziehungen zu Startseite,
nächster Seite, voriger Seite, Kapitel, Sektion und Untersektion zu finden.
</para>
</listitem>
<listitem>
<para>
<code>searchRev{Section|Subsection}()</code> durchsucht einen
Container um rückwärtsgerichtete Beziehungen zu Sektionen oder Untersektionen zu
finden.
</para>
</listitem>
<listitem>
<para>
<methodname>renderLink()</methodname> stellt ein einzelnes <code>link</code>
Element dar.
</para>
</listitem>
</itemizedlist>
<example id="zend.view.helpers.initial.navigation.links.example1">
<title>Beziehungen in Seiten spezifizieren</title>
<para>
Dieses Beispiel zeigt wir Beziehungen in Seiten spezifiziert werden können.
</para>
<programlisting language="php"><![CDATA[
$container = new Zend_Navigation(array(
array(
'label' => 'Strings für Beziehungen verwenden',
'rel' => array(
'alternate' => 'http://www.example.org/'
),
'rev' => array(
'alternate' => 'http://www.example.net/'
)
),
array(
'label' => 'Arrays für Beziehungen verwenden',
'rel' => array(
'alternate' => array(
'label' => 'Example.org',
'uri' => 'http://www.example.org/'
)
)
),
array(
'label' => 'Konfigurationen für Beziehungen verwenden',
'rel' => array(
'alternate' => new Zend_Config(array(
'label' => 'Example.org',
'uri' => 'http://www.example.org/'
))
)
),
array(
'label' => 'Instanzen von Seiten für Beziehungen verwenden',
'rel' => array(
'alternate' => Zend_Navigation_Page::factory(array(
'label' => 'Example.org',
'uri' => 'http://www.example.org/'
))
)
)
));
]]></programlisting>
</example>
<example id="zend.view.helpers.initial.navigation.links.example2">
<title>Standardmäßige Darstellung von Links</title>
<para>
Dieses Beispiel zeigt wie ein Menü von einem Container dargestellt wird, der im
View Helfer registriert/gefunden wurde.
</para>
<programlisting language="php"><![CDATA[
Im View Skript oder Layout:
<?php echo $this->view->navigation()->links(); ?>
Ausgabe:
<link rel="alternate" href="/products/server/faq/format/xml">
<link rel="start" href="/" title="Home">
<link rel="next" href="/products/server/editions" title="Editionen">
<link rel="prev" href="/products/server" title="Foo Server">
<link rel="chapter" href="/products" title="Produkte">
<link rel="chapter" href="/company/about" title="Firma">
<link rel="chapter" href="/community" title="Community">
<link rel="canonical" href="http://www.example.com/?page=server-faq">
<link rev="subsection" href="/products/server" title="Foo Server">
]]></programlisting>
</example>
<example id="zend.view.helpers.initial.navigation.links.example3">
<title>Spezifizieren welche Beziehungen dargestellt werden sollen</title>
<para>
Dieses Beispiel zeigt wie spezifiziert werden kann, welche Beziehungen zu finden
und darzustellen sind.
</para>
<programlisting language="php"><![CDATA[
Nur start, next und prev darstellen:
$helper->setRenderFlag(Zend_View_Helper_Navigation_Links::RENDER_START |
Zend_View_Helper_Navigation_Links::RENDER_NEXT |
Zend_View_Helper_Navigation_Links::RENDER_PREV);
Ausgabe:
<link rel="start" href="/" title="Home">
<link rel="next" href="/products/server/editions" title="Editionen">
<link rel="prev" href="/products/server" title="Foo Server">
]]></programlisting>
<programlisting language="php"><![CDATA[
Nur native Linktypen darstellen:
$helper->setRenderFlag(Zend_View_Helper_Navigation_Links::RENDER_ALL ^
Zend_View_Helper_Navigation_Links::RENDER_CUSTOM);
Ausgabe:
<link rel="alternate" href="/products/server/faq/format/xml">
<link rel="start" href="/" title="Home">
<link rel="next" href="/products/server/editions" title="Editionen">
<link rel="prev" href="/products/server" title="Foo Server">
<link rel="chapter" href="/products" title="Produkte">
<link rel="chapter" href="/company/about" title="Firma">
<link rel="chapter" href="/community" title="Community">
<link rev="subsection" href="/products/server" title="Foo Server">
]]></programlisting>
<programlisting language="php"><![CDATA[
Alles ausser Kapitel darstellen:
$helper->setRenderFlag(Zend_View_Helper_Navigation_Links::RENDER_ALL ^
Zend_View_Helper_Navigation_Links::RENDER_CHAPTER);
Ausgabe:
<link rel="alternate" href="/products/server/faq/format/xml">
<link rel="start" href="/" title="Home">
<link rel="next" href="/products/server/editions" title="Editionen">
<link rel="prev" href="/products/server" title="Foo Server">
<link rel="canonical" href="http://www.example.com/?page=server-faq">
<link rev="subsection" href="/products/server" title="Foo Server">
]]></programlisting>
</example>
</sect4>
<sect4 id="zend.view.helpers.initial.navigation.menu">
<title>Menu Helfer</title>
<para>
Der Menu Helfer wird für die Darstellung von Menüs aus Navigations Containern
verwendet. Standardmäßig wird das Menü durch Verwendung der <acronym>HTML</acronym>
Tags <code>UL</code> und <code>LI</code> dargestellt. Der Helfer erlaubt aber auch
die Verwendung eines partiellen View Skripts.
</para>
<para>
Methoden im Menu Helfer:
</para>
<itemizedlist>
<listitem>
<para>
<code>{get|set}UlClass()</code> empfängt/setzt die <acronym>CSS</acronym> Klasse
zur Verwendung in <methodname>renderMenu()</methodname>.
</para>
</listitem>
<listitem>
<para>
<code>{get|set}OnlyActiveBranch()</code> empfängt/setzt ein Flag das
spezifiziert ob der aktive Zweig eines Containers dargestellt werden soll.
</para>
</listitem>
<listitem>
<para>
<code>{get|set}RenderParents()</code> empfängt/setzt ein Flag das
spezifiziert ob Eltern nur dargestellt werden sollen wenn nur der aktive
Zweig eines Containers dargestellt wird. Wenn es auf <constant>FALSE</constant>
gesetzt wird, wird nur das tiefste aktive Menü dargestellt.
</para>
</listitem>
<listitem>
<para>
<code>{get|set}Partial()</code> empfängt/setzt ein partielles View Skript
das für die Darstellung des Menüs verwendet werden soll. Wenn ein partielles
Skript gesetzt ist, verwendet die <methodname>render()</methodname> Methode des
Helfers die <methodname>renderPartial()</methodname> Methode. Wenn kein
Partieller gesetzt ist, wird die <methodname>renderMenu()</methodname> Methode
verwendet. Der Helfer erwartet das der Partielle ein <type>String</type>, oder
ein <type>Array</type> mit zwei Elementen, ist. Wenn der Partielle ein
<type>String</type> ist bezeichnet er den Namen des partiellen Skripts das zu
verwenden ist. Wenn er ein <type>Array</type> ist wird das erste Element als
Name des partiellen View Skripts verwendet, und das zweite Element ist das Modul
indem das Skript gefunden wird.
</para>
</listitem>
<listitem>
<para>
<methodname>htmlify()</methodname> überschreibt die Methode der abstrakten
Klasse damit <code>span</code> Elemente zurückgegeben werden wenn die Seite kein
<code>href</code> hat.
</para>
</listitem>
<listitem>
<para>
<methodname>renderMenu($container = null, $options = array())</methodname> ist
eine standardmäßige render Methode, und stellt einen Container als
<acronym>HTML</acronym> <code>UL</code> Liste dar.
</para>
<para>
Wenn <varname>$container</varname> nicht angegeben wird, wird der Container der
im Helfer registriert ist dargestellt.
</para>
<para>
<varname>$options</varname> wird verwendet um temporär spezifizierte Optionen zu
überschreiben ohne das die Werte in der Helferinstanz zurückgesetzt werden. Es
ist ein assoziatives Array wobei jeder Schlüssel mit einer Option im Helfer
korrespondiert.
</para>
<para>
Erkannte Optionen:
</para>
<itemizedlist>
<listitem>
<para>
<code>indent</code>; Einrückung. Erwartet einen <type>String</type>
oder einen <code>int</code> Wert.
</para>
</listitem>
<listitem>
<para>
<code>minDepth</code>; Minimale Tiefe. Erwartet ein
<code>int</code> oder <constant>NULL</constant> (keine minimale
Tiefe).
</para>
</listitem>
<listitem>
<para>
<code>maxDepth</code>; Maximale Tiefe. Erwartet ein
<code>int</code> oder <constant>NULL</constant> (keine maximale
Tiefe).
</para>
</listitem>
<listitem>
<para>
<code>ulClass</code>; <acronym>CSS</acronym> Klasse für das
<code>ul</code> Element. Erwartet einen <type>String</type>.
</para>
</listitem>
<listitem>
<para>
<code>onlyActiveBranch</code>; Ob nur der aktive Branch dargestellt
werden soll. Erwartet einen <type>Boolean</type> Wert.
</para>
</listitem>
<listitem>
<para>
<code>renderParents</code>; Ob eltern dargestellt werden sollen
wenn nur der aktive Branch dargestellt wird. Erwartet einen
<type>Boolean</type> Wert.
</para>
</listitem>
</itemizedlist>
<para>
Wenn keine Option angegeben wird, werden die Werte die im Helfer gesetzt
sind verwendet.
</para>
</listitem>
<listitem>
<para>
<methodname>renderPartial()</methodname> wird für die Darstellung des Menüs in
einem partiellen View Skript verwendet.
</para>
</listitem>
<listitem>
<para>
<methodname>renderSubMenu()</methodname> stellt das tiefste Menü Level des
aktiven Branches eines Containers dar.
</para>
</listitem>
</itemizedlist>
<example id="zend.view.helpers.initial.navigation.menu.example1">
<title>Darstellung eines Menüs</title>
<para>
Dieses Beispiel zeigt wie ein Menü von einem registrierten/im View Helfer
gefundenen Container, dargestellt wird. Es ist zu beachten das Seiten basierend
auf Ihrer Sichtbarkeit und <acronym>ACL</acronym> ausgefiltert werden.
</para>
<programlisting language="php"><![CDATA[
In einem View Skript oder Layout:
<?php echo $this->navigation()->menu()->render() ?>
Oder einfach:
<?php echo $this->navigation()->menu() ?>
Ausgabe:
<ul class="navigation">
<li>
<a title="Geh zu Home" href="/">Home</a>
</li>
<li class="active">
<a href="/products">Produkte</a>
<ul>
<li class="active">
<a href="/products/server">Foo Server</a>
<ul>
<li class="active">
<a href="/products/server/faq">FAQ</a>
</li>
<li>
<a href="/products/server/editions">Editionen</a>
</li>
<li>
<a href="/products/server/requirements">System Anforderungen</a>
</li>
</ul>
</li>
<li>
<a href="/products/studio">Foo Studio</a>
<ul>
<li>
<a href="/products/studio/customers">Kunden Stories</a>
</li>
<li>
<a href="/prodcts/studio/support">Support</a>
</li>
</ul>
</li>
</ul>
</li>
<li>
<a title="About us" href="/company/about">Firma</a>
<ul>
<li>
<a href="/company/about/investors">Investor Relations</a>
</li>
<li>
<a class="rss" href="/company/news">News</a>
<ul>
<li>
<a href="/company/news/press">Für die Presse</a>
</li>
<li>
<a href="/archive">Archiv</a>
</li>
</ul>
</li>
</ul>
</li>
<li>
<a href="/community">Community</a>
<ul>
<li>
<a href="/community/account">Mein Account</a>
</li>
<li>
<a class="external" href="http://forums.example.com/">Forums</a>
</li>
</ul>
</li>
</ul>
]]></programlisting>
</example>
<example id="zend.view.helpers.initial.navigation.menu.example2">
<title>renderMenu() direkt aufrufen</title>
<para>
Dieses Beispiel zeigt wie ein Menü dargestellt werden kann das nicht im View
Helfer registriert ist, indem <methodname>renderMenu()</methodname> direkt
aufgerufen wird und ein paar wenige Optionen spezifiziert werden.
</para>
<programlisting language="php"><![CDATA[
<?php
// Nur das 'Community' Menü darstellen
$community = $this->navigation()->findOneByLabel('Community');
$options = array(
'indent' => 16,
'ulClass' => 'community'
);
echo $this->navigation()
->menu()
->renderMenu($community, $options);
?>
Output:
<ul class="community">
<li>
<a href="/community/account">Mein Account</a>
</li>
<li>
<a class="external" href="http://forums.example.com/">Forums</a>
</li>
</ul>
]]></programlisting>
</example>
<example id="zend.view.helpers.initial.navigation.menu.example3">
<title>Das tiefste aktive Menü darstellen</title>
<para>
Dieses Beispiel zeigt wie <methodname>renderSubMenu()</methodname> das tiefste
Untermenü des aktiven Branches dargestellt wird.
</para>
<para>
Der Aufruf von <methodname>renderSubMenu($container, $ulClass, $indent)</methodname>
ist identisch mit dem Aufruf von
<methodname>renderMenu($container, $options)</methodname> mit den folgenden
Optionen:
</para>
<programlisting language="php"><![CDATA[
array(
'ulClass' => $ulClass,
'indent' => $indent,
'minDepth' => null,
'maxDepth' => null,
'onlyActiveBranch' => true,
'renderParents' => false
);
]]></programlisting>
<programlisting language="php"><![CDATA[
<?php
echo $this->navigation()
->menu()
->renderSubMenu(null, 'sidebar', 4);
?>
Die Ausgabe ist die gleiche wenn 'FAQ' oder 'Foo Server' aktiv sind:
<ul class="sidebar">
<li class="active">
<a href="/products/server/faq">FAQ</a>
</li>
<li>
<a href="/products/server/editions">Editionen</a>
</li>
<li>
<a href="/products/server/requirements">System Anforderungen</a>
</li>
</ul>
]]></programlisting>
</example>
<example id="zend.view.helpers.initial.navigation.menu.example4">
<title>Darstellung eines Menüs mit maximaler Tiefe</title>
<programlisting language="php"><![CDATA[
<?php
echo $this->navigation()
->menu()
->setMaxDepth(1);
?>
Ausgabe:
<ul class="navigation">
<li>
<a title="Geh zu Home" href="/">Home</a>
</li>
<li class="active">
<a href="/products">Produkte</a>
<ul>
<li class="active">
<a href="/products/server">Foo Server</a>
</li>
<li>
<a href="/products/studio">Foo Studio</a>
</li>
</ul>
</li>
<li>
<a title="About us" href="/company/about">Firma</a>
<ul>
<li>
<a href="/company/about/investors">Investor Relations</a>
</li>
<li>
<a class="rss" href="/company/news">News</a>
</li>
</ul>
</li>
<li>
<a href="/community">Community</a>
<ul>
<li>
<a href="/community/account">Mein Account</a>
</li>
<li>
<a class="external" href="http://forums.example.com/">Forums</a>
</li>
</ul>
</li>
</ul>
]]></programlisting>
</example>
<example id="zend.view.helpers.initial.navigation.menu.example5">
<title>Darstellung eines Menüs mit minimaler Tiefe</title>
<programlisting language="php"><![CDATA[
<?php
echo $this->navigation()
->menu()
->setMinDepth(1);
?>
Ausgabe:
<ul class="navigation">
<li class="active">
<a href="/products/server">Foo Server</a>
<ul>
<li class="active">
<a href="/products/server/faq">FAQ</a>
</li>
<li>
<a href="/products/server/editions">Editionen</a>
</li>
<li>
<a href="/products/server/requirements">System Anforderungen</a>
</li>
</ul>
</li>
<li>
<a href="/products/studio">Foo Studio</a>
<ul>
<li>
<a href="/products/studio/customers">Kunden Stories</a>
</li>
<li>
<a href="/prodcts/studio/support">Support</a>
</li>
</ul>
</li>
<li>
<a href="/company/about/investors">Investor Relations</a>
</li>
<li>
<a class="rss" href="/company/news">News</a>
<ul>
<li>
<a href="/company/news/press">Für die Presse</a>
</li>
<li>
<a href="/archive">Archiv</a>
</li>
</ul>
</li>
<li>
<a href="/community/account">Mein Account</a>
</li>
<li>
<a class="external" href="http://forums.example.com/">Forums</a>
</li>
</ul>
]]></programlisting>
</example>
<example id="zend.view.helpers.initial.navigation.menu.example6">
<title>Nur den aktiven Branch eines Menüs darstellen</title>
<programlisting language="php"><![CDATA[
<?php
echo $this->navigation()
->menu()
->setOnlyActiveBranch(true);
?>
Ausgabe:
<ul class="navigation">
<li class="active">
<a href="/products">Produkte</a>
<ul>
<li class="active">
<a href="/products/server">Foo Server</a>
<ul>
<li class="active">
<a href="/products/server/faq">FAQ</a>
</li>
<li>
<a href="/products/server/editions">Editionen</a>
</li>
<li>
<a href="/products/server/requirements">System Anforderungen</a>
</li>
</ul>
</li>
</ul>
</li>
</ul>
]]></programlisting>
</example>
<example id="zend.view.helpers.initial.navigation.menu.example7">
<title>
Nur den aktiven Branch eines Menüs mit minimaler Tiefe darstellen
</title>
<programlisting language="php"><![CDATA[
<?php
echo $this->navigation()
->menu()
->setOnlyActiveBranch(true)
->setMinDepth(1);
?>
Ausgabe:
<ul class="navigation">
<li class="active">
<a href="/products/server">Foo Server</a>
<ul>
<li class="active">
<a href="/products/server/faq">FAQ</a>
</li>
<li>
<a href="/products/server/editions">Editionen</a>
</li>
<li>
<a href="/products/server/requirements">System Anforderungen</a>
</li>
</ul>
</li>
</ul>
]]></programlisting>
</example>
<example id="zend.view.helpers.initial.navigation.menu.example8">
<title>
Nur den aktiven Branch eines Menüs mit maximaler Tiefe darstellen
</title>
<programlisting language="php"><![CDATA[
<?php
echo $this->navigation()
->menu()
->setOnlyActiveBranch(true)
->setMaxDepth(1);
?>
Ausgabe:
<ul class="navigation">
<li class="active">
<a href="/products">Produkte</a>
<ul>
<li class="active">
<a href="/products/server">Foo Server</a>
</li>
<li>
<a href="/products/studio">Foo Studio</a>
</li>
</ul>
</li>
</ul>
]]></programlisting>
</example>
<example id="zend.view.helpers.initial.navigation.menu.example9">
<title>
Nur den aktiven Branch eines Menüs mit maximaler Tiefe aber ohne Eltern darstellen
</title>
<para>
</para>
<programlisting language="php"><![CDATA[
<?php
echo $this->navigation()
->menu()
->setOnlyActiveBranch(true)
->setRenderParents(false)
->setMaxDepth(1);
?>
Ausgabe:
<ul class="navigation">
<li class="active">
<a href="/products/server">Foo Server</a>
</li>
<li>
<a href="/products/studio">Foo Studio</a>
</li>
</ul>
]]></programlisting>
</example>
<example id="zend.view.helpers.initial.navigation.menu.example10">
<title>
Darstellen eines eigenen Menüs durch Verwendung eines partiellen View Skripts
</title>
<para>
Dieses Beispiel zeigt wie ein eigenes Menü, durch Verwendung eines partiellen View
Skripts, dargestellt werden kann. Durch Aufruf von
<methodname>setPartial()</methodname> kann ein partielles View Skript spezifiziert
werden das verwendet wird wenn man <methodname>render()</methodname> aufruft. Wenn
ein Partielles spezifiziert ist, wird die <methodname>renderPartial()</methodname>
Methode aufgerufen. Diese Methode fügt den Container in die View ein, und verwendet
hierbei den Schlüssel <code>container</code>.
</para>
<para>In a layout:</para>
<programlisting language="php"><![CDATA[
$partial = array('menu.phtml', 'default');
$this->navigation()->menu()->setPartial($partial);
echo $this->navigation()->menu()->render();
]]></programlisting>
<para>In application/modules/default/views/menu.phtml:</para>
<programlisting language="php"><![CDATA[
foreach ($this->container as $page) {
echo $this->navigation()->menu()->htmlify($page), PHP_EOL;
}
]]></programlisting>
<para>Ausgabe:</para>
<programlisting language="php"><![CDATA[
<a title="Geh zu Home" href="/">Home</a>
<a href="/products">Produkte</a>
<a title="About us" href="/company/about">Firma</a>
<a href="/community">Community</a>
]]></programlisting>
</example>
</sect4>
<sect4 id="zend.view.helpers.initial.navigation.sitemap">
<title>Sitemap Helfer</title>
<para>
Der Sitemap Helfer wird für die Erzeugung von <acronym>XML</acronym> Sitemaps verwendet
wie im <ulink url="http://www.sitemaps.org/protocol.php">Sitemaps <acronym>XML</acronym>
Format</ulink> definiert. Mehr darüber kann unter <ulink
url="http://en.wikipedia.org/wiki/Sitemaps"> Sitemaps in Wikipedia</ulink>
nachgelesen werden.
</para>
<para>
Standardmäßig verwendet der Sitemap Helfer
<link linkend="zend.validate.sitemap">Sitemap Prüfungen</link> um jedes Element zu
prüfen das dargestellt werden soll. Das kann deaktiviert werden indem man
<code>$helper->setUseSitemapValidators(false)</code> aufruft.
</para>
<note>
<para>
Wenn man die Sitemap Prüfungen deaktiviert, werden die eigenen Eigenschaften
(siehe Tabelle) nicht geprüft.
</para>
</note>
<para>
Der Sitemap Helfer unterstützt auch die Pürfung von
<ulink url="http://www.sitemaps.org/schemas/sitemap/0.9/sitemap.xsd">Sitemap XSD
Schemas</ulink> der erzeugten Sitemap. Das ist standardmäßig deaktiviert, da es eine
Anfrage auf die Schema Datei benötigt. Es kann mit
<code>$helper->setUseSchemaValidation(true)</code> aktiviert werden.
</para>
<table id="zend.view.helpers.initial.navigation.sitemap.elements">
<title>Sitemap XML Elemente</title>
<tgroup cols="2">
<thead>
<row>
<entry>Element</entry>
<entry>Beschreibung</entry>
</row>
</thead>
<tbody>
<row>
<entry><code>loc</code></entry>
<entry>
Absolute <acronym>URL</acronym> zur Seite. Eine absolute
<acronym>URL</acronym> wird vom Helfer erzeugt.
</entry>
</row>
<row>
<entry><code>lastmod</code></entry>
<entry>
<para>
Das Datum der letzten Änderung der Datei, im
<ulink url="http://www.w3.org/TR/NOTE-datetime">W3C
Datetime</ulink> Format. Dieser Zeitabschnitt kann bei Bedarf
unterdrückt, und nur YYYY-MM-DD verwendet werden.
</para>
<para>
Der Helfer versucht den <code>lastmod</code> Wert von der
Seiteneigenschaft <code>lastmod</code> zu erhalten wenn diese auf
der Seite gesetzt ist. Wenn der Wert kein gültiges Datum ist, wird
er ignoriert.
</para>
</entry>
</row>
<row>
<entry><code>changefreq</code></entry>
<entry>
<para>
Wie oft eine Seite geändert wird. Dieser Wert bietet eine generelle
Information für Suchmaschinen und muß nicht exakt mit der Anzahl
der Suchen auf der Seite übereinstimmen. Gültige Werte sind:
</para>
<itemizedlist>
<listitem><para>always</para></listitem>
<listitem><para>hourly</para></listitem>
<listitem><para>daily</para></listitem>
<listitem><para>weekly</para></listitem>
<listitem><para>monthly</para></listitem>
<listitem><para>yearly</para></listitem>
<listitem><para>never</para></listitem>
</itemizedlist>
<para>
Der Helfer versucht den <code>changefreq</code> Wert von der
Seiteneigenschaft <code>changefreq</code> zu erhalten, wenn diese
auf der Seite gesetzt ist. Wenn der Wert nicht gültig ist, wird er
ignoriert.
</para>
</entry>
</row>
<row>
<entry><code>priority</code></entry>
<entry>
<para>
Die Priorität dieser <acronym>URL</acronym> relativ zu anderen
<acronym>URL</acronym>s auf der eigenen Site. Der gültige Bereich
für diesen Wert ist von 0.0 bis 1.0.
</para>
<para>
Der Helfer versucht den <code>priority</code> Wert von der
Seiteneigenschaft <code>priority</code> zu erhalten wenn dieser
auf der Seite gesetzt ist. Wenn der Wert nicht gültig ist, wird
er ignoriert.
</para>
</entry>
</row>
</tbody>
</tgroup>
</table>
<para>
Methoden im Sitemap Helfer:
</para>
<itemizedlist>
<listitem>
<para>
<code>{get|set}FormatOutput()</code> empfängt/setzt ein Flag das anzeigt ob
<acronym>XML</acronym> Ausgaben formatiert werden sollen. Das entspricht der
Eigenschaft <code>formatOutput</code> der nativen
<classname>DOMDocument</classname> Klasse. Mehr kann man unter <ulink
url="http://php.net/domdocument">PHP: DOMDocument - Handbuch</ulink>
nachlesen. Der Standardwert ist <constant>FALSE</constant>.
</para>
</listitem>
<listitem>
<para>
<code>{get|set}UseXmlDeclaration()</code> empfängt/setzt ein Flag das
anzeigt ob die <acronym>XML</acronym> Deklaration bei der Darstellung enthalten
sein soll. Der Standardwert ist <constant>TRUE</constant>.
</para>
</listitem>
<listitem>
<para>
<code>{get|set}UseSitemapValidators()</code> empfängt/setzt ein Flag das
anzeigt ob Sitemap Prüfungen verwendet werden sollen wenn die DOM Sitemap
dargestellt werden soll. Der Standardwert ist <constant>TRUE</constant>.
</para>
</listitem>
<listitem>
<para>
<code>{get|set}UseSchemaValidation()</code> empfängt/setzt ein Flag das
anzeigt ob der Helfer eine <acronym>XML</acronym> Schema Prüfung verwenden soll
wenn die DOM Sitemap erzeugt wird. Der Standardwert ist
<constant>FALSE</constant>. Wenn <constant>TRUE</constant>.
</para>
</listitem>
<listitem>
<para>
<code>{get|set}ServerUrl()</code> empfängt/setzt die Server
<acronym>URL</acronym> die nicht-absoluten <acronym>URL</acronym>s in der
<methodname>url()</methodname> Methode vorangestellt werden. Wenn keine Server
<acronym>URL</acronym> spezifiziert ist, wird diese vom Helfer festgestellt.
</para>
</listitem>
<listitem>
<para>
<methodname>url()</methodname> wird verwendet um absolute
<acronym>URL</acronym>s zu Seiten zu erstellen.
</para>
</listitem>
<listitem>
<para>
<methodname>getDomSitemap()</methodname> erzeugt ein DOMDocument von einem
angegebenen Container.
</para>
</listitem>
</itemizedlist>
<example id="zend.view.helpers.initial.navigation.sitemap.example">
<title>Eine XML Sitemap darstellen</title>
<para>
Dieses Beispiel zeigt wie eine <acronym>XML</acronym> Sitemap, basierend auf dem
Setup das wir vorher angegeben haben, dargestellt wird.
</para>
<programlisting language="php"><![CDATA[
// In einem View Skript oder Layout:
// Ausgabeformat
$this->navigation()
->sitemap()
->setFormatOutput(true); // Standardwert ist false
// Andere mögliche Methoden:
// ->setUseXmlDeclaration(false); // Standardwert ist true
// ->setServerUrl('http://my.otherhost.com');
// Standard ist die automatische Erkennung
// Sitemap ausdrucken
echo $this->navigation()->sitemap();
]]></programlisting>
<para>
Es ist zu beachten wie Seiten die unsichtbar oder Seiten mit <acronym>ACL</acronym>
Rollen die mit dem View Helfer inkompatibel sin, ausgefiltert werden:
</para>
<programlisting language="xml"><![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>http://www.example.com/</loc>
</url>
<url>
<loc>http://www.example.com/products</loc>
</url>
<url>
<loc>http://www.example.com/products/server</loc>
</url>
<url>
<loc>http://www.example.com/products/server/faq</loc>
</url>
<url>
<loc>http://www.example.com/products/server/editions</loc>
</url>
<url>
<loc>http://www.example.com/products/server/requirements</loc>
</url>
<url>
<loc>http://www.example.com/products/studio</loc>
</url>
<url>
<loc>http://www.example.com/products/studio/customers</loc>
</url>
<url>
<loc>http://www.example.com/prodcts/studio/support</loc>
</url>
<url>
<loc>http://www.example.com/company/about</loc>
</url>
<url>
<loc>http://www.example.com/company/about/investors</loc>
</url>
<url>
<loc>http://www.example.com/company/news</loc>
</url>
<url>
<loc>http://www.example.com/company/news/press</loc>
</url>
<url>
<loc>http://www.example.com/archive</loc>
</url>
<url>
<loc>http://www.example.com/community</loc>
</url>
<url>
<loc>http://www.example.com/community/account</loc>
</url>
<url>
<loc>http://forums.example.com/</loc>
</url>
</urlset>
]]></programlisting>
<para>
Die Sitemap ohne Verwendung einer <acronym>ACL</acronym> Rolle darstellen (sollte
/community/account ausfiltern):
</para>
<programlisting language="php"><![CDATA[
echo $this->navigation()
->sitemap()
->setFormatOutput(true)
->setRole();
]]></programlisting>
<programlisting language="xml"><![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>http://www.example.com/</loc>
</url>
<url>
<loc>http://www.example.com/products</loc>
</url>
<url>
<loc>http://www.example.com/products/server</loc>
</url>
<url>
<loc>http://www.example.com/products/server/faq</loc>
</url>
<url>
<loc>http://www.example.com/products/server/editions</loc>
</url>
<url>
<loc>http://www.example.com/products/server/requirements</loc>
</url>
<url>
<loc>http://www.example.com/products/studio</loc>
</url>
<url>
<loc>http://www.example.com/products/studio/customers</loc>
</url>
<url>
<loc>http://www.example.com/prodcts/studio/support</loc>
</url>
<url>
<loc>http://www.example.com/company/about</loc>
</url>
<url>
<loc>http://www.example.com/company/about/investors</loc>
</url>
<url>
<loc>http://www.example.com/company/news</loc>
</url>
<url>
<loc>http://www.example.com/company/news/press</loc>
</url>
<url>
<loc>http://www.example.com/archive</loc>
</url>
<url>
<loc>http://www.example.com/community</loc>
</url>
<url>
<loc>http://forums.example.com/</loc>
</url>
</urlset>
]]></programlisting>
<para>
Darstellen der Sitemap mit Verwendung einer maximalen Tiefe von 1.
</para>
<programlisting language="php"><![CDATA[
echo $this->navigation()
->sitemap()
->setFormatOutput(true)
->setMaxDepth(1);
]]></programlisting>
<programlisting language="xml"><![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>http://www.example.com/</loc>
</url>
<url>
<loc>http://www.example.com/products</loc>
</url>
<url>
<loc>http://www.example.com/products/server</loc>
</url>
<url>
<loc>http://www.example.com/products/studio</loc>
</url>
<url>
<loc>http://www.example.com/company/about</loc>
</url>
<url>
<loc>http://www.example.com/company/about/investors</loc>
</url>
<url>
<loc>http://www.example.com/company/news</loc>
</url>
<url>
<loc>http://www.example.com/community</loc>
</url>
<url>
<loc>http://www.example.com/community/account</loc>
</url>
<url>
<loc>http://forums.example.com/</loc>
</url>
</urlset>
]]></programlisting>
</example>
<note>
<title>Standardmäßig wird die UTF-8 Kodierung verwendet</title>
<para>
Standardmäßig verwendet Zend Framework <acronym>UTF-8</acronym> als seine
Standardkodierung, und speziell in diesem Fall, macht das
<classname>Zend_View</classname> genauso. Die Zeichenkodierung kann im View Objekt
selbst auf etwas anderes gesetzt werden indem die Methode
<methodname>setEncoding()</methodname> verwendet wird (oder der Parameter
<varname>encoding</varname> bei der Instanzierung angegeben wird). Trotzdem, da
<classname>Zend_View_Interface</classname> keine Zugriffsmethoden für die Kodierung
anbietet ist es möglich dass, wenn man eine eigene View Implementation verwendet,
man keine <methodname>getEncoding()</methodname> Methode hat, welche der View Helfer
intern für die Erkennung des Zeichensets verwendet in das kodiert werden soll.
</para>
<para>
Wenn man <acronym>UTF-8</acronym> in solch einer Situation nicht verwenden will,
muss man in der eigenen View Implementation eine
<methodname>getEncoding()</methodname> Methode implementieren.
</para>
</note>
</sect4>
<sect4 id="zend.view.helpers.initial.navigation.navigation">
<title>Navigation Helfer</title>
<para>
Der Navigation Helfer ist ein Proxy Helfer der Aufrufe zu anderen Navigations Helfern
durchführt. Er kann als Einstiegspunkt für alle navigations-basierenden View Tasks
verwendet werden. Die vorher erwähnten Navigations Helfer sind im Namespace
<classname>Zend_View_Helper_Navigation</classname> und würden es deshalb benötigen, den
Pfad <code>Zend/View/Helper/Navigation</code> als Helfer Pfad der View hinzuzufügen. Mit
dem Proxy Helfer der im <classname>Zend_View_Helper</classname> Namespace sitzt, ist er
immer vorhanden, ohne das irgendein Helfer Pfad an der View hinzugefügt werden muß.
</para>
<para>
Der Navigations Helfer findet andere Helfer die das
<classname>Zend_View_Helper_Navigation_Helper</classname> Interface implementieren,
was bedeuet das auch auf eigene View Helfer weitergeleitet wird. Das würde trotzdem
das Hinzufügen des eigenen Helfer Pfades zur View benötigen.
</para>
<para>
Wenn auf andere Helfer weitergeleitet wird, kann der Navigations Helfer seinen
Container, <acronym>ACL</acronym>/Rolle und Übersetzer injizieren. Das bedeutet weder
das man diese drei nicht explizit in allen navigatorischen Helfern setzen muß, noch das
diese in <classname>Zend_Registry</classname> oder in statische Methoden injiziert
werden muß.
</para>
<itemizedlist>
<listitem>
<para>
<methodname>findHelper()</methodname> findet alle angegebenen Helfer, prüft das
dieser ein navigatorischer Helfer ist, und injiziiert Container,
<acronym>ACL</acronym>/Rolle und Übersetzer.
</para>
</listitem>
<listitem>
<para>
<code>{get|set}InjectContainer()</code> empfängt/setzt ein Flag das anzeigt
ob der Container an weitergeleitete Helfer injiziiert werden soll. Der
Standardwert ist <constant>TRUE</constant>.
</para>
</listitem>
<listitem>
<para>
<code>{get|set}InjectAcl()</code> empfängt/setzt ein Flag das anzeigt ob die
<acronym>ACL</acronym>/Rolle an weitergeleitete Helfer injiziiert werden soll.
Der Standardwert ist <constant>TRUE</constant>.
</para>
</listitem>
<listitem>
<para>
<code>{get|set}InjectTranslator()</code> empfängt/setzt ein Flag das anzeigt
ob der Übersetzer an weitergeleitete Helfer injiziiert werden soll. Der
Standardwert ist <constant>TRUE</constant>.
</para>
</listitem>
<listitem>
<para>
<code>{get|set}DefaultProxy()</code> empfängt/setzt den Standard Proxy. Der
Standardwert ist <code>'menu'</code>.
</para>
</listitem>
<listitem>
<para>
<methodname>render()</methodname> leitet auf die render Methode des
Standardproxies weiter.
</para>
</listitem>
</itemizedlist>
</sect4>
</sect3>
|