NewFunctionParametersSniff.php 30 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109
  1. <?php
  2. /**
  3. * PHPCompatibility, an external standard for PHP_CodeSniffer.
  4. *
  5. * @package PHPCompatibility
  6. * @copyright 2012-2019 PHPCompatibility Contributors
  7. * @license https://opensource.org/licenses/LGPL-3.0 LGPL3
  8. * @link https://github.com/PHPCompatibility/PHPCompatibility
  9. */
  10. namespace PHPCompatibility\Sniffs\FunctionUse;
  11. use PHPCompatibility\AbstractNewFeatureSniff;
  12. use PHP_CodeSniffer_File as File;
  13. use PHP_CodeSniffer_Tokens as Tokens;
  14. /**
  15. * Detect use of new function parameters in calls to native PHP functions.
  16. *
  17. * PHP version All
  18. *
  19. * @link https://www.php.net/manual/en/doc.changelog.php
  20. *
  21. * @since 7.0.0
  22. * @since 7.1.0 Now extends the `AbstractNewFeatureSniff` instead of the base `Sniff` class..
  23. */
  24. class NewFunctionParametersSniff extends AbstractNewFeatureSniff
  25. {
  26. /**
  27. * A list of functions which have new parameters, not present in older versions.
  28. *
  29. * The array lists : version number with false (not present) or true (present).
  30. * The index is the location of the parameter in the parameter list, starting at 0 !
  31. * If's sufficient to list the first version where the function appears.
  32. *
  33. * @since 7.0.0
  34. * @since 7.0.2 Visibility changed from `public` to `protected`.
  35. *
  36. * @var array
  37. */
  38. protected $newFunctionParameters = array(
  39. 'array_filter' => array(
  40. 2 => array(
  41. 'name' => 'flag',
  42. '5.5' => false,
  43. '5.6' => true,
  44. ),
  45. ),
  46. 'array_slice' => array(
  47. 1 => array(
  48. 'name' => 'preserve_keys',
  49. '5.0.1' => false,
  50. '5.0.2' => true,
  51. ),
  52. ),
  53. 'array_unique' => array(
  54. 1 => array(
  55. 'name' => 'sort_flags',
  56. '5.2.8' => false,
  57. '5.2.9' => true,
  58. ),
  59. ),
  60. 'assert' => array(
  61. 1 => array(
  62. 'name' => 'description',
  63. '5.4.7' => false,
  64. '5.4.8' => true,
  65. ),
  66. ),
  67. 'base64_decode' => array(
  68. 1 => array(
  69. 'name' => 'strict',
  70. '5.1' => false,
  71. '5.2' => true,
  72. ),
  73. ),
  74. 'bcmod' => array(
  75. 2 => array(
  76. 'name' => 'scale',
  77. '7.1' => false,
  78. '7.2' => true,
  79. ),
  80. ),
  81. 'class_implements' => array(
  82. 1 => array(
  83. 'name' => 'autoload',
  84. '5.0' => false,
  85. '5.1' => true,
  86. ),
  87. ),
  88. 'class_parents' => array(
  89. 1 => array(
  90. 'name' => 'autoload',
  91. '5.0' => false,
  92. '5.1' => true,
  93. ),
  94. ),
  95. 'clearstatcache' => array(
  96. 0 => array(
  97. 'name' => 'clear_realpath_cache',
  98. '5.2' => false,
  99. '5.3' => true,
  100. ),
  101. 1 => array(
  102. 'name' => 'filename',
  103. '5.2' => false,
  104. '5.3' => true,
  105. ),
  106. ),
  107. 'copy' => array(
  108. 2 => array(
  109. 'name' => 'context',
  110. '5.2' => false,
  111. '5.3' => true,
  112. ),
  113. ),
  114. 'curl_multi_info_read' => array(
  115. 1 => array(
  116. 'name' => 'msgs_in_queue',
  117. '5.1' => false,
  118. '5.2' => true,
  119. ),
  120. ),
  121. 'debug_backtrace' => array(
  122. 0 => array(
  123. 'name' => 'options',
  124. '5.2.4' => false,
  125. '5.2.5' => true,
  126. ),
  127. 1 => array(
  128. 'name' => 'limit',
  129. '5.3' => false,
  130. '5.4' => true,
  131. ),
  132. ),
  133. 'debug_print_backtrace' => array(
  134. 0 => array(
  135. 'name' => 'options',
  136. '5.3.5' => false,
  137. '5.3.6' => true,
  138. ),
  139. 1 => array(
  140. 'name' => 'limit',
  141. '5.3' => false,
  142. '5.4' => true,
  143. ),
  144. ),
  145. 'dirname' => array(
  146. 1 => array(
  147. 'name' => 'levels',
  148. '5.6' => false,
  149. '7.0' => true,
  150. ),
  151. ),
  152. 'dns_get_record' => array(
  153. 4 => array(
  154. 'name' => 'raw',
  155. '5.3' => false,
  156. '5.4' => true,
  157. ),
  158. ),
  159. 'fgetcsv' => array(
  160. 4 => array(
  161. 'name' => 'escape',
  162. '5.2' => false,
  163. '5.3' => true,
  164. ),
  165. ),
  166. 'fputcsv' => array(
  167. 4 => array(
  168. 'name' => 'escape_char',
  169. '5.5.3' => false,
  170. '5.5.4' => true,
  171. ),
  172. ),
  173. 'file_get_contents' => array(
  174. 3 => array(
  175. 'name' => 'offset',
  176. '5.0' => false,
  177. '5.1' => true,
  178. ),
  179. 4 => array(
  180. 'name' => 'maxlen',
  181. '5.0' => false,
  182. '5.1' => true,
  183. ),
  184. ),
  185. 'filter_input_array' => array(
  186. 2 => array(
  187. 'name' => 'add_empty',
  188. '5.3' => false,
  189. '5.4' => true,
  190. ),
  191. ),
  192. 'filter_var_array' => array(
  193. 2 => array(
  194. 'name' => 'add_empty',
  195. '5.3' => false,
  196. '5.4' => true,
  197. ),
  198. ),
  199. 'getenv' => array(
  200. 1 => array(
  201. 'name' => 'local_only',
  202. '5.5.37' => false,
  203. '5.5.38' => true, // Also introduced in PHP 5.6.24 and 7.0.9.
  204. ),
  205. ),
  206. 'getopt' => array(
  207. 2 => array(
  208. 'name' => 'optind',
  209. '7.0' => false,
  210. '7.1' => true,
  211. ),
  212. ),
  213. 'gettimeofday' => array(
  214. 0 => array(
  215. 'name' => 'return_float',
  216. '5.0' => false,
  217. '5.1' => true,
  218. ),
  219. ),
  220. 'get_defined_functions' => array(
  221. 0 => array(
  222. 'name' => 'exclude_disabled',
  223. '7.0.14' => false,
  224. '7.0.15' => true,
  225. ),
  226. ),
  227. 'get_headers' => array(
  228. 2 => array(
  229. 'name' => 'context',
  230. '7.0' => false,
  231. '7.1' => true,
  232. ),
  233. ),
  234. 'get_html_translation_table' => array(
  235. 2 => array(
  236. 'name' => 'encoding',
  237. '5.3.3' => false,
  238. '5.3.4' => true,
  239. ),
  240. ),
  241. 'get_loaded_extensions' => array(
  242. 0 => array(
  243. 'name' => 'zend_extensions',
  244. '5.2.3' => false,
  245. '5.2.4' => true,
  246. ),
  247. ),
  248. 'gzcompress' => array(
  249. 2 => array(
  250. 'name' => 'encoding',
  251. '5.3' => false,
  252. '5.4' => true,
  253. ),
  254. ),
  255. 'gzdeflate' => array(
  256. 2 => array(
  257. 'name' => 'encoding',
  258. '5.3' => false,
  259. '5.4' => true,
  260. ),
  261. ),
  262. 'htmlentities' => array(
  263. 3 => array(
  264. 'name' => 'double_encode',
  265. '5.2.2' => false,
  266. '5.2.3' => true,
  267. ),
  268. ),
  269. 'htmlspecialchars' => array(
  270. 3 => array(
  271. 'name' => 'double_encode',
  272. '5.2.2' => false,
  273. '5.2.3' => true,
  274. ),
  275. ),
  276. 'http_build_query' => array(
  277. 2 => array(
  278. 'name' => 'arg_separator',
  279. '5.1.1' => false,
  280. '5.1.2' => true,
  281. ),
  282. 3 => array(
  283. 'name' => 'enc_type',
  284. '5.3' => false,
  285. '5.4' => true,
  286. ),
  287. ),
  288. 'idn_to_ascii' => array(
  289. 2 => array(
  290. 'name' => 'variant',
  291. '5.3' => false,
  292. '5.4' => true,
  293. ),
  294. 3 => array(
  295. 'name' => 'idna_info',
  296. '5.3' => false,
  297. '5.4' => true,
  298. ),
  299. ),
  300. 'idn_to_utf8' => array(
  301. 2 => array(
  302. 'name' => 'variant',
  303. '5.3' => false,
  304. '5.4' => true,
  305. ),
  306. 3 => array(
  307. 'name' => 'idna_info',
  308. '5.3' => false,
  309. '5.4' => true,
  310. ),
  311. ),
  312. 'imagecolorset' => array(
  313. 5 => array(
  314. 'name' => 'alpha',
  315. '5.3' => false,
  316. '5.4' => true,
  317. ),
  318. ),
  319. 'imagepng' => array(
  320. 2 => array(
  321. 'name' => 'quality',
  322. '5.1.1' => false,
  323. '5.1.2' => true,
  324. ),
  325. 3 => array(
  326. 'name' => 'filters',
  327. '5.1.2' => false,
  328. '5.1.3' => true,
  329. ),
  330. ),
  331. 'imagerotate' => array(
  332. 3 => array(
  333. 'name' => 'ignore_transparent',
  334. '5.0' => false,
  335. '5.1' => true,
  336. ),
  337. ),
  338. 'imap_open' => array(
  339. 4 => array(
  340. 'name' => 'n_retries',
  341. '5.1' => false,
  342. '5.2' => true,
  343. ),
  344. 5 => array(
  345. 'name' => 'params',
  346. '5.3.1' => false,
  347. '5.3.2' => true,
  348. ),
  349. ),
  350. 'imap_reopen' => array(
  351. 3 => array(
  352. 'name' => 'n_retries',
  353. '5.1' => false,
  354. '5.2' => true,
  355. ),
  356. ),
  357. 'ini_get_all' => array(
  358. 1 => array(
  359. 'name' => 'details',
  360. '5.2' => false,
  361. '5.3' => true,
  362. ),
  363. ),
  364. 'is_a' => array(
  365. 2 => array(
  366. 'name' => 'allow_string',
  367. '5.3.8' => false,
  368. '5.3.9' => true,
  369. ),
  370. ),
  371. 'is_subclass_of' => array(
  372. 2 => array(
  373. 'name' => 'allow_string',
  374. '5.3.8' => false,
  375. '5.3.9' => true,
  376. ),
  377. ),
  378. 'iterator_to_array' => array(
  379. 1 => array(
  380. 'name' => 'use_keys',
  381. '5.2.0' => false,
  382. '5.2.1' => true,
  383. ),
  384. ),
  385. 'json_decode' => array(
  386. 2 => array(
  387. 'name' => 'depth',
  388. '5.2' => false,
  389. '5.3' => true,
  390. ),
  391. 3 => array(
  392. 'name' => 'options',
  393. '5.3' => false,
  394. '5.4' => true,
  395. ),
  396. ),
  397. 'json_encode' => array(
  398. 1 => array(
  399. 'name' => 'options',
  400. '5.2' => false,
  401. '5.3' => true,
  402. ),
  403. 2 => array(
  404. 'name' => 'depth',
  405. '5.4' => false,
  406. '5.5' => true,
  407. ),
  408. ),
  409. 'ldap_add' => array(
  410. 3 => array(
  411. 'name' => 'serverctrls',
  412. '7.2' => false,
  413. '7.3' => true,
  414. ),
  415. ),
  416. 'ldap_compare' => array(
  417. 4 => array(
  418. 'name' => 'serverctrls',
  419. '7.2' => false,
  420. '7.3' => true,
  421. ),
  422. ),
  423. 'ldap_delete' => array(
  424. 2 => array(
  425. 'name' => 'serverctrls',
  426. '7.2' => false,
  427. '7.3' => true,
  428. ),
  429. ),
  430. 'ldap_list' => array(
  431. 8 => array(
  432. 'name' => 'serverctrls',
  433. '7.2' => false,
  434. '7.3' => true,
  435. ),
  436. ),
  437. 'ldap_mod_add' => array(
  438. 3 => array(
  439. 'name' => 'serverctrls',
  440. '7.2' => false,
  441. '7.3' => true,
  442. ),
  443. ),
  444. 'ldap_mod_del' => array(
  445. 3 => array(
  446. 'name' => 'serverctrls',
  447. '7.2' => false,
  448. '7.3' => true,
  449. ),
  450. ),
  451. 'ldap_mod_replace' => array(
  452. 3 => array(
  453. 'name' => 'serverctrls',
  454. '7.2' => false,
  455. '7.3' => true,
  456. ),
  457. ),
  458. 'ldap_modify_batch' => array(
  459. 3 => array(
  460. 'name' => 'serverctrls',
  461. '7.2' => false,
  462. '7.3' => true,
  463. ),
  464. ),
  465. 'ldap_parse_result' => array(
  466. 6 => array(
  467. 'name' => 'serverctrls',
  468. '7.2' => false,
  469. '7.3' => true,
  470. ),
  471. ),
  472. 'ldap_read' => array(
  473. 8 => array(
  474. 'name' => 'serverctrls',
  475. '7.2' => false,
  476. '7.3' => true,
  477. ),
  478. ),
  479. 'ldap_rename' => array(
  480. 5 => array(
  481. 'name' => 'serverctrls',
  482. '7.2' => false,
  483. '7.3' => true,
  484. ),
  485. ),
  486. 'ldap_search' => array(
  487. 8 => array(
  488. 'name' => 'serverctrls',
  489. '7.2' => false,
  490. '7.3' => true,
  491. ),
  492. ),
  493. 'memory_get_peak_usage' => array(
  494. 0 => array(
  495. 'name' => 'real_usage',
  496. '5.1' => false,
  497. '5.2' => true,
  498. ),
  499. ),
  500. 'memory_get_usage' => array(
  501. 0 => array(
  502. 'name' => 'real_usage',
  503. '5.1' => false,
  504. '5.2' => true,
  505. ),
  506. ),
  507. 'mb_encode_numericentity' => array(
  508. 3 => array(
  509. 'name' => 'is_hex',
  510. '5.3' => false,
  511. '5.4' => true,
  512. ),
  513. ),
  514. 'mb_strrpos' => array(
  515. /*
  516. * Note: the actual position is 2, but the original 3rd
  517. * parameter 'encoding' was moved to the 4th position.
  518. * So the only way to detect if offset is used is when
  519. * both offset and encoding are set.
  520. */
  521. 3 => array(
  522. 'name' => 'offset',
  523. '5.1' => false,
  524. '5.2' => true,
  525. ),
  526. ),
  527. 'mssql_connect' => array(
  528. 3 => array(
  529. 'name' => 'new_link',
  530. '5.0' => false,
  531. '5.1' => true,
  532. ),
  533. ),
  534. 'mysqli_commit' => array(
  535. 1 => array(
  536. 'name' => 'flags',
  537. '5.4' => false,
  538. '5.5' => true,
  539. ),
  540. 2 => array(
  541. 'name' => 'name',
  542. '5.4' => false,
  543. '5.5' => true,
  544. ),
  545. ),
  546. 'mysqli_rollback' => array(
  547. 1 => array(
  548. 'name' => 'flags',
  549. '5.4' => false,
  550. '5.5' => true,
  551. ),
  552. 2 => array(
  553. 'name' => 'name',
  554. '5.4' => false,
  555. '5.5' => true,
  556. ),
  557. ),
  558. 'nl2br' => array(
  559. 1 => array(
  560. 'name' => 'is_xhtml',
  561. '5.2' => false,
  562. '5.3' => true,
  563. ),
  564. ),
  565. 'openssl_decrypt' => array(
  566. 4 => array(
  567. 'name' => 'iv',
  568. '5.3.2' => false,
  569. '5.3.3' => true,
  570. ),
  571. 5 => array(
  572. 'name' => 'tag',
  573. '7.0' => false,
  574. '7.1' => true,
  575. ),
  576. 6 => array(
  577. 'name' => 'aad',
  578. '7.0' => false,
  579. '7.1' => true,
  580. ),
  581. ),
  582. 'openssl_encrypt' => array(
  583. 4 => array(
  584. 'name' => 'iv',
  585. '5.3.2' => false,
  586. '5.3.3' => true,
  587. ),
  588. 5 => array(
  589. 'name' => 'tag',
  590. '7.0' => false,
  591. '7.1' => true,
  592. ),
  593. 6 => array(
  594. 'name' => 'aad',
  595. '7.0' => false,
  596. '7.1' => true,
  597. ),
  598. 7 => array(
  599. 'name' => 'tag_length',
  600. '7.0' => false,
  601. '7.1' => true,
  602. ),
  603. ),
  604. 'openssl_open' => array(
  605. 4 => array(
  606. 'name' => 'method',
  607. '5.2' => false,
  608. '5.3' => true,
  609. ),
  610. 5 => array(
  611. 'name' => 'iv',
  612. '5.6' => false,
  613. '7.0' => true,
  614. ),
  615. ),
  616. 'openssl_pkcs7_verify' => array(
  617. 5 => array(
  618. 'name' => 'content',
  619. '5.0' => false,
  620. '5.1' => true,
  621. ),
  622. 6 => array(
  623. 'name' => 'p7bfilename',
  624. '7.1' => false,
  625. '7.2' => true,
  626. ),
  627. ),
  628. 'openssl_seal' => array(
  629. 4 => array(
  630. 'name' => 'method',
  631. '5.2' => false,
  632. '5.3' => true,
  633. ),
  634. 5 => array(
  635. 'name' => 'iv',
  636. '5.6' => false,
  637. '7.0' => true,
  638. ),
  639. ),
  640. 'openssl_verify' => array(
  641. 3 => array(
  642. 'name' => 'signature_alg',
  643. '5.1' => false,
  644. '5.2' => true,
  645. ),
  646. ),
  647. 'parse_ini_file' => array(
  648. 2 => array(
  649. 'name' => 'scanner_mode',
  650. '5.2' => false,
  651. '5.3' => true,
  652. ),
  653. ),
  654. 'parse_url' => array(
  655. 1 => array(
  656. 'name' => 'component',
  657. '5.1.1' => false,
  658. '5.1.2' => true,
  659. ),
  660. ),
  661. 'pg_fetch_all' => array(
  662. 1 => array(
  663. 'name' => 'result_type',
  664. '7.0' => false,
  665. '7.1' => true,
  666. ),
  667. ),
  668. 'pg_last_notice' => array(
  669. 1 => array(
  670. 'name' => 'option',
  671. '7.0' => false,
  672. '7.1' => true,
  673. ),
  674. ),
  675. 'pg_lo_create' => array(
  676. 1 => array(
  677. 'name' => 'object_id',
  678. '5.2' => false,
  679. '5.3' => true,
  680. ),
  681. ),
  682. 'pg_lo_import' => array(
  683. 2 => array(
  684. 'name' => 'object_id',
  685. '5.2' => false,
  686. '5.3' => true,
  687. ),
  688. ),
  689. 'pg_select' => array(
  690. 4 => array(
  691. 'name' => 'result_type',
  692. '7.0' => false,
  693. '7.1' => true,
  694. ),
  695. ),
  696. 'php_uname' => array(
  697. 0 => array(
  698. 'name' => 'mode',
  699. '4.2' => false,
  700. '4.3' => true,
  701. ),
  702. ),
  703. 'preg_replace' => array(
  704. 4 => array(
  705. 'name' => 'count',
  706. '5.0' => false,
  707. '5.1' => true,
  708. ),
  709. ),
  710. 'preg_replace_callback' => array(
  711. 4 => array(
  712. 'name' => 'count',
  713. '5.0' => false,
  714. '5.1' => true,
  715. ),
  716. 5 => array(
  717. 'name' => 'flags',
  718. '7.3' => false,
  719. '7.4' => true,
  720. ),
  721. ),
  722. 'preg_replace_callback_array' => array(
  723. 4 => array(
  724. 'name' => 'flags',
  725. '7.3' => false,
  726. '7.4' => true,
  727. ),
  728. ),
  729. 'round' => array(
  730. 2 => array(
  731. 'name' => 'mode',
  732. '5.2' => false,
  733. '5.3' => true,
  734. ),
  735. ),
  736. 'sem_acquire' => array(
  737. 1 => array(
  738. 'name' => 'nowait',
  739. '5.6' => false,
  740. '5.6.1' => true,
  741. ),
  742. ),
  743. 'session_regenerate_id' => array(
  744. 0 => array(
  745. 'name' => 'delete_old_session',
  746. '5.0' => false,
  747. '5.1' => true,
  748. ),
  749. ),
  750. 'session_set_cookie_params' => array(
  751. 4 => array(
  752. 'name' => 'httponly',
  753. '5.1' => false,
  754. '5.2' => true,
  755. ),
  756. ),
  757. 'session_set_save_handler' => array(
  758. 6 => array(
  759. 'name' => 'create_sid',
  760. '5.5.0' => false,
  761. '5.5.1' => true,
  762. ),
  763. 7 => array(
  764. 'name' => 'validate_sid',
  765. '5.6' => false,
  766. '7.0' => true,
  767. ),
  768. 8 => array(
  769. 'name' => 'update_timestamp',
  770. '5.6' => false,
  771. '7.0' => true,
  772. ),
  773. ),
  774. 'session_start' => array(
  775. 0 => array(
  776. 'name' => 'options',
  777. '5.6' => false,
  778. '7.0' => true,
  779. ),
  780. ),
  781. 'setcookie' => array(
  782. 6 => array(
  783. 'name' => 'httponly',
  784. '5.1' => false,
  785. '5.2' => true,
  786. ),
  787. ),
  788. 'setrawcookie' => array(
  789. 6 => array(
  790. 'name' => 'httponly',
  791. '5.1' => false,
  792. '5.2' => true,
  793. ),
  794. ),
  795. 'simplexml_load_file' => array(
  796. 4 => array(
  797. 'name' => 'is_prefix',
  798. '5.1' => false,
  799. '5.2' => true,
  800. ),
  801. ),
  802. 'simplexml_load_string' => array(
  803. 4 => array(
  804. 'name' => 'is_prefix',
  805. '5.1' => false,
  806. '5.2' => true,
  807. ),
  808. ),
  809. 'spl_autoload_register' => array(
  810. 2 => array(
  811. 'name' => 'prepend',
  812. '5.2' => false,
  813. '5.3' => true,
  814. ),
  815. ),
  816. 'stream_context_create' => array(
  817. 1 => array(
  818. 'name' => 'params',
  819. '5.2' => false,
  820. '5.3' => true,
  821. ),
  822. ),
  823. 'stream_copy_to_stream' => array(
  824. 3 => array(
  825. 'name' => 'offset',
  826. '5.0' => false,
  827. '5.1' => true,
  828. ),
  829. ),
  830. 'stream_get_contents' => array(
  831. 2 => array(
  832. 'name' => 'offset',
  833. '5.0' => false,
  834. '5.1' => true,
  835. ),
  836. ),
  837. 'stream_wrapper_register' => array(
  838. 2 => array(
  839. 'name' => 'flags',
  840. '5.2.3' => false,
  841. '5.2.4' => true,
  842. ),
  843. ),
  844. 'stristr' => array(
  845. 2 => array(
  846. 'name' => 'before_needle',
  847. '5.2' => false,
  848. '5.3' => true,
  849. ),
  850. ),
  851. 'strstr' => array(
  852. 2 => array(
  853. 'name' => 'before_needle',
  854. '5.2' => false,
  855. '5.3' => true,
  856. ),
  857. ),
  858. 'str_word_count' => array(
  859. 2 => array(
  860. 'name' => 'charlist',
  861. '5.0' => false,
  862. '5.1' => true,
  863. ),
  864. ),
  865. 'substr_count' => array(
  866. 2 => array(
  867. 'name' => 'offset',
  868. '5.0' => false,
  869. '5.1' => true,
  870. ),
  871. 3 => array(
  872. 'name' => 'length',
  873. '5.0' => false,
  874. '5.1' => true,
  875. ),
  876. ),
  877. 'sybase_connect' => array(
  878. 5 => array(
  879. 'name' => 'new',
  880. '5.2' => false,
  881. '5.3' => true,
  882. ),
  883. ),
  884. 'timezone_transitions_get' => array(
  885. 1 => array(
  886. 'name' => 'timestamp_begin',
  887. '5.2' => false,
  888. '5.3' => true,
  889. ),
  890. 2 => array(
  891. 'name' => 'timestamp_end',
  892. '5.2' => false,
  893. '5.3' => true,
  894. ),
  895. ),
  896. 'timezone_identifiers_list' => array(
  897. 0 => array(
  898. 'name' => 'what',
  899. '5.2' => false,
  900. '5.3' => true,
  901. ),
  902. 1 => array(
  903. 'name' => 'country',
  904. '5.2' => false,
  905. '5.3' => true,
  906. ),
  907. ),
  908. 'token_get_all' => array(
  909. 1 => array(
  910. 'name' => 'flags',
  911. '5.6' => false,
  912. '7.0' => true,
  913. ),
  914. ),
  915. 'ucwords' => array(
  916. 1 => array(
  917. 'name' => 'delimiters',
  918. '5.4.31' => false,
  919. '5.5.15' => false,
  920. '5.4.32' => true,
  921. '5.5.16' => true,
  922. ),
  923. ),
  924. 'unpack' => array(
  925. 2 => array(
  926. 'name' => 'offset',
  927. '7.0' => false,
  928. '7.1' => true,
  929. ),
  930. ),
  931. 'unserialize' => array(
  932. 1 => array(
  933. 'name' => 'options',
  934. '5.6' => false,
  935. '7.0' => true,
  936. ),
  937. ),
  938. );
  939. /**
  940. * Returns an array of tokens this test wants to listen for.
  941. *
  942. * @since 7.0.0
  943. *
  944. * @return array
  945. */
  946. public function register()
  947. {
  948. // Handle case-insensitivity of function names.
  949. $this->newFunctionParameters = $this->arrayKeysToLowercase($this->newFunctionParameters);
  950. return array(\T_STRING);
  951. }
  952. /**
  953. * Processes this test, when one of its tokens is encountered.
  954. *
  955. * @since 7.0.0
  956. *
  957. * @param \PHP_CodeSniffer_File $phpcsFile The file being scanned.
  958. * @param int $stackPtr The position of the current token in
  959. * the stack passed in $tokens.
  960. *
  961. * @return void
  962. */
  963. public function process(File $phpcsFile, $stackPtr)
  964. {
  965. $tokens = $phpcsFile->getTokens();
  966. $ignore = array(
  967. \T_DOUBLE_COLON => true,
  968. \T_OBJECT_OPERATOR => true,
  969. \T_FUNCTION => true,
  970. \T_CONST => true,
  971. );
  972. $prevToken = $phpcsFile->findPrevious(\T_WHITESPACE, ($stackPtr - 1), null, true);
  973. if (isset($ignore[$tokens[$prevToken]['code']]) === true) {
  974. // Not a call to a PHP function.
  975. return;
  976. }
  977. $function = $tokens[$stackPtr]['content'];
  978. $functionLc = strtolower($function);
  979. if (isset($this->newFunctionParameters[$functionLc]) === false) {
  980. return;
  981. }
  982. $parameterCount = $this->getFunctionCallParameterCount($phpcsFile, $stackPtr);
  983. if ($parameterCount === 0) {
  984. return;
  985. }
  986. // If the parameter count returned > 0, we know there will be valid open parenthesis.
  987. $openParenthesis = $phpcsFile->findNext(Tokens::$emptyTokens, $stackPtr + 1, null, true, null, true);
  988. $parameterOffsetFound = $parameterCount - 1;
  989. foreach ($this->newFunctionParameters[$functionLc] as $offset => $parameterDetails) {
  990. if ($offset <= $parameterOffsetFound) {
  991. $itemInfo = array(
  992. 'name' => $function,
  993. 'nameLc' => $functionLc,
  994. 'offset' => $offset,
  995. );
  996. $this->handleFeature($phpcsFile, $openParenthesis, $itemInfo);
  997. }
  998. }
  999. }
  1000. /**
  1001. * Get the relevant sub-array for a specific item from a multi-dimensional array.
  1002. *
  1003. * @since 7.1.0
  1004. *
  1005. * @param array $itemInfo Base information about the item.
  1006. *
  1007. * @return array Version and other information about the item.
  1008. */
  1009. public function getItemArray(array $itemInfo)
  1010. {
  1011. return $this->newFunctionParameters[$itemInfo['nameLc']][$itemInfo['offset']];
  1012. }
  1013. /**
  1014. * Get an array of the non-PHP-version array keys used in a sub-array.
  1015. *
  1016. * @since 7.1.0
  1017. *
  1018. * @return array
  1019. */
  1020. protected function getNonVersionArrayKeys()
  1021. {
  1022. return array('name');
  1023. }
  1024. /**
  1025. * Retrieve the relevant detail (version) information for use in an error message.
  1026. *
  1027. * @since 7.1.0
  1028. *
  1029. * @param array $itemArray Version and other information about the item.
  1030. * @param array $itemInfo Base information about the item.
  1031. *
  1032. * @return array
  1033. */
  1034. public function getErrorInfo(array $itemArray, array $itemInfo)
  1035. {
  1036. $errorInfo = parent::getErrorInfo($itemArray, $itemInfo);
  1037. $errorInfo['paramName'] = $itemArray['name'];
  1038. return $errorInfo;
  1039. }
  1040. /**
  1041. * Get the item name to be used for the creation of the error code.
  1042. *
  1043. * @since 7.1.0
  1044. *
  1045. * @param array $itemInfo Base information about the item.
  1046. * @param array $errorInfo Detail information about an item.
  1047. *
  1048. * @return string
  1049. */
  1050. protected function getItemName(array $itemInfo, array $errorInfo)
  1051. {
  1052. return $itemInfo['name'] . '_' . $errorInfo['paramName'];
  1053. }
  1054. /**
  1055. * Get the error message template for this sniff.
  1056. *
  1057. * @since 7.1.0
  1058. *
  1059. * @return string
  1060. */
  1061. protected function getErrorMsgTemplate()
  1062. {
  1063. return 'The function %s() does not have a parameter "%s" in PHP version %s or earlier';
  1064. }
  1065. /**
  1066. * Allow for concrete child classes to filter the error data before it's passed to PHPCS.
  1067. *
  1068. * @since 7.1.0
  1069. *
  1070. * @param array $data The error data array which was created.
  1071. * @param array $itemInfo Base information about the item this error message applies to.
  1072. * @param array $errorInfo Detail information about an item this error message applies to.
  1073. *
  1074. * @return array
  1075. */
  1076. protected function filterErrorData(array $data, array $itemInfo, array $errorInfo)
  1077. {
  1078. array_shift($data);
  1079. array_unshift($data, $itemInfo['name'], $errorInfo['paramName']);
  1080. return $data;
  1081. }
  1082. }