## Apache Zeta Components Manual :: Package ConsoleTools Element Index

## Element index for package ConsoleTools

#### Package indexes

- Document
- NoPackageName
- SystemInformation
- File
- UserInput
- PersistentObjectDatabaseSchemaTiein
- Cache
- Database
- UnitTest
- Feed
- Base
- AuthenticationDatabaseTiein
- TemplateTranslationTiein
- MvcMailTiein
- MvcTools
- MvcTemplateTiein
- Reflection
- Authentication
- Execution
- TranslationCacheTiein
- Archive
- Url
- PhpGenerator
- WorkflowDatabaseTiein
- SignalSlot
- DatabaseSchema
- TreePersistentObjectTiein
- EventLog
- Tree
- Workflow
- ImageConversion
- PersistentObject
- Graph
- EventLogDatabaseTiein
- Translation
- WorkflowSignalSlotTiein
- Template
- Webdav
- Debug
- GraphDatabaseTiein
- MvcAuthenticationTiein
- MvcFeedTiein
- Mail
- TreeDatabaseTiein
- ImageAnalysis
- Search
- Configuration
- WorkflowEventLogTiein

[ a ] [ b ] [ c ] [ d ] [ e ] [ f ] [ g ] [ h ] [ i ] [ k ] [ m ] [ n ] [ o ] [ p ] [ q ] [ r ] [ s ] [ t ] [ u ] [ v ] [ w ] [ y ] [ _ ]

### Letter '_'

__construct
  in file output.php, method ezcConsoleOutputOptions::__construct()
  Construct a new options object.
__construct
  in file output_format.php, method ezcConsoleOutputFormat::__construct()
  Create a new ezcConsoleOutputFormat object.
__construct
  in file output_formats.php, method ezcConsoleOutputFormats::__construct()
  Create a new ezcConsoleOutputFormats object.
__construct
  in file progressbar.php, method ezcConsoleProgressbar::__construct()
  Creates a new progress bar.
__construct
  in file output.php, method ezcConsoleOutput::__construct()
  Create a new console output handler.
__construct
  in file option_type_violation.php, method ezcConsoleOptionTypeViolationException::__construct()
  Creates a new exception object.
__construct
  in file option_no_alias.php, method ezcConsoleOptionNoAliasException::__construct()
  Creates a new exception object.
__construct
  in file option_rule.php, method ezcConsoleOptionRule::__construct()
  Creates a new option rule.
__construct
  in file argument.php, method ezcConsoleArgument::__construct()
  Creates a new console argument object.
__construct
  in file option_too_many_values.php, method ezcConsoleOptionTooManyValuesException::__construct()
  Creates a new exception object.
__construct
  in file progressmonitor.php, method ezcConsoleProgressMonitor::__construct()
  Creates a new progress monitor.
__construct
  in file question_dialog.php, method ezcConsoleQuestionDialog::__construct()
  Creates a new question dialog.
__construct
  in file row.php, method ezcConsoleTableRow::__construct()
  Create a new ezcConsoleProgressbarRow.
__construct
  in file statusbar.php, method ezcConsoleStatusbar::__construct()
  Creates a new status bar.
__construct
  in file table.php, method ezcConsoleTable::__construct()
  Creates a new table.
__construct
  in file table.php, method ezcConsoleTableOptions::__construct()
  Construct a new options object.
__construct
  in file question_dialog_type.php, method ezcConsoleQuestionDialogTypeValidator::__construct()
  Creates a new question dialog type validator.
__construct
  in file question_dialog_regex.php, method ezcConsoleQuestionDialogRegexValidator::__construct()
  Create a new question dialog regex validator.
__construct
  in file question_dialog.php, method ezcConsoleQuestionDialogOptions::__construct()
  Construct a new options object.
__construct
  in file question_dialog_collection.php, method ezcConsoleQuestionDialogCollectionValidator::__construct()
  Creates a new question dialog collection validator.
__construct
  in file question_dialog_mapping.php, method ezcConsoleQuestionDialogMappingValidator::__construct()
  Creates a new question dialog mapping validator.
__construct
  in file option_not_exists.php, method ezcConsoleOptionNotExistsException::__construct()
  Creates a new exception object.
__construct
  in file option_string_not_wellformed.php, method ezcConsoleOptionStringNotWellformedException::__construct()
  Creates a new exception object.
__construct
  in file invalid_option_name.php, method ezcConsoleInvalidOptionNameException::__construct()
  Creates a new exception object.
__construct
  in file input.php, method ezcConsoleInput::__construct()
  Creates an input handler.
__construct
  in file invalid_output_target.php, method ezcConsoleInvalidOutputTargetException::__construct()
  Creates a new exception object.
__construct
  in file menu_dialog.php, method ezcConsoleMenuDialogOptions::__construct()
  Construct a new options object.
__construct
  in file option_missing_value.php, method ezcConsoleOptionMissingValueException::__construct()
  Creates a new exception object.
__construct
  in file dialog_abort.php, method ezcConsoleDialogAbortException::__construct()
  Creates a new exception object.
__construct
  in file cell.php, method ezcConsoleTableCell::__construct()
  Create a new ezcConsoleProgressbarCell.
__construct
  in file argument_already_registered.php, method ezcConsoleArgumentAlreadyRegisteredException::__construct()
  Creates a new exception object.
__construct
  in file argument_mandatory_violation.php, method ezcConsoleArgumentMandatoryViolationException::__construct()
  Creates a new exception object.
__construct
  in file argument_too_many.php, method ezcConsoleTooManyArgumentsException::__construct()
  Creates a new exception object.
__construct
  in file argument_type_violation.php, method ezcConsoleArgumentTypeViolationException::__construct()
  Creates a new exception object.
