PHP Class Webmozart\Console\UI\Style\BorderStyle

Use {@link none()}, {@link ascii()} or {@link solid()} to obtain predefined border styles.
Since: 1.0
Author: Bernhard Schussek ([email protected])
Afficher le fichier Open project: webmozart/console Class Usage Examples

Méthodes publiques

Méthode Description
ascii ( ) : BorderStyle A style that uses ASCII characters only.
getCornerBLChar ( ) : string Returns the character used to draw a corner on the bottom left.
getCornerBRChar ( ) : string Returns the character used to draw a corner on the bottom right.
getCornerTLChar ( ) : string Returns the character used to draw a corner on the top left.
getCornerTRChar ( ) : string Returns the character used to draw a corner on the top right.
getCrossingBChar ( ) : string Returns the character used to draw a crossing at the bottom.
getCrossingCChar ( ) : string Returns the character used to draw a crossing at the center.
getCrossingLChar ( ) : string Returns the character used to draw a crossing on the left.
getCrossingRChar ( ) : string Returns the character used to draw a crossing on the right.
getCrossingTChar ( ) : string Returns the character used to draw a crossing at the top.
getLineHBChar ( ) : string Returns the character used to draw a horizontal line at the bottom.
getLineHCChar ( ) : string Returns the character used to draw a horizontal line at the center.
getLineHTChar ( ) : string Returns the character used to draw a horizontal line at the top.
getLineVCChar ( ) : string Returns the character used to draw a vertical line in the middle.
getLineVLChar ( ) : string Returns the character used to draw a vertical line on the left.
getLineVRChar ( ) : string Returns the character used to draw a vertical line on the right.
getStyle ( ) : Style Returns the border style.
none ( ) : BorderStyle A borderless style.
setCornerBLChar ( string $char ) : static Sets the character used to draw a corner on the bottom left.
setCornerBRChar ( string $char ) : static Sets the character used to draw a corner on the bottom right.
setCornerTLChar ( string $char ) : static Sets the character used to draw a corner on the top left.
setCornerTRChar ( string $char ) : static Sets the character used to draw a corner on the top right.
setCrossingBChar ( string $char ) : static Sets the character used to draw a crossing at the bottom.
setCrossingCChar ( string $char ) : static Sets the character used to draw a crossing at the center.
setCrossingLChar ( string $char ) : static Sets the character used to draw a crossing on the left.
setCrossingRChar ( string $char ) : static Sets the character used to draw a crossing on the right.
setCrossingTChar ( string $char ) : static Sets the character used to draw a crossing at the top.
setLineHBChar ( string $char ) : static Sets the character used to draw a horizontal line at the bottom.
setLineHCChar ( string $char ) : static Sets the character used to draw a horizontal line at the center.
setLineHTChar ( string $char ) : static Sets the character used to draw a horizontal line at the top.
setLineVCChar ( string $char ) : static Sets the character used to draw a vertical line in the middle.
setLineVLChar ( string $char ) : static Sets the character used to draw a vertical line on the left.
setLineVRChar ( string $char ) : static Sets the character used to draw a vertical line on the right.
setStyle ( Style $style ) : static Sets the border style.
solid ( ) : BorderStyle A style that uses Unicode characters to draw solid lines.

Method Details

ascii() public static méthode

A style that uses ASCII characters only.
public static ascii ( ) : BorderStyle
Résultat BorderStyle The style.

getCornerBLChar() public méthode

Returns the character used to draw a corner on the bottom left.
public getCornerBLChar ( ) : string
Résultat string The corner character.

getCornerBRChar() public méthode

Returns the character used to draw a corner on the bottom right.
public getCornerBRChar ( ) : string
Résultat string The corner character.

getCornerTLChar() public méthode

Returns the character used to draw a corner on the top left.
public getCornerTLChar ( ) : string
Résultat string The corner character.

getCornerTRChar() public méthode

Returns the character used to draw a corner on the top right.
public getCornerTRChar ( ) : string
Résultat string The corner character.

getCrossingBChar() public méthode

Returns the character used to draw a crossing at the bottom.
public getCrossingBChar ( ) : string
Résultat string The crossing character.

getCrossingCChar() public méthode

Returns the character used to draw a crossing at the center.
public getCrossingCChar ( ) : string
Résultat string The crossing character.

getCrossingLChar() public méthode

Returns the character used to draw a crossing on the left.
public getCrossingLChar ( ) : string
Résultat string The crossing character.

