[ Tutorial ] [ Class tree ] [ Element index ] [ ChangeLog ] [ Credits ]

Element index for package ConsoleTools

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

_

__construct : ezcConsoleOutput

in file output.php, method ezcConsoleOutput::__construct()
    Create a new console output handler.

__construct : ezcConsoleOutputOptions

in file output.php, method ezcConsoleOutputOptions::__construct()
    Construct a new options object.

__construct : ezcConsoleOutputFormat

in file output_format.php, method ezcConsoleOutputFormat::__construct()
    Create a new ezcConsoleOutputFormat object.

__construct : ezcConsoleOutputFormats

in file output_formats.php, method ezcConsoleOutputFormats::__construct()
    Create a new ezcConsoleOutputFormats object.

__construct : ezcConsoleOptionTypeViolationException

in file option_type_violation.php, method ezcConsoleOptionTypeViolationException::__construct()
    Creates a new exception object.

__construct : ezcConsoleOptionTooManyValuesException

in file option_too_many_values.php, method ezcConsoleOptionTooManyValuesException::__construct()
    Creates a new exception object.

__construct : ezcConsoleOptionNoAliasException

in file option_no_alias.php, method ezcConsoleOptionNoAliasException::__construct()
    Creates a new exception object.

__construct : ezcConsoleArgument

in file argument.php, method ezcConsoleArgument::__construct()
    Creates a new console argument object.

__construct : ezcConsoleOptionStringNotWellformedException

in file option_string_not_wellformed.php, method ezcConsoleOptionStringNotWellformedException::__construct()
    Creates a new exception object.

__construct : ezcConsoleProgressbar

in file progressbar.php, method ezcConsoleProgressbar::__construct()
    Creates a new progress bar.

__construct : ezcConsoleProgressMonitor

in file progressmonitor.php, method ezcConsoleProgressMonitor::__construct()
    Creates a new progress monitor.

__construct : ezcConsoleTableRow

in file row.php, method ezcConsoleTableRow::__construct()
    Create a new ezcConsoleProgressbarRow.

__construct : ezcConsoleStatusbar

in file statusbar.php, method ezcConsoleStatusbar::__construct()
    Creates a new status bar.

__construct : ezcConsoleTableOptions

in file table.php, method ezcConsoleTableOptions::__construct()
    Construct a new options object.

__construct : ezcConsoleTable

in file table.php, method ezcConsoleTable::__construct()
    Creates a new table.

__construct : ezcConsoleQuestionDialogTypeValidator

in file question_dialog_type.php, method ezcConsoleQuestionDialogTypeValidator::__construct()
    Creates a new question dialog type validator.

__construct : ezcConsoleQuestionDialogRegexValidator

in file question_dialog_regex.php, method ezcConsoleQuestionDialogRegexValidator::__construct()
    Create a new question dialog regex validator.

__construct : ezcConsoleQuestionDialog

in file question_dialog.php, method ezcConsoleQuestionDialog::__construct()
    Creates a new question dialog.

__construct : ezcConsoleQuestionDialogOptions

in file question_dialog.php, method ezcConsoleQuestionDialogOptions::__construct()
    Construct a new options object.

__construct : ezcConsoleQuestionDialogCollectionValidator

in file question_dialog_collection.php, method ezcConsoleQuestionDialogCollectionValidator::__construct()
    Creates a new question dialog collection validator.

__construct : ezcConsoleOptionNotExistsException

in file option_not_exists.php, method ezcConsoleOptionNotExistsException::__construct()
    Creates a new exception object.

__construct : ezcConsoleOptionRule

in file option_rule.php, method ezcConsoleOptionRule::__construct()
    Creates a new option rule.

__construct : ezcConsoleInvalidOptionNameException

in file invalid_option_name.php, method ezcConsoleInvalidOptionNameException::__construct()
    Creates a new exception object.

__construct : ezcConsoleInvalidOutputTargetException

in file invalid_output_target.php, method ezcConsoleInvalidOutputTargetException::__construct()
    Creates a new exception object.

__construct : ezcConsoleMenuDialog

in file menu_dialog.php, method ezcConsoleMenuDialog::__construct()
    Creates a new menu dialog.

__construct : ezcConsoleMenuDialogOptions

in file menu_dialog.php, method ezcConsoleMenuDialogOptions::__construct()
    Construct a new options object.

__construct : ezcConsoleInput

in file input.php, method ezcConsoleInput::__construct()
    Creates an input handler.

__construct : ezcConsoleTableCell

in file cell.php, method ezcConsoleTableCell::__construct()
    Create a new ezcConsoleProgressbarCell.

__construct : ezcConsoleArgumentAlreadyRegisteredException

in file argument_already_registered.php, method ezcConsoleArgumentAlreadyRegisteredException::__construct()
    Creates a new exception object.