__construct
  in file menu_dialog_default.php, method ezcConsoleMenuDialogDefaultValidator::__construct()
  Creates a new menu default validator.
__construct
  in file menu_dialog.php, method ezcConsoleMenuDialog::__construct()
  Creates a new menu dialog.
__construct
  in file option_arguments_violation.php, method ezcConsoleOptionArgumentsViolationException::__construct()
  Creates a new exception object.
__construct
  in file option_already_registered.php, method ezcConsoleOptionAlreadyRegisteredException::__construct()
  Creates a new exception object.
__construct
  in file option_dependency_violation.php, method ezcConsoleOptionDependencyViolationException::__construct()
  Creates a new exception object.
__construct
  in file option_exclusion_violation.php, method ezcConsoleOptionExclusionViolationException::__construct()
  Creates a new exception object.
__construct
  in file option_mandatory_violation.php, method ezcConsoleOptionMandatoryViolationException::__construct()
  Creates a new exception object.
__construct
  in file option.php, method ezcConsoleOption::__construct()
  Create a new parameter struct.
__construct
  in file no_valid_dialog_result.php, method ezcConsoleNoValidDialogResultException::__construct()
  Creates a new exception object.
__construct
  in file no_position_stored.php, method ezcConsoleNoPositionStoredException::__construct()
  Creates a new exception object.
__get
  in file progressmonitor.php, method ezcConsoleProgressMonitor::__get()
  Property read access.
__get
  in file output_formats.php, method ezcConsoleOutputFormats::__get()
  Read access to the formats.
__isset
  in file progressmonitor.php, method ezcConsoleProgressMonitor::__isset()
  Property isset access.
__isset
  in file output_formats.php, method ezcConsoleOutputFormats::__isset()
  Property isset access.
__set
  in file progressmonitor.php, method ezcConsoleProgressMonitor::__set()
  Property write access.
__set
  in file output_formats.php, method ezcConsoleOutputFormats::__set()
  Write access to the formats.
__toString
  in file table.php, method ezcConsoleTable::__toString()
  Returns the table in a string.

### Letter 'a'

add
  in file statusbar.php, method ezcConsoleStatusbar::add()
  Add a status to the status bar.
addDependency
  in file option.php, method ezcConsoleOption::addDependency()
  Add a new dependency for a parameter.
addEntry
  in file progressmonitor.php, method ezcConsoleProgressMonitor::addEntry()
  Print a status entry.
addExclusion
  in file option.php, method ezcConsoleOption::addExclusion()
  Add a new exclusion for an option.
advance
  in file progressbar.php, method ezcConsoleProgressbar::advance()
  Advance the progress bar.
ALIGN_CENTER
  in file table.php, class constant ezcConsoleTable::ALIGN_CENTER
  Align text in cells to the center.
ALIGN_DEFAULT
  in file table.php, class constant ezcConsoleTable::ALIGN_DEFAULT
  Align text in the default direction.
ALIGN_LEFT
  in file table.php, class constant ezcConsoleTable::ALIGN_LEFT
  Align text in cells to the right.
ALIGN_RIGHT
  in file table.php, class constant ezcConsoleTable::ALIGN_RIGHT
  Align text in cells to the left.
argumentsAllowed
  in file input.php, method ezcConsoleInput::argumentsAllowed()
  Returns if arguments are allowed with the current option submition.
argument.php
  procedural page argument.php
argument_already_registered.php
  procedural page argument_already_registered.php
argument_mandatory_violation.php
  procedural page argument_mandatory_violation.php
argument_too_many.php
  procedural page argument_too_many.php
argument_type_violation.php
  procedural page argument_type_violation.php
argument.php
  procedural page argument.php
arguments.php
  procedural page arguments.php

### Letter 'b'

$bgcolor
  in file output.php, variable ezcConsoleOutput::$bgcolor
  Stores the mapping of bgcolor names to their escape sequence values.
buildSequence
  in file output.php, method ezcConsoleOutput::buildSequence()
  Returns the escape sequence for a specific format.

### Letter 'c'

$cells
  in file row.php, variable ezcConsoleTableRow::$cells
  The cells of the row.
$color
  in file output.php, variable ezcConsoleOutput::$color
  Stores the mapping of color names to their escape sequence values.
$counter
  in file statusbar.php, variable ezcConsoleStatusbar::$counter
  Counter for success and failure outputs.
$counter
  in file progressmonitor.php, variable ezcConsoleProgressMonitor::$counter
  Counter for the items already printed.
$currentStep
  in file progressbar.php, variable ezcConsoleProgressbar::$currentStep
  The current step the progress bar should show.
calculateMeasures
  in file progressbar.php, method ezcConsoleProgressbar::calculateMeasures()
  Calculate several measures necessary to generate a bar.
cell.php
  procedural page cell.php
CONVERT_LOWER
  in file dialog_validator.php, class constant ezcConsoleDialogValidator::CONVERT_LOWER
  Convert result to lower-case.
CONVERT_NONE
  in file dialog_validator.php, class constant ezcConsoleDialogValidator::CONVERT_NONE
  Perform no conversion on the result.
CONVERT_UPPER
  in file dialog_validator.php, class constant ezcConsoleDialogValidator::CONVERT_UPPER
  Convert result to upper-case.
count
  in file table.php, method ezcConsoleTable::count()
  Returns the number of cells in the row.
count
  in file row.php, method ezcConsoleTableRow::count()
  Returns the number of cells in the row.
count
  in file output_formats.php, method ezcConsoleOutputFormats::count()
  Returns the number of registered formats.
count
  in file arguments.php, method ezcConsoleArguments::count()
  Returns the number of registered arguments.
createOptionSynopsis
  in file input.php, method ezcConsoleInput::createOptionSynopsis()
  Returns the synopsis string for a single option and its dependencies.
