/usr/share/php/PHP/CodeSniffer/File.php is in php-codesniffer 1.5.5-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 | <?php
/**
* A PHP_CodeSniffer_File object represents a PHP source file and the tokens
* associated with it.
*
* PHP version 5
*
* @category PHP
* @package PHP_CodeSniffer
* @author Greg Sherwood <gsherwood@squiz.net>
* @author Marc McIntyre <mmcintyre@squiz.net>
* @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600)
* @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
* @link http://pear.php.net/package/PHP_CodeSniffer
*/
/**
* A PHP_CodeSniffer_File object represents a PHP source file and the tokens
* associated with it.
*
* It provides a means for traversing the token stack, along with
* other token related operations. If a PHP_CodeSniffer_Sniff finds and error or
* warning within a PHP_CodeSniffer_File, you can raise an error using the
* addError() or addWarning() methods.
*
* <b>Token Information</b>
*
* Each token within the stack contains information about itself:
*
* <code>
* array(
* 'code' => 301, // the token type code (see token_get_all())
* 'content' => 'if', // the token content
* 'type' => 'T_IF', // the token name
* 'line' => 56, // the line number when the token is located
* 'column' => 12, // the column in the line where this token
* // starts (starts from 1)
* 'level' => 2 // the depth a token is within the scopes open
* 'conditions' => array( // a list of scope condition token
* // positions => codes that
* 2 => 50, // openened the scopes that this token exists
* 9 => 353, // in (see conditional tokens section below)
* ),
* );
* </code>
*
* <b>Conditional Tokens</b>
*
* In addition to the standard token fields, conditions contain information to
* determine where their scope begins and ends:
*
* <code>
* array(
* 'scope_condition' => 38, // the token position of the condition
* 'scope_opener' => 41, // the token position that started the scope
* 'scope_closer' => 70, // the token position that ended the scope
* );
* </code>
*
* The condition, the scope opener and the scope closer each contain this
* information.
*
* <b>Parenthesis Tokens</b>
*
* Each parenthesis token (T_OPEN_PARENTHESIS and T_CLOSE_PARENTHESIS) has a
* reference to their opening and closing parenthesis, one being itself, the
* other being its opposite.
*
* <code>
* array(
* 'parenthesis_opener' => 34,
* 'parenthesis_closer' => 40,
* );
* </code>
*
* Some tokens can "own" a set of parenthesis. For example a T_FUNCTION token
* has parenthesis around its argument list. These tokens also have the
* parenthesis_opener and and parenthesis_closer indices. Not all parenthesis
* have owners, for example parenthesis used for arithmetic operations and
* function calls. The parenthesis tokens that have an owner have the following
* auxiliary array indices.
*
* <code>
* array(
* 'parenthesis_opener' => 34,
* 'parenthesis_closer' => 40,
* 'parenthesis_owner' => 33,
* );
* </code>
*
* Each token within a set of parenthesis also has an array indice
* 'nested_parenthesis' which is an array of the
* left parenthesis => right parenthesis token positions.
*
* <code>
* 'nested_parenthesis' => array(
* 12 => 15
* 11 => 14
* );
* </code>
*
* <b>Extended Tokens</b>
*
* PHP_CodeSniffer extends and augments some of the tokens created by
* <i>token_get_all()</i>. A full list of these tokens can be seen in the
* <i>Tokens.php</i> file.
*
* @category PHP
* @package PHP_CodeSniffer
* @author Greg Sherwood <gsherwood@squiz.net>
* @author Marc McIntyre <mmcintyre@squiz.net>
* @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600)
* @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
* @version Release: 1.5.5
* @link http://pear.php.net/package/PHP_CodeSniffer
*/
class PHP_CodeSniffer_File
{
/**
* The absolute path to the file associated with this object.
*
* @var string
*/
private $_file = '';
/**
* The EOL character this file uses.
*
* @var string
*/
public $eolChar = '';
/**
* The PHP_CodeSniffer object controlling this run.
*
* @var PHP_CodeSniffer
*/
public $phpcs = null;
/**
* The tokenizer being used for this file.
*
* @var object
*/
public $tokenizer = null;
/**
* The tokenizer being used for this file.
*
* @var string
*/
public $tokenizerType = 'PHP';
/**
* The number of tokens in this file.
*
* Stored here to save calling count() everywhere.
*
* @var int
*/
public $numTokens = 0;
/**
* The tokens stack map.
*
* Note that the tokens in this array differ in format to the tokens
* produced by token_get_all(). Tokens are initially produced with
* token_get_all(), then augmented so that it's easier to process them.
*
* @var array()
* @see Tokens.php
*/
private $_tokens = array();
/**
* The errors raised from PHP_CodeSniffer_Sniffs.
*
* @var array()
* @see getErrors()
*/
private $_errors = array();
/**
* The warnings raised form PHP_CodeSniffer_Sniffs.
*
* @var array()
* @see getWarnings()
*/
private $_warnings = array();
/**
* Record the errors and warnings raised.
*
* @var bool
*/
private $_recordErrors = true;
/**
* And array of lines being ignored by PHP_CodeSniffer.
*
* @var array()
*/
private $_ignoredLines = array();
/**
* The total number of errors raised.
*
* @var int
*/
private $_errorCount = 0;
/**
* The total number of warnings raised.
*
* @var int
*/
private $_warningCount = 0;
/**
* An array of sniffs listening to this file's processing.
*
* @var array(PHP_CodeSniffer_Sniff)
*/
private $_listeners = array();
/**
* The class name of the sniff currently processing the file.
*
* @var string
*/
private $_activeListener = '';
/**
* An array of sniffs being processed and how long they took.
*
* @var array()
*/
private $_listenerTimes = array();
/**
* An array of extensions mapping to the tokenizer to use.
*
* This value gets set by PHP_CodeSniffer when the object is created.
*
* @var array
*/
protected $tokenizers = array();
/**
* An array of rules from the ruleset.xml file.
*
* This value gets set by PHP_CodeSniffer when the object is created.
* It may be empty, indicating that the ruleset does not override
* any of the default sniff settings.
*
* @var array
*/
protected $ruleset = array();
/**
* An array of sniff codes to restrict violations to.
*
* This value gets set by PHP_CodeSniffer when the object is created.
* It may be empty, indicating that no fitering should take place.
*
* @var array
*/
protected $restrictions = array();
/**
* Constructs a PHP_CodeSniffer_File.
*
* @param string $file The absolute path to the file to process.
* @param array(string) $listeners The initial listeners listening
* to processing of this file.
* @param array $tokenizers An array of extensions mapping
* to the tokenizer to use.
* @param array $ruleset An array of rules from the
* ruleset.xml file.
* @param array $restrictions An array of sniff codes to
* restrict violations to.
* @param PHP_CodeSniffer $phpcs The PHP_CodeSniffer object controlling
* this run.
*
* @throws PHP_CodeSniffer_Exception If the register() method does
* not return an array.
*/
public function __construct(
$file,
array $listeners,
array $tokenizers,
array $ruleset,
array $restrictions,
PHP_CodeSniffer $phpcs
) {
$this->_file = trim($file);
$this->_listeners = $listeners;
$this->tokenizers = $tokenizers;
$this->ruleset = $ruleset;
$this->restrictions = $restrictions;
$this->phpcs = $phpcs;
$cliValues = $phpcs->cli->getCommandLineValues();
if (isset($cliValues['showSources']) === true
&& $cliValues['showSources'] !== true
&& array_key_exists('summary', $cliValues['reports']) === true
&& count($cliValues['reports']) === 1
) {
$this->_recordErrors = false;
}
}//end __construct()
/**
* Sets the name of the currently active sniff.
*
* @param string $activeListener The class name of the current sniff.
*
* @return void
*/
public function setActiveListener($activeListener)
{
$this->_activeListener = $activeListener;
}//end setActiveListener()
/**
* Adds a listener to the token stack that listens to the specific tokens.
*
* When PHP_CodeSniffer encounters on the the tokens specified in $tokens,
* it invokes the process method of the sniff.
*
* @param PHP_CodeSniffer_Sniff $listener The listener to add to the
* listener stack.
* @param array(int) $tokens The token types the listener wishes to
* listen to.
*
* @return void
*/
public function addTokenListener(PHP_CodeSniffer_Sniff $listener, array $tokens)
{
foreach ($tokens as $token) {
if (isset($this->_listeners[$token]) === false) {
$this->_listeners[$token] = array();
}
if (in_array($listener, $this->_listeners[$token], true) === false) {
$this->_listeners[$token][] = $listener;
}
}
}//end addTokenListener()
/**
* Removes a listener from listening from the specified tokens.
*
* @param PHP_CodeSniffer_Sniff $listener The listener to remove from the
* listener stack.
* @param array(int) $tokens The token types the listener wishes to
* stop listen to.
*
* @return void
*/
public function removeTokenListener(
PHP_CodeSniffer_Sniff $listener,
array $tokens
) {
foreach ($tokens as $token) {
if (isset($this->_listeners[$token]) === false) {
continue;
}
if (in_array($listener, $this->_listeners[$token]) === true) {
foreach ($this->_listeners[$token] as $pos => $value) {
if ($value === $listener) {
unset($this->_listeners[$token][$pos]);
}
}
}
}
}//end removeTokenListener()
/**
* Returns the token stack for this file.
*
* @return array
*/
public function getTokens()
{
return $this->_tokens;
}//end getTokens()
/**
* Starts the stack traversal and tells listeners when tokens are found.
*
* @param string $contents The contents to parse. If NULL, the content
* is taken from the file system.
*
* @return void
*/
public function start($contents=null)
{
$this->_parse($contents);
if (PHP_CODESNIFFER_VERBOSITY > 2) {
echo "\t*** START TOKEN PROCESSING ***".PHP_EOL;
}
$foundCode = false;
$ignoring = false;
// Foreach of the listeners that have registered to listen for this
// token, get them to process it.
foreach ($this->_tokens as $stackPtr => $token) {
// Check for ignored lines.
if ($token['code'] === T_COMMENT || $token['code'] === T_DOC_COMMENT) {
if (strpos($token['content'], '@codingStandardsIgnoreStart') !== false) {
$ignoring = true;
} else if (strpos($token['content'], '@codingStandardsIgnoreEnd') !== false) {
$ignoring = false;
// Ignore this comment too.
$this->_ignoredLines[$token['line']] = true;
} else if (strpos($token['content'], '@codingStandardsIgnoreFile') !== false) {
// Ignoring the whole file, just a little late.
$this->_errors = array();
$this->_warnings = array();
$this->_errorCount = 0;
$this->_warningCount = 0;
return;
} else if (strpos($token['content'], '@codingStandardsChangeSetting') !== false) {
$start = strpos($token['content'], '@codingStandardsChangeSetting');
$comment = substr($token['content'], $start + 30);
$parts = explode(' ', $comment);
$sniffParts = explode('.', $parts[0]);
$listenerClass = $sniffParts[0].'_Sniffs_'.$sniffParts[1].'_'.$sniffParts[2].'Sniff';
$this->phpcs->setSniffProperty($listenerClass, $parts[1], $parts[2]);
}
}
if ($ignoring === true) {
$this->_ignoredLines[$token['line']] = true;
continue;
}
if (PHP_CODESNIFFER_VERBOSITY > 2) {
$type = $token['type'];
$content = str_replace($this->eolChar, '\n', $token['content']);
echo "\t\tProcess token $stackPtr: $type => $content".PHP_EOL;
}
$tokenType = $token['code'];
if ($tokenType !== T_INLINE_HTML) {
$foundCode = true;
}
if (isset($this->_listeners[$tokenType]) === false) {
continue;
}
foreach ($this->_listeners[$tokenType] as $listenerData) {
// Make sure this sniff supports the tokenizer
// we are currently using.
$listener = $listenerData['listener'];
$class = $listenerData['class'];
if (in_array($this->tokenizerType, $listenerData['tokenizers']) === false) {
continue;
}
// If the file path matches one of our ignore patterns, skip it.
$parts = explode('_', str_replace('\\', '_', $class));
if (isset($parts[3]) === true) {
$source = $parts[0].'.'.$parts[2].'.'.substr($parts[3], 0, -5);
$patterns = $this->phpcs->getIgnorePatterns($source);
foreach ($patterns as $pattern => $type) {
// While there is support for a type of each pattern
// (absolute or relative) we don't actually support it here.
$replacements = array(
'\\,' => ',',
'*' => '.*',
);
$pattern = strtr($pattern, $replacements);
if (preg_match("|{$pattern}|i", $this->_file) === 1) {
continue(2);
}
}
}
$this->setActiveListener($class);
if (PHP_CODESNIFFER_VERBOSITY > 2) {
$startTime = microtime(true);
echo "\t\t\tProcessing ".$this->_activeListener.'... ';
}
$listener->process($this, $stackPtr);
if (PHP_CODESNIFFER_VERBOSITY > 2) {
$timeTaken = (microtime(true) - $startTime);
if (isset($this->_listenerTimes[$this->_activeListener]) === false) {
$this->_listenerTimes[$this->_activeListener] = 0;
}
$this->_listenerTimes[$this->_activeListener] += $timeTaken;
$timeTaken = round(($timeTaken), 4);
echo "DONE in $timeTaken seconds".PHP_EOL;
}
$this->_activeListener = '';
}//end foreach
}//end foreach
// Remove errors and warnings for ignored lines.
foreach ($this->_ignoredLines as $line => $ignore) {
if (isset($this->_errors[$line]) === true) {
if ($this->_recordErrors === false) {
$this->_errorCount -= $this->_errors[$line];
} else {
foreach ($this->_errors[$line] as $col => $errors) {
$this->_errorCount -= count($errors);
}
}
unset($this->_errors[$line]);
}
if (isset($this->_warnings[$line]) === true) {
if ($this->_recordErrors === false) {
$this->_errorCount -= $this->_warnings[$line];
} else {
foreach ($this->_warnings[$line] as $col => $warnings) {
$this->_warningCount -= count($warnings);
}
}
unset($this->_warnings[$line]);
}
}//end foreach
if ($this->_recordErrors === false) {
$this->_errors = array();
$this->_warnings = array();
}
// If short open tags are off but the file being checked uses
// short open tags, the whole content will be inline HTML
// and nothing will be checked. So try and handle this case.
if ($foundCode === false) {
$shortTags = (bool) ini_get('short_open_tag');
if ($shortTags === false) {
$error = 'No PHP code was found in this file and short open tags are not allowed by this install of PHP. This file may be using short open tags but PHP does not allow them.';
$this->addWarning($error, null, 'Internal.NoCodeFound');
}
}
if (PHP_CODESNIFFER_VERBOSITY > 2) {
echo "\t*** END TOKEN PROCESSING ***".PHP_EOL;
}
if (PHP_CODESNIFFER_VERBOSITY > 2) {
echo "\t*** START SNIFF PROCESSING REPORT ***".PHP_EOL;
asort($this->_listenerTimes, SORT_NUMERIC);
$this->_listenerTimes = array_reverse($this->_listenerTimes, true);
foreach ($this->_listenerTimes as $listener => $timeTaken) {
echo "\t$listener: ".round(($timeTaken), 4).' secs'.PHP_EOL;
}
echo "\t*** END SNIFF PROCESSING REPORT ***".PHP_EOL;
}
}//end start()
/**
* Remove vars stored in this sniff that are no longer required.
*
* @return void
*/
public function cleanUp()
{
$this->_tokens = null;
$this->_listeners = null;
}//end cleanUp()
/**
* Tokenizes the file and prepares it for the test run.
*
* @param string $contents The contents to parse. If NULL, the content
* is taken from the file system.
*
* @return void
*/
private function _parse($contents=null)
{
try {
$this->eolChar = self::detectLineEndings($this->_file, $contents);
} catch (PHP_CodeSniffer_Exception $e) {
$this->addWarning($e->getMessage(), null, 'Internal.DetectLineEndings');
return;
}
// Determine the tokenizer from the file extension.
$fileParts = explode('.', $this->_file);
$extension = array_pop($fileParts);
if (isset($this->tokenizers[$extension]) === true) {
$tokenizerClass = 'PHP_CodeSniffer_Tokenizers_'.$this->tokenizers[$extension];
$this->tokenizerType = $this->tokenizers[$extension];
} else {
// Revert to default.
$tokenizerClass = 'PHP_CodeSniffer_Tokenizers_'.$this->tokenizerType;
}
$tokenizer = new $tokenizerClass();
$this->tokenizer = $tokenizer;
if ($contents === null) {
$contents = file_get_contents($this->_file);
}
$this->_tokens = self::tokenizeString($contents, $tokenizer, $this->eolChar);
$this->numTokens = count($this->_tokens);
// Check for mixed line endings as these can cause tokenizer errors and we
// should let the user know that the results they get may be incorrect.
// This is done by removing all backslashes, removing the newline char we
// detected, then converting newlines chars into text. If any backslashes
// are left at the end, we have additional newline chars in use.
$contents = str_replace('\\', '', $contents);
$contents = str_replace($this->eolChar, '', $contents);
$contents = str_replace("\n", '\n', $contents);
$contents = str_replace("\r", '\r', $contents);
if (strpos($contents, '\\') !== false) {
$error = 'File has mixed line endings; this may cause incorrect results';
$this->addWarning($error, 0, 'Internal.LineEndings.Mixed');
}
if (PHP_CODESNIFFER_VERBOSITY > 0) {
if ($this->numTokens === 0) {
$numLines = 0;
} else {
$numLines = $this->_tokens[($this->numTokens - 1)]['line'];
}
echo "[$this->numTokens tokens in $numLines lines]... ";
if (PHP_CODESNIFFER_VERBOSITY > 1) {
echo PHP_EOL;
}
}
}//end _parse()
/**
* Opens a file and detects the EOL character being used.
*
* @param string $file The full path to the file.
* @param string $contents The contents to parse. If NULL, the content
* is taken from the file system.
*
* @return string
* @throws PHP_CodeSniffer_Exception If $file could not be opened.
*/
public static function detectLineEndings($file, $contents=null)
{
if ($contents === null) {
// Determine the newline character being used in this file.
// Will be either \r, \r\n or \n.
if (is_readable($file) === false) {
$error = 'Error opening file; file no longer exists or you do not have access to read the file';
throw new PHP_CodeSniffer_Exception($error);
} else {
$handle = fopen($file, 'r');
if ($handle === false) {
$error = 'Error opening file; could not auto-detect line endings';
throw new PHP_CodeSniffer_Exception($error);
}
}
$firstLine = fgets($handle);
fclose($handle);
$eolChar = substr($firstLine, -1);
if ($eolChar === "\n") {
$secondLastChar = substr($firstLine, -2, 1);
if ($secondLastChar === "\r") {
$eolChar = "\r\n";
}
} else if ($eolChar !== "\r") {
// Must not be an EOL char at the end of the line.
// Probably a one-line file, so assume \n as it really
// doesn't matter considering there are no newlines.
$eolChar = "\n";
}
} else {
if (preg_match("/\r\n?|\n/", $contents, $matches) !== 1) {
// Assuming there are no newlines.
$eolChar = "\n";
} else {
$eolChar = $matches[0];
}
}//end if
return $eolChar;
}//end detectLineEndings()
/**
* Adds an error to the error stack.
*
* @param string $error The error message.
* @param int $stackPtr The stack position where the error occurred.
* @param string $code A violation code unique to the sniff message.
* @param array $data Replacements for the error message.
* @param int $severity The severity level for this error. A value of 0
* will be converted into the default severity level.
*
* @return void
*/
public function addError($error, $stackPtr, $code='', $data=array(), $severity=0)
{
// Work out which sniff generated the error.
if (substr($code, 0, 9) === 'Internal.') {
// Any internal message.
$sniff = $code;
$sniffCode = $code;
} else {
$parts = explode('_', str_replace('\\', '_', $this->_activeListener));
if (isset($parts[3]) === true) {
$sniff = $parts[0].'.'.$parts[2].'.'.$parts[3];
// Remove "Sniff" from the end.
$sniff = substr($sniff, 0, -5);
} else {
$sniff = 'unknownSniff';
}
$sniffCode = $sniff;
if ($code !== '') {
$sniffCode .= '.'.$code;
}
}//end if
// Make sure this message type is allowed based on the --sniffs
// command line argument values.
if (empty($this->restrictions) === false
&& in_array($sniffCode, $this->restrictions) === false
&& in_array($sniff, $this->restrictions) === false
) {
return;
}
// Make sure this message type has not been set to "warning".
if (isset($this->ruleset[$sniffCode]['type']) === true
&& $this->ruleset[$sniffCode]['type'] === 'warning'
) {
// Pass this off to the warning handler.
$this->addWarning($error, $stackPtr, $code, $data, $severity);
return;
} else if ($this->phpcs->cli->errorSeverity === 0) {
// Don't bother doing any processing as errors are just going to
// be hidden in the reports anyway.
return;
}
// Make sure we are interested in this severity level.
if (isset($this->ruleset[$sniffCode]['severity']) === true) {
$severity = $this->ruleset[$sniffCode]['severity'];
} else if ($severity === 0) {
$severity = PHPCS_DEFAULT_ERROR_SEV;
}
if ($this->phpcs->cli->errorSeverity > $severity) {
return;
}
// Make sure we are not ignoring this file.
$patterns = $this->phpcs->getIgnorePatterns($sniffCode);
foreach ($patterns as $pattern => $type) {
// While there is support for a type of each pattern
// (absolute or relative) we don't actually support it here.
$replacements = array(
'\\,' => ',',
'*' => '.*',
);
$pattern = strtr($pattern, $replacements);
if (preg_match("|{$pattern}|i", $this->_file) === 1) {
return;
}
}
if ($stackPtr === null) {
$lineNum = 1;
$column = 1;
} else {
$lineNum = $this->_tokens[$stackPtr]['line'];
$column = $this->_tokens[$stackPtr]['column'];
}
$this->_errorCount++;
if ($this->_recordErrors === false) {
if (isset($this->_errors[$lineNum]) === false) {
$this->_errors[$lineNum] = 0;
}
$this->_errors[$lineNum]++;
return;
}
// Work out the warning message.
if (isset($this->ruleset[$sniffCode]['message']) === true) {
$error = $this->ruleset[$sniffCode]['message'];
}
if (empty($data) === true) {
$message = $error;
} else {
$message = vsprintf($error, $data);
}
if (isset($this->_errors[$lineNum]) === false) {
$this->_errors[$lineNum] = array();
}
if (isset($this->_errors[$lineNum][$column]) === false) {
$this->_errors[$lineNum][$column] = array();
}
$this->_errors[$lineNum][$column][] = array(
'message' => $message,
'source' => $sniffCode,
'severity' => $severity,
);
}//end addError()
/**
* Adds an warning to the warning stack.
*
* @param string $warning The error message.
* @param int $stackPtr The stack position where the error occurred.
* @param string $code A violation code unique to the sniff message.
* @param array $data Replacements for the warning message.
* @param int $severity The severity level for this warning. A value of 0
* will be converted into the default severity level.
*
* @return void
*/
public function addWarning($warning, $stackPtr, $code='', $data=array(), $severity=0)
{
// Work out which sniff generated the warning.
if (substr($code, 0, 9) === 'Internal.') {
// Any internal message.
$sniff = $code;
$sniffCode = $code;
} else {
$parts = explode('_', str_replace('\\', '_', $this->_activeListener));
if (isset($parts[3]) === true) {
$sniff = $parts[0].'.'.$parts[2].'.'.$parts[3];
// Remove "Sniff" from the end.
$sniff = substr($sniff, 0, -5);
} else {
$sniff = 'unknownSniff';
}
$sniffCode = $sniff;
if ($code !== '') {
$sniffCode .= '.'.$code;
}
}//end if
// Make sure this message type is allowed based on the --sniffs
// command line argument values.
if (empty($this->restrictions) === false
&& in_array($sniffCode, $this->restrictions) === false
&& in_array($sniff, $this->restrictions) === false
) {
return;
}
// Make sure this message type has not been set to "error".
if (isset($this->ruleset[$sniffCode]['type']) === true
&& $this->ruleset[$sniffCode]['type'] === 'error'
) {
// Pass this off to the error handler.
$this->addError($warning, $stackPtr, $code, $data, $severity);
return;
} else if ($this->phpcs->cli->warningSeverity === 0) {
// Don't bother doing any processing as warnings are just going to
// be hidden in the reports anyway.
return;
}
// Make sure we are interested in this severity level.
if (isset($this->ruleset[$sniffCode]['severity']) === true) {
$severity = $this->ruleset[$sniffCode]['severity'];
} else if ($severity === 0) {
$severity = PHPCS_DEFAULT_WARN_SEV;
}
if ($this->phpcs->cli->warningSeverity > $severity) {
return;
}
// Make sure we are not ignoring this file.
$patterns = $this->phpcs->getIgnorePatterns($sniffCode);
foreach ($patterns as $pattern => $type) {
// While there is support for a type of each pattern
// (absolute or relative) we don't actually support it here.
$replacements = array(
'\\,' => ',',
'*' => '.*',
);
$pattern = strtr($pattern, $replacements);
if (preg_match("|{$pattern}|i", $this->_file) === 1) {
return;
}
}
if ($stackPtr === null) {
$lineNum = 1;
$column = 1;
} else {
$lineNum = $this->_tokens[$stackPtr]['line'];
$column = $this->_tokens[$stackPtr]['column'];
}
$this->_warningCount++;
if ($this->_recordErrors === false) {
if (isset($this->_warnings[$lineNum]) === false) {
$this->_warnings[$lineNum] = 0;
}
$this->_warnings[$lineNum]++;
return;
}
// Work out the warning message.
if (isset($this->ruleset[$sniffCode]['message']) === true) {
$warning = $this->ruleset[$sniffCode]['message'];
}
if (empty($data) === true) {
$message = $warning;
} else {
$message = vsprintf($warning, $data);
}
if (isset($this->_warnings[$lineNum]) === false) {
$this->_warnings[$lineNum] = array();
}
if (isset($this->_warnings[$lineNum][$column]) === false) {
$this->_warnings[$lineNum][$column] = array();
}
$this->_warnings[$lineNum][$column][] = array(
'message' => $message,
'source' => $sniffCode,
'severity' => $severity,
);
}//end addWarning()
/**
* Returns the number of errors raised.
*
* @return int
*/
public function getErrorCount()
{
return $this->_errorCount;
}//end getErrorCount()
/**
* Returns the number of warnings raised.
*
* @return int
*/
public function getWarningCount()
{
return $this->_warningCount;
}//end getWarningCount()
/**
* Returns the list of ignored lines.
*
* @return array
*/
public function getIgnoredLines()
{
return $this->_ignoredLines;
}//end getIgnoredLines()
/**
* Returns the errors raised from processing this file.
*
* @return array
*/
public function getErrors()
{
return $this->_errors;
}//end getErrors()
/**
* Returns the warnings raised from processing this file.
*
* @return array
*/
public function getWarnings()
{
return $this->_warnings;
}//end getWarnings()
/**
* Returns the absolute filename of this file.
*
* @return string
*/
public function getFilename()
{
return $this->_file;
}//end getFilename()
/**
* Creates an array of tokens when given some PHP code.
*
* Starts by using token_get_all() but does a lot of extra processing
* to insert information about the context of the token.
*
* @param string $string The string to tokenize.
* @param object $tokenizer A tokenizer class to use to tokenize the string.
* @param string $eolChar The EOL character to use for splitting strings.
*
* @return array
*/
public static function tokenizeString($string, $tokenizer, $eolChar='\n')
{
$tokens = $tokenizer->tokenizeString($string, $eolChar);
self::_createLineMap($tokens, $tokenizer, $eolChar);
self::_createBracketMap($tokens, $tokenizer, $eolChar);
self::_createParenthesisMap($tokens, $tokenizer, $eolChar);
self::_createParenthesisNestingMap($tokens, $tokenizer, $eolChar);
self::_createScopeMap($tokens, $tokenizer, $eolChar);
// If we know the width of each tab, convert tabs
// into spaces so sniffs can use one method of checking.
if (PHP_CODESNIFFER_TAB_WIDTH > 0) {
self::_convertTabs($tokens, $tokenizer, $eolChar);
}
// Column map requires the line map to be complete.
self::_createColumnMap($tokens, $tokenizer, $eolChar);
self::_createLevelMap($tokens, $tokenizer, $eolChar);
// Allow the tokenizer to do additional processing if required.
$tokenizer->processAdditional($tokens, $eolChar);
return $tokens;
}//end tokenizeString()
/**
* Creates a map of tokens => line numbers for each token.
*
* @param array $tokens The array of tokens to process.
* @param object $tokenizer The tokenizer being used to process this file.
* @param string $eolChar The EOL character to use for splitting strings.
*
* @return void
*/
private static function _createLineMap(&$tokens, $tokenizer, $eolChar)
{
$lineNumber = 1;
$count = count($tokens);
for ($i = 0; $i < $count; $i++) {
$tokens[$i]['line'] = $lineNumber;
if ($tokens[$i]['content'] === '') {
continue;
}
$lineNumber += substr_count($tokens[$i]['content'], $eolChar);
}
}//end _createLineMap()
/**
* Converts tabs into spaces.
*
* Each tab can represent between 1 and $width spaces, so
* this cannot be a straight string replace.
*
* @param array $tokens The array of tokens to process.
* @param object $tokenizer The tokenizer being used to process this file.
* @param string $eolChar The EOL character to use for splitting strings.
*
* @return void
*/
private static function _convertTabs(&$tokens, $tokenizer, $eolChar)
{
$currColumn = 1;
$count = count($tokens);
for ($i = 0; $i < $count; $i++) {
$tokenContent = $tokens[$i]['content'];
if (strpos($tokenContent, "\t") === false) {
// There are no tabs in this content.
$currColumn += strlen($tokenContent);
} else {
// We need to determine the length of each tab.
$tabs = preg_split(
"|(\t)|",
$tokenContent,
-1,
PREG_SPLIT_DELIM_CAPTURE
);
$tabNum = 0;
$tabsToSpaces = array();
$newContent = '';
foreach ($tabs as $content) {
if ($content === '') {
continue;
}
if (strpos($content, "\t") === false) {
// This piece of content is not a tab.
$currColumn += strlen($content);
$newContent .= $content;
} else {
$lastCurrColumn = $currColumn;
$tabNum++;
// Move the pointer to the next tab stop.
if (($currColumn % PHP_CODESNIFFER_TAB_WIDTH) === 0) {
// This is the first tab, and we are already at a
// tab stop, so this tab counts as a single space.
$currColumn++;
} else {
$currColumn++;
while (($currColumn % PHP_CODESNIFFER_TAB_WIDTH) != 0) {
$currColumn++;
}
$currColumn++;
}
$length = ($currColumn - $lastCurrColumn);
$newContent .= str_repeat(' ', $length);
}//end if
}//end foreach
$tokens[$i]['content'] = $newContent;
}//end if
if (isset($tokens[($i + 1)]['line']) === true
&& $tokens[($i + 1)]['line'] !== $tokens[$i]['line']
) {
$currColumn = 1;
}
}//end for
}//end _convertTabs()
/**
* Creates a column map.
*
* The column map indicates where the token started on the line where it
* exists.
*
* @param array $tokens The array of tokens to process.
* @param object $tokenizer The tokenizer being used to process this file.
* @param string $eolChar The EOL character to use for splitting strings.
*
* @return void
*/
private static function _createColumnMap(&$tokens, $tokenizer, $eolChar)
{
$currColumn = 1;
$count = count($tokens);
for ($i = 0; $i < $count; $i++) {
$tokens[$i]['column'] = $currColumn;
if (isset($tokens[($i + 1)]['line']) === true
&& $tokens[($i + 1)]['line'] !== $tokens[$i]['line']
) {
$currColumn = 1;
} else {
$currColumn += strlen($tokens[$i]['content']);
}
}
}//end _createColumnMap()
/**
* Creates a map for opening and closing of square brackets.
*
* Each bracket token (T_OPEN_SQUARE_BRACKET and T_CLOSE_SQUARE_BRACKET)
* has a reference to their opening and closing bracket
* (bracket_opener and bracket_closer).
*
* @param array $tokens The array of tokens to process.
* @param object $tokenizer The tokenizer being used to process this file.
* @param string $eolChar The EOL character to use for splitting strings.
*
* @return void
*/
private static function _createBracketMap(&$tokens, $tokenizer, $eolChar)
{
if (PHP_CODESNIFFER_VERBOSITY > 1) {
echo "\t*** START BRACKET MAP ***".PHP_EOL;
}
$squareOpeners = array();
$curlyOpeners = array();
$numTokens = count($tokens);
for ($i = 0; $i < $numTokens; $i++) {
switch ($tokens[$i]['code']) {
case T_OPEN_SQUARE_BRACKET:
$squareOpeners[] = $i;
if (PHP_CODESNIFFER_VERBOSITY > 1) {
echo str_repeat("\t", count($squareOpeners));
echo str_repeat("\t", count($curlyOpeners));
echo "=> Found square bracket opener at $i".PHP_EOL;
}
break;
case T_OPEN_CURLY_BRACKET:
if (isset($tokens[$i]['scope_closer']) === false) {
$curlyOpeners[] = $i;
if (PHP_CODESNIFFER_VERBOSITY > 1) {
echo str_repeat("\t", count($squareOpeners));
echo str_repeat("\t", count($curlyOpeners));
echo "=> Found curly bracket opener at $i".PHP_EOL;
}
}
break;
case T_CLOSE_SQUARE_BRACKET:
if (empty($squareOpeners) === false) {
$opener = array_pop($squareOpeners);
$tokens[$i]['bracket_opener'] = $opener;
$tokens[$i]['bracket_closer'] = $i;
$tokens[$opener]['bracket_opener'] = $opener;
$tokens[$opener]['bracket_closer'] = $i;
if (PHP_CODESNIFFER_VERBOSITY > 1) {
echo str_repeat("\t", count($squareOpeners));
echo str_repeat("\t", count($curlyOpeners));
echo "\t=> Found square bracket closer at $i for $opener".PHP_EOL;
}
}
break;
case T_CLOSE_CURLY_BRACKET:
if (empty($curlyOpeners) === false
&& isset($tokens[$i]['scope_opener']) === false
) {
$opener = array_pop($curlyOpeners);
$tokens[$i]['bracket_opener'] = $opener;
$tokens[$i]['bracket_closer'] = $i;
$tokens[$opener]['bracket_opener'] = $opener;
$tokens[$opener]['bracket_closer'] = $i;
if (PHP_CODESNIFFER_VERBOSITY > 1) {
echo str_repeat("\t", count($squareOpeners));
echo str_repeat("\t", count($curlyOpeners));
echo "\t=> Found curly bracket closer at $i for $opener".PHP_EOL;
}
}
break;
default:
continue;
}//end switch
}//end for
if (PHP_CODESNIFFER_VERBOSITY > 1) {
echo "\t*** END BRACKET MAP ***".PHP_EOL;
}
}//end _createBracketMap()
/**
* Creates a map for opening and closing of parenthesis.
*
* Each parenthesis token (T_OPEN_PARENTHESIS and T_CLOSE_PARENTHESIS) has a
* reference to their opening and closing parenthesis (parenthesis_opener
* and parenthesis_closer).
*
* @param array $tokens The array of tokens to process.
* @param object $tokenizer The tokenizer being used to process this file.
* @param string $eolChar The EOL character to use for splitting strings.
*
* @return void
*/
private static function _createParenthesisMap(&$tokens, $tokenizer, $eolChar)
{
$openers = array();
$numTokens = count($tokens);
$openOwner = null;
for ($i = 0; $i < $numTokens; $i++) {
if (in_array($tokens[$i]['code'], PHP_CodeSniffer_Tokens::$parenthesisOpeners) === true) {
$tokens[$i]['parenthesis_opener'] = null;
$tokens[$i]['parenthesis_closer'] = null;
$tokens[$i]['parenthesis_owner'] = $i;
$openOwner = $i;
} else if ($tokens[$i]['code'] === T_OPEN_PARENTHESIS) {
$openers[] = $i;
$tokens[$i]['parenthesis_opener'] = $i;
if ($openOwner !== null) {
$tokens[$openOwner]['parenthesis_opener'] = $i;
$tokens[$i]['parenthesis_owner'] = $openOwner;
$openOwner = null;
}
} else if ($tokens[$i]['code'] === T_CLOSE_PARENTHESIS) {
// Did we set an owner for this set of parenthesis?
$numOpeners = count($openers);
if ($numOpeners !== 0) {
$opener = array_pop($openers);
if (isset($tokens[$opener]['parenthesis_owner']) === true) {
$owner = $tokens[$opener]['parenthesis_owner'];
$tokens[$owner]['parenthesis_closer'] = $i;
$tokens[$i]['parenthesis_owner'] = $owner;
}
$tokens[$i]['parenthesis_opener'] = $opener;
$tokens[$i]['parenthesis_closer'] = $i;
$tokens[$opener]['parenthesis_closer'] = $i;
}
}//end if
}//end for
}//end _createParenthesisMap()
/**
* Creates a map for the parenthesis tokens that surround other tokens.
*
* @param array $tokens The array of tokens to process.
* @param object $tokenizer The tokenizer being used to process this file.
* @param string $eolChar The EOL character to use for splitting strings.
*
* @return void
*/
private static function _createParenthesisNestingMap(
&$tokens,
$tokenizer,
$eolChar
) {
$numTokens = count($tokens);
$map = array();
for ($i = 0; $i < $numTokens; $i++) {
if (isset($tokens[$i]['parenthesis_opener']) === true
&& $i === $tokens[$i]['parenthesis_opener']
) {
if (empty($map) === false) {
$tokens[$i]['nested_parenthesis'] = $map;
}
if (isset($tokens[$i]['parenthesis_closer']) === true) {
$map[$tokens[$i]['parenthesis_opener']]
= $tokens[$i]['parenthesis_closer'];
}
} else if (isset($tokens[$i]['parenthesis_closer']) === true
&& $i === $tokens[$i]['parenthesis_closer']
) {
array_pop($map);
if (empty($map) === false) {
$tokens[$i]['nested_parenthesis'] = $map;
}
} else {
if (empty($map) === false) {
$tokens[$i]['nested_parenthesis'] = $map;
}
}//end if
}//end for
}//end _createParenthesisNestingMap()
/**
* Creates a scope map of tokens that open scopes.
*
* @param array $tokens The array of tokens to process.
* @param object $tokenizer The tokenizer being used to process this file.
* @param string $eolChar The EOL character to use for splitting strings.
*
* @return void
* @see _recurseScopeMap()
*/
private static function _createScopeMap(&$tokens, $tokenizer, $eolChar)
{
if (PHP_CODESNIFFER_VERBOSITY > 1) {
echo "\t*** START SCOPE MAP ***".PHP_EOL;
}
$numTokens = count($tokens);
for ($i = 0; $i < $numTokens; $i++) {
// Check to see if the current token starts a new scope.
if (isset($tokenizer->scopeOpeners[$tokens[$i]['code']]) === true) {
if (PHP_CODESNIFFER_VERBOSITY > 1) {
$type = $tokens[$i]['type'];
$content = str_replace($eolChar, '\n', $tokens[$i]['content']);
echo "\tStart scope map at $i:$type => $content".PHP_EOL;
}
$i = self::_recurseScopeMap(
$tokens,
$numTokens,
$tokenizer,
$eolChar,
$i
);
}
}//end for
if (PHP_CODESNIFFER_VERBOSITY > 1) {
echo "\t*** END SCOPE MAP ***".PHP_EOL;
}
}//end _createScopeMap()
/**
* Recurses though the scope openers to build a scope map.
*
* @param array $tokens The array of tokens to process.
* @param int $numTokens The size of the tokens array.
* @param object $tokenizer The tokenizer being used to process this file.
* @param string $eolChar The EOL character to use for splitting strings.
* @param int $stackPtr The position in the stack of the token that
* opened the scope (eg. an IF token or FOR token).
* @param int $depth How many scope levels down we are.
* @param int $ignore How many curly braces we are ignoring.
*
* @return int The position in the stack that closed the scope.
*/
private static function _recurseScopeMap(
&$tokens,
$numTokens,
$tokenizer,
$eolChar,
$stackPtr,
$depth=1,
&$ignore=0
) {
$opener = null;
$currType = $tokens[$stackPtr]['code'];
$startLine = $tokens[$stackPtr]['line'];
// We will need this to restore the value if we end up
// returning a token ID that causes our calling function to go back
// over already ignored braces.
$originalIgnore = $ignore;
// If the start token for this scope opener is the same as
// the scope token, we have already found our opener.
if (in_array($currType, $tokenizer->scopeOpeners[$currType]['start']) === true) {
$opener = $stackPtr;
}
for ($i = ($stackPtr + 1); $i < $numTokens; $i++) {
$tokenType = $tokens[$i]['code'];
if (PHP_CODESNIFFER_VERBOSITY > 1) {
$type = $tokens[$i]['type'];
$content = str_replace($eolChar, '\n', $tokens[$i]['content']);
echo str_repeat("\t", $depth);
echo "Process token $i [";
if ($opener !== null) {
echo "opener:$opener;";
}
if ($ignore > 0) {
echo "ignore=$ignore;";
}
echo "]: $type => $content".PHP_EOL;
}
// Very special case for IF statements in PHP that can be defined without
// scope tokens. If an IF statement below this one has an opener but no
// keyword, the opener will be incorrectly assigned to this IF statement.
// E.g., if (1) 1; 1 ? (1 ? 1 : 1) : 1;
if (($currType === T_IF || $currType === T_ELSE) && $opener === null && $tokens[$i]['code'] === T_SEMICOLON) {
if (PHP_CODESNIFFER_VERBOSITY > 1) {
$type = $tokens[$stackPtr]['type'];
echo str_repeat("\t", $depth);
echo "=> Found semicolon before scope opener for $stackPtr:$type, bailing".PHP_EOL;
}
return $i;
}
if ($opener !== null
&& (isset($tokens[$i]['scope_opener']) === false
|| $tokenizer->scopeOpeners[$tokens[$stackPtr]['code']]['shared'] === true)
&& in_array($tokenType, $tokenizer->scopeOpeners[$currType]['end']) === true
) {
if ($ignore > 0 && $tokenType === T_CLOSE_CURLY_BRACKET) {
// The last opening bracket must have been for a string
// offset or alike, so let's ignore it.
if (PHP_CODESNIFFER_VERBOSITY > 1) {
echo str_repeat("\t", $depth);
echo '* finished ignoring curly brace *'.PHP_EOL;
}
$ignore--;
continue;
} else if ($tokens[$opener]['code'] === T_OPEN_CURLY_BRACKET
&& $tokenType !== T_CLOSE_CURLY_BRACKET
) {
// The opener is a curly bracket so the closer must be a curly bracket as well.
// We ignore this closer to handle cases such as T_ELSE or T_ELSEIF being considered
// a closer of T_IF when it should not.
if (PHP_CODESNIFFER_VERBOSITY > 1) {
$type = $tokens[$stackPtr]['type'];
echo str_repeat("\t", $depth);
echo "=> Ignoring non-culry scope closer for $stackPtr:$type".PHP_EOL;
}
} else {
if (PHP_CODESNIFFER_VERBOSITY > 1) {
$type = $tokens[$stackPtr]['type'];
$closerType = $tokens[$i]['type'];
echo str_repeat("\t", $depth);
echo "=> Found scope closer ($i:$closerType) for $stackPtr:$type".PHP_EOL;
}
foreach (array($stackPtr, $opener, $i) as $token) {
$tokens[$token]['scope_condition'] = $stackPtr;
$tokens[$token]['scope_opener'] = $opener;
$tokens[$token]['scope_closer'] = $i;
}
if ($tokenizer->scopeOpeners[$tokens[$stackPtr]['code']]['shared'] === true) {
// As we are going back to where we started originally, restore
// the ignore value back to its original value.
$ignore = $originalIgnore;
return $opener;
} else if (isset($tokenizer->scopeOpeners[$tokenType]) === true) {
// Unset scope_condition here or else the token will appear to have
// already been processed, and it will be skipped. Normally we want that,
// but in this case, the token is both a closer and an opener, so
// it needs to act like an opener. This is also why we return the
// token before this one; so the closer has a chance to be processed
// a second time, but as an opener.
unset($tokens[$i]['scope_condition']);
return ($i - 1);
} else {
return $i;
}
}//end if
}//end if
// Is this an opening condition ?
if (isset($tokenizer->scopeOpeners[$tokenType]) === true) {
if ($opener === null) {
// Found another opening condition but still haven't
// found our opener, so we are never going to find one.
if (PHP_CODESNIFFER_VERBOSITY > 1) {
$type = $tokens[$stackPtr]['type'];
echo str_repeat("\t", $depth);
echo "=> Couldn't find scope opener for $stackPtr:$type, bailing".PHP_EOL;
}
return $stackPtr;
}
if (PHP_CODESNIFFER_VERBOSITY > 1) {
echo str_repeat("\t", $depth);
echo '* token is an opening condition *'.PHP_EOL;
}
$isShared = ($tokenizer->scopeOpeners[$tokenType]['shared'] === true);
if (isset($tokens[$i]['scope_condition']) === true) {
// We've been here before.
if (PHP_CODESNIFFER_VERBOSITY > 1) {
echo str_repeat("\t", $depth);
echo '* already processed, skipping *'.PHP_EOL;
}
if ($isShared === false
&& isset($tokens[$i]['scope_closer']) === true
) {
$i = $tokens[$i]['scope_closer'];
}
continue;
} else if ($currType === $tokenType
&& $isShared === false
&& $opener === null
) {
// We haven't yet found our opener, but we have found another
// scope opener which is the same type as us, and we don't
// share openers, so we will never find one.
if (PHP_CODESNIFFER_VERBOSITY > 1) {
echo str_repeat("\t", $depth);
echo '* it was another token\'s opener, bailing *'.PHP_EOL;
}
return $stackPtr;
} else {
if (PHP_CODESNIFFER_VERBOSITY > 1) {
echo str_repeat("\t", $depth);
echo '* searching for opener *'.PHP_EOL;
}
if (in_array(T_CLOSE_CURLY_BRACKET, $tokenizer->scopeOpeners[$tokenType]['end']) === true) {
$oldIgnore = $ignore;
$ignore = 0;
}
$i = self::_recurseScopeMap(
$tokens,
$numTokens,
$tokenizer,
$eolChar,
$i,
($depth + 1),
$ignore
);
if (in_array(T_CLOSE_CURLY_BRACKET, $tokenizer->scopeOpeners[$tokenType]['end']) === true) {
$ignore = $oldIgnore;
}
}//end if
}//end if
if (in_array($tokenType, $tokenizer->scopeOpeners[$currType]['start']) === true
&& $opener === null
) {
if ($tokenType === T_OPEN_CURLY_BRACKET) {
// Make sure this is actually an opener and not a
// string offset (e.g., $var{0}).
for ($x = ($i - 1); $x > 0; $x--) {
if (in_array($tokens[$x]['code'], PHP_CodeSniffer_Tokens::$emptyTokens) === true) {
continue;
} else {
// If the first non-whitespace/comment token is a
// variable or object operator then this is an opener
// for a string offset and not a scope.
if ($tokens[$x]['code'] === T_VARIABLE
|| $tokens[$x]['code'] === T_OBJECT_OPERATOR
) {
if (PHP_CODESNIFFER_VERBOSITY > 1) {
echo str_repeat("\t", $depth);
echo '* ignoring curly brace *'.PHP_EOL;
}
$ignore++;
}//end if
break;
}//end if
}//end for
}//end if
if ($ignore === 0) {
// We found the opening scope token for $currType.
if (PHP_CODESNIFFER_VERBOSITY > 1) {
$type = $tokens[$stackPtr]['type'];
echo str_repeat("\t", $depth);
echo "=> Found scope opener for $stackPtr:$type".PHP_EOL;
}
$opener = $i;
}
} else if ($tokenType === T_OPEN_PARENTHESIS) {
if (isset($tokens[$i]['parenthesis_owner']) === true) {
$owner = $tokens[$i]['parenthesis_owner'];
if (in_array($tokens[$owner]['code'], PHP_CodeSniffer_Tokens::$scopeOpeners) === true
&& isset($tokens[$i]['parenthesis_closer']) === true
) {
// If we get into here, then we opened a parenthesis for
// a scope (eg. an if or else if). We can just skip to
// the closing parenthesis.
$i = $tokens[$i]['parenthesis_closer'];
// Update the start of the line so that when we check to see
// if the closing parenthesis is more than 3 lines away from
// the statement, we check from the closing parenthesis.
$startLine
= $tokens[$tokens[$i]['parenthesis_closer']]['line'];
if (PHP_CODESNIFFER_VERBOSITY > 1) {
echo str_repeat("\t", $depth);
echo '* skipping parenthesis *'.PHP_EOL;
}
}
}//end if
} else if ($tokenType === T_OPEN_CURLY_BRACKET && $opener !== null) {
// We opened something that we don't have a scope opener for.
// Examples of this are curly brackets for string offsets etc.
// We want to ignore this so that we don't have an invalid scope
// map.
if (PHP_CODESNIFFER_VERBOSITY > 1) {
echo str_repeat("\t", $depth);
echo '* ignoring curly brace *'.PHP_EOL;
}
$ignore++;
} else if ($opener === null
&& isset($tokenizer->scopeOpeners[$currType]) === true
) {
// If we still haven't found the opener after 3 lines,
// we're not going to find it, unless we know it requires
// an opener (in which case we better keep looking) or the last
// token was empty (in which case we'll just confirm there is
// more code in this file and not just a big comment).
if ($tokens[$i]['line'] >= ($startLine + 3)
&& in_array($tokens[($i - 1)]['code'], PHP_CodeSniffer_Tokens::$emptyTokens) === false
) {
if ($tokenizer->scopeOpeners[$currType]['strict'] === true) {
if (PHP_CODESNIFFER_VERBOSITY > 1) {
$type = $tokens[$stackPtr]['type'];
$lines = ($tokens[$i]['line'] - $startLine);
echo str_repeat("\t", $depth);
echo "=> Still looking for $stackPtr:$type scope opener after $lines lines".PHP_EOL;
}
} else {
if (PHP_CODESNIFFER_VERBOSITY > 1) {
$type = $tokens[$stackPtr]['type'];
echo str_repeat("\t", $depth);
echo "=> Couldn't find scope opener for $stackPtr:$type, bailing".PHP_EOL;
}
return $stackPtr;
}
}
} else if ($opener !== null
&& $tokenType !== T_BREAK
&& in_array($tokenType, $tokenizer->endScopeTokens) === true
) {
if (isset($tokens[$i]['scope_condition']) === false) {
if ($ignore > 0) {
// We found the end token for the opener we were ignoring.
if (PHP_CODESNIFFER_VERBOSITY > 1) {
echo str_repeat("\t", $depth);
echo '* finished ignoring curly brace *'.PHP_EOL;
}
$ignore--;
} else {
// We found a token that closes the scope but it doesn't
// have a condition, so it belongs to another token and
// our token doesn't have a closer, so pretend this is
// the closer.
if (PHP_CODESNIFFER_VERBOSITY > 1) {
$type = $tokens[$stackPtr]['type'];
echo str_repeat("\t", $depth);
echo "=> Found (unexpected) scope closer for $stackPtr:$type".PHP_EOL;
}
foreach (array($stackPtr, $opener) as $token) {
$tokens[$token]['scope_condition'] = $stackPtr;
$tokens[$token]['scope_opener'] = $opener;
$tokens[$token]['scope_closer'] = $i;
}
return ($i - 1);
}//end if
}//end if
}//end if
}//end for
return $stackPtr;
}//end _recurseScopeMap()
/**
* Constructs the level map.
*
* The level map adds a 'level' indice to each token which indicates the
* depth that a token within a set of scope blocks. It also adds a
* 'condition' indice which is an array of the scope conditions that opened
* each of the scopes - position 0 being the first scope opener.
*
* @param array $tokens The array of tokens to process.
* @param object $tokenizer The tokenizer being used to process this file.
* @param string $eolChar The EOL character to use for splitting strings.
*
* @return void
*/
private static function _createLevelMap(&$tokens, $tokenizer, $eolChar)
{
if (PHP_CODESNIFFER_VERBOSITY > 1) {
echo "\t*** START LEVEL MAP ***".PHP_EOL;
}
$numTokens = count($tokens);
$level = 0;
$conditions = array();
$lastOpener = null;
$openers = array();
for ($i = 0; $i < $numTokens; $i++) {
if (PHP_CODESNIFFER_VERBOSITY > 1) {
$type = $tokens[$i]['type'];
$line = $tokens[$i]['line'];
$content = str_replace($eolChar, '\n', $tokens[$i]['content']);
echo str_repeat("\t", ($level + 1));
echo "Process token $i on line $line [lvl:$level;";
if (empty($conditions) !== true) {
$condString = 'conds;';
foreach ($conditions as $condition) {
$condString .= token_name($condition).',';
}
echo rtrim($condString, ',').';';
}
echo "]: $type => $content".PHP_EOL;
}
$tokens[$i]['level'] = $level;
$tokens[$i]['conditions'] = $conditions;
if (isset($tokens[$i]['scope_condition']) === true) {
// Check to see if this token opened the scope.
if ($tokens[$i]['scope_opener'] === $i) {
$stackPtr = $tokens[$i]['scope_condition'];
if (PHP_CODESNIFFER_VERBOSITY > 1) {
$type = $tokens[$stackPtr]['type'];
echo str_repeat("\t", ($level + 1));
echo "=> Found scope opener for $stackPtr:$type".PHP_EOL;
}
$stackPtr = $tokens[$i]['scope_condition'];
// If we find a scope opener that has a shared closer,
// then we need to go back over the condition map that we
// just created and fix ourselves as we just added some
// conditions where there was none. This happens for T_CASE
// statements that are using the same break statement.
if ($lastOpener !== null && $tokens[$lastOpener]['scope_closer'] === $tokens[$i]['scope_closer']) {
// This opener shares its closer with the previous opener,
// but we still need to check if the two openers share their
// closer with each other directly (like CASE and DEFAULT)
// or if they are just sharing because one doesn't have a
// closer (like CASE with no BREAK using a SWITCHes closer).
$thisType = $tokens[$tokens[$i]['scope_condition']]['code'];
$opener = $tokens[$lastOpener]['scope_condition'];
$isShared = in_array(
$tokens[$opener]['code'],
$tokenizer->scopeOpeners[$thisType]['with']
);
$sameEnd = ($tokenizer->scopeOpeners[$thisType]['end'][0] === $tokenizer->scopeOpeners[$tokens[$opener]['code']]['end'][0]);
if ($isShared === true && $sameEnd === true) {
$badToken = $opener;
if (PHP_CODESNIFFER_VERBOSITY > 1) {
$type = $tokens[$badToken]['type'];
echo str_repeat("\t", ($level + 1));
echo "* shared closer, cleaning up $badToken:$type *".PHP_EOL;
}
for ($x = $tokens[$i]['scope_condition']; $x <= $i; $x++) {
$oldConditions = $tokens[$x]['conditions'];
$oldLevel = $tokens[$x]['level'];
$tokens[$x]['level']--;
unset($tokens[$x]['conditions'][$badToken]);
if (PHP_CODESNIFFER_VERBOSITY > 1) {
$type = $tokens[$x]['type'];
$oldConds = '';
foreach ($oldConditions as $condition) {
$oldConds .= token_name($condition).',';
}
$oldConds = rtrim($oldConds, ',');
$newConds = '';
foreach ($tokens[$x]['conditions'] as $condition) {
$newConds .= token_name($condition).',';
}
$newConds = rtrim($newConds, ',');
$newLevel = $tokens[$x]['level'];
echo str_repeat("\t", ($level + 1));
echo "* cleaned $x:$type *".PHP_EOL;
echo str_repeat("\t", ($level + 2));
echo "=> level changed from $oldLevel to $newLevel".PHP_EOL;
echo str_repeat("\t", ($level + 2));
echo "=> conditions changed from $oldConds to $newConds".PHP_EOL;
}//end if
}//end for
unset($conditions[$badToken]);
if (PHP_CODESNIFFER_VERBOSITY > 1) {
$type = $tokens[$badToken]['type'];
echo str_repeat("\t", ($level + 1));
echo "* token $badToken:$type removed from conditions array *".PHP_EOL;
}
unset ($openers[$lastOpener]);
$level--;
if (PHP_CODESNIFFER_VERBOSITY > 1) {
echo str_repeat("\t", ($level + 2));
echo '* level decreased *'.PHP_EOL;
}
}//end if
}//end if
$level++;
if (PHP_CODESNIFFER_VERBOSITY > 1) {
echo str_repeat("\t", ($level + 1));
echo '* level increased *'.PHP_EOL;
}
$conditions[$stackPtr] = $tokens[$stackPtr]['code'];
if (PHP_CODESNIFFER_VERBOSITY > 1) {
$type = $tokens[$stackPtr]['type'];
echo str_repeat("\t", ($level + 1));
echo "* token $stackPtr:$type added to conditions array *".PHP_EOL;
}
$lastOpener = $tokens[$i]['scope_opener'];
if ($lastOpener !== null) {
$openers[$lastOpener] = $lastOpener;
}
} else if ($lastOpener !== null && $tokens[$lastOpener]['scope_closer'] === $i) {
foreach (array_reverse($openers) as $opener) {
if ($tokens[$opener]['scope_closer'] === $i) {
$oldOpener = array_pop($openers);
if (empty($openers) === false) {
$lastOpener = array_pop($openers);
$openers[$lastOpener] = $lastOpener;
} else {
$lastOpener = null;
}
if (PHP_CODESNIFFER_VERBOSITY > 1) {
$type = $tokens[$oldOpener]['type'];
echo str_repeat("\t", ($level + 1));
echo "=> Found scope closer for $oldOpener:$type".PHP_EOL;
}
$oldCondition = array_pop($conditions);
if (PHP_CODESNIFFER_VERBOSITY > 1) {
echo str_repeat("\t", ($level + 1));
echo '* token '.token_name($oldCondition).' removed from conditions array *'.PHP_EOL;
}
// Make sure this closer actually belongs to us.
// Either the condition also has to think this is the
// closer, or it has to allow sharing with us.
$condition
= $tokens[$tokens[$i]['scope_condition']]['code'];
if ($condition !== $oldCondition) {
if (in_array($condition, $tokenizer->scopeOpeners[$oldCondition]['with']) === false) {
$badToken = $tokens[$oldOpener]['scope_condition'];
if (PHP_CODESNIFFER_VERBOSITY > 1) {
$type = token_name($oldCondition);
echo str_repeat("\t", ($level + 1));
echo "* scope closer was bad, cleaning up $badToken:$type *".PHP_EOL;
}
for ($x = ($oldOpener + 1); $x <= $i; $x++) {
$oldConditions = $tokens[$x]['conditions'];
$oldLevel = $tokens[$x]['level'];
$tokens[$x]['level']--;
unset($tokens[$x]['conditions'][$badToken]);
if (PHP_CODESNIFFER_VERBOSITY > 1) {
$type = $tokens[$x]['type'];
$oldConds = '';
foreach ($oldConditions as $condition) {
$oldConds .= token_name($condition).',';
}
$oldConds = rtrim($oldConds, ',');
$newConds = '';
foreach ($tokens[$x]['conditions'] as $condition) {
$newConds .= token_name($condition).',';
}
$newConds = rtrim($newConds, ',');
$newLevel = $tokens[$x]['level'];
echo str_repeat("\t", ($level + 1));
echo "* cleaned $x:$type *".PHP_EOL;
echo str_repeat("\t", ($level + 2));
echo "=> level changed from $oldLevel to $newLevel".PHP_EOL;
echo str_repeat("\t", ($level + 2));
echo "=> conditions changed from $oldConds to $newConds".PHP_EOL;
}//end if
}//end for
}//end if
}//end if
$level--;
if (PHP_CODESNIFFER_VERBOSITY > 1) {
echo str_repeat("\t", ($level + 2));
echo '* level decreased *'.PHP_EOL;
}
$tokens[$i]['level'] = $level;
$tokens[$i]['conditions'] = $conditions;
}//end if
}//end foreach
}//end if
}//end if
}//end for
if (PHP_CODESNIFFER_VERBOSITY > 1) {
echo "\t*** END LEVEL MAP ***".PHP_EOL;
}
}//end _createLevelMap()
/**
* Returns the declaration names for T_CLASS, T_INTERFACE and T_FUNCTION tokens.
*
* @param int $stackPtr The position of the declaration token which
* declared the class, interface or function.
*
* @return string|null The name of the class, interface or function.
* or NULL if the function is a closure.
* @throws PHP_CodeSniffer_Exception If the specified token is not of type
* T_FUNCTION, T_CLASS or T_INTERFACE.
*/
public function getDeclarationName($stackPtr)
{
$tokenCode = $this->_tokens[$stackPtr]['code'];
if ($tokenCode !== T_FUNCTION
&& $tokenCode !== T_CLASS
&& $tokenCode !== T_INTERFACE
&& $tokenCode !== T_TRAIT
) {
throw new PHP_CodeSniffer_Exception('Token type is not T_FUNCTION, T_CLASS, T_INTERFACE or T_TRAIT');
}
if ($tokenCode === T_FUNCTION
&& $this->isAnonymousFunction($stackPtr) === true
) {
return null;
}
$token = $this->findNext(T_STRING, $stackPtr);
return $this->_tokens[$token]['content'];
}//end getDeclarationName()
/**
* Check if the token at the specified position is a anonymous function.
*
* @param int $stackPtr The position of the declaration token which
* declared the class, interface or function.
*
* @return boolean
* @throws PHP_CodeSniffer_Exception If the specified token is not of type
* T_FUNCTION
*/
public function isAnonymousFunction($stackPtr)
{
$tokenCode = $this->_tokens[$stackPtr]['code'];
if ($tokenCode !== T_FUNCTION) {
throw new PHP_CodeSniffer_Exception('Token type is not T_FUNCTION');
}
if (isset($this->_tokens[$stackPtr]['parenthesis_opener']) === false) {
// Something is not right with this function.
return false;
}
$name = $this->findNext(T_STRING, ($stackPtr + 1));
if ($name === false) {
// No name found.
return true;
}
$open = $this->_tokens[$stackPtr]['parenthesis_opener'];
if ($name > $open) {
return true;
}
return false;
}//end isAnonymousFunction()
/**
* Returns the method parameters for the specified T_FUNCTION token.
*
* Each parameter is in the following format:
*
* <code>
* 0 => array(
* 'name' => '$var', // The variable name.
* 'pass_by_reference' => false, // Passed by reference.
* 'type_hint' => string, // Type hint for array or custom type
* )
* </code>
*
* Parameters with default values have and additional array indice of
* 'default' with the value of the default as a string.
*
* @param int $stackPtr The position in the stack of the T_FUNCTION token
* to acquire the parameters for.
*
* @return array
* @throws PHP_CodeSniffer_Exception If the specified $stackPtr is not of
* type T_FUNCTION.
*/
public function getMethodParameters($stackPtr)
{
if ($this->_tokens[$stackPtr]['code'] !== T_FUNCTION) {
throw new PHP_CodeSniffer_Exception('$stackPtr must be of type T_FUNCTION');
}
$opener = $this->_tokens[$stackPtr]['parenthesis_opener'];
$closer = $this->_tokens[$stackPtr]['parenthesis_closer'];
$vars = array();
$currVar = null;
$defaultStart = null;
$paramCount = 0;
$passByReference = false;
$typeHint = '';
for ($i = ($opener + 1); $i <= $closer; $i++) {
// Check to see if this token has a parenthesis opener. If it does
// its likely to be an array, which might have arguments in it, which
// we cause problems in our parsing below, so lets just skip to the
// end of it.
if (isset($this->_tokens[$i]['parenthesis_opener']) === true) {
// Don't do this if it's the close parenthesis for the method.
if ($i !== $this->_tokens[$i]['parenthesis_closer']) {
$i = ($this->_tokens[$i]['parenthesis_closer'] + 1);
}
}
switch ($this->_tokens[$i]['code']) {
case T_BITWISE_AND:
$passByReference = true;
break;
case T_VARIABLE:
$currVar = $i;
break;
case T_ARRAY_HINT:
case T_CALLABLE:
$typeHint = $this->_tokens[$i]['content'];
break;
case T_STRING:
// This is a string, so it may be a type hint, but it could
// also be a constant used as a default value.
$prevComma = $this->findPrevious(T_COMMA, $i, $opener);
if ($prevComma !== false) {
$nextEquals = $this->findNext(T_EQUAL, $prevComma, $i);
if ($nextEquals !== false) {
break;
}
}
if ($defaultStart === null) {
$typeHint .= $this->_tokens[$i]['content'];
}
break;
case T_NS_SEPARATOR:
// Part of a type hint or default value.
if ($defaultStart === null) {
$typeHint .= $this->_tokens[$i]['content'];
}
break;
case T_CLOSE_PARENTHESIS:
case T_COMMA:
// If it's null, then there must be no parameters for this
// method.
if ($currVar === null) {
continue;
}
$vars[$paramCount] = array();
$vars[$paramCount]['name'] = $this->_tokens[$currVar]['content'];
if ($defaultStart !== null) {
$vars[$paramCount]['default']
= $this->getTokensAsString(
$defaultStart,
($i - $defaultStart)
);
}
$vars[$paramCount]['pass_by_reference'] = $passByReference;
$vars[$paramCount]['type_hint'] = $typeHint;
// Reset the vars, as we are about to process the next parameter.
$defaultStart = null;
$passByReference = false;
$typeHint = '';
$paramCount++;
break;
case T_EQUAL:
$defaultStart = ($i + 1);
break;
}//end switch
}//end for
return $vars;
}//end getMethodParameters()
/**
* Returns the visibility and implementation properties of a method.
*
* The format of the array is:
* <code>
* array(
* 'scope' => 'public', // public private or protected
* 'scope_specified' => true, // true is scope keyword was found.
* 'is_abstract' => false, // true if the abstract keyword was found.
* 'is_final' => false, // true if the final keyword was found.
* 'is_static' => false, // true if the static keyword was found.
* 'is_closure' => false, // true if no name is found.
* );
* </code>
*
* @param int $stackPtr The position in the stack of the T_FUNCTION token to
* acquire the properties for.
*
* @return array
* @throws PHP_CodeSniffer_Exception If the specified position is not a
* T_FUNCTION token.
*/
public function getMethodProperties($stackPtr)
{
if ($this->_tokens[$stackPtr]['code'] !== T_FUNCTION) {
throw new PHP_CodeSniffer_Exception('$stackPtr must be of type T_FUNCTION');
}
$valid = array(
T_PUBLIC,
T_PRIVATE,
T_PROTECTED,
T_STATIC,
T_FINAL,
T_ABSTRACT,
T_WHITESPACE,
T_COMMENT,
T_DOC_COMMENT,
);
$scope = 'public';
$scopeSpecified = false;
$isAbstract = false;
$isFinal = false;
$isStatic = false;
$isClosure = $this->isAnonymousFunction($stackPtr);
for ($i = ($stackPtr - 1); $i > 0; $i--) {
if (in_array($this->_tokens[$i]['code'], $valid) === false) {
break;
}
switch ($this->_tokens[$i]['code']) {
case T_PUBLIC:
$scope = 'public';
$scopeSpecified = true;
break;
case T_PRIVATE:
$scope = 'private';
$scopeSpecified = true;
break;
case T_PROTECTED:
$scope = 'protected';
$scopeSpecified = true;
break;
case T_ABSTRACT:
$isAbstract = true;
break;
case T_FINAL:
$isFinal = true;
break;
case T_STATIC:
$isStatic = true;
break;
}//end switch
}//end for
return array(
'scope' => $scope,
'scope_specified' => $scopeSpecified,
'is_abstract' => $isAbstract,
'is_final' => $isFinal,
'is_static' => $isStatic,
'is_closure' => $isClosure,
);
}//end getMethodProperties()
/**
* Returns the visibility and implementation properties of the class member
* variable found at the specified position in the stack.
*
* The format of the array is:
*
* <code>
* array(
* 'scope' => 'public', // public private or protected
* 'is_static' => false, // true if the static keyword was found.
* );
* </code>
*
* @param int $stackPtr The position in the stack of the T_VARIABLE token to
* acquire the properties for.
*
* @return array
* @throws PHP_CodeSniffer_Exception If the specified position is not a
* T_VARIABLE token, or if the position is not
* a class member variable.
*/
public function getMemberProperties($stackPtr)
{
if ($this->_tokens[$stackPtr]['code'] !== T_VARIABLE) {
throw new PHP_CodeSniffer_Exception('$stackPtr must be of type T_VARIABLE');
}
$conditions = array_keys($this->_tokens[$stackPtr]['conditions']);
$ptr = array_pop($conditions);
if (isset($this->_tokens[$ptr]) === false
|| ($this->_tokens[$ptr]['code'] !== T_CLASS
&& $this->_tokens[$ptr]['code'] !== T_TRAIT)
) {
if (isset($this->_tokens[$ptr]) === true
&& $this->_tokens[$ptr]['code'] === T_INTERFACE
) {
// T_VARIABLEs in interfaces can actually be method arguments
// but they wont be seen as being inside the method because there
// are no scope openers and closers for abstract methods. If it is in
// parentheses, we can be pretty sure it is a method argument.
if (isset($this->_tokens[$stackPtr]['nested_parenthesis']) === false
|| empty($this->_tokens[$stackPtr]['nested_parenthesis']) === true
) {
$error = 'Possible parse error: interfaces may not include member vars';
$this->addWarning($error, $stackPtr, 'Internal.ParseError.InterfaceHasMemberVar');
return array();
}
} else {
throw new PHP_CodeSniffer_Exception('$stackPtr is not a class member var');
}
}
$valid = array(
T_PUBLIC,
T_PRIVATE,
T_PROTECTED,
T_STATIC,
T_WHITESPACE,
T_COMMENT,
T_DOC_COMMENT,
T_VARIABLE,
T_COMMA,
);
$scope = 'public';
$scopeSpecified = false;
$isStatic = false;
for ($i = ($stackPtr - 1); $i > 0; $i--) {
if (in_array($this->_tokens[$i]['code'], $valid) === false) {
break;
}
switch ($this->_tokens[$i]['code']) {
case T_PUBLIC:
$scope = 'public';
$scopeSpecified = true;
break;
case T_PRIVATE:
$scope = 'private';
$scopeSpecified = true;
break;
case T_PROTECTED:
$scope = 'protected';
$scopeSpecified = true;
break;
case T_STATIC:
$isStatic = true;
break;
}
}//end for
return array(
'scope' => $scope,
'scope_specified' => $scopeSpecified,
'is_static' => $isStatic,
);
}//end getMemberProperties()
/**
* Returns the visibility and implementation properties of a class.
*
* The format of the array is:
* <code>
* array(
* 'is_abstract' => false, // true if the abstract keyword was found.
* 'is_final' => false, // true if the final keyword was found.
* );
* </code>
*
* @param int $stackPtr The position in the stack of the T_CLASS token to
* acquire the properties for.
*
* @return array
* @throws PHP_CodeSniffer_Exception If the specified position is not a
* T_CLASS token.
*/
public function getClassProperties($stackPtr)
{
if ($this->_tokens[$stackPtr]['code'] !== T_CLASS) {
throw new PHP_CodeSniffer_Exception('$stackPtr must be of type T_CLASS');
}
$valid = array(
T_FINAL,
T_ABSTRACT,
T_WHITESPACE,
T_COMMENT,
T_DOC_COMMENT,
);
$isAbstract = false;
$isFinal = false;
for ($i = ($stackPtr - 1); $i > 0; $i--) {
if (in_array($this->_tokens[$i]['code'], $valid) === false) {
break;
}
switch ($this->_tokens[$i]['code']) {
case T_ABSTRACT:
$isAbstract = true;
break;
case T_FINAL:
$isFinal = true;
break;
}
}//end for
return array(
'is_abstract' => $isAbstract,
'is_final' => $isFinal,
);
}//end getClassProperties()
/**
* Determine if the passed token is a reference operator.
*
* Returns true if the specified token position represents a reference.
* Returns false if the token represents a bitwise operator.
*
* @param int $stackPtr The position of the T_BITWISE_AND token.
*
* @return boolean
*/
public function isReference($stackPtr)
{
if ($this->_tokens[$stackPtr]['code'] !== T_BITWISE_AND) {
return false;
}
$tokenBefore = $this->findPrevious(
PHP_CodeSniffer_Tokens::$emptyTokens,
($stackPtr - 1),
null,
true
);
if ($this->_tokens[$tokenBefore]['code'] === T_FUNCTION) {
// Function returns a reference.
return true;
}
if ($this->_tokens[$tokenBefore]['code'] === T_DOUBLE_ARROW) {
// Inside a foreach loop, this is a reference.
return true;
}
if ($this->_tokens[$tokenBefore]['code'] === T_AS) {
// Inside a foreach loop, this is a reference.
return true;
}
if (in_array($this->_tokens[$tokenBefore]['code'], PHP_CodeSniffer_Tokens::$assignmentTokens) === true) {
// This is directly after an assignment. It's a reference. Even if
// it is part of an operation, the other tests will handle it.
return true;
}
if (isset($this->_tokens[$stackPtr]['nested_parenthesis']) === true) {
$brackets = $this->_tokens[$stackPtr]['nested_parenthesis'];
$lastBracket = array_pop($brackets);
if (isset($this->_tokens[$lastBracket]['parenthesis_owner']) === true) {
$owner = $this->_tokens[$this->_tokens[$lastBracket]['parenthesis_owner']];
if ($owner['code'] === T_FUNCTION
|| $owner['code'] === T_CLOSURE
|| $owner['code'] === T_ARRAY
) {
// Inside a function or array declaration, this is a reference.
return true;
}
} else {
$prev = $this->findPrevious(
array(T_WHITESPACE),
($this->_tokens[$lastBracket]['parenthesis_opener'] - 1),
null,
true
);
if ($prev !== false && $this->_tokens[$prev]['code'] === T_USE) {
return true;
}
}
}
$tokenAfter = $this->findNext(
PHP_CodeSniffer_Tokens::$emptyTokens,
($stackPtr + 1),
null,
true
);
if ($this->_tokens[$tokenAfter]['code'] === T_VARIABLE
&& ($this->_tokens[$tokenBefore]['code'] === T_OPEN_PARENTHESIS
|| $this->_tokens[$tokenBefore]['code'] === T_COMMA)
) {
return true;
}
return false;
}//end isReference()
/**
* Returns the content of the tokens from the specified start position in
* the token stack for the specified length.
*
* @param int $start The position to start from in the token stack.
* @param int $length The length of tokens to traverse from the start pos.
*
* @return string The token contents.
*/
public function getTokensAsString($start, $length)
{
$str = '';
$end = ($start + $length);
if ($end > $this->numTokens) {
$end = $this->numTokens;
}
for ($i = $start; $i < $end; $i++) {
$str .= $this->_tokens[$i]['content'];
}
return $str;
}//end getTokensAsString()
/**
* Returns the position of the next specified token(s).
*
* If a value is specified, the next token of the specified type(s)
* containing the specified value will be returned.
*
* Returns false if no token can be found.
*
* @param int|array $types The type(s) of tokens to search for.
* @param int $start The position to start searching from in the
* token stack.
* @param int $end The end position to fail if no token is found.
* if not specified or null, end will default to
* the start of the token stack.
* @param bool $exclude If true, find the next token that are NOT of
* the types specified in $types.
* @param string $value The value that the token(s) must be equal to.
* If value is omitted, tokens with any value will
* be returned.
* @param bool $local If true, tokens outside the current statement
* will not be checked. IE. checking will stop
* at the next semi-colon found.
*
* @return int | bool
* @see findNext()
*/
public function findPrevious(
$types,
$start,
$end=null,
$exclude=false,
$value=null,
$local=false
) {
$types = (array) $types;
if ($end === null) {
$end = 0;
}
for ($i = $start; $i >= $end; $i--) {
$found = (bool) $exclude;
foreach ($types as $type) {
if ($this->_tokens[$i]['code'] === $type) {
$found = !$exclude;
break;
}
}
if ($found === true) {
if ($value === null) {
return $i;
} else if ($this->_tokens[$i]['content'] === $value) {
return $i;
}
}
if ($local === true && $this->_tokens[$i]['code'] === T_SEMICOLON) {
break;
}
}//end for
return false;
}//end findPrevious()
/**
* Returns the position of the next specified token(s).
*
* If a value is specified, the next token of the specified type(s)
* containing the specified value will be returned.
*
* Returns false if no token can be found.
*
* @param int|array $types The type(s) of tokens to search for.
* @param int $start The position to start searching from in the
* token stack.
* @param int $end The end position to fail if no token is found.
* if not specified or null, end will default to
* the end of the token stack.
* @param bool $exclude If true, find the next token that is NOT of
* a type specified in $types.
* @param string $value The value that the token(s) must be equal to.
* If value is omitted, tokens with any value will
* be returned.
* @param bool $local If true, tokens outside the current statement
* will not be checked. i.e., checking will stop
* at the next semi-colon found.
*
* @return int | bool
* @see findPrevious()
*/
public function findNext(
$types,
$start,
$end=null,
$exclude=false,
$value=null,
$local=false
) {
$types = (array) $types;
if ($end === null || $end > $this->numTokens) {
$end = $this->numTokens;
}
for ($i = $start; $i < $end; $i++) {
$found = (bool) $exclude;
foreach ($types as $type) {
if ($this->_tokens[$i]['code'] === $type) {
$found = !$exclude;
break;
}
}
if ($found === true) {
if ($value === null) {
return $i;
} else if ($this->_tokens[$i]['content'] === $value) {
return $i;
}
}
if ($local === true && $this->_tokens[$i]['code'] === T_SEMICOLON) {
break;
}
}//end for
return false;
}//end findNext()
/**
* Returns the position of the first token on a line, matching given type.
*
* Returns false if no token can be found.
*
* @param int|array $types The type(s) of tokens to search for.
* @param int $start The position to start searching from in the
* token stack. The first token matching on
* this line before this token will be returned.
* @param bool $exclude If true, find the token that is NOT of
* the types specified in $types.
* @param string $value The value that the token must be equal to.
* If value is omitted, tokens with any value will
* be returned.
*
* @return int | bool
*/
public function findFirstOnLine($types, $start, $exclude=false, $value=null)
{
if (is_array($types) === false) {
$types = array($types);
}
$foundToken = false;
for ($i = $start; $i >= 0; $i--) {
if ($this->_tokens[$i]['line'] < $this->_tokens[$start]['line']) {
break;
}
$found = $exclude;
foreach ($types as $type) {
if ($exclude === false) {
if ($this->_tokens[$i]['code'] === $type) {
$found = true;
break;
}
} else {
if ($this->_tokens[$i]['code'] === $type) {
$found = false;
break;
}
}
}
if ($found === true) {
if ($value === null) {
$foundToken = $i;
} else if ($this->_tokens[$i]['content'] === $value) {
$foundToken = $i;
}
}
}//end for
return $foundToken;
}//end findFirstOnLine()
/**
* Determine if the passed token has a condition of one of the passed types.
*
* @param int $stackPtr The position of the token we are checking.
* @param int|array $types The type(s) of tokens to search for.
*
* @return boolean
*/
public function hasCondition($stackPtr, $types)
{
// Check for the existence of the token.
if (isset($this->_tokens[$stackPtr]) === false) {
return false;
}
// Make sure the token has conditions.
if (isset($this->_tokens[$stackPtr]['conditions']) === false) {
return false;
}
$types = (array) $types;
$conditions = $this->_tokens[$stackPtr]['conditions'];
foreach ($types as $type) {
if (in_array($type, $conditions) === true) {
// We found a token with the required type.
return true;
}
}
return false;
}//end hasCondition()
/**
* Return the position of the condition for the passed token.
*
* Returns FALSE if the token does not have the condition.
*
* @param int $stackPtr The position of the token we are checking.
* @param int $type The type of token to search for.
*
* @return int
*/
public function getCondition($stackPtr, $type)
{
// Check for the existence of the token.
if (isset($this->_tokens[$stackPtr]) === false) {
return false;
}
// Make sure the token has conditions.
if (isset($this->_tokens[$stackPtr]['conditions']) === false) {
return false;
}
$conditions = $this->_tokens[$stackPtr]['conditions'];
foreach ($conditions as $token => $condition) {
if ($condition === $type) {
return $token;
}
}
return false;
}//end getCondition()
/**
* Returns the name of the class that the specified class extends.
*
* Returns FALSE on error or if there is no extended class name.
*
* @param int $stackPtr The stack position of the class.
*
* @return string
*/
public function findExtendedClassName($stackPtr)
{
// Check for the existence of the token.
if (isset($this->_tokens[$stackPtr]) === false) {
return false;
}
if ($this->_tokens[$stackPtr]['code'] !== T_CLASS) {
return false;
}
if (isset($this->_tokens[$stackPtr]['scope_closer']) === false) {
return false;
}
$classCloserIndex = $this->_tokens[$stackPtr]['scope_closer'];
$extendsIndex = $this->findNext(T_EXTENDS, $stackPtr, $classCloserIndex);
if (false === $extendsIndex) {
return false;
}
$find = array(
T_NS_SEPARATOR,
T_STRING,
T_WHITESPACE,
);
$end = $this->findNext($find, ($extendsIndex + 1), $classCloserIndex, true);
$name = $this->getTokensAsString(($extendsIndex + 1), ($end - $extendsIndex - 1));
$name = trim($name);
if ($name === '') {
return false;
}
return $name;
}//end findExtendedClassName()
}//end class
?>
|