PHP Class HippoPHP\Hippo\HippoTextUI

Inheritance: implements HippoInterface
Show file Open project: hippophp/hippo

Protected Properties

Property Type Description
$checkRepository CheckRepository
$configReader HippoPHP\Hippo\Config\ConfigReaderInterface
$context HippoTextUIContext
$environment Environment
$fileSystem FileSystem
$pathToSelf string

Public Methods

Method Description
__construct ( Environment $environment, FileSystem $fileSystem, CheckRepository $checkRepository, HippoPHP\Hippo\Config\ConfigReaderInterface $configReader, string $pathToSelf, HippoTextUIContext $context )
main ( $args )

Protected Methods

Method Description
reportCheckResults ( array $reporters, File $file, array $checkResults )
run ( )
runChecks ( )
showHelp ( ) Shows the help information.
showVersion ( ) Shows the version information.

Private Methods

Method Description
_finishReporter ( ReporterInterface &$reporter ) : mixed Finishes the reporter. Usually used for cleanups.
_getAllStandardNames ( ) : string[]
_getAuthors ( ) : string Returns package authors.
_getComposerPath ( ) : string Returns the absolute path for composer.json.
_getPackageVersion ( ) : string Returns the package version number for Hippo via composer.json.
_getStandardPath ( $standardName ) : string Returns the absolute path for a standards file.
_getStandardsFolder ( ) : string Returns the absolute path for the folder that contains standard files.
_startReporter ( ReporterInterface &$reporter ) : mixed Starts the reporter. Can be used for setup.

Method Details

__construct() public method

public __construct ( Environment $environment, FileSystem $fileSystem, CheckRepository $checkRepository, HippoPHP\Hippo\Config\ConfigReaderInterface $configReader, string $pathToSelf, HippoTextUIContext $context )
$environment Environment
$fileSystem FileSystem
$checkRepository CheckRepository
$configReader HippoPHP\Hippo\Config\ConfigReaderInterface
$pathToSelf string
$context HippoTextUIContext

main() public static method

public static main ( $args )

reportCheckResults() protected method

protected reportCheckResults ( array $reporters, File $file, array $checkResults )
$reporters array
$file File
$checkResults array

run() protected method

protected run ( )

runChecks() protected method

protected runChecks ( )

showHelp() protected method

Shows the help information.
protected showHelp ( )

showVersion() protected method

Shows the version information.
protected showVersion ( )

Property Details

$checkRepository protected property

protected CheckRepository,HippoPHP\Hippo $checkRepository
return CheckRepository

$configReader protected property

protected ConfigReaderInterface,HippoPHP\Hippo\Config $configReader
return HippoPHP\Hippo\Config\ConfigReaderInterface

$context protected property

protected HippoTextUIContext,HippoPHP\Hippo $context
return HippoTextUIContext

$environment protected property

protected Environment,HippoPHP\Hippo $environment
return Environment

$fileSystem protected property

protected FileSystem,HippoPHP\Hippo $fileSystem
return FileSystem

$pathToSelf protected property

protected string $pathToSelf
return string