current
  in file table.php, method ezcConsoleTable::current()
  Returns the currently selected cell.
current
  in file output_formats.php, method ezcConsoleOutputFormats::current()
  Returns the current Iterator value.
current
  in file arguments.php, method ezcConsoleArguments::current()
  Returns the currently selected argument from the list.
current
  in file row.php, method ezcConsoleTableRow::current()
  Returns the currently selected cell.

### Letter 'd'

$dependencies
  in file option.php, variable ezcConsoleOption::$dependencies
  Dependency rules of this parameter.
dialog_viewer.php
  procedural page dialog_viewer.php
dialog_abort.php
  procedural page dialog_abort.php
dialog.php
  procedural page dialog.php
dialog_validator.php
  procedural page dialog_validator.php
dialog.php
  procedural page dialog.php
display
  in file question_dialog.php, method ezcConsoleQuestionDialog::display()
  Displays the dialog and retreives a value from the user.
display
  in file dialog.php, method ezcConsoleDialog::display()
  Displays the dialog.
display
  in file menu_dialog.php, method ezcConsoleMenuDialog::display()
  Displays the dialog and retreives a value from the user.
displayDialog
  in file dialog_viewer.php, method ezcConsoleDialogViewer::displayDialog()
  Displays a dialog and returns a valid result from it.

### Letter 'e'

$exclusions
  in file option.php, variable ezcConsoleOption::$exclusions
  Exclusion rules of this parameter.
exception.php
  procedural page exception.php
ezcConsoleArgument
  in file argument.php, class ezcConsoleArgument
  The ezcConsoleArgument class represents an argument on the console.
ezcConsoleArgumentAlreadyRegisteredException
  in file argument_already_registered.php, class ezcConsoleArgumentAlreadyRegisteredException
  There is already an argument registered with the given name or at the given place.
ezcConsoleArgumentException
  in file argument.php, class ezcConsoleArgumentException
  General exception container for the ConsoleTools component referring to argument handling.
ezcConsoleArgumentMandatoryViolationException
  in file argument_mandatory_violation.php, class ezcConsoleArgumentMandatoryViolationException
  An argument was marked to be mandatory but was not submitted.
ezcConsoleArguments
  in file arguments.php, class ezcConsoleArguments
  Collection class for ezcConsoleArgument objects. Used in ezcConsoleInput.
ezcConsoleArgumentTypeViolationException
  in file argument_type_violation.php, class ezcConsoleArgumentTypeViolationException
  An argument was submitted with an illigal type.
ezcConsoleDialog
  in file dialog.php, class ezcConsoleDialog
  Interface that every console dialog class must implement.
ezcConsoleDialogAbortException
  in file dialog_abort.php, class ezcConsoleDialogAbortException
  Occurs if the user sends <CTRL>-D to a dialog instead of a valid answer.
ezcConsoleDialogOptions
  in file dialog.php, class ezcConsoleDialogOptions
  Basic options class for ezcConsoleDialog implementations.
ezcConsoleDialogValidator
  in file dialog_validator.php, class ezcConsoleDialogValidator
  Interface that every console dialog validator class must implement.
ezcConsoleDialogViewer
  in file dialog_viewer.php, class ezcConsoleDialogViewer
  Utility class for ezcConsoleDialog implementations.
ezcConsoleException
  in file exception.php, class ezcConsoleException
  General exception container for the ConsoleTools component.
ezcConsoleInput
  in file input.php, class ezcConsoleInput
  The ezcConsoleInput class handles the given options and arguments on the console.
ezcConsoleInvalidOptionNameException
  in file invalid_option_name.php, class ezcConsoleInvalidOptionNameException
  Thrown if an invalid option name (containing whitespaces or starting with a "-") was received by ezcConsoleOption::__construct.
ezcConsoleInvalidOutputTargetException
  in file invalid_output_target.php, class ezcConsoleInvalidOutputTargetException
  Thrown if a given target ezcConsoleOutputFormat could not be opened.
ezcConsoleMenuDialog
  in file menu_dialog.php, class ezcConsoleMenuDialog
  Dialog class to make the user choose from a menu.
ezcConsoleMenuDialogDefaultValidator
  in file menu_dialog_default.php, class ezcConsoleMenuDialogDefaultValidator
  Default validator for ezcConsoleMenuDialog.
ezcConsoleMenuDialogOptions
  in file menu_dialog.php, class ezcConsoleMenuDialogOptions
  Basic options class for ezcConsoleDialog implementations.
ezcConsoleMenuDialogValidator
  in file menu_dialog_validator.php, class ezcConsoleMenuDialogValidator
  Interface that every console menu dialog validator class must implement.
ezcConsoleNoPositionStoredException
  in file no_position_stored.php, class ezcConsoleNoPositionStoredException
  'Cannot restore position, if no position has been stored before.'.
ezcConsoleNoValidDialogResultException
  in file no_valid_dialog_result.php, class ezcConsoleNoValidDialogResultException
  Thrown if ezcConsoleDialog::getResult() is called before a valid result was received.
ezcConsoleOption
  in file option.php, class ezcConsoleOption
  Objects of this class store data about a single option for ezcConsoleInput.
ezcConsoleOptionAlreadyRegisteredException
  in file option_already_registered.php, class ezcConsoleOptionAlreadyRegisteredException
  The option name you tried to register is already in use.
ezcConsoleOptionArgumentsViolationException
  in file option_arguments_violation.php, class ezcConsoleOptionArgumentsViolationException
  An option excludes the usage of arguments, but there were arguments submitted.
ezcConsoleOptionDependencyViolationException
  in file option_dependency_violation.php, class ezcConsoleOptionDependencyViolationException
  A dependency rule for a parameter was violated.
ezcConsoleOptionException
  in file option.php, class ezcConsoleOptionException
  General exception container for the ConsoleTools component referring to option handling.