__construct : ezcConsoleArgumentMandatoryViolationException

in file argument_mandatory_violation.php, method ezcConsoleArgumentMandatoryViolationException::__construct()
    Creates a new exception object.

__construct : ezcConsoleTooManyArgumentsException

in file argument_too_many.php, method ezcConsoleTooManyArgumentsException::__construct()
    Creates a new exception object.

__construct : ezcConsoleArgumentTypeViolationException

in file argument_type_violation.php, method ezcConsoleArgumentTypeViolationException::__construct()
    Creates a new exception object.

__construct : ezcConsoleOptionMissingValueException

in file option_missing_value.php, method ezcConsoleOptionMissingValueException::__construct()
    Creates a new exception object.

__construct : ezcConsoleMenuDialogDefaultValidator

in file menu_dialog_default.php, method ezcConsoleMenuDialogDefaultValidator::__construct()
    Creates a new menu default validator.

__construct : ezcConsoleOptionAlreadyRegisteredException

in file option_already_registered.php, method ezcConsoleOptionAlreadyRegisteredException::__construct()
    Creates a new exception object.

__construct : ezcConsoleOption

in file option.php, method ezcConsoleOption::__construct()
    Create a new parameter struct.

__construct : ezcConsoleOptionArgumentsViolationException

in file option_arguments_violation.php, method ezcConsoleOptionArgumentsViolationException::__construct()
    Creates a new exception object.

__construct : ezcConsoleOptionDependencyViolationException

in file option_dependency_violation.php, method ezcConsoleOptionDependencyViolationException::__construct()
    Creates a new exception object.

__construct : ezcConsoleOptionMandatoryViolationException

in file option_mandatory_violation.php, method ezcConsoleOptionMandatoryViolationException::__construct()
    Creates a new exception object.

__construct : ezcConsoleOptionExclusionViolationException

in file option_exclusion_violation.php, method ezcConsoleOptionExclusionViolationException::__construct()
    Creates a new exception object.

__construct : ezcConsoleNoValidDialogResultException

in file no_valid_dialog_result.php, method ezcConsoleNoValidDialogResultException::__construct()
    Creates a new exception object.

__construct : ezcConsoleNoPositionStoredException

in file no_position_stored.php, method ezcConsoleNoPositionStoredException::__construct()
    Creates a new exception object.

__get : ezcConsoleProgressMonitor

in file progressmonitor.php, method ezcConsoleProgressMonitor::__get()
    Property read access.

__get : ezcConsoleOutputFormats

in file output_formats.php, method ezcConsoleOutputFormats::__get()
    Read access to the formats.

__isset : ezcConsoleProgressMonitor

in file progressmonitor.php, method ezcConsoleProgressMonitor::__isset()
    Property isset access.

__isset : ezcConsoleOutputFormats

in file output_formats.php, method ezcConsoleOutputFormats::__isset()
    Property isset access.

__set : ezcConsoleProgressMonitor

in file progressmonitor.php, method ezcConsoleProgressMonitor::__set()
    Property write access.

__set : ezcConsoleOutputFormats

in file output_formats.php, method ezcConsoleOutputFormats::__set()
    Write access to the formats.

a

add : ezcConsoleStatusbar

in file statusbar.php, method ezcConsoleStatusbar::add()
    Add a status to the status bar.

addDependency : ezcConsoleOption

in file option.php, method ezcConsoleOption::addDependency()
    Add a new dependency for a parameter.

addEntry : ezcConsoleProgressMonitor

in file progressmonitor.php, method ezcConsoleProgressMonitor::addEntry()
    Print a status entry.

addExclusion : ezcConsoleOption

in file option.php, method ezcConsoleOption::addExclusion()
    Add a new exclusion for an option.

advance : ezcConsoleProgressbar

in file progressbar.php, method ezcConsoleProgressbar::advance()
    Advance the progress bar.

argumentsAllowed : ezcConsoleInput

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

NAMED : ezcConsoleArgumentAlreadyRegisteredException

in file argument_already_registered.php, class constant ezcConsoleArgumentAlreadyRegisteredException::NAMED
    The name of the argument is already in use.

TARGET_OUTPUT : ezcConsoleOutput

in file output.php, class constant ezcConsoleOutput::TARGET_OUTPUT
    Target to print to standard out, with output buffering possibility.

TARGET_STDERR : ezcConsoleOutput

in file output.php, class constant ezcConsoleOutput::TARGET_STDERR
    Target to print to standard error.

TARGET_STDOUT : ezcConsoleOutput

in file output.php, class constant ezcConsoleOutput::TARGET_STDOUT
    Target to print to standard out.

b

$bgcolor : ezcConsoleOutput