getCrossingRChar() public méthode

Returns the character used to draw a crossing on the right.
public getCrossingRChar ( ) : string
Résultat string The crossing character.

getCrossingTChar() public méthode

Returns the character used to draw a crossing at the top.
public getCrossingTChar ( ) : string
Résultat string The crossing character.

getLineHBChar() public méthode

Returns the character used to draw a horizontal line at the bottom.
public getLineHBChar ( ) : string
Résultat string The line character.

getLineHCChar() public méthode

Returns the character used to draw a horizontal line at the center.
public getLineHCChar ( ) : string
Résultat string The line character.

getLineHTChar() public méthode

Returns the character used to draw a horizontal line at the top.
public getLineHTChar ( ) : string
Résultat string The line character.

getLineVCChar() public méthode

Returns the character used to draw a vertical line in the middle.
public getLineVCChar ( ) : string
Résultat string The line character.

getLineVLChar() public méthode

Returns the character used to draw a vertical line on the left.
public getLineVLChar ( ) : string
Résultat string The line character.

getLineVRChar() public méthode

Returns the character used to draw a vertical line on the right.
public getLineVRChar ( ) : string
Résultat string The line character.

getStyle() public méthode

Returns the border style.
public getStyle ( ) : Style
Résultat Webmozart\Console\Api\Formatter\Style The border style.

none() public static méthode

A borderless style.
public static none ( ) : BorderStyle
Résultat BorderStyle The style.

setCornerBLChar() public méthode

Sets the character used to draw a corner on the bottom left.
public setCornerBLChar ( string $char ) : static
$char string The corner character.
Résultat static The current instance.

setCornerBRChar() public méthode

Sets the character used to draw a corner on the bottom right.
public setCornerBRChar ( string $char ) : static
$char string The corner character.
Résultat static The current instance.

setCornerTLChar() public méthode

Sets the character used to draw a corner on the top left.
public setCornerTLChar ( string $char ) : static
$char string The corner character.
Résultat static The current instance.

setCornerTRChar() public méthode

Sets the character used to draw a corner on the top right.
public setCornerTRChar ( string $char ) : static
$char string The corner character.
Résultat static The current instance.

setCrossingBChar() public méthode

Sets the character used to draw a crossing at the bottom.
public setCrossingBChar ( string $char ) : static
$char string The crossing character.
Résultat static The current instance.

setCrossingCChar() public méthode

Sets the character used to draw a crossing at the center.
public setCrossingCChar ( string $char ) : static
$char string The crossing character.
Résultat static The current instance.

setCrossingLChar() public méthode

Sets the character used to draw a crossing on the left.
public setCrossingLChar ( string $char ) : static
$char string The crossing character.
Résultat static The current instance.

setCrossingRChar() public méthode

Sets the character used to draw a crossing on the right.
public setCrossingRChar ( string $char ) : static
$char string The crossing character.
Résultat static The current instance.

setCrossingTChar() public méthode

Sets the character used to draw a crossing at the top.
public setCrossingTChar ( string $char ) : static
$char string The crossing character.
Résultat static The current instance.

setLineHBChar() public méthode

Sets the character used to draw a horizontal line at the bottom.
public setLineHBChar ( string $char ) : static
$char string The line character.
Résultat static The current instance.

setLineHCChar() public méthode

Sets the character used to draw a horizontal line at the center.
public setLineHCChar ( string $char ) : static
$char string The line character.
Résultat static The current instance.

setLineHTChar() public méthode

Sets the character used to draw a horizontal line at the top.
public setLineHTChar ( string $char ) : static
$char string The line character.
Résultat static The current instance.

setLineVCChar() public méthode

Sets the character used to draw a vertical line in the middle.
public setLineVCChar ( string $char ) : static
$char string The line character.
Résultat static The current instance.

setLineVLChar() public méthode

Sets the character used to draw a vertical line on the left.
public setLineVLChar ( string $char ) : static
$char string The line character.
Résultat static The current instance.

setLineVRChar() public méthode

Sets the character used to draw a vertical line on the right.
public setLineVRChar ( string $char ) : static
$char string The line character.
Résultat static The current instance.

setStyle() public méthode

Sets the border style.
public setStyle ( Style $style ) : static
$style Webmozart\Console\Api\Formatter\Style The border style.
Résultat static The current instance.

solid() public static méthode

A style that uses Unicode characters to draw solid lines.
public static solid ( ) : BorderStyle
Résultat BorderStyle The style.