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

Breadcrumb

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

class Svnblame

Hierarchy

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

Expanded class hierarchy of Svnblame

File

vendor/squizlabs/php_codesniffer/src/Reports/Svnblame.php, line 14

Namespace

PHP_CodeSniffer\Reports
View source
class Svnblame extends VersionControl {
    
    /**
     * The name of the report we want in the output
     *
     * @var string
     */
    protected $reportName = 'SVN';
    
    /**
     * 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 = [];
        preg_match('|\\s*([^\\s]+)\\s+([^\\s]+)|', $line, $blameParts);
        if (isset($blameParts[2]) === false) {
            return false;
        }
        return $blameParts[2];
    }
    
    //end getAuthor()
    
    /**
     * Gets the blame output.
     *
     * @param string $filename File to blame.
     *
     * @return array
     * @throws \PHP_CodeSniffer\Exceptions\DeepExitException
     */
    protected function getBlameContent($filename) {
        $command = 'svn blame "' . $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);
        return $blames;
    }
    
    //end getBlameContent()

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title
Svnblame::$reportName protected property The name of the report we want in the output Overrides VersionControl::$reportName
Svnblame::getAuthor protected function Extract the author from a blame line. Overrides VersionControl::getAuthor
Svnblame::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 "version control blame". 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