in file output.php, variable ezcConsoleOutput::$bgcolor
    Stores the mapping of bgcolor names to their escape sequence values.

buildSequence : ezcConsoleOutput

in file output.php, method ezcConsoleOutput::buildSequence()
    Returns the escape sequence for a specific format.

c

$cells : ezcConsoleTableRow

in file row.php, variable ezcConsoleTableRow::$cells
    The cells of the row.

$color : ezcConsoleOutput

in file output.php, variable ezcConsoleOutput::$color
    Stores the mapping of color names to their escape sequence values.

$counter : ezcConsoleProgressMonitor

in file progressmonitor.php, variable ezcConsoleProgressMonitor::$counter
    Counter for the items already printed.

$counter : ezcConsoleStatusbar

in file statusbar.php, variable ezcConsoleStatusbar::$counter
    Counter for success and failure outputs.

$currentStep : ezcConsoleProgressbar

in file progressbar.php, variable ezcConsoleProgressbar::$currentStep
    The current step the progress bar should show.

calculateMeasures : ezcConsoleProgressbar

in file progressbar.php, method ezcConsoleProgressbar::calculateMeasures()
    Calculate several measures necessary to generate a bar.

cell.php

procedural page cell.php

count : ezcConsoleTable

in file table.php, method ezcConsoleTable::count()
    Returns the number of cells in the row.

count : ezcConsoleArguments

in file arguments.php, method ezcConsoleArguments::count()
    Returns the number of registered arguments.

count : ezcConsoleTableRow

in file row.php, method ezcConsoleTableRow::count()
    Returns the number of cells in the row.

createOptionSynopsis : ezcConsoleInput

in file input.php, method ezcConsoleInput::createOptionSynopsis()
    Returns the synopsis string for a single option and its dependencies.

current : ezcConsoleTable

in file table.php, method ezcConsoleTable::current()
    Returns the currently selected cell.

current : ezcConsoleArguments

in file arguments.php, method ezcConsoleArguments::current()
    Returns the currently selected argument from the list.

current : ezcConsoleTableRow

in file row.php, method ezcConsoleTableRow::current()
    Returns the currently selected cell.

d

$dependencies : ezcConsoleOption

in file option.php, variable ezcConsoleOption::$dependencies
    Dependency rules of this parameter.

dialog_viewer.php

procedural page dialog_viewer.php

dialog.php

procedural page dialog.php

dialog_validator.php

procedural page dialog_validator.php

dialog.php

procedural page dialog.php

display : ezcConsoleQuestionDialog

in file question_dialog.php, method ezcConsoleQuestionDialog::display()
    Displays the dialog and retreives a value from the user.

display : ezcConsoleMenuDialog

in file menu_dialog.php, method ezcConsoleMenuDialog::display()
    Displays the dialog and retreives a value from the user.

display : ezcConsoleDialog

in file dialog.php, method ezcConsoleDialog::display()
    Displays the dialog.

displayDialog : ezcConsoleDialogViewer

in file dialog_viewer.php, method ezcConsoleDialogViewer::displayDialog()
    Displays a dialog and returns a valid result from it.

e

$exclusions : ezcConsoleOption

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.

ezcConsoleDialogOptions

in file dialog.php, class ezcConsoleDialogOptions
    Basic options class for ezcConsoleDialog implementations.

ezcConsoleDialogValidator

in file dialog_validator.php, class ezcConsoleDialogValidator
    Interface for ezcConsoleDialog validator classes.

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 for ezcConsoleMenuDialog validator classes.

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.

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
    File containing the ezcConsoleQuestionDialogValidator class.

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.

f

$formats : ezcConsoleOutputFormats

in file output_formats.php, variable ezcConsoleOutputFormats::$formats
    Array of ezcConsoleOutputFormat.

finish : ezcConsoleProgressbar

in file progressbar.php, method ezcConsoleProgressbar::finish()
    Finish the progress bar.

fixup : ezcConsoleQuestionDialogRegexValidator

in file question_dialog_regex.php, method ezcConsoleQuestionDialogRegexValidator::fixup()
    Returns a fixed version of the result, if possible.

fixup : ezcConsoleQuestionDialogTypeValidator

in file question_dialog_type.php, method ezcConsoleQuestionDialogTypeValidator::fixup()
    Returns a fixed version of the result, if possible.

fixup : ezcConsoleQuestionDialogCollectionValidator

in file question_dialog_collection.php, method ezcConsoleQuestionDialogCollectionValidator::fixup()
    Returns a fixed version of the result, if possible.

fixup : ezcConsoleMenuDialogDefaultValidator

in file menu_dialog_default.php, method ezcConsoleMenuDialogDefaultValidator::fixup()
    Returns a fixed version of the result, if possible.

fixup : ezcConsoleDialogValidator

