Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. Gitblame.php

class Gitblame

Hierarchy

  • class \PHP_CodeSniffer\Reports\VersionControl implements \PHP_CodeSniffer\Reports\Report
    • class \PHP_CodeSniffer\Reports\Gitblame extends \PHP_CodeSniffer\Reports\VersionControl

Expanded class hierarchy of Gitblame

File

vendor/squizlabs/php_codesniffer/src/Reports/Gitblame.php, line 15

Namespace

PHP_CodeSniffer\Reports
View source
class Gitblame extends VersionControl {
    
    /**
     * The name of the report we want in the output
     *
     * @var string
     */
    protected $reportName = 'GIT';
    
    /**
     * Extract the author from a blame line.
     *
     * @param string $line Line to parse.
     *
     * @return mixed string or false if impossible to recover.
     */
    protected function getAuthor($line) {
        $blameParts = [];
        $line = preg_replace('|\\s+|', ' ', $line);
        preg_match('|\\(.+[0-9]{4}-[0-9]{2}-[0-9]{2}\\s+[0-9]+\\)|', $line, $blameParts);
        if (isset($blameParts[0]) === false) {
            return false;
        }
        $parts = explode(' ', $blameParts[0]);
        if (count($parts) < 2) {
            return false;
        }
        $parts = array_slice($parts, 0, count($parts) - 2);
        $author = preg_replace('|\\(|', '', implode(' ', $parts));
        return $author;
    }
    
    //end getAuthor()
    
    /**
     * Gets the blame output.
     *
     * @param string $filename File to blame.
     *
     * @return array
     * @throws \PHP_CodeSniffer\Exceptions\DeepExitException
     */
    protected function getBlameContent($filename) {
        $cwd = getcwd();
        chdir(dirname($filename));
        $command = 'git blame --date=short "' . basename($filename) . '" 2>&1';
        $handle = popen($command, 'r');
        if ($handle === false) {
            $error = 'ERROR: Could not execute "' . $command . '"' . PHP_EOL . PHP_EOL;
            throw new DeepExitException($error, 3);
        }
        $rawContent = stream_get_contents($handle);
        pclose($handle);
        $blames = explode("\n", $rawContent);
        chdir($cwd);
        return $blames;
    }
    
    //end getBlameContent()

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title
Gitblame::$reportName protected property The name of the report we want in the output Overrides VersionControl::$reportName
Gitblame::getAuthor protected function Extract the author from a blame line. Overrides VersionControl::getAuthor
Gitblame::getBlameContent protected function Gets the blame output. Overrides VersionControl::getBlameContent
VersionControl::generate public function Prints the author of all errors and warnings, as given by &quot;version control blame&quot;. Overrides Report::generate
VersionControl::generateFileReport public function Generate a partial report for a single processed file. Overrides Report::generateFileReport

API Navigation

  • Drupal Core 11.1.x
  • Topics
  • Classes
  • Functions
  • Constants
  • Globals
  • Files
  • Namespaces
  • Deprecated
  • Services
RSS feed
Powered by Drupal