PageRenderTime 46ms CodeModel.GetById 16ms RepoModel.GetById 1ms app.codeStats 0ms

/PHPCompatibility/Tests/FunctionUse/NewFunctionParametersUnitTest.php

http://github.com/wimg/PHPCompatibility
PHP | 253 lines | 182 code | 11 blank | 60 comment | 0 complexity | 146633d446421e16f641338d397947d9 MD5 | raw file
Possible License(s): LGPL-3.0 
    

  1. <?php
    2. 

  2. /**
    3. 

  3.  * PHPCompatibility, an external standard for PHP_CodeSniffer.
    4. 

  4.  *
    5. 

  5.  * @package   PHPCompatibility
    6. 

  6.  * @copyright 2012-2020 PHPCompatibility Contributors
    7. 

  7.  * @license   https://opensource.org/licenses/LGPL-3.0 LGPL3
    8. 

  8.  * @link      https://github.com/PHPCompatibility/PHPCompatibility
    9. 

  9.  */
    10. 

  10. 

  11. namespace PHPCompatibility\Tests\FunctionUse;
    12. 

  12. 

  13. use PHPCompatibility\Tests\BaseSniffTest;
    14. 

  14. 

  15. /**
    16. 

  16.  * Test the NewFunctionParameters sniff.
    17. 

  17.  *
    18. 

  18.  * @group newFunctionParameters
    19. 

  19.  * @group functionUse
    20. 

  20.  *
    21. 

  21.  * @covers \PHPCompatibility\Sniffs\FunctionUse\NewFunctionParametersSniff
    22. 

  22.  *
    23. 

  23.  * @since 7.0.0
    24. 

  24.  */
    25. 

  25. class NewFunctionParametersUnitTest extends BaseSniffTest
    26. 

  26. {
    27. 

  27. 

  28.     /**
    29. 

  29.      * testInvalidParameter
    30. 

  30.      *
    31. 

  31.      * @dataProvider dataInvalidParameter
    32. 

  32.      *
    33. 

  33.      * @param string $functionName      Function name.
    34. 

  34.      * @param string $parameterName     Parameter name.
    35. 

  35.      * @param string $lastVersionBefore The PHP version just *before* the parameter was introduced.
    36. 

  36.      * @param array  $lines             The line numbers in the test file which apply to this function parameter.
    37. 

  37.      * @param string $okVersion         A PHP version in which the parameter was ok to be used.
    38. 

  38.      * @param string $testVersion       Optional PHP version to use for testing the flagged case.
    39. 

  39.      *
    40. 

  40.      * @return void
    41. 

  41.      */
    42. 

  42.     public function testInvalidParameter($functionName, $parameterName, $lastVersionBefore, $lines, $okVersion, $testVersion = null)
    43. 

  43.     {
    44. 

  44.         $errorVersion = (isset($testVersion)) ? $testVersion : $lastVersionBefore;
    45. 

  45.         $file         = $this->sniffFile(__FILE__, $errorVersion);
    46. 

  46.         $error        = "The function {$functionName}() does not have a parameter \"{$parameterName}\" in PHP version {$lastVersionBefore} or earlier";
    47. 

  47.         foreach ($lines as $line) {
    48. 

  48.             $this->assertError($file, $line, $error);
    49. 

  49.         }
    50. 

  50. 

  51.         $file = $this->sniffFile(__FILE__, $okVersion);
    52. 

  52.         foreach ($lines as $line) {
    53. 

  53.             $this->assertNoViolation($file, $line);
    54. 

  54.         }
    55. 

  55.     }
    56. 

  56. 

  57.     /**
    58. 

  58.      * Data provider.
    59. 

  59.      *
    60. 

  60.      * @see testInvalidParameter()
    61. 

  61.      *
    62. 

  62.      * @return array
    63. 

  63.      */
    64. 

  64.     public function dataInvalidParameter()
    65. 

  65.     {
    66. 

  66.         return [
    67. 

  67.             ['array_filter', 'flag', '5.5', [11], '5.6'],
    68. 

  68.             ['array_slice', 'preserve_keys', '5.0.1', [12], '5.1', '5.0'],
    69. 

  69.             ['array_unique', 'sort_flags', '5.2.8', [13], '5.3', '5.2'],
    70. 

  70.             ['assert', 'description', '5.4.7', [14], '5.5', '5.4'],
    71. 

  71.             ['base64_decode', 'strict', '5.1', [15], '5.2'],
    72. 

  72.             ['bcmod', 'scale', '7.1', [96], '7.2'],
    73. 

  73.             ['class_implements', 'autoload', '5.0', [16], '5.1'],
    74. 

  74.             ['class_parents', 'autoload', '5.0', [17], '5.1'],
    75. 

  75.             ['clearstatcache', 'clear_realpath_cache', '5.2', [18], '5.3'],
    76. 

  76.             ['clearstatcache', 'filename', '5.2', [18], '5.3'],
    77. 

  77.             ['copy', 'context', '5.2', [19], '5.3'],
    78. 

  78.             ['curl_multi_info_read', 'msgs_in_queue', '5.1', [20], '5.2'],
    79. 

  79.             ['date_time_set', 'microseconds', '7.0', [119], '7.1'],
    80. 

  80.             ['debug_backtrace', 'options', '5.2.4', [21], '5.4', '5.2'],
    81. 

  81.             ['debug_backtrace', 'limit', '5.3', [21], '5.4'],
    82. 

  82.             ['debug_print_backtrace', 'options', '5.3.5', [22], '5.4', '5.3'],
    83. 

  83.             ['debug_print_backtrace', 'limit', '5.3', [22], '5.4'],
    84. 

  84.             ['dirname', 'levels', '5.6', [23], '7.0'],
    85. 

  85.             ['dns_get_record', 'raw', '5.3', [24], '5.4'],
    86. 

  86.             ['fgetcsv', 'escape', '5.2', [25], '5.3'],
    87. 

  87.             ['fputcsv', 'escape_char', '5.5.3', [26], '5.6', '5.5'],
    88. 

  88.             ['file_get_contents', 'offset', '5.0', [27], '5.1'],
    89. 

  89.             ['file_get_contents', 'maxlen', '5.0', [27], '5.1'],
    90. 

  90.             ['filter_input_array', 'add_empty', '5.3', [28], '5.4'],
    91. 

  91.             ['filter_var_array', 'add_empty', '5.3', [29], '5.4'],
    92. 

  92.             ['getenv', 'local_only', '5.5.37', [105], '5.6', '5.5'],
    93. 

  93.             ['getopt', 'optind', '7.0', [98], '7.1'],
    94. 

  94.             ['gettimeofday', 'return_float', '5.0', [30], '5.1'],
    95. 

  95.             ['get_defined_functions', 'exclude_disabled', '7.0.14', [95], '7.1', '7.0'],
    96. 

  96.             ['get_headers', 'context', '7.0', [97], '7.1'],
    97. 

  97.             ['get_html_translation_table', 'encoding', '5.3.3', [31], '5.4', '5.3'],
    98. 

  98.             ['get_loaded_extensions', 'zend_extensions', '5.2.3', [32], '5.3', '5.2'],
    99. 

  99.             ['gzcompress', 'encoding', '5.3', [33], '5.4'],
    100. 

  100.             ['gzdeflate', 'encoding', '5.3', [34], '5.4'],
    101. 

  101.             ['htmlentities', 'double_encode', '5.2.2', [35], '5.3', '5.2'],
    102. 

  102.             ['htmlspecialchars', 'double_encode', '5.2.2', [36], '5.3', '5.2'],
    103. 

  103.             ['http_build_query', 'arg_separator', '5.1.1', [37], '5.4', '5.1'],
    104. 

  104.             ['http_build_query', 'enc_type', '5.3', [37], '5.4'],
    105. 

  105.             ['idn_to_ascii', 'variant', '5.3', [38], '5.4'],
    106. 

  106.             ['idn_to_ascii', 'idna_info', '5.3', [38], '5.4'],
    107. 

  107.             ['idn_to_utf8', 'variant', '5.3', [39], '5.4'],
    108. 

  108.             ['idn_to_utf8', 'idna_info', '5.3', [39], '5.4'],
    109. 

  109.             ['imagecolorset', 'alpha', '5.3', [40], '5.4'],
    110. 

  110.             ['imagepng', 'quality', '5.1.1', [41], '5.2', '5.1'],
    111. 

  111.             ['imagepng', 'filters', '5.1.2', [41], '5.2', '5.1'],
    112. 

  112.             ['imagerotate', 'ignore_transparent', '5.0', [42], '5.1'],
    113. 

  113.             ['imap_open', 'n_retries', '5.1', [43], '5.4'],
    114. 

  114.             ['imap_open', 'params', '5.3.1', [43], '5.4', '5.3'],
    115. 

  115.             ['imap_reopen', 'n_retries', '5.1', [44], '5.2'],
    116. 

  116.             ['ini_get_all', 'details', '5.2', [45], '5.3'],
    117. 

  117.             ['is_a', 'allow_string', '5.3.8', [46], '5.4', '5.3'],
    118. 

  118.             ['is_subclass_of', 'allow_string', '5.3.8', [47], '5.4', '5.3'],
    119. 

  119.             ['iterator_to_array', 'use_keys', '5.2.0', [48], '5.3', '5.2'], // Function introduced in 5.2.1.
    120. 

  120.             ['json_decode', 'depth', '5.2', [49], '5.4'], // OK version > version in which last parameter was added to the function.
    121. 

  121.             ['json_decode', 'options', '5.3', [49], '5.4'],
    122. 

  122.             ['json_encode', 'options', '5.2', [50], '5.5'], // OK version > version in which last parameter was added to the function.
    123. 

  123.             ['json_encode', 'depth', '5.4', [50], '5.5'],
    124. 

  124.             ['ldap_add', 'serverctrls', '7.2', [106], '7.3'],
    125. 

  125.             ['ldap_compare', 'serverctrls', '7.2', [107], '7.3'],
    126. 

  126.             ['ldap_delete', 'serverctrls', '7.2', [108], '7.3'],
    127. 

  127.             ['ldap_exop', 'serverctrls', '7.2', [121], '7.3'],
    128. 

  128.             ['ldap_exop_passwd', 'serverctrls', '7.2', [122], '7.3'],
    129. 

  129.             ['ldap_list', 'serverctrls', '7.2', [109], '7.3'],
    130. 

  130.             ['ldap_mod_add', 'serverctrls', '7.2', [110], '7.3'],
    131. 

  131.             ['ldap_mod_del', 'serverctrls', '7.2', [111], '7.3'],
    132. 

  132.             ['ldap_mod_replace', 'serverctrls', '7.2', [112], '7.3'],
    133. 

  133.             ['ldap_modify_batch', 'serverctrls', '7.2', [113], '7.3'],
    134. 

  134.             ['ldap_parse_result', 'serverctrls', '7.2', [114], '7.3'],
    135. 

  135.             ['ldap_read', 'serverctrls', '7.2', [115], '7.3'],
    136. 

  136.             ['ldap_rename', 'serverctrls', '7.2', [116], '7.3'],
    137. 

  137.             ['ldap_search', 'serverctrls', '7.2', [117], '7.3'],
    138. 

  138.             ['memory_get_peak_usage', 'real_usage', '5.1', [51], '5.2'],
    139. 

  139.             ['memory_get_usage', 'real_usage', '5.1', [52], '5.2'],
    140. 

  140.             ['mb_decode_numericentity', 'is_hex', '5.3', [120], '5.4'],
    141. 

  141.             ['mb_encode_numericentity', 'is_hex', '5.3', [53], '5.4'],
    142. 

  142.             ['mb_strrpos', 'offset', '5.1', [54], '5.2'],
    143. 

  143.             ['mssql_connect', 'new_link', '5.0', [55], '5.1'],
    144. 

  144.             ['mysqli_commit', 'flags', '5.4', [56], '5.5'],
    145. 

  145.             ['mysqli_commit', 'name', '5.4', [56], '5.5'],
    146. 

  146.             ['mysqli_rollback', 'flags', '5.4', [57], '5.5'],
    147. 

  147.             ['mysqli_rollback', 'name', '5.4', [57], '5.5'],
    148. 

  148.             ['nl2br', 'is_xhtml', '5.2', [58], '5.3'],
    149. 

  149.             ['openssl_decrypt', 'iv', '5.3.2', [59], '7.1', '5.3'], // OK version > version in which last parameter was added to the function.
    150. 

  150.             ['openssl_decrypt', 'tag', '7.0', [59], '7.1'],
    151. 

  151.             ['openssl_decrypt', 'aad', '7.0', [59], '7.1'],
    152. 

  152.             ['openssl_encrypt', 'iv', '5.3.2', [60], '7.1', '5.3'], // OK version > version in which last parameter was added to the function.
    153. 

  153.             ['openssl_encrypt', 'tag', '7.0', [60], '7.1'],
    154. 

  154.             ['openssl_encrypt', 'aad', '7.0', [60], '7.1'],
    155. 

  155.             ['openssl_encrypt', 'tag_length', '7.0', [60], '7.1'],
    156. 

  156.             ['openssl_open', 'method', '5.2', [103], '7.0'], // OK version > version in which last parameter was added to the function.
    157. 

  157.             ['openssl_open', 'iv', '5.6', [103], '7.0'],
    158. 

  158.             ['openssl_pkcs7_verify', 'content', '5.0', [61], '7.2'], // OK version > version in which last parameter was added to the function.
    159. 

  159.             ['openssl_pkcs7_verify', 'p7bfilename', '7.1', [61], '7.2'],
    160. 

  160.             ['openssl_seal', 'method', '5.2', [62], '7.0'], // OK version > version in which last parameter was added to the function.
    161. 

  161.             ['openssl_seal', 'iv', '5.6', [62], '7.0'],
    162. 

  162.             ['openssl_verify', 'signature_alg', '5.1', [63], '5.2'],
    163. 

  163.             ['parse_ini_file', 'scanner_mode', '5.2', [64], '5.3'],
    164. 

  164.             ['parse_url', 'component', '5.1.1', [65], '5.2', '5.1'],
    165. 

  165.             ['pg_escape_bytea', 'connection', '5.1', [123], '5.2'],
    166. 

  166.             ['pg_escape_string', 'connection', '5.1', [124], '5.2'],
    167. 

  167.             ['pg_fetch_all', 'result_type', '7.0', [99], '7.1'],
    168. 

  168.             ['pg_last_notice', 'option', '7.0', [100], '7.1'],
    169. 

  169.             ['pg_lo_create', 'object_id', '5.2', [66], '5.3'],
    170. 

  170.             ['pg_lo_import', 'object_id', '5.2', [67], '5.3'],
    171. 

  171.             ['pg_meta_data', 'extended', '5.5', [125], '5.6'],
    172. 

  172.             ['pg_select', 'result_type', '7.0', [101], '7.1'],
    173. 

  173.             ['php_uname', 'mode', '4.2', [104], '4.3'],
    174. 

  174.             ['preg_replace', 'count', '5.0', [68], '5.1'],
    175. 

  175.             ['preg_replace_callback', 'count', '5.0', [69], '7.4'], // OK version > version in which last parameter was added to the function.
    176. 

  176.             ['preg_replace_callback', 'flags', '7.3', [69], '7.4'],
    177. 

  177.             ['preg_replace_callback_array', 'flags', '7.3', [118], '7.4'],
    178. 

  178.             ['round', 'mode', '5.2', [70], '5.3'],
    179. 

  179.             ['sem_acquire', 'nowait', '5.6.0', [71], '7.0', '5.6'],
    180. 

  180.             ['session_regenerate_id', 'delete_old_session', '5.0', [72], '5.1'],
    181. 

  181.             ['session_set_cookie_params', 'httponly', '5.1', [73], '5.2'],
    182. 

  182.             ['session_set_save_handler', 'create_sid', '5.5.0', [74], '7.0', '5.5'], // OK version > version in which last parameter was added to the function.
    183. 

  183.             ['session_set_save_handler', 'validate_sid', '5.6', [74], '7.0'],
    184. 

  184.             ['session_set_save_handler', 'update_timestamp', '5.6', [74], '7.0'],
    185. 

  185.             ['session_start', 'options', '5.6', [75], '7.0'],
    186. 

  186.             ['setcookie', 'httponly', '5.1', [76], '5.2'],
    187. 

  187.             ['setrawcookie', 'httponly', '5.1', [77], '5.2'],
    188. 

  188.             ['simplexml_load_file', 'is_prefix', '5.1', [78], '5.2'],
    189. 

  189.             ['simplexml_load_string', 'is_prefix', '5.1', [79], '5.2'],
    190. 

  190.             ['spl_autoload_register', 'prepend', '5.2', [80], '5.3'],
    191. 

  191.             ['stream_context_create', 'params', '5.2', [81], '5.3'],
    192. 

  192.             ['stream_copy_to_stream', 'offset', '5.0', [82], '5.1'],
    193. 

  193.             ['stream_get_contents', 'offset', '5.0', [83], '5.1'],
    194. 

  194.             ['stream_wrapper_register', 'flags', '5.2.3', [84], '5.3', '5.2'],
    195. 

  195.             ['stristr', 'before_needle', '5.2', [85], '5.3'],
    196. 

  196.             ['strstr', 'before_needle', '5.2', [86], '5.3'],
    197. 

  197.             ['str_word_count', 'charlist', '5.0', [87], '5.1'],
    198. 

  198.             ['substr_count', 'offset', '5.0', [88], '5.1'],
    199. 

  199.             ['substr_count', 'length', '5.0', [88], '5.1'],
    200. 

  200.             ['sybase_connect', 'new', '5.2', [89], '5.3'],
    201. 

  201.             ['timezone_transitions_get', 'timestamp_begin', '5.2', [90], '5.3'],
    202. 

  202.             ['timezone_transitions_get', 'timestamp_end', '5.2', [90], '5.3'],
    203. 

  203.             ['timezone_identifiers_list', 'what', '5.2', [91], '5.3'],
    204. 

  204.             ['timezone_identifiers_list', 'country', '5.2', [91], '5.3'],
    205. 

  205.             ['token_get_all', 'flags', '5.6', [92], '7.0'],
    206. 

  206.             ['ucwords', 'delimiters', '5.4.31', [93], '5.6', '5.4'], // Function introduced in 5.4.31 and 5.5.15.
    207. 

  207.             ['unpack', 'offset', '7.0', [102], '7.1'],
    208. 

  208.             ['unserialize', 'options', '5.6', [94], '7.0'],
    209. 

  209.         ];
    210. 

  210.     }
    211. 

  211. 

  212. 

  213.     /**
    214. 

  214.      * testNoFalsePositives
    215. 

  215.      *
    216. 

  216.      * @dataProvider dataNoFalsePositives
    217. 

  217.      *
    218. 

  218.      * @param int $line The line number.
    219. 

  219.      *
    220. 

  220.      * @return void
    221. 

  221.      */
    222. 

  222.     public function testNoFalsePositives($line)
    223. 

  223.     {
    224. 

  224.         $file = $this->sniffFile(__FILE__, '5.0'); // Low version below the first addition.
    225. 

  225.         $this->assertNoViolation($file, $line);
    226. 

  226.     }
    227. 

  227. 

  228.     /**
    229. 

  229.      * Data provider.
    230. 

  230.      *
    231. 

  231.      * @see testNoFalsePositives()
    232. 

  232.      *
    233. 

  233.      * @return array
    234. 

  234.      */
    235. 

  235.     public function dataNoFalsePositives()
    236. 

  236.     {
    237. 

  237.         return [
    238. 

  238.             [4],
    239. 

  239.         ];
    240. 

  240.     }
    241. 

  241. 

  242. 

  243.     /**
    244. 

  244.      * Verify no notices are thrown at all.
    245. 

  245.      *
    246. 

  246.      * @return void
    247. 

  247.      */
    248. 

  248.     public function testNoViolationsInFileOnValidVersion()
    249. 

  249.     {
    250. 

  250.         $file = $this->sniffFile(__FILE__, '99.0'); // High version beyond newest addition.
    251. 

  251.         $this->assertNoViolation($file);
    252. 

  252.     }
    253. 

  253. }
    254. 

  254.