in file dialog_validator.php, method ezcConsoleDialogValidator::fixup()
    Returns a fixed version of the result, if possible.

formatText : ezcConsoleOutput

in file output.php, method ezcConsoleOutput::formatText()
    Returns a formated version of the text.

g

generateValues : ezcConsoleProgressbar

in file progressbar.php, method ezcConsoleProgressbar::generateValues()
    Generate all values to be replaced in the format string.

getArguments : ezcConsoleInput

in file input.php, method ezcConsoleInput::getArguments()
    Returns arguments provided to the program.

getDependencies : ezcConsoleOption

in file option.php, method ezcConsoleOption::getDependencies()
    Returns the dependency rules registered with this parameter.

getElements : ezcConsoleMenuDialogValidator

in file menu_dialog_validator.php, method ezcConsoleMenuDialogValidator::getElements()
    Returns an array of the elements to display.

getElements : ezcConsoleMenuDialogDefaultValidator

in file menu_dialog_default.php, method ezcConsoleMenuDialogDefaultValidator::getElements()
    Returns an array of the elements to display.

getExclusions : ezcConsoleOption

in file option.php, method ezcConsoleOption::getExclusions()
    Returns the exclusion rules registered with this parameter.

getFailureCount : ezcConsoleStatusbar

in file statusbar.php, method ezcConsoleStatusbar::getFailureCount()
    Returns number of failures during the run.

getFormatCode : ezcConsoleOutput

in file output.php, method ezcConsoleOutput::getFormatCode()
    Returns the code for a given formating option of a given type.

getHelp : ezcConsoleInput

in file input.php, method ezcConsoleInput::getHelp()
    Get help information for your options.

getHelpTable : ezcConsoleInput

in file input.php, method ezcConsoleInput::getHelpTable()
    Get help information for your options as a table.

getHelpText : ezcConsoleInput

in file input.php, method ezcConsoleInput::getHelpText()
    Returns a standard help output for your program.

getOption : ezcConsoleInput

in file input.php, method ezcConsoleInput::getOption()
    Returns the definition object for the option with the name $name.

getOptions : ezcConsoleProgressbar

in file progressbar.php, method ezcConsoleProgressbar::getOptions()
    Returns the current options.

getOptions : ezcConsoleStatusbar

in file statusbar.php, method ezcConsoleStatusbar::getOptions()
    Returns the current options.

getOptions : ezcConsoleTable

in file table.php, method ezcConsoleTable::getOptions()
    Returns the current options.

getOptions : ezcConsoleInput

in file input.php, method ezcConsoleInput::getOptions()
    Returns an array of all registered options.

getOptions : ezcConsoleProgressMonitor

in file progressmonitor.php, method ezcConsoleProgressMonitor::getOptions()
    Returns the currently set options.

getOptions : ezcConsoleOutput

in file output.php, method ezcConsoleOutput::getOptions()
    Returns the current options.

getOptionValues : ezcConsoleInput

in file input.php, method ezcConsoleInput::getOptionValues()
    Returns the values of all submitted options.

getResult : ezcConsoleDialog

in file dialog.php, method ezcConsoleDialog::getResult()
    Returns the result retrieved.

getResult : ezcConsoleQuestionDialog

in file question_dialog.php, method ezcConsoleQuestionDialog::getResult()
    Returns the result retrieved.

getResult : ezcConsoleMenuDialog

in file menu_dialog.php, method ezcConsoleMenuDialog::getResult()
    Returns the result retrieved.

getResultString : ezcConsoleMenuDialogDefaultValidator

in file menu_dialog_default.php, method ezcConsoleMenuDialogDefaultValidator::getResultString()
    Returns a string representing the default value.

getResultString : ezcConsoleQuestionDialogValidator

in file question_dialog_validator.php, method ezcConsoleQuestionDialogValidator::getResultString()
    Returns a string of possible results to be displayed with the question.

getResultString : ezcConsoleQuestionDialogTypeValidator

in file question_dialog_type.php, method ezcConsoleQuestionDialogTypeValidator::getResultString()
    Returns a string representing valid results.

getResultString : ezcConsoleQuestionDialogCollectionValidator

in file question_dialog_collection.php, method ezcConsoleQuestionDialogCollectionValidator::getResultString()
    Returns a string representing valid results.

getResultString : ezcConsoleQuestionDialogRegexValidator

in file question_dialog_regex.php, method ezcConsoleQuestionDialogRegexValidator::getResultString()
    Returns a string representing valid results.

getSuccessCount : ezcConsoleStatusbar

in file statusbar.php, method ezcConsoleStatusbar::getSuccessCount()
    Returns number of successes during the run.

getSynopsis : ezcConsoleInput

in file input.php, method ezcConsoleInput::getSynopsis()
    Returns the synopsis string for the program.

