[Horde_Argv] element index

Package indexes

All elements
a b c d e f g h i l m n o p r s t v _
_
top
Variable $_title
Variable $_usage
Method _addHelpOption
Method _addVersionOption
Method _checkAction
Method _checkCallback
Method _checkChoice
Method _checkConflict
Method _checkConst
Method _checkDest
Method _checkNargs
Method _checkOptStrings
Method _checkType
Method _createOptionList
Method _createOptionList
Method _createOptionMappings
For use by Horde_Argv_Parser constructor -- create the master option mappings used by this Horde_Argv_Parser and all OptionGroups that it owns.
Method _formatText
Format a paragraph of free-form text for inclusion in the help output at the current indentation level.
Method _getAllOptions
Method _getArgs
Method _initParsingState
Method _matchLongOpt
opt : string) -> string
Method _populateOptionList
Method _processArgs
_process_args(largs : [string], rargs : [string], values : Values)
Method _processLongOpt
Method _processShortOpts
Method _setAttrs
Method _setOptStrings
Method _shareOptionMappings
For use by OptionGroup constructor -- use shared option mappings from the Horde_Argv_Parser that owns this OptionGroup.
Method __construct
Method __construct
Method __construct
Method __construct
Method __construct
Method __construct
Method __construct
Method __construct
Initialize the option list and related data structures.
Method __construct
Method __construct
Method __construct
Method __destruct
Declare that you are done with this Horde_Argv_Parser. This cleans up reference cycles so the Horde_Argv_Parser (and all objects referenced by it) can be garbage-collected promptly. After calling destroy(), the Horde_Argv_Parser is unusable.
Method __destruct
Method __toString
Method __toString
Method __construct
Method __toString
a
top
Variable $ACTIONS
Variable $ALWAYS_TYPED_ACTIONS
The set of actions which *require* a value type, ie. that always consume an argument from the command line.
Variable $ATTRS
Method addOption
Method addOptionGroup
Method addOptions
Page AmbiguousOptionException.php
AmbiguousOptionException.php in AmbiguousOptionException.php
Variable $ACTIONS
Page AllTests.php
AllTests.php in AllTests.php
Method assertConflictError
Method assertHelp
Method assertHelpEquals
Method assertOptionError
Method assertOutput
Assert the parser prints the expected output on stdout.
Method assertParseFail
Assert the parser fails with the expected message. Caller must ensure that $this->parser is an InterceptingParser.
Method assertParseOK
Assert the options are what we expected when parsing arguments.
Method assertRaises
Assert that the expected exception is raised when calling a function, and that the right error message is included with that exception.
Method assertRemoved
Method assertTypeError
Assert that TypeError is raised when executing func.
Method assertUsage
Method assertVersion
b
top
Page BadOptionException.php
BadOptionException.php in BadOptionException.php
Page BoolTest.php
BoolTest.php in BoolTest.php
c
top
Variable $CHECK_METHODS
Variable $conflictHandler
Variable $CONST_ACTIONS
Method checkBuiltin
Method checkChoice
Method checkValue
Method checkValues
Check that the supplied option values and leftover arguments are
Method convertValue
Method count
Page CallbackCheckAbbrevTest.php
CallbackCheckAbbrevTest.php in CallbackCheckAbbrevTest.php
Page CallbackExtraArgsTest.php
CallbackExtraArgsTest.php in CallbackExtraArgsTest.php
Page CallbackManyArgsTest.php
CallbackManyArgsTest.php in CallbackManyArgsTest.php
Page CallbackMeddleArgsTest.php
CallbackMeddleArgsTest.php in CallbackMeddleArgsTest.php
Page CallbackTest.php
CallbackTest.php in CallbackTest.php
Page CallbackVarArgsTest.php
CallbackVarArgsTest.php in CallbackVarArgsTest.php
Page ChoiceTest.php
ChoiceTest.php in ChoiceTest.php
Page ConflictingDefaultsTest.php
ConflictingDefaultsTest.php in ConflictingDefaultsTest.php
Page ConflictOverrideTest.php
ConflictOverrideTest.php in ConflictOverrideTest.php
Page ConflictResolveTest.php
ConflictResolveTest.php in ConflictResolveTest.php
Page ConflictTest.php
ConflictTest.php in ConflictTest.php
Page ConflictTestBase.php
ConflictTestBase.php in ConflictTestBase.php
Page CountTest.php
CountTest.php in CountTest.php
Method checkAbbrev
Method checkDuration
Method checkFile
d
top
Variable $default
Variable $defaults
Variable $description
Variable $dest
Method dedent
Method disableInterspersedArgs
Page DefaultValuesTest.php
DefaultValuesTest.php in DefaultValuesTest.php
Method dummy
Horde_Argv_OptionChecksTest::dummy() in OptionChecksTest.php
e
top
Page Exception.php
Exception.php in Exception.php
Method enableInterspersedArgs
Method ensureValue
Method expandDefault
Method expandProgName
Variable $expected_help_basic
Variable $expected_help_long_opts_first
Variable $expected_help_short_lines
Variable $expected_help_title_formatter
Page ExpandDefaultsTest.php
ExpandDefaultsTest.php in ExpandDefaultsTest.php
Page ExtendAddActionsTest.php
ExtendAddActionsTest.php in ExtendAddActionsTest.php
Page ExtendAddTypesTest.php
ExtendAddTypesTest.php in ExtendAddTypesTest.php
f
top
Method formatDescription
Method formatDescription
Method formatEpilog
Method formatEpilog
Method formatHeading
Method formatHeading
Method formatHeading
Method formatHelp
Method formatHelp
Method formatHelp
Method formatOption
The help for each option consists of two parts:
Method formatOptionHelp
Method formatOptionHelp
Method formatOptionStrings
Return a comma-separated list of option strings & metavariables.
Method formatUsage
Method formatUsage
Method formatUsage
g
top
Method getDefaultValues
Method getDescription
Method getDescription
Method getIterator
Method getOption
Method getOptionGroup
Method getOptString
Method getProgName
Method getUsage
Method getVersion
h
top
Page HelpFormatter.php
HelpFormatter.php in HelpFormatter.php
Method hasOption
Class Horde_Argv_AmbiguousOptionException
Horde_Argv_AmbiguousOptionException in AmbiguousOptionException.php
Raised if an ambiguous option is seen on the command line.
Class Horde_Argv_BadOptionException
Horde_Argv_BadOptionException in BadOptionException.php
Raised if an invalid option is seen on the command line.
Class Horde_Argv_Exception
Horde_Argv_Exception in Exception.php
Class Horde_Argv_HelpFormatter
Horde_Argv_HelpFormatter in HelpFormatter.php
Abstract base class for formatting option help. Horde_Argv_Parser instances should use one of the HelpFormatter subclasses for formatting help; by default IndentedHelpFormatter is used.
Class Horde_Argv_IndentedHelpFormatter
Horde_Argv_IndentedHelpFormatter in IndentedHelpFormatter.php
Format help with indented section bodies.
Class Horde_Argv_Option
Horde_Argv_Option in Option.php
Defines the Option class and some standard value-checking functions.
Class Horde_Argv_OptionConflictException
Horde_Argv_OptionConflictException in OptionConflictException.php
Raised if conflicting options are added to a Horde_Argv_Parser.
Class Horde_Argv_OptionContainer
Horde_Argv_OptionContainer in OptionContainer.php
Abstract base class.
Class Horde_Argv_OptionException
Horde_Argv_OptionException in OptionException.php
Raised if an Option instance is created with invalid or inconsistent arguments.
Class Horde_Argv_OptionGroup
Horde_Argv_OptionGroup in OptionGroup.php
Class Horde_Argv_OptionValueException
Horde_Argv_OptionValueException in OptionValueException.php
Raised if an invalid option value is encountered on the command
Class Horde_Argv_Parser
Horde_Argv_Parser in Parser.php
Class attributes: standardOptionList : [Option] list of standard options that will be accepted by all instances of this parser class (intended to be overridden by subclasses).
Class Horde_Argv_TitledHelpFormatter
Horde_Argv_TitledHelpFormatter in TitledHelpFormatter.php
Format help with underlined section headers.
Class Horde_Argv_Values
Horde_Argv_Values in Values.php
Result hash for Horde_Argv_Parser
Page HelpTest.php
HelpTest.php in HelpTest.php
Class Horde_Argv_AllTests
Horde_Argv_AllTests in AllTests.php
Class Horde_Argv_BoolTest
Horde_Argv_BoolTest in BoolTest.php
Class Horde_Argv_CallbackCheckAbbrevTest
Horde_Argv_CallbackCheckAbbrevTest in CallbackCheckAbbrevTest.php
Class Horde_Argv_CallbackExtraArgsTest
Horde_Argv_CallbackExtraArgsTest in CallbackExtraArgsTest.php
Class Horde_Argv_CallbackManyArgsTest
Horde_Argv_CallbackManyArgsTest in CallbackManyArgsTest.php
Class Horde_Argv_CallbackMeddleArgsTest
Horde_Argv_CallbackMeddleArgsTest in CallbackMeddleArgsTest.php
Class Horde_Argv_CallbackTest
Horde_Argv_CallbackTest in CallbackTest.php
Class Horde_Argv_CallbackVarArgsTest
Horde_Argv_CallbackVarArgsTest in CallbackVarArgsTest.php
Class Horde_Argv_ChoiceTest
Horde_Argv_ChoiceTest in ChoiceTest.php
Class Horde_Argv_ConflictingDefaultsTest
Horde_Argv_ConflictingDefaultsTest in ConflictingDefaultsTest.php
Conflicting default values: the last one should win.
Class Horde_Argv_ConflictOverrideTest
Horde_Argv_ConflictOverrideTest in ConflictOverrideTest.php
Class Horde_Argv_ConflictResolveTest
Horde_Argv_ConflictResolveTest in ConflictResolveTest.php
Class Horde_Argv_ConflictTest
Horde_Argv_ConflictTest in ConflictTest.php
Class Horde_Argv_ConflictTestBase
Horde_Argv_ConflictTestBase in ConflictTestBase.php
Class Horde_Argv_CountTest
Horde_Argv_CountTest in CountTest.php
Class Horde_Argv_DefaultValuesTest
Horde_Argv_DefaultValuesTest in DefaultValuesTest.php
Class Horde_Argv_DurationOption
Horde_Argv_DurationOption in DefaultValuesTest.php
Defines the Option class and some standard value-checking functions.
Class Horde_Argv_ExpandDefaultsTest
Horde_Argv_ExpandDefaultsTest in ExpandDefaultsTest.php
Class Horde_Argv_ExtendAddActionsTest
Horde_Argv_ExtendAddActionsTest in ExtendAddActionsTest.php
Class Horde_Argv_ExtendAddActionsTest_MyOption
Horde_Argv_ExtendAddActionsTest_MyOption in ExtendAddActionsTest.php
Defines the Option class and some standard value-checking functions.
Class Horde_Argv_ExtendAddTypesTest
Horde_Argv_ExtendAddTypesTest in ExtendAddTypesTest.php
Class Horde_Argv_ExtendAddTypesTest_MyOption
Horde_Argv_ExtendAddTypesTest_MyOption in ExtendAddTypesTest.php
Defines the Option class and some standard value-checking functions.
Class Horde_Argv_HelpTest
Horde_Argv_HelpTest in HelpTest.php
Class Horde_Argv_InterceptedException
Horde_Argv_InterceptedException in InterceptedException.php
Class Horde_Argv_InterceptingParser
Horde_Argv_InterceptingParser in InterceptingParser.php
Class Horde_Argv_MatchAbbrevTest
Horde_Argv_MatchAbbrevTest in MatchAbbrevTest.php
Class Horde_Argv_MultipleArgsAppendTest
Horde_Argv_MultipleArgsAppendTest in MultipleArgsAppendTest.php
Class Horde_Argv_MultipleArgsTest
Horde_Argv_MultipleArgsTest in MultipleArgsTest.php
Class Horde_Argv_OptionChecksTest
Horde_Argv_OptionChecksTest in OptionChecksTest.php
Class Horde_Argv_OptionGroupTest
Horde_Argv_OptionGroupTest in OptionGroupTest.php
Class Horde_Argv_OptionValuesTest
Horde_Argv_OptionValuesTest in OptionValuesTest.php
Class Horde_Argv_ParseNumTest
Horde_Argv_ParseNumTest in ParseNumTest.php
Class Horde_Argv_ParserTest
Horde_Argv_ParserTest in ParserTest.php
Class Horde_Argv_ProgNameTest
Horde_Argv_ProgNameTest in ProgNameTest.php
Class Horde_Argv_StandardTest
Horde_Argv_StandardTest in StandardTest.php
Class Horde_Argv_TestBase
Horde_Argv_TestBase in TestBase.php
Class Horde_Argv_TypeAliasesTest
Horde_Argv_TypeAliasesTest in TypeAliasesTest.php
Class Horde_Argv_VersionTest
Horde_Argv_VersionTest in VersionTest.php
i
top
Page IndentedHelpFormatter.php
IndentedHelpFormatter.php in IndentedHelpFormatter.php
Method indent
Page InterceptedException.php
InterceptedException.php in InterceptedException.php
Page InterceptingParser.php
InterceptingParser.php in InterceptingParser.php
l
top
Variable $longOpt
Variable $longOpts
m
top
Method matchAbbrev
(s : string, wordmap : {string : Option}) -> string
Page MatchAbbrevTest.php
MatchAbbrevTest.php in MatchAbbrevTest.php
Page MultipleArgsAppendTest.php
MultipleArgsAppendTest.php in MultipleArgsAppendTest.php
Page MultipleArgsTest.php
MultipleArgsTest.php in MultipleArgsTest.php
Method main
Method makeOption
Method makeParser
n
top
Variable $NO_DEFAULT
Not supplying a default is different from a default of None, so we need an explicit "not supplied" value.
Class Constant NO_DEFAULT_VALUE
o
top
Variable $optionClass
Variable $optionGroups
Variable $optionList
Page Option.php
Option.php in Option.php
Page OptionConflictException.php
OptionConflictException.php in OptionConflictException.php
Page OptionContainer.php
OptionContainer.php in OptionContainer.php
Page OptionException.php
OptionException.php in OptionException.php
Page OptionGroup.php
OptionGroup.php in OptionGroup.php
Page OptionValueException.php
OptionValueException.php in OptionValueException.php
Method offsetExists
Method offsetGet
Method offsetSet
Method offsetUnset
Page OptionChecksTest.php
OptionChecksTest.php in OptionChecksTest.php
Page OptionGroupTest.php
OptionGroupTest.php in OptionGroupTest.php
Page OptionValuesTest.php
OptionValuesTest.php in OptionValuesTest.php
p
top
Variable $parser
Page Parser.php
Parser.php in Parser.php
Method parseArgs
Parse the command-line options found in 'args' (default:
Method parseNumber
Method parserError
Print a usage message incorporating $msg to stderr and exit.
Method parserExit
Method printHelp
file : file = stdout
Method printUsage
(file : file = stdout)
Method printVersion
file : file = stdout
Method process
Page ParseNumTest.php
ParseNumTest.php in ParseNumTest.php
Page ParserTest.php
ParserTest.php in ParserTest.php
Page ProgNameTest.php
ProgNameTest.php in ProgNameTest.php
Method parserError
Method parserExit
Constant PHPUnit_MAIN_METHOD
PHPUnit_MAIN_METHOD in AllTests.php
Method processMany
Method processOpt
Method processTuple
Method process_n
Callback that meddles in rargs, largs
r
top
Method removeOption
Method returnNull
s
top
Variable $shortOpt
Variable $shortOpts
Variable $standardOptionList
Variable $STORE_ACTIONS
The set of actions that involve storing a value somewhere;
Method setConflictHandler
Method setDefault
Method setDefaults
Method setDescription
Method setLongOptDelimiter
Method setParser
Method setShortOptDelimiter
Method setTitle
Method setUsage
Method storeOptionStrings
Class Constant SUPPRESS_HELP
Class Constant SUPPRESS_USAGE
Variable $STORE_ACTIONS
Page StandardTest.php
StandardTest.php in StandardTest.php
Method setUp
Method setUp
Horde_Argv_MultipleArgsAppendTest::setUp() in MultipleArgsAppendTest.php
Method setUp
Horde_Argv_ExtendAddTypesTest::setUp() in ExtendAddTypesTest.php
Method setUp
Horde_Argv_ExpandDefaultsTest::setUp() in ExpandDefaultsTest.php
Method setUp
Horde_Argv_MultipleArgsTest::setUp() in MultipleArgsTest.php
Method setUp
Horde_Argv_ExtendAddActionsTest::setUp() in ExtendAddActionsTest.php
Method setUp
Horde_Argv_OptionChecksTest::setUp() in OptionChecksTest.php
Method setUp
Method setUp
Method setUp
Method setUp
Method setUp
Method setUp
Horde_Argv_DefaultValuesTest::setUp() in DefaultValuesTest.php
Method setUp
Method setUp
Horde_Argv_CallbackMeddleArgsTest::setUp() in CallbackMeddleArgsTest.php
Method setUp
Method setUp
Horde_Argv_CallbackManyArgsTest::setUp() in CallbackManyArgsTest.php
Method setUp
Horde_Argv_CallbackExtraArgsTest::setUp() in CallbackExtraArgsTest.php
Method setUp
Method setUp
Horde_Argv_CallbackCheckAbbrevTest::setUp() in CallbackCheckAbbrevTest.php
Method setUp
Horde_Argv_CallbackVarArgsTest::setUp() in CallbackVarArgsTest.php
Method setUp
Method setUp
Horde_Argv_ConflictTestBase::setUp() in ConflictTestBase.php
Method setUp
Horde_Argv_ConflictResolveTest::setUp() in ConflictResolveTest.php
Method setUp
Horde_Argv_ConflictOverrideTest::setUp() in ConflictOverrideTest.php
Method setUp
Horde_Argv_ConflictingDefaultsTest::setUp() in ConflictingDefaultsTest.php
Method showVersion
Method suite
t
top
Variable $TYPED_ACTIONS
Variable $TYPES
Variable $TYPE_CHECKER
Page TitledHelpFormatter.php
TitledHelpFormatter.php in TitledHelpFormatter.php
Method takeAction
Method takesValue
Variable $TYPED_ACTIONS
Variable $TYPES
Horde_Argv_DurationOption::$TYPES in DefaultValuesTest.php
Variable $TYPES
Variable $TYPE_CHECKER
Variable $TYPE_CHECKER
Page TestBase.php
TestBase.php in TestBase.php
Page TypeAliasesTest.php
TypeAliasesTest.php in TypeAliasesTest.php
Method takeAction
Method tearDown
Method tearDown
Method tesHelpOldUsage
Method testAbbrevCallbackExpansion
Method testAbbrevLongOption
Method testActionInvalid
Method testAddChoiceOption
Method testAddGroupInvalidArguments
Method testAddGroupNoGroup
Method testAddGroupWrongParser
Method testAddOptionInvalidArguments
Method testAddOptionNoOption
Method testAltExpand
Method testAmbiguousOption
Method testAttrInvalid
Method testBadChoicesList
Method testBasicDefault
Method testBasics
Method testBoolDefault
Method testBoolFalse
Method testBoolFlickerOnAndOff
Method testBoolTrue
Method testCallback
Method testCallbackArgsNoArray
Method testCallbackExtraArgs
Method testCallbackHelp
Method testCallbackMeddleArgs
Method testCallbackMeddleArgsSeparator
Method testCallbackNotCallable
Method testConflictDefault
Method testConflictDefaultNone
Method testConflictError
Method testConflictErrorGroup
Method testConflictOverrideArgs
Method testConflictOverrideHelp
Method testConflictOverrideOpts
Method testConflictResolve
Method testConflictResolveHelp
Method testConflictResolveLongOpt
Method testConflictResolveLongOpts
Method testConflictResolveShortOpt
Method testConsumeSeparatorStopAtOption
Method testCountInterspersedArgs
Method testCountNoInterspersedArgs
Method testCountNoSuchOption
Method testCountOne
Method testCountOptionNoValue
Method testCountOverrideAmount
Method testCountOverrideQuiet
Method testCountOverriding
Method testCountOverridingDefault
Method testCountThree
Method testCountThreeApart
Method testCountWithDefault
Method testCustomProgName
Method testDefaultNone1
Method testDefaultNone2
Method testDefaultProgName
Method testDefaults
Method testEmpty
Method testEmpty
Method testExtendAddAction
Method testExtendAddActionNormal
Method testFiletypeNoexist
Method testFiletypeNotfile
Method testFiletypeOk
Method testFloatDefault
Method testGetOption
Method testGetOptionEquals
Method testGroupManipulate
Method testHasOption
Method testHelp
Method testHelpDescriptionGroups
Method testHelpLongOptsFirst
Method testHelpTitleFormatter
Method testHyphenBecomesPositionalArg
Method testInvalidChoice
Method testInvalidInteger
Method testLongInvalidInteger
Method testLongOptionAppend
Method testLongOptionArgumentJoined
Method testLongOptionArgumentSplit
Method testLongOptionShortOption
Method testManyArgs
Method testMatchAbbrev
Method testMatchAbbrevError
Method testMixedDefaultsPost
Method testMixedDefaultsPre
Method testNargsAppend
Method testNargsAppendConst
Method testNargsAppendRequiredValues
Method testNargsAppendSimple
Method testNargsInvalidFloatValue
Method testNargsLongOpt
Method testNargsRequiredValues
Method testNargsWithPositionalArgs
Method testNewTypeObject
Method testNoAppendVersusAppend
Method testNoCallbackArgsForAction
Method testNoCallbackForAction
Method testNoChoicesForType
Method testNoChoicesList
Method testNoConstForAction
Method testNoDefault
Method testNoExpand
Method testNoNargsForAction
Method testNoSuchConflictHandler
Method testNoSuchOption
Method testNoTypeForAction
Method testNoVersion
Method testNumericOptions
Method testOptionArgumentJoined
Method testOptionArgumentJoinedInteger
Method testOptionArgumentSplit
Method testOptionArgumentSplitNegativeInteger
Method testOptionConsumesOptionLikeString
Method testOptionDefault
Method testOptionGroupCreateInstance
Method testOptStringEmpty
Method testOptStringLongInvalid
Method testOptStringShortInvalid
Method testOptStringTooShort
Method testParseNumFail
Method testParseNumOk
Method testParserDefault1
Method testParserDefault2
Method testPositionalArgAndVariableArgs
Method testProcessDefault
Method testRemoveLongOpt
Method testRemoveNonexistent
Method testRemoveShortOpt
Method testRequiredValue
Method testShortAndLongOptionSplit
Method testShortOptEmptyLongOptAppend
Method testShortOptionConsumesSeparator
Method testShortOptionJoinedAndSeparator
Method testShortOptionSplitLongOptionAppend
Method testShortOptionSplitOnePositionalArg
Method testStopAtInvalidOption
Method testStopAtOption
Method testStrAliasesString
Method testTypeInvalid
Method testValidChoice
Method testVariableArgs
Method testVersion
Method testWrapColumns
v
top
Page Values.php
Values.php in Values.php
Page VersionTest.php
VersionTest.php in VersionTest.php
Method variableArgs
a b c d e f g h i l m n o p r s t v _