1: 2: 3: 4: 5: 6: 7: 8: 9: 10: 11: 12: 13: 14: 15: 16: 17: 18: 19: 20: 21: 22: 23: 24: 25: 26: 27: 28: 29: 30: 31: 32: 33: 34: 35: 36: 37: 38: 39: 40: 41: 42: 43: 44: 45: 46: 47: 48: 49: 50: 51: 52: 53: 54: 55: 56: 57: 58: 59: 60: 61: 62: 63: 64: 65: 66: 67: 68: 69: 70: 71: 72: 73: 74: 75: 76: 77: 78: 79: 80: 81: 82: 83: 84: 85: 86: 87: 88: 89: 90: 91: 92: 93: 94: 95: 96: 97: 98: 99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171: 172: 173: 174: 175: 176: 177: 178: 179: 180: 181: 182: 183: 184: 185: 186: 187: 188: 189: 190: 191: 192: 193: 194: 195: 196: 197: 198: 199: 200: 201: 202: 203: 204: 205: 206: 207: 208: 209: 210: 211: 212: 213: 214: 215: 216: 217: 218: 219: 220: 221: 222: 223: 224: 225: 226: 227: 228: 229: 230: 231: 232: 233: 234: 235: 236: 237:
<?php
/*
* This file is part of the webmozart/console package.
*
* (c) Bernhard Schussek <bschussek@gmail.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Webmozart\Console\UI\Style;
use Webmozart\Assert\Assert;
use Webmozart\Console\Api\Formatter\Style;
/**
* Defines the style of a {@link Grid}.
*
* @since 1.0
*
* @author Bernhard Schussek <bschussek@gmail.com>
*/
class GridStyle
{
/**
* @var GridStyle
*/
private static $borderless;
/**
* @var GridStyle
*/
private static $asciiBorder;
/**
* @var GridStyle
*/
private static $solidBorder;
/**
* @var string
*/
private $paddingChar = ' ';
/**
* @var string
*/
private $cellFormat = '%s';
/**
* @var int
*/
private $cellAlignment = Alignment::LEFT;
/**
* @var BorderStyle
*/
private $borderStyle;
/**
* @var Style
*/
private $cellStyle;
/**
* A borderless style.
*
* @return GridStyle The style.
*/
public static function borderless()
{
if (!self::$borderless) {
self::$borderless = new static();
self::$borderless->borderStyle = BorderStyle::none();
}
return clone self::$borderless;
}
/**
* A style that uses ASCII characters for drawing borders.
*
* @return GridStyle The style.
*/
public static function asciiBorder()
{
if (!self::$asciiBorder) {
self::$asciiBorder = new static();
self::$asciiBorder->cellFormat = ' %s ';
self::$asciiBorder->borderStyle = BorderStyle::ascii();
}
return clone self::$asciiBorder;
}
/**
* A style that uses Unicode characters for drawing solid borders.
*
* @return GridStyle The style.
*/
public static function solidBorder()
{
if (!self::$solidBorder) {
self::$solidBorder = new static();
self::$solidBorder->cellFormat = ' %s ';
self::$solidBorder->borderStyle = BorderStyle::solid();
}
return clone self::$solidBorder;
}
/**
* Returns the character used to pad cells to the desired width.
*
* @return string The padding character.
*/
public function getPaddingChar()
{
return $this->paddingChar;
}
/**
* Sets the character used to pad cells to the desired width.
*
* @param string $char The padding character.
*
* @return static The current instance.
*/
public function setPaddingChar($char)
{
$this->paddingChar = $char;
return $this;
}
/**
* Returns the format string for rendering cells.
*
* @return string The format string. The string contains the substring "%s"
* where the cell content is inserted.
*/
public function getCellFormat()
{
return $this->cellFormat;
}
/**
* Sets the format string for rendering cells.
*
* @param string $format The format string. The string should contain the
* substring "%s" where the cell content is inserted.
*
* @return static The current instance.
*/
public function setCellFormat($format)
{
$this->cellFormat = $format;
return $this;
}
/**
* Returns the cell alignment.
*
* @return int One of the {@link Alignment} constants.
*/
public function getCellAlignment()
{
return $this->cellAlignment;
}
/**
* Sets the cell alignment.
*
* @param int $alignment One of the {@link Alignment} constants.
*
* @return static The current instance.
*/
public function setCellAlignment($alignment)
{
Assert::oneOf($alignment, Alignment::all(), 'The cell alignment must be one of the Alignment constants. Got: %s');
$this->cellAlignment = $alignment;
return $this;
}
/**
* Returns the border style.
*
* @return BorderStyle The border style.
*/
public function getBorderStyle()
{
return $this->borderStyle;
}
/**
* Sets the border style.
*
* @param BorderStyle $borderStyle The border style.
*
* @return static The current instance.
*/
public function setBorderStyle(BorderStyle $borderStyle)
{
$this->borderStyle = $borderStyle;
return $this;
}
/**
* Returns the style of the grid cells.
*
* @return Style The cell style.
*/
public function getCellStyle()
{
return $this->cellStyle;
}
/**
* Sets the style of the grid cells.
*
* @param Style $style The cell style.
*
* @return static The current instance.
*/
public function setCellStyle(Style $style)
{
$this->cellStyle = $style;
return $this;
}
}