PHP Class Webmozart\Console\Handler\Help\HelpAsciiDocHandler

Since: 1.0

Author: Bernhard Schussek ([email protected])

Datei anzeigen Open project: webmozart/console Class Usage Examples

Public Methods

Method	Description
__construct ( string $path, ExecutableFinder $executableFinder = null, ProcessLauncher $processLauncher = null )	Creates the handler.
getLessBinary ( ) : string	Returns the "less" binary used to display the AsciiDoc page.
handle ( Args $args, IO $io )
setLessBinary ( string $lessBinary )	Sets the "less" binary used to display the AsciiDoc page.

Method Details

__construct() public method

Creates the handler.

public __construct ( string $path, ExecutableFinder $executableFinder = null, ProcessLauncher $processLauncher = null )
$path	string	The path to the AsciiDoc file.
$executableFinder	Symfony\Component\Process\ExecutableFinder	The finder used to find the "less" binary.
$processLauncher	Webmozart\Console\Process\ProcessLauncher	The launcher for executing the "less" binary.

getLessBinary() public method

Returns the "less" binary used to display the AsciiDoc page.

public getLessBinary ( ) : string
return	string	The "less" binary or `null` if the binary is auto-detected.

handle() public method

public handle ( Args $args, IO $io )
$args	Webmozart\Console\Api\Args\Args
$io	Webmozart\Console\Api\IO\IO

setLessBinary() public method

Sets the "less" binary used to display the AsciiDoc page.

public setLessBinary ( string $lessBinary )
$lessBinary	string	The "less" binary to use.