[ 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 ] [ w ] [ y ] [ _ ]

_

__construct : ezcConsoleOptionTypeViolationException

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

__construct : ezcConsoleOutput

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

__construct : ezcConsoleOptionTooManyValuesException

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

__construct : ezcConsoleOptionStringNotWellformedException

in file option_string_not_wellformed.php, method ezcConsoleOptionStringNotWellformedException::__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 : ezcConsoleTable

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

__construct : ezcConsoleTableOptions

in file table_options.php, method ezcConsoleTableOptions::__construct()
    Create a new ezcConsoleProgressbarOptions struct.

__construct : ezcConsoleOutputOptions

in file output_options.php, method ezcConsoleOutputOptions::__construct()
    Create a new ezcConsoleOutputOptions struct.

__construct : ezcConsoleProgressbar

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

__construct : ezcConsoleProgressbarOptions

in file progressbar_options.php, method ezcConsoleProgressbarOptions::__construct()
    Create a new ezcConsoleProgressbarOptions struct.

__construct : ezcConsoleOutputFormats

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

__construct : ezcConsoleOutputFormat

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

__construct : ezcConsoleTableCell

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

__construct : ezcConsoleOptionNotExistsException

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

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

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

__construct : ezcConsoleOptionMissingValueException

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

__construct : ezcConsoleOption

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

__construct : ezcConsoleInput

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

__construct : ezcConsoleNoPositionStoredException

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

__construct : ezcConsoleOptionArgumentsViolationException

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

__construct : ezcConsoleOptionDependencyViolationException

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

__construct : ezcConsoleOptionMandatoryViolationException

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

__construct : ezcConsoleOptionExclusionViolationException

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

__get : ezcConsoleOutputFormats

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

__get : ezcConsoleTableCell

in file cell.php, method ezcConsoleTableCell::__get()
    Property read access.

__get : ezcConsoleProgressbarOptions

in file progressbar_options.php, method ezcConsoleProgressbarOptions::__get()
    Property read access.

__get : ezcConsoleOutputOptions

in file output_options.php, method ezcConsoleOutputOptions::__get()
    Property read access.

__get : ezcConsoleStatusbar

in file statusbar.php, method ezcConsoleStatusbar::__get()
    Property read access.

__get : ezcConsoleTable

in file table.php, method ezcConsoleTable::__get()
    Property read access.

__get : ezcConsoleOption

in file option.php, method ezcConsoleOption::__get()
    Property read access.

__get : ezcConsoleProgressbar

in file progressbar.php, method ezcConsoleProgressbar::__get()
    Property read access.

__get : ezcConsoleOptionRule

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

__get : ezcConsoleTableOptions

in file table_options.php, method ezcConsoleTableOptions::__get()
    Property read access.

__get : ezcConsoleTableRow

in file row.php, method ezcConsoleTableRow::__get()
    Property read access.

__get : ezcConsoleOutputFormat

in file output_format.php, method ezcConsoleOutputFormat::__get()
    Overloaded __get() method to gain read-only access to some attributes.

__get : ezcConsoleOutput

in file output.php, method ezcConsoleOutput::__get()
    Property read access.

__isset : ezcConsoleProgressbar

in file progressbar.php, method ezcConsoleProgressbar::__isset()
    Property isset access.

__isset : ezcConsoleTableRow

in file row.php, method ezcConsoleTableRow::__isset()
    Property isset access.

__isset : ezcConsoleProgressbarOptions

in file progressbar_options.php, method ezcConsoleProgressbarOptions::__isset()
    Property isset access.

__isset : ezcConsoleOutput

in file output.php, method ezcConsoleOutput::__isset()
    Property isset access.

__isset : ezcConsoleOptionRule

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

__isset : ezcConsoleTableOptions

in file table_options.php, method ezcConsoleTableOptions::__isset()
    Property isset access.

__isset : ezcConsoleOption

in file option.php, method ezcConsoleOption::__isset()
    Property isset access.

__isset : ezcConsoleTableCell

in file cell.php, method ezcConsoleTableCell::__isset()
    Property isset access.

__isset : ezcConsoleTable

in file table.php, method ezcConsoleTable::__isset()
    Property isset access.

__isset : ezcConsoleStatusbar

in file statusbar.php, method ezcConsoleStatusbar::__isset()
    Property isset access.

__isset : ezcConsoleOutputOptions

in file output_options.php, method ezcConsoleOutputOptions::__isset()
    Property isset access.

__isset : ezcConsoleOutputFormat

in file output_format.php, method ezcConsoleOutputFormat::__isset()
    Property isset access.

__isset : ezcConsoleOutputFormats

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

__set : ezcConsoleTableOptions

in file table_options.php, method ezcConsoleTableOptions::__set()
    Property write access.

__set : ezcConsoleTable

in file table.php, method ezcConsoleTable::__set()
    Property write access.

__set : ezcConsoleStatusbar