getTable : ezcConsoleTable

in file table.php, method ezcConsoleTable::getTable()
    Returns the table in a string.

h

hasDependency : ezcConsoleOption

in file option.php, method ezcConsoleOption::hasDependency()
    Returns if a dependency to the given option exists.

hasExclusion : ezcConsoleOption

in file option.php, method ezcConsoleOption::hasExclusion()
    Returns if a given exclusion rule is registered with the option.

hasOption : ezcConsoleInput

in file input.php, method ezcConsoleInput::hasOption()
    Returns true if an option with the given name exists, otherwise false.

hasValidResult : ezcConsoleQuestionDialog

in file question_dialog.php, method ezcConsoleQuestionDialog::hasValidResult()
    Returns if the dialog retrieved a valid result.

hasValidResult : ezcConsoleMenuDialog

in file menu_dialog.php, method ezcConsoleMenuDialog::hasValidResult()
    Returns if the dialog retrieved a valid result.

hasValidResult : ezcConsoleDialog

in file dialog.php, method ezcConsoleDialog::hasValidResult()
    Returns if the dialog retrieved a valid result.

helpOptionSet : ezcConsoleInput

in file input.php, method ezcConsoleInput::helpOptionSet()
    Returns if a help option was set.

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

insertValues : ezcConsoleProgressbar

in file progressbar.php, method ezcConsoleProgressbar::insertValues()
    Insert values into bar format string.

isValidFormatCode : ezcConsoleOutput

in file output.php, method ezcConsoleOutput::isValidFormatCode()
    Returns if a format code is valid for ta specific formating option.

WIDTH_FIXED : ezcConsoleTable

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 : ezcConsoleTable

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.

k

key : ezcConsoleTable

in file table.php, method ezcConsoleTable::key()
    Returns the key of the currently selected cell.

key : ezcConsoleTableRow

in file row.php, method ezcConsoleTableRow::key()
    Returns the key of the currently selected cell.

key : ezcConsoleArguments

in file arguments.php, method ezcConsoleArguments::key()
    Returns the key of the currently selected argument from the list.

l

ALIGN_CENTER : ezcConsoleTable

in file table.php, class constant ezcConsoleTable::ALIGN_CENTER
    Align text in cells to the center.

ALIGN_DEFAULT : ezcConsoleTable

in file table.php, class constant ezcConsoleTable::ALIGN_DEFAULT
    Align text in the default direction.

ALIGN_LEFT : ezcConsoleTable

in file table.php, class constant ezcConsoleTable::ALIGN_LEFT
    Align text in cells to the right.

ALIGN_RIGHT : ezcConsoleTable

in file table.php, class constant ezcConsoleTable::ALIGN_RIGHT
    Align text in cells to the left.

m

$max : ezcConsoleProgressMonitor

in file progressmonitor.php, variable ezcConsoleProgressMonitor::$max
    The number of entries to expect.

$measures : ezcConsoleProgressbar

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

n

$named : ezcConsoleArguments

in file arguments.php, variable ezcConsoleArguments::$named
    Named list of arguments.

$numSteps : ezcConsoleProgressbar

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

next : ezcConsoleTable

in file table.php, method ezcConsoleTable::next()
    Returns the next cell and selects it or false on the last cell.

next : ezcConsoleTableRow

in file row.php, method ezcConsoleTableRow::next()
    Returns the next cell and selects it or false on the last cell.

next : ezcConsoleArguments

in file arguments.php, method ezcConsoleArguments::next()
    Advances the internal pointer to the next argument and returns it.

o

$options : ezcConsoleProgressMonitor

in file progressmonitor.php, variable ezcConsoleProgressMonitor::$options
    Options

$ordered : ezcConsoleArguments

in file arguments.php, variable ezcConsoleArguments::$ordered
    Ordered list of arguments.

$output : ezcConsoleProgressbar

in file progressbar.php, variable ezcConsoleProgressbar::$output
    The ezcConsoleOutput object to use.

$outputHandler : ezcConsoleStatusbar

in file statusbar.php, variable ezcConsoleStatusbar::$outputHandler
    The ezcConsoleOutput object to use.

$outputHandler : ezcConsoleTable

in file table.php, variable ezcConsoleTable::$outputHandler
    The ezcConsoleOutput object to use.

$outputHandler : ezcConsoleProgressMonitor

in file progressmonitor.php, variable ezcConsoleProgressMonitor::$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

CONVERT_LOWER : ezcConsoleDialogValidator

in file dialog_validator.php, class constant ezcConsoleDialogValidator::CONVERT_LOWER
    Convert result to lower-case.

CONVERT_NONE : ezcConsoleDialogValidator

in file dialog_validator.php, class constant ezcConsoleDialogValidator::CONVERT_NONE
    Perform no conversion on the result.

