PHP Class Phan\Phan

Inheritance: implements Phan\Output\IgnoredFilesFilterInterface
Datei anzeigen Open project: etsy/phan Class Usage Examples

Public Properties

Property Type Description
$printer Phan\Output\IssuePrinterInterface

Public Methods

Method Description
analyzeFileList ( CodeBase $code_base, array $file_path_list ) : boolean Analyze the given set of files and emit any issues found to STDOUT.
expandedFileList ( CodeBase $code_base, array $file_path_list ) : array
getIssueCollector ( ) : Phan\Output\IssueCollectorInterface
isFilenameIgnored ( string $filename ) : boolean
setIssueCollector ( Phan\Output\IssueCollectorInterface $issueCollector ) : void
setPrinter ( Phan\Output\IssuePrinterInterface $printer ) : void

Private Methods

Method Description
collectSerializedResults ( array $results ) Take an array of serialized issues, deserialize them and then add them to the issue collector.
display ( ) : void Emit all collected issues
dumpSignaturesToFile ( CodeBase $code_base, string $filename ) : integer Save json encoded function&method signature to a map.
isExcludedAnalysisFile ( string $file_path ) : boolean

Method Details

analyzeFileList() public static method

Analyze the given set of files and emit any issues found to STDOUT.
See also: Phan\CodeBase
public static analyzeFileList ( CodeBase $code_base, array $file_path_list ) : boolean
$code_base CodeBase A code base needs to be passed in because we require it to be initialized before any classes or files are loaded.
$file_path_list array A list of files to scan
return boolean We emit messages to the configured printer and return true if issues were found.

expandedFileList() public static method

public static expandedFileList ( CodeBase $code_base, array $file_path_list ) : array
$code_base CodeBase A code base needs to be passed in because we require it to be initialized before any classes or files are loaded.
$file_path_list array A set of files to expand with the set of dependencies on those files.
return array Get an expanded list of files and dependencies for the given file list

getIssueCollector() public static method

public static getIssueCollector ( ) : Phan\Output\IssueCollectorInterface
return Phan\Output\IssueCollectorInterface

isFilenameIgnored() public method

public isFilenameIgnored ( string $filename ) : boolean
$filename string
return boolean True if filename is ignored during analysis

setIssueCollector() public static method

public static setIssueCollector ( Phan\Output\IssueCollectorInterface $issueCollector ) : void
$issueCollector Phan\Output\IssueCollectorInterface
return void

setPrinter() public static method

public static setPrinter ( Phan\Output\IssuePrinterInterface $printer ) : void
$printer Phan\Output\IssuePrinterInterface
return void

Property Details

$printer public_oe static_oe property

public static IssuePrinterInterface,Phan\Output $printer
return Phan\Output\IssuePrinterInterface