ezcConsoleOptionExclusionViolationException
  in file option_exclusion_violation.php, class ezcConsoleOptionExclusionViolationException
  An exclusion rule for a parameter was violated.
ezcConsoleOptionMandatoryViolationException
  in file option_mandatory_violation.php, class ezcConsoleOptionMandatoryViolationException
  An option was marked to be mandatory but was not submitted.
ezcConsoleOptionMissingValueException
  in file option_missing_value.php, class ezcConsoleOptionMissingValueException
  An option which expects a value was submitted without.
ezcConsoleOptionNoAliasException
  in file option_no_alias.php, class ezcConsoleOptionNoAliasException
  Occurs if the alias you tried to unregister is not an alias, but a real option.
ezcConsoleOptionNotExistsException
  in file option_not_exists.php, class ezcConsoleOptionNotExistsException
  Occurs if the requested option is not registered.
ezcConsoleOptionRule
  in file option_rule.php, class ezcConsoleOptionRule
  Struct class to store a parameter rule.
ezcConsoleOptionStringNotWellformedException
  in file option_string_not_wellformed.php, class ezcConsoleOptionStringNotWellformedException
  The option definition string supplied is not wellformed.
ezcConsoleOptionTooManyValuesException
  in file option_too_many_values.php, class ezcConsoleOptionTooManyValuesException
  An option that expects only a single value was submitted with multiple values.
ezcConsoleOptionTypeViolationException
  in file option_type_violation.php, class ezcConsoleOptionTypeViolationException
  An option was submitted with an illigal type.
ezcConsoleOutput
  in file output.php, class ezcConsoleOutput
  Class for handling console output.
ezcConsoleOutputFormat
  in file output_format.php, class ezcConsoleOutputFormat
  Struct class to store formating entities used by ezcConsoleOutput.
ezcConsoleOutputFormats
  in file output_formats.php, class ezcConsoleOutputFormats
  Class to store the collection for formating classes.
ezcConsoleOutputOptions
  in file output.php, class ezcConsoleOutputOptions
  Struct class to store the options of the ezcConsoleOutput class.
ezcConsoleProgressbar
  in file progressbar.php, class ezcConsoleProgressbar
  Creating and maintaining progress-bars to be printed to the console.
ezcConsoleProgressbarOptions
  in file progressbar.php, class ezcConsoleProgressbarOptions
  Struct class to store the options of the ezcConsoleOutput class.
ezcConsoleProgressMonitor
  in file progressmonitor.php, class ezcConsoleProgressMonitor
  Printing structured status information on the console.
ezcConsoleProgressMonitorOptions
  in file progressmonitor.php, class ezcConsoleProgressMonitorOptions
  Struct class to store the options of the ezcConsoleOutput class.
ezcConsoleQuestionDialog
  in file question_dialog.php, class ezcConsoleQuestionDialog
  Dialog class to ask a simple question.
ezcConsoleQuestionDialogCollectionValidator
  in file question_dialog_collection.php, class ezcConsoleQuestionDialogCollectionValidator
  Validator class to validate against a set of valid results.
ezcConsoleQuestionDialogMappingValidator
  in file question_dialog_mapping.php, class ezcConsoleQuestionDialogMappingValidator
  Validator class to map certain results to others.
ezcConsoleQuestionDialogOptions
  in file question_dialog.php, class ezcConsoleQuestionDialogOptions
  Basic options class for ezcConsoleDialog implementations.
ezcConsoleQuestionDialogRegexValidator
  in file question_dialog_regex.php, class ezcConsoleQuestionDialogRegexValidator
  Regex validator for ezcConsoleQuestionDialog Validator class for ezcConsoleQuestionDialog objects that validates by matching a certain regular expression.
ezcConsoleQuestionDialogTypeValidator
  in file question_dialog_type.php, class ezcConsoleQuestionDialogTypeValidator
  Validator class to validate a certain data type.
ezcConsoleQuestionDialogValidator
  in file question_dialog_validator.php, class ezcConsoleQuestionDialogValidator
  Interface that every console question dialog validator class must implement.
ezcConsoleStatusbar
  in file statusbar.php, class ezcConsoleStatusbar
  Creating and maintaining status-bars to be printed to the console.
ezcConsoleStatusbarOptions
  in file statusbar.php, class ezcConsoleStatusbarOptions
  Struct class to store the options of the ezcConsoleOutput class.
ezcConsoleTable
  in file table.php, class ezcConsoleTable
  Creating tables to be printed to the console.
ezcConsoleTableCell
  in file cell.php, class ezcConsoleTableCell
  Representation of a table cell.
ezcConsoleTableOptions
  in file table.php, class ezcConsoleTableOptions
  Struct class to store the options of the ezcConsoleTable class.
ezcConsoleTableRow
  in file row.php, class ezcConsoleTableRow
  Structure representing a table row in ezcConsoleTable.
ezcConsoleTooManyArgumentsException
  in file argument_too_many.php, class ezcConsoleTooManyArgumentsException
  Thrown if only a certain number of arguments were expected, but more were submitted.

### Letter 'f'

$formats
  in file output_formats.php, variable ezcConsoleOutputFormats::$formats
  Array of ezcConsoleOutputFormat.
finish
  in file progressbar.php, method ezcConsoleProgressbar::finish()
  Finish the progress bar.
fixup
  in file question_dialog_regex.php, method ezcConsoleQuestionDialogRegexValidator::fixup()
  Returns a fixed version of the result, if possible.
fixup
  in file question_dialog_type.php, method ezcConsoleQuestionDialogTypeValidator::fixup()
  Returns a fixed version of the result, if possible.
fixup
  in file question_dialog_mapping.php, method ezcConsoleQuestionDialogMappingValidator::fixup()
  Returns a fixed version of the result, if possible.