CONVERT_UPPER : ezcConsoleDialogValidator

in file dialog_validator.php, class constant ezcConsoleDialogValidator::CONVERT_UPPER
    Convert result to upper-case.

offsetExists : ezcConsoleTableRow

in file row.php, method ezcConsoleTableRow::offsetExists()
    Returns if the given offset exists.

offsetExists : ezcConsoleArguments

in file arguments.php, method ezcConsoleArguments::offsetExists()
    Returns if the given offset exists.

offsetExists : ezcConsoleTable

in file table.php, method ezcConsoleTable::offsetExists()
    Returns if the given offset exists.

offsetGet : ezcConsoleTableRow

in file row.php, method ezcConsoleTableRow::offsetGet()
    Returns the element with the given offset.

offsetGet : ezcConsoleArguments

in file arguments.php, method ezcConsoleArguments::offsetGet()
    Returns the element with the given offset.

offsetGet : ezcConsoleTable

in file table.php, method ezcConsoleTable::offsetGet()
    Returns the element with the given offset.

offsetSet : ezcConsoleTableRow

in file row.php, method ezcConsoleTableRow::offsetSet()
    Set the element with the given offset.

offsetSet : ezcConsoleArguments

in file arguments.php, method ezcConsoleArguments::offsetSet()
    Set the element with the given offset.

offsetSet : ezcConsoleTable

in file table.php, method ezcConsoleTable::offsetSet()
    Set the element with the given offset.

offsetUnset : ezcConsoleTable

in file table.php, method ezcConsoleTable::offsetUnset()
    Unset the element with the given offset.

offsetUnset : ezcConsoleArguments

in file arguments.php, method ezcConsoleArguments::offsetUnset()
    Unset the element with the given offset.

offsetUnset : ezcConsoleTableRow

in file row.php, method ezcConsoleTableRow::offsetUnset()
    Unset the element with the given offset.

output : ezcConsoleProgressbar

in file progressbar.php, method ezcConsoleProgressbar::output()
    Draw the progress bar.

outputLine : ezcConsoleOutput

in file output.php, method ezcConsoleOutput::outputLine()
    Print text to the console and automatically append a line break.

outputTable : ezcConsoleTable

in file table.php, method ezcConsoleTable::outputTable()
    Output the table.

outputText : ezcConsoleOutput

in file output.php, method ezcConsoleOutput::outputText()
    Print text to the console.

p

$positionStored : ezcConsoleOutput

in file output.php, variable ezcConsoleOutput::$positionStored
    Whether a position has been stored before, using the storePos() method.

$properties : ezcConsoleQuestionDialogCollectionValidator

in file question_dialog_collection.php, variable ezcConsoleQuestionDialogCollectionValidator::$properties
    Properties.

$properties : ezcConsoleQuestionDialog

in file question_dialog.php, variable ezcConsoleQuestionDialog::$properties
    Properties

$properties : ezcConsoleProgressMonitorOptions

in file progressmonitor.php, variable ezcConsoleProgressMonitorOptions::$properties

$properties : ezcConsoleProgressbarOptions

in file progressbar.php, variable ezcConsoleProgressbarOptions::$properties

$properties : ezcConsoleQuestionDialogRegexValidator

in file question_dialog_regex.php, variable ezcConsoleQuestionDialogRegexValidator::$properties
    Properties

$properties : ezcConsoleQuestionDialogTypeValidator

in file question_dialog_type.php, variable ezcConsoleQuestionDialogTypeValidator::$properties
    Properties.

$properties : ezcConsoleTableOptions

in file table.php, variable ezcConsoleTableOptions::$properties

$properties : ezcConsoleTable

in file table.php, variable ezcConsoleTable::$properties
    Container to hold the properties

$properties : ezcConsoleStatusbar

in file statusbar.php, variable ezcConsoleStatusbar::$properties
    Container to hold the properties

$properties : ezcConsoleStatusbarOptions

in file statusbar.php, variable ezcConsoleStatusbarOptions::$properties

$properties : ezcConsoleTableRow

in file row.php, variable ezcConsoleTableRow::$properties
    Container to hold the properties

$properties : ezcConsoleArgument

in file argument.php, variable ezcConsoleArgument::$properties
    Properties

$properties : ezcConsoleProgressbar

in file progressbar.php, variable ezcConsoleProgressbar::$properties
    Container to hold the properties

$properties : ezcConsoleMenuDialog

in file menu_dialog.php, variable ezcConsoleMenuDialog::$properties
    Properties

$properties : ezcConsoleMenuDialogDefaultValidator

in file menu_dialog_default.php, variable ezcConsoleMenuDialogDefaultValidator::$properties
    Properties

$properties : ezcConsoleInput