in file statusbar.php, method ezcConsoleStatusbar::__set()
    Property write access.

__set : ezcConsoleOutputFormat

in file output_format.php, method ezcConsoleOutputFormat::__set()
    Overloaded __set() method to gain read-only access to properties.

__set : ezcConsoleOptionRule

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

__set : ezcConsoleOption

in file option.php, method ezcConsoleOption::__set()
    Property write access.

__set : ezcConsoleTableCell

in file cell.php, method ezcConsoleTableCell::__set()
    Property write access.

__set : ezcConsoleOutput

in file output.php, method ezcConsoleOutput::__set()
    Property write access.

__set : ezcConsoleOutputFormats

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

__set : ezcConsoleProgressbarOptions

in file progressbar_options.php, method ezcConsoleProgressbarOptions::__set()
    Property write access.

__set : ezcConsoleProgressbar

in file progressbar.php, method ezcConsoleProgressbar::__set()
    Property write access.

__set : ezcConsoleOutputOptions

in file output_options.php, method ezcConsoleOutputOptions::__set()
    Property write access.

__set : ezcConsoleTableRow

in file row.php, method ezcConsoleTableRow::__set()
    Property write access.

a

$align : ezcConsoleTableCell

in file cell.php, variable ezcConsoleTableCell::$align
    Alignment of the text inside the cell.

$align : ezcConsoleTableRow

in file row.php, variable ezcConsoleTableRow::$align
    Alignment applied to cells marked with ezcConsoleTable::ALIGN_DEFAULT.

$arguments : ezcConsoleOption

in file option.php, variable ezcConsoleOption::$arguments
    Whether arguments to the program are allowed, when this parameter is submitted.

$autobreak : ezcConsoleOutputOptions

in file output_options.php, variable ezcConsoleOutputOptions::$autobreak
    Determins, whether text is automatically wrapped after a specific amount of characters in a line. If set to 0 (default), lines will not be wrapped automatically.

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

addExclusion : ezcConsoleOption

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

advance : ezcConsoleProgressbar

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

b

$bgcolor : ezcConsoleOutput

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

$borderFormat : ezcConsoleTableRow

in file row.php, variable ezcConsoleTableRow::$borderFormat
    Set the format applied to the borders of this row.

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.

$colPadding : ezcConsoleTableOptions

in file table_options.php, variable ezcConsoleTableOptions::$colPadding
    Padding characters for side padding between data and lines.

$colWidth : ezcConsoleTableOptions

in file table_options.php, variable ezcConsoleTableOptions::$colWidth
    Column width, either a fixed int value (number of chars) or 'auto'.

$colWrap : ezcConsoleTableOptions

in file table_options.php, variable ezcConsoleTableOptions::$colWrap
    Wrap style of text contained in strings.

$content : ezcConsoleTableCell

in file cell.php, variable ezcConsoleTableCell::$content
    Text displayed in the cell.

$corner : ezcConsoleTableOptions

in file table_options.php, variable ezcConsoleTableOptions::$corner
    Character to use for drawing line corners.

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

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

count : ezcConsoleTable

in file table.php, method ezcConsoleTable::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 it's dependencies.

current : ezcConsoleTableRow

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

current : ezcConsoleTable

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

d

$default : ezcConsoleOption

in file option.php, variable ezcConsoleOption::$default
    Default value if the parameter is submitted without value.

$defaultAlign : ezcConsoleTableOptions

in file table_options.php, variable ezcConsoleTableOptions::$defaultAlign
    Standard column alignment, applied to cells that have to explicit alignment assigned.

$defaultBorderFormat : ezcConsoleTableOptions

in file table_options.php, variable ezcConsoleTableOptions::$defaultBorderFormat
    Standard border format, applied to rows that have 'default' as the border format.

$defaultFormat : ezcConsoleTableOptions

in file table_options.php, variable ezcConsoleTableOptions::$defaultFormat
    Standard column content format, applied to cells that have 'default' as the content format.

$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
    Class for handling input submitted to console based programs (meaning options and arguments) .

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
    Struct like class to 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_options.php, class ezcConsoleOutputOptions
    Struct class to store the options of the ezcConsoleOutput class.

ezcConsoleProgressbar

in file progressbar.php, class ezcConsoleProgressbar
    Creating and maintaining progressbars to be printed to the console.

ezcConsoleProgressbarOptions

in file progressbar_options.php, class ezcConsoleProgressbarOptions
    Struct class to store the options of the ezcConsoleOutput class.

ezcConsoleStatusbar

in file statusbar.php, class ezcConsoleStatusbar
    Creating and maintaining statusbars to be printed to the console.

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

f

$format : ezcConsoleTableRow

in file row.php, variable ezcConsoleTableRow::$format
    Format applied to cell contents of cells marked with format "default" in this row.

$format : ezcConsoleTableCell

in file cell.php, variable ezcConsoleTableCell::$format
    Format applied to the displayed text.

$formats : ezcConsoleOutput

