Overview

Namespaces

  • Webmozart
    • Console
      • Adapter
      • Api
        • Application
        • Args
          • Format
        • Command
        • Config
        • Event
        • Formatter
        • IO
        • Resolver
      • Args
      • Config
      • Formatter
      • Handler
        • Help
      • IO
        • InputStream
        • OutputStream
      • Process
      • Resolver
      • UI
        • Alignment
        • Component
        • Help
        • Layout
        • Style
      • Util

Classes

  • Alignment
  • BorderStyle
  • GridStyle
  • TableStyle
  • Overview
  • Namespace
  • Class

Class BorderStyle

Defines the style of a border.

Use Webmozart\Console\UI\Style\BorderStyle::none(), Webmozart\Console\UI\Style\BorderStyle::ascii() or Webmozart\Console\UI\Style\BorderStyle::solid() to obtain predefined border styles.

Namespace: Webmozart\Console\UI\Style
Author: Bernhard Schussek bschussek@gmail.com
Since: 1.0
Located at UI/Style/BorderStyle.php
Methods summary
public static Webmozart\Console\UI\Style\BorderStyle
# none( )

A borderless style.

A borderless style.

Returns

Webmozart\Console\UI\Style\BorderStyle
The style.
public static Webmozart\Console\UI\Style\BorderStyle
# ascii( )

A style that uses ASCII characters only.

A style that uses ASCII characters only.

Returns

Webmozart\Console\UI\Style\BorderStyle
The style.
public static Webmozart\Console\UI\Style\BorderStyle
# solid( )

A style that uses Unicode characters to draw solid lines.

A style that uses Unicode characters to draw solid lines.

Returns

Webmozart\Console\UI\Style\BorderStyle
The style.
public string
# getLineHTChar( )

Returns the character used to draw a horizontal line at the top.

Returns the character used to draw a horizontal line at the top.

Returns

string
The line character.
public static
# setLineHTChar( string $char )

Sets the character used to draw a horizontal line at the top.

Sets the character used to draw a horizontal line at the top.

Parameters

$char
The line character.

Returns

static
The current instance.
public string
# getLineHCChar( )

Returns the character used to draw a horizontal line at the center.

Returns the character used to draw a horizontal line at the center.

Returns

string
The line character.
public static
# setLineHCChar( string $char )

Sets the character used to draw a horizontal line at the center.

Sets the character used to draw a horizontal line at the center.

Parameters

$char
The line character.

Returns

static
The current instance.
public string
# getLineHBChar( )

Returns the character used to draw a horizontal line at the bottom.

Returns the character used to draw a horizontal line at the bottom.

Returns

string
The line character.
public static
# setLineHBChar( string $char )

Sets the character used to draw a horizontal line at the bottom.

Sets the character used to draw a horizontal line at the bottom.

Parameters

$char
The line character.

Returns

static
The current instance.
public string
# getLineVLChar( )

Returns the character used to draw a vertical line on the left.

Returns the character used to draw a vertical line on the left.

Returns

string
The line character.
public static
# setLineVLChar( string $char )

Sets the character used to draw a vertical line on the left.

Sets the character used to draw a vertical line on the left.

Parameters

$char
The line character.

Returns

static
The current instance.
public string
# getLineVCChar( )

Returns the character used to draw a vertical line in the middle.

Returns the character used to draw a vertical line in the middle.

Returns

string
The line character.
public static
# setLineVCChar( string $char )

Sets the character used to draw a vertical line in the middle.

Sets the character used to draw a vertical line in the middle.

Parameters

$char
The line character.

Returns

static
The current instance.
public string
# getLineVRChar( )

Returns the character used to draw a vertical line on the right.

Returns the character used to draw a vertical line on the right.

Returns

string
The line character.
public static
# setLineVRChar( string $char )

Sets the character used to draw a vertical line on the right.

Sets the character used to draw a vertical line on the right.

Parameters

$char
The line character.

Returns

static
The current instance.
public string
# getCornerTLChar( )

Returns the character used to draw a corner on the top left.

Returns the character used to draw a corner on the top left.

Returns

string
The corner character.
public static
# setCornerTLChar( string $char )

Sets the character used to draw a corner on the top left.

Sets the character used to draw a corner on the top left.

Parameters

$char
The corner character.

Returns

static
The current instance.
public string
# getCornerTRChar( )

Returns the character used to draw a corner on the top right.

Returns the character used to draw a corner on the top right.

Returns

string
The corner character.
public static
# setCornerTRChar( string $char )

Sets the character used to draw a corner on the top right.

Sets the character used to draw a corner on the top right.

Parameters

$char
The corner character.

Returns

static
The current instance.
public string
# getCornerBLChar( )

Returns the character used to draw a corner on the bottom left.

Returns the character used to draw a corner on the bottom left.

Returns

string
The corner character.
public static
# setCornerBLChar( string $char )

Sets the character used to draw a corner on the bottom left.

Sets the character used to draw a corner on the bottom left.

Parameters

$char
The corner character.

Returns

static
The current instance.
public string
# getCornerBRChar( )

Returns the character used to draw a corner on the bottom right.

Returns the character used to draw a corner on the bottom right.

Returns

string
The corner character.
public static
# setCornerBRChar( string $char )

Sets the character used to draw a corner on the bottom right.

Sets the character used to draw a corner on the bottom right.

Parameters

$char
The corner character.

Returns

static
The current instance.
public string
# getCrossingCChar( )

Returns the character used to draw a crossing at the center.

Returns the character used to draw a crossing at the center.

Returns

string
The crossing character.
public static
# setCrossingCChar( string $char )

Sets the character used to draw a crossing at the center.

Sets the character used to draw a crossing at the center.

Parameters

$char
The crossing character.

Returns

static
The current instance.
public string
# getCrossingLChar( )

Returns the character used to draw a crossing on the left.

Returns the character used to draw a crossing on the left.

Returns

string
The crossing character.
public static
# setCrossingLChar( string $char )

Sets the character used to draw a crossing on the left.

Sets the character used to draw a crossing on the left.

Parameters

$char
The crossing character.

Returns

static
The current instance.
public string
# getCrossingRChar( )

Returns the character used to draw a crossing on the right.

Returns the character used to draw a crossing on the right.

Returns

string
The crossing character.
public static
# setCrossingRChar( string $char )

Sets the character used to draw a crossing on the right.

Sets the character used to draw a crossing on the right.

Parameters

$char
The crossing character.

Returns

static
The current instance.
public string
# getCrossingTChar( )

Returns the character used to draw a crossing at the top.

Returns the character used to draw a crossing at the top.

Returns

string
The crossing character.
public static
# setCrossingTChar( string $char )

Sets the character used to draw a crossing at the top.

Sets the character used to draw a crossing at the top.

Parameters

$char
The crossing character.

Returns

static
The current instance.
public string
# getCrossingBChar( )

Returns the character used to draw a crossing at the bottom.

Returns the character used to draw a crossing at the bottom.

Returns

string
The crossing character.
public static
# setCrossingBChar( string $char )

Sets the character used to draw a crossing at the bottom.

Sets the character used to draw a crossing at the bottom.

Parameters

$char
The crossing character.

Returns

static
The current instance.
public Webmozart\Console\Api\Formatter\Style
# getStyle( )

Returns the border style.

Returns the border style.

Returns

Webmozart\Console\Api\Formatter\Style
The border style.
public static
# setStyle( Webmozart\Console\Api\Formatter\Style $style )

Sets the border style.

Sets the border style.

Parameters

$style
The border style.

Returns

static
The current instance.
Webmozart Console API API documentation generated by ApiGen