in file input.php, variable ezcConsoleInput::$properties
    Collection of arguments.

$properties : ezcConsoleDialogOptions

in file dialog.php, variable ezcConsoleDialogOptions::$properties
    Properties.

$properties : ezcConsoleTableCell

in file cell.php, variable ezcConsoleTableCell::$properties
    Container to hold the properties

$properties : ezcConsoleOption

in file option.php, variable ezcConsoleOption::$properties
    Container to hold the properties

$properties : ezcConsoleOptionRule

in file option_rule.php, variable ezcConsoleOptionRule::$properties
    Properties.

$properties : ezcConsoleOutput

in file output.php, variable ezcConsoleOutput::$properties
    Container to hold the properties

$properties : ezcConsoleOutputFormat

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 : ezcConsoleInput

in file input.php, method ezcConsoleInput::process()
    Process the input parameters.

q

question_dialog.php

procedural page question_dialog.php

question_dialog_collection.php

procedural page question_dialog_collection.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

r

$result : ezcConsoleMenuDialog

in file menu_dialog.php, variable ezcConsoleMenuDialog::$result
    Dialog result

$result : ezcConsoleQuestionDialog

in file question_dialog.php, variable ezcConsoleQuestionDialog::$result
    Dialog result

$rows : ezcConsoleTable

in file table.php, variable ezcConsoleTable::$rows
    Collection of the rows that are contained in the table.

row.php

procedural page row.php

ORDERED : ezcConsoleArgumentAlreadyRegisteredException

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.

readLine : ezcConsoleDialogViewer

in file dialog_viewer.php, method ezcConsoleDialogViewer::readLine()
    Returns a line from STDIN.

registerAlias : ezcConsoleInput

in file input.php, method ezcConsoleInput::registerAlias()
    Registers an alias for an option.

registerOption : ezcConsoleInput

in file input.php, method ezcConsoleInput::registerOption()
    Registers the new option $option.

registerOptionString : ezcConsoleInput

in file input.php, method ezcConsoleInput::registerOptionString()
    Registers options according to a string specification.

removeAllDependencies : ezcConsoleOption

in file option.php, method ezcConsoleOption::removeAllDependencies()
    Remove all dependency rule referring to a parameter.

removeAllExclusions : ezcConsoleOption

in file option.php, method ezcConsoleOption::removeAllExclusions()
    Remove all exclusion rule referring to a option.

removeDependency : ezcConsoleOption

in file option.php, method ezcConsoleOption::removeDependency()
    Remove a dependency rule from a parameter.

removeExclusion : ezcConsoleOption

in file option.php, method ezcConsoleOption::removeExclusion()
    Remove a exclusion rule from a option.

reset : ezcConsoleQuestionDialog

in file question_dialog.php, method ezcConsoleQuestionDialog::reset()
    Reset the dialog.

reset : ezcConsoleMenuDialog

in file menu_dialog.php, method ezcConsoleMenuDialog::reset()
    Reset the dialog.

reset : ezcConsoleStatusbar

in file statusbar.php, method ezcConsoleStatusbar::reset()
    Reset the state of the status-bar object to its initial one.

reset : ezcConsoleDialog

in file dialog.php, method ezcConsoleDialog::reset()
    Resets the dialog to its initial state.

resetDependencies : ezcConsoleOption

in file option.php, method ezcConsoleOption::resetDependencies()
    Reset existing dependency rules.

resetExclusions : ezcConsoleOption

in file option.php, method ezcConsoleOption::resetExclusions()
    Reset existing exclusion rules.

restorePos : ezcConsoleOutput

in file output.php, method ezcConsoleOutput::restorePos()
    Restores a cursor position.

rewind : ezcConsoleTable

in file table.php, method ezcConsoleTable::rewind()
    Selects the very first cell and returns it.

rewind : ezcConsoleTableRow

in file row.php, method ezcConsoleTableRow::rewind()
    Selects the very first cell and returns it.

rewind : ezcConsoleArguments

in file arguments.php, method ezcConsoleArguments::rewind()
    Rewinds the internal pointer to the first argument and returns it.

WRAP_AUTO : ezcConsoleTable

in file table.php, class constant ezcConsoleTable::WRAP_AUTO
    Automatically wrap text to fit into a column.

WRAP_CUT : ezcConsoleTable

in file table.php, class constant ezcConsoleTable::WRAP_CUT
    Text will be cut to fit into a column.

WRAP_NONE : ezcConsoleTable

in file table.php, class constant ezcConsoleTable::WRAP_NONE
    Do not wrap text. Columns will be extended to fit the largest text.

s

$started : ezcConsoleProgressbar

in file progressbar.php, variable ezcConsoleProgressbar::$started
    Indicates if the starting point for the bar has been stored.

$style : ezcConsoleOutput

