Docs For Class Console_CommandLine_Renderer

__construct (Constructor) [line 71]

Console_CommandLine_Renderer_Default __construct(
object
$parser)

Constructor.

Access: public

Parameters:

object $parser — a Console_CommandLine instance

[ Top ]

argumentList [line 252]

string argumentList(
)

Render the arguments list that will be displayed to the user, you can override this method if you want to change the look of the list.

Return: the formatted argument list
Access: protected

[ Top ]

columnWrap [line 368]

string columnWrap(
string
$text, int
$cw)

Wraps the text passed to the method at the specified width.

Access: protected

Parameters:

string	`$text`	—	the text to wrap
int	`$cw`	—	the wrap width

[ Top ]

commandList [line 312]

string commandList(
)

Render the command list that will be displayed to the user, you can override this method if you want to change the look of the list.

Return: the formatted subcommand list
Access: protected

[ Top ]

commandUsageLine [line 226]

string commandUsageLine(
)

Return the command line usage message for subcommands

Access: protected

[ Top ]

description [line 186]

string description(
)

Return the command line description message

Return: the usage message
Access: protected

[ Top ]

error [line 118]

string error(
string
$error)

Return a formatted error message

Return: the error string
Access: public

Parameters:

string $error — the error message to format

[ Top ]

name [line 159]

string name(
)

return the full name of the program or the sub command

Access: protected

[ Top ]

optionList [line 282]

string optionList(
)

Render the options list that will be displayed to the user, you can override this method if you want to change the look of the list.

Return: the formatted option list
Access: protected

[ Top ]

usage [line 85]

string usage(
)

Return the full usage message

Return: the usage message
Access: public

[ Top ]

usageLine [line 200]

string usageLine(
)

Return the command line usage message

Return: the usage message
Access: protected

[ Top ]

version [line 142]

string version(
)

Return the program version string

Return: the version string
Access: public

[ Top ]

wrap [line 345]

string wrap(
string
$text, [int
$lw = null])

Wraps the text passed to the method.

Access: protected

Parameters:

string	`$text`	—	The text to wrap
int	`$lw`	—	The column width. Defaults to line_width property.

[ Top ]

Class: Console_CommandLine_Renderer_Default

Class Overview

Author(s):

Version:

Copyright:

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

Class Variables

$line_width = 75

$parser = false

Method Detail

__construct (Constructor) [line 71]

Parameters:

argumentList [line 252]

columnWrap [line 368]

Parameters:

commandList [line 312]

commandUsageLine [line 226]

description [line 186]

error [line 118]

Parameters:

name [line 159]

optionList [line 282]

usage [line 85]

usageLine [line 200]

version [line 142]

wrap [line 345]

Parameters: