Console_GetoptPlus
[ class tree: Console_GetoptPlus ] [ index: Console_GetoptPlus ] [ all elements ]

Class: Console_GetoptPlus_Help

Source Location: /Console_GetoptPlus-1.0.0RC1/GetoptPlus/Help.php

Class Overview


Generation of the command usage/help


Author(s):

Version:

  • Release:@package_version@

Copyright:

  • 2008 Michel Corne

Methods


Inherited Variables

Inherited Methods


Class Details

[line 50]
Generation of the command usage/help


[ Top ]


Method Detail

alignLines   [line 84]

array alignLines( array $lines, [string $addon = ''], [integer $paddingLength = null])

Aligns a set of lines

Additional data is added to the first line. The other lines are padded and aligned to the first one.

  • Return: the aligned lines
  • Access: public

Parameters:

array   $lines     the set of lines
string   $addon     the additional data to add to the first line
integer   $paddingLength     the padding length

[ Top ]

get   [line 114]

void get( $config, $command)

  • Access: public

Parameters:

   $config     
   $command     

[ Top ]

set   [line 128]

string set( array $config, string $command)

Creates the help/usage text
  • Return: the help/usage text
  • Access: public

Parameters:

array   $config     the command configuration
string   $command     the command name

[ Top ]

setOptions   [line 154]

array setOptions( array $optionsConfig)

Creates the options help text section
  • Return: the options help text section
  • Access: public

Parameters:

array   $optionsConfig     the options descriptions

[ Top ]

setUsage   [line 197]

array setUsage( $config, string $command, array $usages, array $optionsConfig, array $paramsConfig)

Creates the usage help text section
  • Return: the usage help text section
  • Access: public

Parameters:

array   $usages     the usage descriptions
string   $command     the command name
array   $optionsConfig     the options descriptions
array   $paramsConfig     the parameters descriptions
   $config     

[ Top ]

tidyArray   [line 238]

array tidyArray( array $array, [boolean $tidyString = true])

Tidies an array

Makes an array if passed as a string. Optionally forces the values to strings if there are not.

  • Return: the tidied array
  • Access: public

Parameters:

array   $array     the array
boolean   $tidyString     forces the values to string if true, or leaves them untouched if false

[ Top ]

tidyString   [line 256]

string tidyString( string $string)

Tidies a string

Retains only the first value if passed as an array.

  • Return: the tidy string
  • Access: public

Parameters:

string   $string     the string

[ Top ]


Documentation generated on Sat, 26 Jan 2008 14:30:07 -0500 by phpDocumentor 1.4.0. PEAR Logo Copyright © PHP Group 2004.