in file output.php, variable ezcConsoleOutput::$style
    Stores the mapping of styles names to their escape sequence values.

statusbar.php

procedural page statusbar.php

statusbar.php

procedural page statusbar.php

setOptions : ezcConsoleProgressMonitor

in file progressmonitor.php, method ezcConsoleProgressMonitor::setOptions()
    Set new options.

setOptions : ezcConsoleStatusbar

in file statusbar.php, method ezcConsoleStatusbar::setOptions()
    Set new options.

setOptions : ezcConsoleProgressbar

in file progressbar.php, method ezcConsoleProgressbar::setOptions()
    Set new options.

setOptions : ezcConsoleOutput

in file output.php, method ezcConsoleOutput::setOptions()
    Set new options.

setOptions : ezcConsoleTable

in file table.php, method ezcConsoleTable::setOptions()
    Set new options.

start : ezcConsoleProgressbar

in file progressbar.php, method ezcConsoleProgressbar::start()
    Start the progress bar Starts the progress bar and sticks it to the current line.

storePos : ezcConsoleOutput

in file output.php, method ezcConsoleOutput::storePos()
    Stores the current cursor position.

stripEscapeSequences : ezcConsoleProgressbar

in file progressbar.php, method ezcConsoleProgressbar::stripEscapeSequences()
    Strip all escape sequences from a string to measure it's size correctly.

t

table.php

procedural page table.php

table.php

procedural page table.php

toPos : ezcConsoleOutput

in file output.php, method ezcConsoleOutput::toPos()
    Move the cursor to a specific column of the current line.

u

unregisterAlias : ezcConsoleInput

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

unregisterOption : ezcConsoleInput

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

v

$value : ezcConsoleOption

in file option.php, variable ezcConsoleOption::$value
    The value the parameter was assigned to when being submitted.

$valueMap : ezcConsoleProgressbar

in file progressbar.php, variable ezcConsoleProgressbar::$valueMap
    Storage for actual values to be replaced in the format string.

valid : ezcConsoleArguments

in file arguments.php, method ezcConsoleArguments::valid()
    Checks if the current position is valid.

valid : ezcConsoleTableRow

in file row.php, method ezcConsoleTableRow::valid()
    Returns if the current cell is valid.

valid : ezcConsoleTable

in file table.php, method ezcConsoleTable::valid()
    Returns if the current cell is valid.

validate : ezcConsoleQuestionDialogTypeValidator

in file question_dialog_type.php, method ezcConsoleQuestionDialogTypeValidator::validate()
    Returns if the given result is valid.

validate : ezcConsoleQuestionDialogRegexValidator

in file question_dialog_regex.php, method ezcConsoleQuestionDialogRegexValidator::validate()
    Returns if the given result is valid.

validate : ezcConsoleQuestionDialogCollectionValidator

in file question_dialog_collection.php, method ezcConsoleQuestionDialogCollectionValidator::validate()
    Returns if the given result is valid.

validate : ezcConsoleMenuDialogDefaultValidator

in file menu_dialog_default.php, method ezcConsoleMenuDialogDefaultValidator::validate()
    Returns if the given result is valid.

validate : ezcConsoleDialogValidator

in file dialog_validator.php, method ezcConsoleDialogValidator::validate()
    Returns if the given result is valid.

validateOptionName : ezcConsoleOption

in file option.php, method ezcConsoleOption::validateOptionName()
    Returns if a given name if valid for use as a parameter name a parameter.

y

TYPE_BOOL : ezcConsoleQuestionDialogTypeValidator

in file question_dialog_type.php, class constant ezcConsoleQuestionDialogTypeValidator::TYPE_BOOL
    Data type bool.

TYPE_FLOAT : ezcConsoleQuestionDialogTypeValidator

in file question_dialog_type.php, class constant ezcConsoleQuestionDialogTypeValidator::TYPE_FLOAT
    Data type float.

TYPE_INT : ezcConsoleQuestionDialogTypeValidator

in file question_dialog_type.php, class constant ezcConsoleQuestionDialogTypeValidator::TYPE_INT
    Data type int.

TYPE_INT : ezcConsoleInput

in file input.php, class constant ezcConsoleInput::TYPE_INT
    Option takes an integer value.

TYPE_NONE : ezcConsoleInput

in file input.php, class constant ezcConsoleInput::TYPE_NONE
    Option does not carry a value.

TYPE_STRING : ezcConsoleInput

in file input.php, class constant ezcConsoleInput::TYPE_STRING
    Option takes a string value.

TYPE_STRING : ezcConsoleQuestionDialogTypeValidator

in file question_dialog_type.php, class constant ezcConsoleQuestionDialogTypeValidator::TYPE_STRING
    Data type string.

YesNoQuestion : ezcConsoleQuestionDialog

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