Overview

Namespaces

  • Webmozart
    • Console
      • Adapter
      • Api
        • Application
        • Args
          • Format
        • Command
        • Config
        • Event
        • Formatter
        • IO
        • Resolver
      • Args
      • Config
      • Formatter
      • Handler
        • Help
      • IO
        • InputStream
        • OutputStream
      • Process
      • Resolver
      • UI
        • Alignment
        • Component
        • Help
        • Layout
        • Style
      • Util

Classes

  • HelpAsciiDocHandler
  • HelpHandler
  • HelpJsonHandler
  • HelpManHandler
  • HelpTextHandler
  • HelpXmlHandler
  • Overview
  • Namespace
  • Class

Class HelpAsciiDocHandler

Displays the application/command help as AsciiDoc.

Namespace: Webmozart\Console\Handler\Help
Author: Bernhard Schussek bschussek@gmail.com
Since: 1.0
Located at Handler/Help/HelpAsciiDocHandler.php
Methods summary
public
# __construct( string $path, Symfony\Component\Process\ExecutableFinder $executableFinder = null, Webmozart\Console\Process\ProcessLauncher $processLauncher = null )

Creates the handler.

Creates the handler.

Parameters

$path
The path to the AsciiDoc file.
$executableFinder

The finder used to find the "less" binary.

$processLauncher

The launcher for executing the "less" binary.

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

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

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

Returns

string
The "less" binary or null if the binary is auto-detected.
public
# setLessBinary( string $lessBinary )

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

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

Parameters

$lessBinary
The "less" binary to use.
Webmozart Console API API documentation generated by ApiGen