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

  • OutputStyle
  • SymfonyStyle

Interfaces

  • StyleInterface
  • Overview
  • Namespace
  • Class

Interface StyleInterface

Output style helpers.

Direct known implementers

Symfony\Component\Console\Style\OutputStyle

Indirect known implementers

Symfony\Component\Console\Style\SymfonyStyle, Symfony\Component\Console\Tests\Style\SymfonyStyleWithForcedLineLength
Namespace: Symfony\Component\Console\Style
Author: Kevin Bond kevinbond@gmail.com
Located at Style/StyleInterface.php
Methods summary
public
# title( string $message )

Formats a command title.

Formats a command title.

Parameters

$message
public
# section( string $message )

Formats a section title.

Formats a section title.

Parameters

$message
public
# listing( array $elements )

Formats a list.

Formats a list.

Parameters

$elements
public
# text( string|array $message )

Formats informational text.

Formats informational text.

Parameters

$message
public
# success( string|array $message )

Formats a success result bar.

Formats a success result bar.

Parameters

$message
public
# error( string|array $message )

Formats an error result bar.

Formats an error result bar.

Parameters

$message
public
# warning( string|array $message )

Formats an warning result bar.

Formats an warning result bar.

Parameters

$message
public
# note( string|array $message )

Formats a note admonition.

Formats a note admonition.

Parameters

$message
public
# caution( string|array $message )

Formats a caution admonition.

Formats a caution admonition.

Parameters

$message
public
# table( array $headers, array $rows )

Formats a table.

Formats a table.

Parameters

$headers
$rows
public string
# ask( string $question, string|null $default = null, callable|null $validator = null )

Asks a question.

Asks a question.

Parameters

$question
$default
$validator

Returns

string
public string
# askHidden( string $question, callable|null $validator = null )

Asks a question with the user input hidden.

Asks a question with the user input hidden.

Parameters

$question
$validator

Returns

string
public boolean
# confirm( string $question, boolean $default = true )

Asks for confirmation.

Asks for confirmation.

Parameters

$question
$default

Returns

boolean
public string
# choice( string $question, array $choices, string|integer|null $default = null )

Asks a choice question.

Asks a choice question.

Parameters

$question
$choices
$default

Returns

string
public
# newLine( integer $count = 1 )

Add newline(s).

Add newline(s).

Parameters

$count
The number of newlines
public
# progressStart( integer $max = 0 )

Starts the progress output.

Starts the progress output.

Parameters

$max
Maximum steps (0 if unknown)
public
# progressAdvance( integer $step = 1 )

Advances the progress output X steps.

Advances the progress output X steps.

Parameters

$step
Number of steps to advance
public
# progressFinish( )

Finishes the progress output.

Finishes the progress output.

Peridot API documentation generated by ApiGen