dedalozzo / lint

src/Lint/Lint.php

<?php

/**
 * @file Lint.php
 * @brief This file contains the Lint class.
 * @details
 * @author Filippo F. Fadda
 */


//! Global namespace.

50% of this comment could be valid code. Did you maybe forget this after debugging?

namespace Lint;


/**
 * @brief Lint is a wrapper to `php -l` command.
*/
final class Lint {


  /**
   * @brief Performs the real syntax check.
   * @param string $sourceCode The source code.
   * @param bool $addTags (optional) Tells if you want add PHP tags to the source code, because PHP lint needs
   * them or it will raise an exception.
   */
  protected static function checkSyntax($sourceCode, $addTags = FALSE) {
    if ($addTags)
      // We add the PHP tags, else the lint ignores the code. The PHP command line option -r doesn't work.
      $sourceCode = "<?php ".$sourceCode." ?>";

    // Try to create a temporary physical file. The function `proc_open` doesn't allow to use a memory file.
    if ($fd = fopen("php://temp", "r+")) {
      fputs($fd, $sourceCode); // We don't need to flush because we call rewind.
      rewind($fd); // Sets the pointer to the beginning of the file stream.

      $dspec = array(
        $fd,
        1 => array('pipe', 'w'), // stdout
        2 => array('pipe', 'w'), // stderr
      );

      $proc = proc_open(PHP_BINARY." -l", $dspec, $pipes);

      if (is_resource($proc)) {
        // Reads the stdout output.
        $output = "";
        while (!feof($pipes[1])) {
          $output .= fgets($pipes[1]);
        }

        // Reads the stderr output.
        $error = "";
        while (!feof($pipes[2])) {
          $error .= fgets($pipes[2]);
        }

        // Free all resources.
        fclose($fd);
        fclose($pipes[1]);
        fclose($pipes[2]);
        $exitCode = proc_close($proc);

        if ($exitCode != 0) {
          $pattern = array("/\APHP Parse error:  /",
            "/in - /",
            "/\z -\n/");

          $error = ucfirst(preg_replace($pattern, "", $error));

          throw new \RuntimeException($error);
        }
      }
      else
        throw new \RuntimeException("Cannot execute the `php -l` command.");
    }
    else
      throw new \RuntimeException("Cannot create the temporary file with the source code.");
  }


  /**
   * @brief Makes the syntax check of the specified file. If an error occurs, generates an exception.
   * @warning File source code must be included in PHP tags.
   * @param string $fileName The file name you want check.
   */
  public static function checkSourceFile($fileName) {
    if (file_exists($fileName)) {
      $fd = fopen($fileName, "r");

      if (is_resource($fd)) {
        $sourceCode = "";

        while (!feof($fd))
          $sourceCode .= fgets($fd);

        self::checkSyntax($sourceCode);
      }
      else
        throw new \RuntimeException("Cannot open the file.");
    }
    else
      throw new \RuntimeException("File not found.");
  }


  /**
   * @brief Makes the syntax check of the given source code. If an error occurs, generates an exception.
   * @param string $str The source code.
   * @param bool $addTags (optional) Tells if you want add PHP tags to the source code, because PHP lint needs
   * them or it will raise an exception.
   */
  public static function checkSourceCode($str, $addTags = TRUE) {
    if (is_string($str))
      self::checkSyntax($str, $addTags);
    else
      throw new \RuntimeException("\$str must be a string.");
  }

}