fixup
  in file question_dialog_collection.php, method ezcConsoleQuestionDialogCollectionValidator::fixup()
  Returns a fixed version of the result, if possible.
fixup
  in file menu_dialog_default.php, method ezcConsoleMenuDialogDefaultValidator::fixup()
  Returns a fixed version of the result, if possible.
fixup
  in file dialog_validator.php, method ezcConsoleDialogValidator::fixup()
  Returns a fixed version of the result, if possible.
formatText
  in file output.php, method ezcConsoleOutput::formatText()
  Returns a formated version of the text.

### Letter 'g'

generateValues
  in file progressbar.php, method ezcConsoleProgressbar::generateValues()
  Generate all values to be replaced in the format string.
getArguments
  in file input.php, method ezcConsoleInput::getArguments()
  Returns arguments provided to the program.
getDependencies
  in file option.php, method ezcConsoleOption::getDependencies()
  Returns the dependency rules registered with this parameter.
getElements
  in file menu_dialog_validator.php, method ezcConsoleMenuDialogValidator::getElements()
  Returns an array of the elements to display.
getElements
  in file menu_dialog_default.php, method ezcConsoleMenuDialogDefaultValidator::getElements()
  Returns an array of the elements to display.
getExclusions
  in file option.php, method ezcConsoleOption::getExclusions()
  Returns the exclusion rules registered with this parameter.
getFailureCount
  in file statusbar.php, method ezcConsoleStatusbar::getFailureCount()
  Returns number of failures during the run.
getFormatCode
  in file output.php, method ezcConsoleOutput::getFormatCode()
  Returns the code for a given formating option of a given type.
getHelp
  in file input.php, method ezcConsoleInput::getHelp()
  Get help information for your options.
getHelpTable
  in file input.php, method ezcConsoleInput::getHelpTable()
  Get help information for your options as a table.
getHelpText
  in file input.php, method ezcConsoleInput::getHelpText()
  Returns a standard help output for your program.
getOption
  in file input.php, method ezcConsoleInput::getOption()
  Returns the definition object for the option with the name $name.
getOptions
  in file progressbar.php, method ezcConsoleProgressbar::getOptions()
  Returns the current options.
getOptions
  in file statusbar.php, method ezcConsoleStatusbar::getOptions()
  Returns the current options.
getOptions
  in file table.php, method ezcConsoleTable::getOptions()
  Returns the current options.
getOptions
  in file input.php, method ezcConsoleInput::getOptions()
  Returns an array of all registered options.
getOptions
  in file progressmonitor.php, method ezcConsoleProgressMonitor::getOptions()
  Returns the currently set options.
getOptions
  in file output.php, method ezcConsoleOutput::getOptions()
  Returns the current options.
getOptionValues
  in file input.php, method ezcConsoleInput::getOptionValues()
  Returns the values of all submitted options.
getResult
  in file dialog.php, method ezcConsoleDialog::getResult()
  Returns the result retrieved.
getResult
  in file question_dialog.php, method ezcConsoleQuestionDialog::getResult()
  Returns the result retrieved.
getResult
  in file menu_dialog.php, method ezcConsoleMenuDialog::getResult()
  Returns the result retrieved.
getResultString
  in file menu_dialog_default.php, method ezcConsoleMenuDialogDefaultValidator::getResultString()
  Returns a string representing the default value.
getResultString
  in file question_dialog_validator.php, method ezcConsoleQuestionDialogValidator::getResultString()
  Returns a string of possible results to be displayed with the question.
getResultString
  in file question_dialog_type.php, method ezcConsoleQuestionDialogTypeValidator::getResultString()
  Returns a string representing valid results.
getResultString
  in file question_dialog_collection.php, method ezcConsoleQuestionDialogCollectionValidator::getResultString()
  Returns a string representing valid results.
getResultString
  in file question_dialog_regex.php, method ezcConsoleQuestionDialogRegexValidator::getResultString()
  Returns a string representing valid results.
getSuccessCount
  in file statusbar.php, method ezcConsoleStatusbar::getSuccessCount()
  Returns number of successes during the run.
getSynopsis
  in file input.php, method ezcConsoleInput::getSynopsis()
  Returns the synopsis string for the program.
getTable
  in file table.php, method ezcConsoleTable::getTable()
  Returns the table in an array.

### Letter 'h'

hasDependency
  in file option.php, method ezcConsoleOption::hasDependency()
  Returns if a dependency to the given option exists.
hasExclusion
  in file option.php, method ezcConsoleOption::hasExclusion()
  Returns if a given exclusion rule is registered with the option.
hasOption
  in file input.php, method ezcConsoleInput::hasOption()
  Returns true if an option with the given name exists, otherwise false.
hasValidResult
  in file question_dialog.php, method ezcConsoleQuestionDialog::hasValidResult()
  Returns if the dialog retrieved a valid result.
hasValidResult
  in file menu_dialog.php, method ezcConsoleMenuDialog::hasValidResult()
  Returns if the dialog retrieved a valid result.
hasValidResult
  in file dialog.php, method ezcConsoleDialog::hasValidResult()
  Returns if the dialog retrieved a valid result.
helpOptionSet
  in file input.php, method ezcConsoleInput::helpOptionSet()
  Returns if a help option was set.

### Letter 'i'

invalid_option_name.php
  procedural page invalid_option_name.php
invalid_output_target.php
  procedural page invalid_output_target.php
input.php
  procedural page input.php
input_help_generator.php
  procedural page input_help_generator.php
input_validator.php
  procedural page input_validator.php
insertValues
  in file progressbar.php, method ezcConsoleProgressbar::insertValues()
  Insert values into bar format string.
isValidFormatCode
  in file output.php, method ezcConsoleOutput::isValidFormatCode()
  Returns if a format code is valid for the specific formating option.

