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 HelpHandler

Handler for the "help" command.

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

Creates the handler.

Creates the handler.

Parameters

$executableFinder

The finder used to find the "less"/"man" binaries.

$processLauncher

The launcher for executing the "less"/"man" binaries.

public Webmozart\Console\Handler\Help\HelpAsciiDocHandler
# createAsciiDocHandler( Webmozart\Console\Api\Args\Args $args, Webmozart\Console\Api\IO\IO $io, Webmozart\Console\Api\Command\Command $command )

Callback for creating the "--ascii-doc" handler.

Callback for creating the "--ascii-doc" handler.

Parameters

$args
The console arguments.
$io
The I/O.
$command
The handled command.

Returns

Webmozart\Console\Handler\Help\HelpAsciiDocHandler
The created handler.
public Webmozart\Console\Handler\Help\HelpJsonHandler
# createJsonHandler( )

Callback for creating the "--json" handler.

Callback for creating the "--json" handler.

Returns

Webmozart\Console\Handler\Help\HelpJsonHandler
The created handler.
public Webmozart\Console\Handler\Help\HelpManHandler
# createManHandler( Webmozart\Console\Api\Args\Args $args, Webmozart\Console\Api\IO\IO $io, Webmozart\Console\Api\Command\Command $command )

Callback for creating the "--man" handler.

Callback for creating the "--man" handler.

Parameters

$args
The console arguments.
$io
The I/O.
$command
The handled command.

Returns

Webmozart\Console\Handler\Help\HelpManHandler
The created handler.
public Webmozart\Console\Handler\Help\HelpTextHandler
# createTextHandler( )

Callback for creating the "--text" handler.

Callback for creating the "--text" handler.

Returns

Webmozart\Console\Handler\Help\HelpTextHandler
The created handler.
public Webmozart\Console\Handler\Help\HelpXmlHandler
# createXmlHandler( )

Callback for creating the "--xml" handler.

Callback for creating the "--xml" handler.

Returns

Webmozart\Console\Handler\Help\HelpXmlHandler
The created handler.
public string
# getHandlerToRun( Webmozart\Console\Api\Args\Args $args, Webmozart\Console\Api\IO\IO $io, Webmozart\Console\Api\Command\Command $command )

Callback for selecting the handler that should be run.

Callback for selecting the handler that should be run.

Parameters

$args
The console arguments.
$io
The I/O.
$command
The handled command.

Returns

string
The name of the handler to run.
public string
# getManBinary( )

Returns the "man" binary used to display the man pages.

Returns the "man" binary used to display the man pages.

Returns

string
The "man" binary or null if the binary is auto-detected.
public
# setManBinary( string $manBinary )

Sets the "man" binary used to display the AsciiDoc pages.

Sets the "man" binary used to display the AsciiDoc pages.

Parameters

$manBinary
The "man" binary to use.
public string
# getLessBinary( )

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

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

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 pages.

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

Parameters

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

Returns the directory containing the man pages.

Returns the directory containing the man pages.

Returns

string
The directory that contains the man pages.
public
# setManDir( string $dir )

Sets the directory containing the man pages.

Sets the directory containing the man pages.

Parameters

$dir
The directory that contains the man pages.
public string
# getAsciiDocDir( )

Returns the directory containing the AsciiDoc pages.

Returns the directory containing the AsciiDoc pages.

Returns

string
The directory that contains the AsciiDoc pages.
public
# setAsciiDocDir( string $dir )

Sets the directory containing the AsciiDoc pages.

Sets the directory containing the AsciiDoc pages.

Parameters

$dir
The directory that contains the AsciiDoc pages.
public string
# getApplicationPage( )

Returns the name of the file displayed when the application help is shown with less/man.

Returns the name of the file displayed when the application help is shown with less/man.

Returns

string
The application page.
public
# setApplicationPage( string $page )

Sets the name of the file displayed when the application help is shown with less/man.

Sets the name of the file displayed when the application help is shown with less/man.

Parameters

$page
The application page.
public string
# getCommandPagePrefix( )

Returns the prefix of the files displayed when a command help is shown with less/man.

Returns the prefix of the files displayed when a command help is shown with less/man.

Returns

string
The page prefix.
public
# setCommandPagePrefix( string $prefix )

Sets the prefix of the files displayed when a command help is shown with less/man.

Sets the prefix of the files displayed when a command help is shown with less/man.

Parameters

$prefix
The page prefix.
Methods inherited from Webmozart\Console\Handler\DelegatingHandler
getRegisteredNames(), handle(), register(), selectHandler(), unregister()
Webmozart Console API API documentation generated by ApiGen