[ 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 ] [ r ] [ s ] [ t ] [ u ] [ v ] [ y ] [ _ ]

_

__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 : ezcConsoleProgressbarOptions

in file progressbar.php, method ezcConsoleProgressbarOptions::__construct()
    Construct a new options object.

__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 : ezcConsoleOptionTooManyValuesException

in file option_too_many_values.php, method ezcConsoleOptionTooManyValuesException::__construct()

__construct : ezcConsoleTableCell

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

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

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

__construct : ezcConsoleTableOptions

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

__construct : ezcTranslationTsBackendOptions

in file ts_backend.php, method ezcTranslationTsBackendOptions::__construct()
    Constructs a new options class.

__construct : ezcConsoleStatusbar

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

__construct : ezcConsoleStatusbarOptions

in file statusbar.php, method ezcConsoleStatusbarOptions::__construct()
    Construct a new options object.

__construct : ezcConsoleProgressMonitorOptions

in file progressmonitor.php, method ezcConsoleProgressMonitorOptions::__construct()
    Construct a new options object.

__construct : ezcConsoleTableRow

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

__construct : ezcConsoleOptionStringNotWellformedException

in file option_string_not_wellformed.php, method ezcConsoleOptionStringNotWellformedException::__construct()

__construct : ezcConsoleOptionTypeViolationException

in file option_type_violation.php, method ezcConsoleOptionTypeViolationException::__construct()

__construct : ezcConsoleOptionAlreadyRegisteredException

in file option_already_registered.php, method ezcConsoleOptionAlreadyRegisteredException::__construct()

__construct : ezcConsoleOptionArgumentsViolationException

in file option_arguments_violation.php, method ezcConsoleOptionArgumentsViolationException::__construct()

__construct : ezcConsoleOptionDependencyViolationException

in file option_dependency_violation.php, method ezcConsoleOptionDependencyViolationException::__construct()

__construct : ezcConsoleOption

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

__construct : ezcConsoleNoPositionStoredException

in file no_position_stored.php, method ezcConsoleNoPositionStoredException::__construct()

__construct : ezcConsoleInput

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

__construct : ezcConsoleInvalidOptionNameException

in file invalid_option_name.php, method ezcConsoleInvalidOptionNameException::__construct()

__construct : ezcConsoleInvalidOutputTargetException

in file invalid_output_target.php, method ezcConsoleInvalidOutputTargetException::__construct()

__construct : ezcConsoleOptionMandatoryViolationException

in file option_mandatory_violation.php, method ezcConsoleOptionMandatoryViolationException::__construct()

__construct : ezcConsoleOptionExclusionViolationException

in file option_exclusion_violation.php, method ezcConsoleOptionExclusionViolationException::__construct()

__construct : ezcConsoleOptionNotExistsException

in file option_not_exists.php, method ezcConsoleOptionNotExistsException::__construct()

__construct : ezcConsoleOptionNoAliasException

in file option_no_alias.php, method ezcConsoleOptionNoAliasException::__construct()

__construct : ezcConsoleOptionRule

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

__construct : ezcConsoleOptionMissingValueException

in file option_missing_value.php, method ezcConsoleOptionMissingValueException::__construct()

__get : ezcConsoleOptionRule

in file option_rule.php, method ezcConsoleOptionRule::__get()
    Property read access overloading.

__get : ezcConsoleOutputFormats

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

__get : ezcConsoleProgressMonitor

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

__isset : ezcConsoleOutputFormats

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

__isset : ezcConsoleOptionRule

in file option_rule.php, method ezcConsoleOptionRule::__isset()
    Property isset access.

__isset : ezcConsoleProgressMonitor

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

__set : ezcConsoleOptionRule

in file option_rule.php, method ezcConsoleOptionRule::__set()
    Property read access overloading.

__set : ezcConsoleOutputFormats

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

__set : ezcConsoleProgressMonitor

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

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()

addEntry : ezcConsoleProgressMonitor

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

addExclusion : ezcConsoleOption

in file option.php, method ezcConsoleOption::addExclusion()

advance : ezcConsoleProgressbar

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

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

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

$counter : ezcConsoleProgressMonitor

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

$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 : 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 : 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.

e

$exclusions : ezcConsoleOption

in file option.php, variable ezcConsoleOption::$exclusions
    Exclusion rules of this parameter.

exception.php

procedural page exception.php

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 {@see ezcConsoleOutputFormat} could not be opened.

ezcConsoleNoPositionStoredException

in file no_position_stored.php, class ezcConsoleNoPositionStoredException
    'Cannot restore position, if no position has been stored before.'.

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
    The alias you tried to unregister is a real option.

ezcConsoleOptionNotExistsException

in file option_not_exists.php, class ezcConsoleOptionNotExistsException
    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.

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.

ezcTranslationTsBackendOptions

in file ts_backend.php, class ezcTranslationTsBackendOptions
    Struct class to store the options of the ezcTranslationTsBackend class.

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.

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.

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

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

getOptions : ezcConsoleStatusbar

in file statusbar.php, method ezcConsoleStatusbar::getOptions()
    Returns the current 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.

getOptions : ezcConsoleInput

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

getOptions : ezcConsoleProgressbar

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

getOptionValues : ezcConsoleInput

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

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 given dependency rule is registered with the parameter.

hasExclusion : ezcConsoleOption

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

hasOption : ezcConsoleInput

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

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.

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.

n

$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

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.

o

$options : ezcConsoleProgressMonitor

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

$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

offsetExists : ezcConsoleTableRow

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

offsetExists : ezcConsoleTable

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

offsetGet : ezcConsoleTable

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

offsetGet : ezcConsoleTableRow

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

offsetSet : ezcConsoleTable

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

offsetSet : ezcConsoleTableRow

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

offsetUnset : ezcConsoleTableRow

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

offsetUnset : ezcConsoleTable

in file table.php, method ezcConsoleTable::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 : ezcConsoleTableCell

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

$properties : ezcConsoleStatusbar

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

$properties : ezcConsoleProgressbar

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

$properties : ezcConsoleOutputFormat

in file output_format.php, variable ezcConsoleOutputFormat::$properties
    Container to hold the properties

$properties : ezcConsoleOutput

in file output.php, variable ezcConsoleOutput::$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
    Property array containing this class' properties.

$properties : ezcConsoleTableRow

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

$properties : ezcConsoleTable

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

r

$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

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 parameter.

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 parameter.

reset : ezcConsoleStatusbar

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

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

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

rewind : ezcConsoleTable

in file table.php, method ezcConsoleTable::rewind()
    Selects the very first cell 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.

ts_backend.php

procedural page ts_backend.php

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

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

valid : ezcConsoleTableRow

in file row.php, method ezcConsoleTableRow::valid()
    Returns if the current cell 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_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.