### Letter 'k'

key
  in file table.php, method ezcConsoleTable::key()
  Returns the key of the currently selected cell.
key
  in file row.php, method ezcConsoleTableRow::key()
  Returns the key of the currently selected cell.
key
  in file output_formats.php, method ezcConsoleOutputFormats::key()
  Returns the current Iterator key.
key
  in file arguments.php, method ezcConsoleArguments::key()
  Returns the key of the currently selected argument from the list.

### Letter 'm'

$max
  in file progressmonitor.php, variable ezcConsoleProgressMonitor::$max
  The number of entries to expect.
$measures
  in file progressbar.php, variable ezcConsoleProgressbar::$measures
  Stores the bar utilization.
menu_dialog.php
  procedural page menu_dialog.php
menu_dialog_default.php
  procedural page menu_dialog_default.php
menu_dialog_validator.php
  procedural page menu_dialog_validator.php
menu_dialog.php
  procedural page menu_dialog.php

### Letter 'n'

$named
  in file arguments.php, variable ezcConsoleArguments::$named
  Named list of arguments.
$numSteps
  in file progressbar.php, variable ezcConsoleProgressbar::$numSteps
  The maximum number of steps to go.
no_position_stored.php
  procedural page no_position_stored.php
no_valid_dialog_result.php
  procedural page no_valid_dialog_result.php
NAMED
  in file argument_already_registered.php, class constant ezcConsoleArgumentAlreadyRegisteredException::NAMED
  The name of the argument is already in use.
next
  in file table.php, method ezcConsoleTable::next()
  Returns the next cell and selects it or false on the last cell.
next
  in file row.php, method ezcConsoleTableRow::next()
  Returns the next cell and selects it or false on the last cell.
next
  in file arguments.php, method ezcConsoleArguments::next()
  Advances the internal pointer to the next argument and returns it.
next
  in file output_formats.php, method ezcConsoleOutputFormats::next()
  Advances the Iterator to the next element.

### Letter 'o'

$options
  in file progressmonitor.php, variable ezcConsoleProgressMonitor::$options
  Options
$ordered
  in file arguments.php, variable ezcConsoleArguments::$ordered
  Ordered list of arguments.
$output
  in file progressbar.php, variable ezcConsoleProgressbar::$output
  The ezcConsoleOutput object to use.
$outputHandler
  in file progressmonitor.php, variable ezcConsoleProgressMonitor::$outputHandler
  The ezcConsoleOutput object to use.
$outputHandler
  in file table.php, variable ezcConsoleTable::$outputHandler
  The ezcConsoleOutput object to use.
$outputHandler
  in file statusbar.php, variable ezcConsoleStatusbar::$outputHandler
  The ezcConsoleOutput object to use.
option.php
  procedural page option.php
option_already_registered.php
  procedural page option_already_registered.php
option_arguments_violation.php
  procedural page option_arguments_violation.php
option_dependency_violation.php
  procedural page option_dependency_violation.php
option_exclusion_violation.php
  procedural page option_exclusion_violation.php
option_mandatory_violation.php
  procedural page option_mandatory_violation.php
option_missing_value.php
  procedural page option_missing_value.php
option_not_exists.php
  procedural page option_not_exists.php
option_no_alias.php
  procedural page option_no_alias.php
option_string_not_wellformed.php
  procedural page option_string_not_wellformed.php
option_too_many_values.php
  procedural page option_too_many_values.php
option_type_violation.php
  procedural page option_type_violation.php
option.php
  procedural page option.php
output.php
  procedural page output.php
output.php
  procedural page output.php
option_rule.php
  procedural page option_rule.php
output_format.php
  procedural page output_format.php
output_formats.php
  procedural page output_formats.php
offsetExists
  in file arguments.php, method ezcConsoleArguments::offsetExists()
  Returns if the given offset exists.
offsetExists
  in file table.php, method ezcConsoleTable::offsetExists()
  Returns if the given offset exists.
offsetExists
  in file row.php, method ezcConsoleTableRow::offsetExists()
  Returns if the given offset exists.
offsetGet
  in file arguments.php, method ezcConsoleArguments::offsetGet()
  Returns the element with the given offset.
offsetGet
  in file table.php, method ezcConsoleTable::offsetGet()
  Returns the element with the given offset.
offsetGet
  in file row.php, method ezcConsoleTableRow::offsetGet()
  Returns the element with the given offset.
offsetSet
  in file row.php, method ezcConsoleTableRow::offsetSet()
  Set the element with the given offset.
offsetSet
  in file table.php, method ezcConsoleTable::offsetSet()
  Set the element with the given offset.
offsetSet
  in file arguments.php, method ezcConsoleArguments::offsetSet()
  Set the element with the given offset.
offsetUnset
  in file table.php, method ezcConsoleTable::offsetUnset()
  Unset the element with the given offset.
offsetUnset
  in file row.php, method ezcConsoleTableRow::offsetUnset()
  Unset the element with the given offset.
offsetUnset
  in file arguments.php, method ezcConsoleArguments::offsetUnset()
  Unset the element with the given offset.
ORDERED
  in file argument_already_registered.php, class constant ezcConsoleArgumentAlreadyRegisteredException::ORDERED
  The position of the argument is already in use. Unset the position first and the re-register.
output
  in file progressbar.php, method ezcConsoleProgressbar::output()
  Draw the progress bar.
outputLine
  in file output.php, method ezcConsoleOutput::outputLine()
  Print text to the console and automatically append a line break.
outputTable
  in file table.php, method ezcConsoleTable::outputTable()
  Output the table.
outputText
  in file output.php, method ezcConsoleOutput::outputText()
  Print text to the console.

### Letter 'p'

$positionStored
  in file output.php, variable ezcConsoleOutput::$positionStored
  Whether a position has been stored before, using the storePos() method.
