Conditions | 7 |
Paths | 20 |
Total Lines | 53 |
Code Lines | 32 |
Lines | 0 |
Ratio | 0 % |
Changes | 0 |
Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.
For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.
Commonly applied refactorings include:
If many parameters/temporary variables are present:
1 | <?php |
||
27 | protected static function checkSyntax($sourceCode, $addTags = FALSE) { |
||
28 | if ($addTags) |
||
29 | // We add the PHP tags, else the lint ignores the code. The PHP command line option -r doesn't work. |
||
30 | $sourceCode = "<?php ".$sourceCode." ?>"; |
||
31 | |||
32 | // Try to create a temporary physical file. The function `proc_open` doesn't allow to use a memory file. |
||
33 | if ($fd = fopen("php://temp", "r+")) { |
||
34 | fputs($fd, $sourceCode); // We don't need to flush because we call rewind. |
||
35 | rewind($fd); // Sets the pointer to the beginning of the file stream. |
||
36 | |||
37 | $dspec = array( |
||
38 | $fd, |
||
39 | 1 => array('pipe', 'w'), // stdout |
||
40 | 2 => array('pipe', 'w'), // stderr |
||
41 | ); |
||
42 | |||
43 | $proc = proc_open(PHP_BINARY." -l", $dspec, $pipes); |
||
44 | |||
45 | if (is_resource($proc)) { |
||
46 | // Reads the stdout output. |
||
47 | $output = ""; |
||
48 | while (!feof($pipes[1])) { |
||
49 | $output .= fgets($pipes[1]); |
||
50 | } |
||
51 | |||
52 | // Reads the stderr output. |
||
53 | $error = ""; |
||
54 | while (!feof($pipes[2])) { |
||
55 | $error .= fgets($pipes[2]); |
||
56 | } |
||
57 | |||
58 | // Free all resources. |
||
59 | fclose($fd); |
||
60 | fclose($pipes[1]); |
||
61 | fclose($pipes[2]); |
||
62 | $exitCode = proc_close($proc); |
||
63 | |||
64 | if ($exitCode != 0) { |
||
65 | $pattern = array("/\APHP Parse error: /", |
||
66 | "/in - /", |
||
67 | "/\z -\n/"); |
||
68 | |||
69 | $error = ucfirst(preg_replace($pattern, "", $error)); |
||
70 | |||
71 | throw new \RuntimeException($error); |
||
72 | } |
||
73 | } |
||
74 | else |
||
75 | throw new \RuntimeException("Cannot execute the `php -l` command."); |
||
76 | } |
||
77 | else |
||
78 | throw new \RuntimeException("Cannot create the temporary file with the source code."); |
||
79 | } |
||
80 | |||
120 | } |
Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.
The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.
This check looks for comments that seem to be mostly valid code and reports them.