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 TableHelper

Provides helpers to display table output.

Symfony\Component\Console\Helper\Helper implements Symfony\Component\Console\Helper\HelperInterface
Extended by Symfony\Component\Console\Helper\TableHelper
Namespace: Symfony\Component\Console\Helper
Deprecated:

since version 2.5, to be removed in 3.0 Use Symfony\Component\Console\Helper\Table instead.


Author: Саша Стаменковић umpirsky@gmail.com
Author: Fabien Potencier fabien@symfony.com
Located at Helper/TableHelper.php
Methods summary
public
# __construct( $triggerDeprecationError = true )
public Symfony\Component\Console\Helper\TableHelper
# setLayout( integer $layout )

Sets table layout type.

Sets table layout type.

Parameters

$layout
self::LAYOUT_*

Returns

Symfony\Component\Console\Helper\TableHelper

Throws

Symfony\Component\Console\Exception\InvalidArgumentException
when the table layout is not known
public
# setHeaders( array $headers )
public
# setRows( array $rows )
public
# addRows( array $rows )
public
# addRow( array $row )
public
# setRow( $column, array $row )
public Symfony\Component\Console\Helper\TableHelper
# setPaddingChar( string $paddingChar )

Sets padding character, used for cell padding.

Sets padding character, used for cell padding.

Parameters

$paddingChar

Returns

Symfony\Component\Console\Helper\TableHelper
public Symfony\Component\Console\Helper\TableHelper
# setHorizontalBorderChar( string $horizontalBorderChar )

Sets horizontal border character.

Sets horizontal border character.

Parameters

$horizontalBorderChar

Returns

Symfony\Component\Console\Helper\TableHelper
public Symfony\Component\Console\Helper\TableHelper
# setVerticalBorderChar( string $verticalBorderChar )

Sets vertical border character.

Sets vertical border character.

Parameters

$verticalBorderChar

Returns

Symfony\Component\Console\Helper\TableHelper
public Symfony\Component\Console\Helper\TableHelper
# setCrossingChar( string $crossingChar )

Sets crossing character.

Sets crossing character.

Parameters

$crossingChar

Returns

Symfony\Component\Console\Helper\TableHelper
public Symfony\Component\Console\Helper\TableHelper
# setCellHeaderFormat( string $cellHeaderFormat )

Sets header cell format.

Sets header cell format.

Parameters

$cellHeaderFormat

Returns

Symfony\Component\Console\Helper\TableHelper
public Symfony\Component\Console\Helper\TableHelper
# setCellRowFormat( string $cellRowFormat )

Sets row cell format.

Sets row cell format.

Parameters

$cellRowFormat

Returns

Symfony\Component\Console\Helper\TableHelper
public Symfony\Component\Console\Helper\TableHelper
# setCellRowContentFormat( string $cellRowContentFormat )

Sets row cell content format.

Sets row cell content format.

Parameters

$cellRowContentFormat

Returns

Symfony\Component\Console\Helper\TableHelper
public Symfony\Component\Console\Helper\TableHelper
# setBorderFormat( string $borderFormat )

Sets table border format.

Sets table border format.

Parameters

$borderFormat

Returns

Symfony\Component\Console\Helper\TableHelper
public Symfony\Component\Console\Helper\TableHelper
# setPadType( integer $padType )

Sets cell padding type.

Sets cell padding type.

Parameters

$padType
STR_PAD_*

Returns

Symfony\Component\Console\Helper\TableHelper
public
# render( Symfony\Component\Console\Output\OutputInterface $output )

Renders table to output.

Renders table to output.

Example: +---------------+-----------------------+------------------+ | ISBN | Title | Author | +---------------+-----------------------+------------------+ | 99921-58-10-7 | Divine Comedy | Dante Alighieri | | 9971-5-0210-0 | A Tale of Two Cities | Charles Dickens | | 960-425-059-0 | The Lord of the Rings | J. R. R. Tolkien | +---------------+-----------------------+------------------+

Parameters

$output
public string
# getName( )

Returns the canonical name of this helper.

Returns the canonical name of this helper.

Returns

string
The canonical name
Methods inherited from Symfony\Component\Console\Helper\Helper
formatMemory(), formatTime(), getHelperSet(), setHelperSet(), strlen(), strlenWithoutDecoration()
Constants summary
integer LAYOUT_DEFAULT
# 0
integer LAYOUT_BORDERLESS
# 1
integer LAYOUT_COMPACT
# 2
Properties inherited from Symfony\Component\Console\Helper\Helper
$helperSet
Peridot API documentation generated by ApiGen