in file output.php, variable ezcConsoleOutput::$formats
    Formats

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

getOption : ezcConsoleInput

in file input.php, method ezcConsoleInput::getOption()
    Returns the definition object for a specific option.

getOptions : ezcConsoleInput

in file input.php, method ezcConsoleInput::getOptions()
    Returns an array of all registered 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 a 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 if an option with the given name exists.

i

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

$lineHorizontal : ezcConsoleTableOptions

in file table_options.php, variable ezcConsoleTableOptions::$lineHorizontal
    Character to use for drawing hozizontal lines.

$lineVertical : ezcConsoleTableOptions

in file table_options.php, variable ezcConsoleTableOptions::$lineVertical
    Character to use for drawing vertical lines.

$longhelp : ezcConsoleOption

in file option.php, variable ezcConsoleOption::$longhelp
    Long help text. Ususally displayed when showing parameter detailed help.

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

$mandatory : ezcConsoleOption

in file option.php, variable ezcConsoleOption::$mandatory
    Wether a parameter is mandatory to be set.

$measures : ezcConsoleProgressbar

in file progressbar.php, variable ezcConsoleProgressbar::$measures
    One tima calculated measures.

$multiple : ezcConsoleOption

in file option.php, variable ezcConsoleOption::$multiple
    Is the submition of multiple instances of this parameters allowed?

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

in file output.php, variable ezcConsoleOutput::$options
    Options

$options : ezcConsoleTable

in file table.php, variable ezcConsoleTable::$options
    Options for the table.

$options : ezcConsoleStatusbar

in file statusbar.php, variable ezcConsoleStatusbar::$options
    Options

$options : ezcConsoleProgressbar

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

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

option_rule.php

procedural page option_rule.php

output_format.php

procedural page output_format.php

output_formats.php

procedural page output_formats.php

output_options.php

procedural page output_options.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 : ezcConsoleTableRow

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

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

in file progressbar_options.php, variable ezcConsoleProgressbarOptions::$properties
    Property array defining all this class' properties

$properties : ezcConsoleOption

in file option.php, variable ezcConsoleOption::$properties
    Properties, which provide only read access.

$properties : ezcConsoleOutputFormat

in file output_format.php, variable ezcConsoleOutputFormat::$properties
    Array that defines this class' properties.

$properties : ezcConsoleOptionRule

in file option_rule.php, variable ezcConsoleOptionRule::$properties
    Property array containing this class' properties.

progressbar.php

procedural page progressbar.php

progressbar_options.php

procedural page progressbar_options.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()
    Register an alias to a option.

registerOption : ezcConsoleInput

in file input.php, method ezcConsoleInput::registerOption()
    Register a new option.

registerOptionString : ezcConsoleInput

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

removeAllDependencies : ezcConsoleOption

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

removeAllExclusions : ezcConsoleOption

in file option.php, method ezcConsoleOption::removeAllExclusions()
    Remove all exclusion rule refering 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 statusbar 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

$settings : ezcConsoleProgressbar

in file progressbar.php, variable ezcConsoleProgressbar::$settings
    Settings for the progress bar.

$settings : ezcConsoleTable

in file table.php, variable ezcConsoleTable::$settings
    Settings for the table.

$shorthelp : ezcConsoleOption

in file option.php, variable ezcConsoleOption::$shorthelp
    Short help text. Ususally displayed when showing parameter help overview.

$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

setOptions : ezcConsoleStatusbar

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

setOptions : ezcConsoleTable

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

setOptions : ezcConsoleProgressbar

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

setOptions : ezcConsoleOutput

in file output.php, method ezcConsoleOutput::setOptions()
    Set options for this object.

start : ezcConsoleProgressbar

in file progressbar.php, method ezcConsoleProgressbar::start()
    Start the progress bar Starts the progess 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

$type : ezcConsoleOption

in file option.php, variable ezcConsoleOption::$type
    Value type of this parameter, default is ezcConsoleInput::TYPE_NONE.

table_options.php

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

$useFormats : ezcConsoleOutputOptions

in file output_options.php, variable ezcConsoleOutputOptions::$useFormats
    Wether to use formatings or not.

unregisterAlias : ezcConsoleInput

in file input.php, method ezcConsoleInput::unregisterAlias()
    Remove a alias to be no more supported.

unregisterOption : ezcConsoleInput

in file input.php, method ezcConsoleInput::unregisterOption()
    Remove a option to be no more supported.

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.

$verbosityLevel : ezcConsoleOutputOptions

in file output_options.php, variable ezcConsoleOutputOptions::$verbosityLevel
    Determines the level of verbosity.

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

w

$widthType : ezcConsoleTableOptions

in file table_options.php, variable ezcConsoleTableOptions::$widthType
    Type of the given table width (fixed or maximal value).

y

TYPE_INT : ezcConsoleInput

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

TYPE_NONE : ezcConsoleInput

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

TYPE_STRING : ezcConsoleInput

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