apidoc
[ class tree: apidoc ] [ index: apidoc ] [ all elements ]

Class: Hgblame

Source Location: /PHP_CodeSniffer-3.1.1/src/Reports/Hgblame.php

Class Overview

VersionControl
   |
   --Hgblame

Mercurial blame report for PHP_CodeSniffer.


Author(s):

Copyright:

  • 2006-2015 Squiz Pty Ltd (ABN 77 084 670 600)

Variables

Methods


Inherited Variables

Inherited Methods

Class: VersionControl

VersionControl::generate()
Prints the author of all errors and warnings, as given by "version control blame".
VersionControl::generateFileReport()
Generate a partial report for a single processed file.
VersionControl::getAuthor()
Extract the author from a blame line.
VersionControl::getBlameContent()
Gets the blame output.

Class Details

[line 15]
Mercurial blame report for PHP_CodeSniffer.


[ Top ]


Class Variables

$reportName =  'MERCURIAL'

[line 23]

The name of the report we want in the output
  • Access: protected

Type:   string
Overrides:   Array


[ Top ]



Method Detail

getAuthor   [line 33]

mixed getAuthor( string $line)

Extract the author from a blame line.
  • Return: string or false if impossible to recover.
  • Access: protected

Overrides VersionControl::getAuthor() (Extract the author from a blame line.)

Parameters:

string   $line   —  Line to parse.

[ Top ]

getBlameContent   [line 68]

array getBlameContent( string $filename)

Gets the blame output.
  • Access: protected

Overrides VersionControl::getBlameContent() (Gets the blame output.)

Parameters:

string   $filename   —  File to blame.

[ Top ]


Documentation generated on Mon, 11 Mar 2019 15:27:33 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.