$properties
  in file question_dialog_collection.php, variable ezcConsoleQuestionDialogCollectionValidator::$properties
  Properties.
$properties
  in file question_dialog.php, variable ezcConsoleQuestionDialog::$properties
  Properties
$properties
  in file progressmonitor.php, variable ezcConsoleProgressMonitorOptions::$properties
$properties
  in file progressbar.php, variable ezcConsoleProgressbar::$properties
  Container to hold the properties
$properties
  in file question_dialog_regex.php, variable ezcConsoleQuestionDialogRegexValidator::$properties
  Properties
$properties
  in file question_dialog_type.php, variable ezcConsoleQuestionDialogTypeValidator::$properties
  Properties.
$properties
  in file table.php, variable ezcConsoleTable::$properties
  Container to hold the properties
$properties
  in file table.php, variable ezcConsoleTableOptions::$properties
$properties
  in file statusbar.php, variable ezcConsoleStatusbar::$properties
  Container to hold the properties
$properties
  in file statusbar.php, variable ezcConsoleStatusbarOptions::$properties
$properties
  in file row.php, variable ezcConsoleTableRow::$properties
  Container to hold the properties
$properties
  in file argument.php, variable ezcConsoleArgument::$properties
  Properties
$properties
  in file progressbar.php, variable ezcConsoleProgressbarOptions::$properties
$properties
  in file menu_dialog.php, variable ezcConsoleMenuDialog::$properties
  Properties
$properties
  in file menu_dialog_default.php, variable ezcConsoleMenuDialogDefaultValidator::$properties
  Properties
$properties
  in file input.php, variable ezcConsoleInput::$properties
  Collection of properties.
$properties
  in file dialog.php, variable ezcConsoleDialogOptions::$properties
  Properties.
$properties
  in file cell.php, variable ezcConsoleTableCell::$properties
  Container to hold the properties
$properties
  in file option.php, variable ezcConsoleOption::$properties
  Container to hold the properties
$properties
  in file option_rule.php, variable ezcConsoleOptionRule::$properties
  Properties.
$properties
  in file output.php, variable ezcConsoleOutput::$properties
  Container to hold the properties
$properties
  in file output_format.php, variable ezcConsoleOutputFormat::$properties
  Container to hold the properties
progressbar.php
  procedural page progressbar.php
progressmonitor.php
  procedural page progressmonitor.php
progressbar.php
  procedural page progressbar.php
progressmonitor.php
  procedural page progressmonitor.php
process
  in file input.php, method ezcConsoleInput::process()
  Process the input parameters.

### Letter 'q'

question_dialog.php
  procedural page question_dialog.php
question_dialog_collection.php
  procedural page question_dialog_collection.php
question_dialog_mapping.php
  procedural page question_dialog_mapping.php
question_dialog_regex.php
  procedural page question_dialog_regex.php
question_dialog_type.php
  procedural page question_dialog_type.php
question_dialog_validator.php
  procedural page question_dialog_validator.php
question_dialog.php
  procedural page question_dialog.php

### Letter 'r'

$result
  in file question_dialog.php, variable ezcConsoleQuestionDialog::$result
  Dialog result
$result
  in file menu_dialog.php, variable ezcConsoleMenuDialog::$result
  Dialog result
$rows
  in file table.php, variable ezcConsoleTable::$rows
  Collection of the rows that are contained in the table.
row.php
  procedural page row.php
readLine
  in file dialog_viewer.php, method ezcConsoleDialogViewer::readLine()
  Returns a line from STDIN.
registerAlias
  in file input.php, method ezcConsoleInput::registerAlias()
  Registers an alias for an option.
registerOption
  in file input.php, method ezcConsoleInput::registerOption()
  Registers the new option $option.
registerOptionString
  in file input.php, method ezcConsoleInput::registerOptionString()
  Registers options according to a string specification.
removeAllDependencies
  in file option.php, method ezcConsoleOption::removeAllDependencies()
  Remove all dependency rule referring to a parameter.
removeAllExclusions
  in file option.php, method ezcConsoleOption::removeAllExclusions()
  Remove all exclusion rule referring to a option.
removeDependency
  in file option.php, method ezcConsoleOption::removeDependency()
  Remove a dependency rule from a parameter.
removeExclusion
  in file option.php, method ezcConsoleOption::removeExclusion()
  Remove a exclusion rule from a option.
reset
  in file input.php, method ezcConsoleInput::reset()
  Resets all option and argument values.
reset
  in file statusbar.php, method ezcConsoleStatusbar::reset()
  Reset the state of the status-bar object to its initial one.
reset
  in file dialog.php, method ezcConsoleDialog::reset()
  Resets the dialog to its initial state.
reset
  in file question_dialog.php, method ezcConsoleQuestionDialog::reset()
  Reset the dialog.
reset
  in file menu_dialog.php, method ezcConsoleMenuDialog::reset()
  Reset the dialog.
resetDependencies
  in file option.php, method ezcConsoleOption::resetDependencies()
  Reset existing dependency rules.
resetExclusions
  in file option.php, method ezcConsoleOption::resetExclusions()
  Reset existing exclusion rules.
restorePos
  in file output.php, method ezcConsoleOutput::restorePos()
  Restores a cursor position.
rewind
  in file table.php, method ezcConsoleTable::rewind()
  Selects the very first cell and returns it.
rewind
  in file row.php, method ezcConsoleTableRow::rewind()
  Selects the very first cell and returns it.
rewind
  in file output_formats.php, method ezcConsoleOutputFormats::rewind()
  Resets the Iterator to the first element.
rewind
  in file arguments.php, method ezcConsoleArguments::rewind()
  Rewinds the internal pointer to the first argument and returns it.

### Letter 's'

