Overview

Namespaces

  • Evenement
  • None
  • Peridot
    • Console
    • Core
    • Reporter
    • Runner
    • Scope
    • Test
  • Symfony
    • Component
      • Console
        • Command
        • Descriptor
        • Event
        • Exception
        • Formatter
        • Helper
        • Input
        • Logger
        • Output
        • Question
        • Style
        • Tester
        • Tests
          • Command
          • Descriptor
          • Fixtures
          • Formatter
          • Helper
          • Input
          • Logger
          • Output
          • Style
          • Tester

Classes

  • DebugFormatterHelper
  • DescriptorHelper
  • DialogHelper
  • FormatterHelper
  • Helper
  • HelperSet
  • InputAwareHelper
  • ProcessHelper
  • ProgressBar
  • ProgressHelper
  • ProgressIndicator
  • QuestionHelper
  • SymfonyQuestionHelper
  • Table
  • TableCell
  • TableHelper
  • TableSeparator
  • TableStyle

Interfaces

  • HelperInterface
  • Overview
  • Namespace
  • Class

Class ProgressIndicator

Namespace: Symfony\Component\Console\Helper
Author: Kevin Bond kevinbond@gmail.com
Located at Helper/ProgressIndicator.php
Methods summary
public
# __construct( Symfony\Component\Console\Output\OutputInterface $output, string|null $format = null, integer $indicatorChangeInterval = 100, array|null $indicatorValues = null )

Parameters

$output
$format
Indicator format
$indicatorChangeInterval
Change interval in milliseconds
$indicatorValues
Animated indicator characters
public
# setMessage( string|null $message )

Sets the current indicator message.

Sets the current indicator message.

Parameters

$message
public string|null
# getMessage( )

Gets the current indicator message.

Gets the current indicator message.

Returns

string|null
public integer
# getStartTime( )

Gets the progress bar start time.

Gets the progress bar start time.

Returns

integer
The progress bar start time
public string
# getCurrentValue( )

Gets the current animated indicator character.

Gets the current animated indicator character.

Returns

string
public
# start( $message )

Starts the indicator output.

Starts the indicator output.

Parameters

$message
public
# advance( )

Advances the indicator.

Advances the indicator.

public
# finish( $message )

Finish the indicator with message.

Finish the indicator with message.

Parameters

$message
public static string|null
# getFormatDefinition( string $name )

Gets the format for a given name.

Gets the format for a given name.

Parameters

$name
The format name

Returns

string|null
A format string
public static
# setPlaceholderFormatterDefinition( string $name, callable $callable )

Sets a placeholder formatter for a given name.

Sets a placeholder formatter for a given name.

This method also allow you to override an existing placeholder.

Parameters

$name
The placeholder name (including the delimiter char like %)
$callable
A PHP callable
public static callable|null
# getPlaceholderFormatterDefinition( string $name )

Gets the placeholder formatter for a given name.

Gets the placeholder formatter for a given name.

Parameters

$name
The placeholder name (including the delimiter char like %)

Returns

callable|null
A PHP callable
Peridot API documentation generated by ApiGen