class TableStyle in Zircon Profile 8

Defines the styles for a Table.

@author Fabien Potencier <[e-mail]> @author Саша Стаменковић <[e-mail]>

Hierarchy

• class \Symfony\Component\Console\Helper\TableStyle

2 files declare their use of TableStyle

TableStyleTest.php in vendor/symfony/console/Tests/Helper/TableStyleTest.php

TableTest.php in vendor/symfony/console/Tests/Helper/TableTest.php

File

vendor/symfony/console/Helper/TableStyle.php, line 20

Namespace

Symfony\Component\Console\Helper

class TableStyle {
  private $paddingChar = ' ';
  private $horizontalBorderChar = '-';
  private $verticalBorderChar = '|';
  private $crossingChar = '+';
  private $cellHeaderFormat = '<info>%s</info>';
  private $cellRowFormat = '%s';
  private $cellRowContentFormat = ' %s ';
  private $borderFormat = '%s';
  private $padType = STR_PAD_RIGHT;

  /**
   * Sets padding character, used for cell padding.
   *
   * @param string $paddingChar
   *
   * @return TableStyle
   */
  public function setPaddingChar($paddingChar) {
    if (!$paddingChar) {
      throw new \LogicException('The padding char must not be empty');
    }
    $this->paddingChar = $paddingChar;
    return $this;
  }

  /**
   * Gets padding character, used for cell padding.
   *
   * @return string
   */
  public function getPaddingChar() {
    return $this->paddingChar;
  }

  /**
   * Sets horizontal border character.
   *
   * @param string $horizontalBorderChar
   *
   * @return TableStyle
   */
  public function setHorizontalBorderChar($horizontalBorderChar) {
    $this->horizontalBorderChar = $horizontalBorderChar;
    return $this;
  }

  /**
   * Gets horizontal border character.
   *
   * @return string
   */
  public function getHorizontalBorderChar() {
    return $this->horizontalBorderChar;
  }

  /**
   * Sets vertical border character.
   *
   * @param string $verticalBorderChar
   *
   * @return TableStyle
   */
  public function setVerticalBorderChar($verticalBorderChar) {
    $this->verticalBorderChar = $verticalBorderChar;
    return $this;
  }

  /**
   * Gets vertical border character.
   *
   * @return string
   */
  public function getVerticalBorderChar() {
    return $this->verticalBorderChar;
  }

  /**
   * Sets crossing character.
   *
   * @param string $crossingChar
   *
   * @return TableStyle
   */
  public function setCrossingChar($crossingChar) {
    $this->crossingChar = $crossingChar;
    return $this;
  }

  /**
   * Gets crossing character.
   *
   * @return string $crossingChar
   */
  public function getCrossingChar() {
    return $this->crossingChar;
  }

  /**
   * Sets header cell format.
   *
   * @param string $cellHeaderFormat
   *
   * @return TableStyle
   */
  public function setCellHeaderFormat($cellHeaderFormat) {
    $this->cellHeaderFormat = $cellHeaderFormat;
    return $this;
  }

  /**
   * Gets header cell format.
   *
   * @return string
   */
  public function getCellHeaderFormat() {
    return $this->cellHeaderFormat;
  }

  /**
   * Sets row cell format.
   *
   * @param string $cellRowFormat
   *
   * @return TableStyle
   */
  public function setCellRowFormat($cellRowFormat) {
    $this->cellRowFormat = $cellRowFormat;
    return $this;
  }

  /**
   * Gets row cell format.
   *
   * @return string
   */
  public function getCellRowFormat() {
    return $this->cellRowFormat;
  }

  /**
   * Sets row cell content format.
   *
   * @param string $cellRowContentFormat
   *
   * @return TableStyle
   */
  public function setCellRowContentFormat($cellRowContentFormat) {
    $this->cellRowContentFormat = $cellRowContentFormat;
    return $this;
  }

  /**
   * Gets row cell content format.
   *
   * @return string
   */
  public function getCellRowContentFormat() {
    return $this->cellRowContentFormat;
  }

  /**
   * Sets table border format.
   *
   * @param string $borderFormat
   *
   * @return TableStyle
   */
  public function setBorderFormat($borderFormat) {
    $this->borderFormat = $borderFormat;
    return $this;
  }

  /**
   * Gets table border format.
   *
   * @return string
   */
  public function getBorderFormat() {
    return $this->borderFormat;
  }

  /**
   * Sets cell padding type.
   *
   * @param int $padType STR_PAD_*
   *
   * @return TableStyle
   */
  public function setPadType($padType) {
    if (!in_array($padType, array(
      STR_PAD_LEFT,
      STR_PAD_RIGHT,
      STR_PAD_BOTH,
    ), true)) {
      throw new \InvalidArgumentException('Invalid padding type. Expected one of (STR_PAD_LEFT, STR_PAD_RIGHT, STR_PAD_BOTH).');
    }
    $this->padType = $padType;
    return $this;
  }

  /**
   * Gets cell padding type.
   *
   * @return int
   */
  public function getPadType() {
    return $this->padType;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
TableStyle::$borderFormat	private	property
TableStyle::$cellHeaderFormat	private	property
TableStyle::$cellRowContentFormat	private	property
TableStyle::$cellRowFormat	private	property
TableStyle::$crossingChar	private	property
TableStyle::$horizontalBorderChar	private	property
TableStyle::$paddingChar	private	property
TableStyle::$padType	private	property
TableStyle::$verticalBorderChar	private	property
TableStyle::getBorderFormat	public	function	Gets table border format.
TableStyle::getCellHeaderFormat	public	function	Gets header cell format.
TableStyle::getCellRowContentFormat	public	function	Gets row cell content format.
TableStyle::getCellRowFormat	public	function	Gets row cell format.
TableStyle::getCrossingChar	public	function	Gets crossing character.
TableStyle::getHorizontalBorderChar	public	function	Gets horizontal border character.
TableStyle::getPaddingChar	public	function	Gets padding character, used for cell padding.
TableStyle::getPadType	public	function	Gets cell padding type.
TableStyle::getVerticalBorderChar	public	function	Gets vertical border character.
TableStyle::setBorderFormat	public	function	Sets table border format.
TableStyle::setCellHeaderFormat	public	function	Sets header cell format.
TableStyle::setCellRowContentFormat	public	function	Sets row cell content format.
TableStyle::setCellRowFormat	public	function	Sets row cell format.
TableStyle::setCrossingChar	public	function	Sets crossing character.
TableStyle::setHorizontalBorderChar	public	function	Sets horizontal border character.
TableStyle::setPaddingChar	public	function	Sets padding character, used for cell padding.
TableStyle::setPadType	public	function	Sets cell padding type.
TableStyle::setVerticalBorderChar	public	function	Sets vertical border character.