$started
  in file progressbar.php, variable ezcConsoleProgressbar::$started
  Indicates if the starting point for the bar has been stored.
$style
  in file output.php, variable ezcConsoleOutput::$style
  Stores the mapping of styles names to their escape sequence values.
standard.php
  procedural page standard.php
standard.php
  procedural page standard.php
statusbar.php
  procedural page statusbar.php
statusbar.php
  procedural page statusbar.php
string.php
  procedural page string.php
setOptions
  in file statusbar.php, method ezcConsoleStatusbar::setOptions()
  Set new options.
setOptions
  in file table.php, method ezcConsoleTable::setOptions()
  Set new options.
setOptions
  in file progressmonitor.php, method ezcConsoleProgressMonitor::setOptions()
  Set new options.
setOptions
  in file output.php, method ezcConsoleOutput::setOptions()
  Set new options.
setOptions
  in file progressbar.php, method ezcConsoleProgressbar::setOptions()
  Set new options.
start
  in file progressbar.php, method ezcConsoleProgressbar::start()
  Start the progress bar Starts the progress bar and sticks it to the current line.
storePos
  in file output.php, method ezcConsoleOutput::storePos()
  Stores the current cursor position.
stripEscapeSequences
  in file progressbar.php, method ezcConsoleProgressbar::stripEscapeSequences()
  Strip all escape sequences from a string to measure it's size correctly.

### Letter 't'

table.php
  procedural page table.php
table.php
  procedural page table.php
TARGET_OUTPUT
  in file output.php, class constant ezcConsoleOutput::TARGET_OUTPUT
  Target to print to standard out, with output buffering possibility.
TARGET_STDERR
  in file output.php, class constant ezcConsoleOutput::TARGET_STDERR
  Target to print to standard error.
TARGET_STDOUT
  in file output.php, class constant ezcConsoleOutput::TARGET_STDOUT
  Target to print to standard out.
toPos
  in file output.php, method ezcConsoleOutput::toPos()
  Move the cursor to a specific column of the current line.
TYPE_BOOL
  in file question_dialog_type.php, class constant ezcConsoleQuestionDialogTypeValidator::TYPE_BOOL
  Data type bool.
TYPE_FLOAT
  in file question_dialog_type.php, class constant ezcConsoleQuestionDialogTypeValidator::TYPE_FLOAT
  Data type float.
TYPE_INT
  in file input.php, class constant ezcConsoleInput::TYPE_INT
  Option takes an integer value.
TYPE_INT
  in file question_dialog_type.php, class constant ezcConsoleQuestionDialogTypeValidator::TYPE_INT
  Data type int.
TYPE_NONE
  in file input.php, class constant ezcConsoleInput::TYPE_NONE
  Option does not carry a value.
TYPE_STRING
  in file input.php, class constant ezcConsoleInput::TYPE_STRING
  Option takes a string value.
TYPE_STRING
  in file question_dialog_type.php, class constant ezcConsoleQuestionDialogTypeValidator::TYPE_STRING
  Data type string.

### Letter 'u'

unregisterAlias
  in file input.php, method ezcConsoleInput::unregisterAlias()
  Removes an alias to an option.
unregisterOption
  in file input.php, method ezcConsoleInput::unregisterOption()
  Removes an option.

### Letter 'v'

$value
  in file option.php, variable ezcConsoleOption::$value
  The value the parameter was assigned to when being submitted.
$valueMap
  in file progressbar.php, variable ezcConsoleProgressbar::$valueMap
  Storage for actual values to be replaced in the format string.
valid
  in file row.php, method ezcConsoleTableRow::valid()
  Returns if the current cell is valid.
valid
  in file table.php, method ezcConsoleTable::valid()
  Returns if the current cell is valid.
valid
  in file arguments.php, method ezcConsoleArguments::valid()
  Checks if the current position is valid.
valid
  in file output_formats.php, method ezcConsoleOutputFormats::valid()
  Checks if the current Iterator position is still valid.
validate
  in file menu_dialog_default.php, method ezcConsoleMenuDialogDefaultValidator::validate()
  Returns if the given result is valid.
validate
  in file dialog_validator.php, method ezcConsoleDialogValidator::validate()
  Returns if the given result is valid.
validate
  in file question_dialog_type.php, method ezcConsoleQuestionDialogTypeValidator::validate()
  Returns if the given result is valid.
validate
  in file question_dialog_regex.php, method ezcConsoleQuestionDialogRegexValidator::validate()
  Returns if the given result is valid.
validate
  in file question_dialog_collection.php, method ezcConsoleQuestionDialogCollectionValidator::validate()
  Returns if the given result is valid.
validateOptionName
  in file option.php, method ezcConsoleOption::validateOptionName()
  Returns if a given name if valid for use as a parameter name a parameter.

### Letter 'w'

WIDTH_FIXED
  in file table.php, class constant ezcConsoleTable::WIDTH_FIXED
  The width given by settings must be used even if the data allows it smaller.
WIDTH_MAX
  in file table.php, class constant ezcConsoleTable::WIDTH_MAX
  The width given by settings is a maximum value, if data allows it, the table gets smaller.
WRAP_AUTO
  in file table.php, class constant ezcConsoleTable::WRAP_AUTO
  Automatically wrap text to fit into a column.
WRAP_CUT
  in file table.php, class constant ezcConsoleTable::WRAP_CUT
  Text will be cut to fit into a column.
WRAP_NONE
  in file table.php, class constant ezcConsoleTable::WRAP_NONE
  Do not wrap text. Columns will be extended to fit the largest text.

### Letter 'y'

YesNoQuestion
  in file question_dialog.php, method ezcConsoleQuestionDialog::YesNoQuestion()
  Returns a ready to use yes/no question dialog.

Documentation generated by phpDocumentor 1.4.3