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: 238: 239: 240: 241: 242: 243: 244: 245: 246: 247: 248: 249: 250: 251: 252: 253: 254: 255: 256: 257: 258: 259: 260: 261: 262: 263: 264: 265: 266: 267: 268: 269: 270: 271: 272: 273: 274: 275: 276: 277: 278: 279: 280: 281: 282: 283: 284: 285: 286: 287: 288: 289: 290: 291: 292: 293: 294: 295: 296: 297: 298: 299: 300: 301: 302: 303: 304: 305: 306: 307: 308: 309: 310: 311: 312: 313: 314: 315: 316: 317: 318: 319: 320: 321: 322: 323: 324: 325: 326: 327: 328: 329: 330: 331: 332: 333: 334: 335: 336: 337: 338: 339: 340: 341: 342: 343: 344: 345: 346: 347: 348: 349: 350: 351: 352: 353: 354: 355: 356: 357: 358: 359: 360: 361: 362: 363: 364: 365: 366: 367: 368: 369: 370: 371: 372: 373: 374: 375: 376: 377: 378: 379: 380: 381: 382: 383: 384: 385: 386: 387: 388: 389: 390: 391: 392: 393: 394: 395: 396: 397: 398: 399: 400: 401: 402: 403: 404: 405: 406: 407: 408: 409: 410: 411: 412: 413: 414: 415: 416: 417: 418: 419: 420: 421: 422: 423: 424: 425: 426: 427: 428: 429: 430: 431: 432: 433: 434: 435: 436: 437: 438: 439: 440: 441: 442: 443: 444: 445: 446: 447: 448: 449: 450: 451: 452: 453: 454: 455: 456: 457: 458: 459: 460: 461: 462: 463: 464: 465: 466: 467: 468: 469: 470: 471: 472: 473: 474: 475: 476: 477: 478: 479: 480: 481: 482: 483: 484: 485: 486: 487: 488: 489: 490: 491: 492: 493: 494: 495: 496: 497: 498: 499: 500: 501: 502: 503: 504: 505: 506: 507: 508: 509: 510: 511: 512: 513: 514: 515: 516: 517: 518: 519: 520: 521: 522: 523: 524: 525: 526: 527: 528: 529: 530: 531: 532: 533: 534: 535: 536: 537: 538: 539: 540: 541: 542: 543: 544: 545: 546: 547: 548: 549: 550: 551: 552: 553: 554: 555: 556: 557: 558: 559: 560: 561: 562: 563: 564: 565: 566: 567: 568: 569: 570: 571: 572: 573: 574: 575: 576: 577: 578: 579: 580: 581: 582: 583: 584: 585: 586: 587: 588: 589: 590: 591: 592: 593: 594: 595: 596: 597: 598: 599: 600: 601: 602: 603: 604: 605: 606: 607: 608: 609: 610: <?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\Api\Formatter;
use Webmozart\Assert\Assert;
/**
* A formatter style.
*
* @since 1.0
*
* @author Bernhard Schussek <bschussek@gmail.com>
*/
class Style
{
/**
* Color: black.
*/
const BLACK = 'black';
/**
* Color: red.
*/
const RED = 'red';
/**
* Color: green.
*/
const GREEN = 'green';
/**
* Color: yellow.
*/
const YELLOW = 'yellow';
/**
* Color: blue.
*/
const BLUE = 'blue';
/**
* Color: magenta.
*/
const MAGENTA = 'magenta';
/**
* Color: cyan.
*/
const CYAN = 'cyan';
/**
* Color: white.
*/
const WHITE = 'white';
/**
* @var string[]
*/
private static $colors = array(
self::BLACK,
self::RED,
self::GREEN,
self::YELLOW,
self::BLUE,
self::MAGENTA,
self::CYAN,
self::WHITE,
);
/**
* @var string
*/
private $tag;
/**
* @var string
*/
private $fgColor;
/**
* @var string
*/
private $bgColor;
/**
* @var bool
*/
private $bold = false;
/**
* @var bool
*/
private $underlined = false;
/**
* @var bool
*/
private $blinking = false;
/**
* @var bool
*/
private $inverse = false;
/**
* @var bool
*/
private $hidden = false;
/**
* Creates a style with the given tag name.
*
* @param string $tag The tag name.
*
* @return static The created style.
*
* @see noTag()
*/
public static function tag($tag)
{
return new static($tag);
}
/**
* Creates a style without a tag name.
*
* @return static The created style.
*
* @see tag()
*/
public static function noTag()
{
return new static();
}
/**
* Creates a style.
*
* @param string $tag The tag name.
*/
public function __construct($tag = null)
{
$this->tag = $tag;
}
/**
* Sets the foreground color.
*
* @param string $color One of the color constants.
*
* @return static The current instance.
*/
public function fg($color)
{
Assert::nullOrOneOf($color, self::$colors, 'The color must be null or one of the Style::* color constants. Got: "%s"');
$this->fgColor = $color;
return $this;
}
/**
* Resets the foreground color to the system's default.
*
* @return static The current instance.
*/
public function fgDefault()
{
$this->fgColor = null;
return $this;
}
/**
* Sets the foreground color to black.
*
* @return static The current instance.
*/
public function fgBlack()
{
$this->fgColor = self::BLACK;
return $this;
}
/**
* Sets the foreground color to red.
*
* @return static The current instance.
*/
public function fgRed()
{
$this->fgColor = self::RED;
return $this;
}
/**
* Sets the foreground color to green.
*
* @return static The current instance.
*/
public function fgGreen()
{
$this->fgColor = self::GREEN;
return $this;
}
/**
* Sets the foreground color to yellow.
*
* @return static The current instance.
*/
public function fgYellow()
{
$this->fgColor = self::YELLOW;
return $this;
}
/**
* Sets the foreground color to blue.
*
* @return static The current instance.
*/
public function fgBlue()
{
$this->fgColor = self::BLUE;
return $this;
}
/**
* Sets the foreground color to magenta.
*
* @return static The current instance.
*/
public function fgMagenta()
{
$this->fgColor = self::MAGENTA;
return $this;
}
/**
* Sets the foreground color to cyan.
*
* @return static The current instance.
*/
public function fgCyan()
{
$this->fgColor = self::CYAN;
return $this;
}
/**
* Sets the foreground color to white.
*
* @return static The current instance.
*/
public function fgWhite()
{
$this->fgColor = self::WHITE;
return $this;
}
/**
* Sets the background color.
*
* @param string $color One of the color constants.
*
* @return static The current instance.
*/
public function bg($color)
{
Assert::nullOrOneOf($color, self::$colors, 'The color must be null or one of the Style::* color constants. Got: "%s"');
$this->bgColor = $color;
return $this;
}
/**
* Resets the background color to the system's default.
*
* @return static The current instance.
*/
public function bgDefault()
{
$this->bgColor = null;
return $this;
}
/**
* Sets the background color to black.
*
* @return static The current instance.
*/
public function bgBlack()
{
$this->bgColor = self::BLACK;
return $this;
}
/**
* Sets the background color to red.
*
* @return static The current instance.
*/
public function bgRed()
{
$this->bgColor = self::RED;
return $this;
}
/**
* Sets the background color to green.
*
* @return static The current instance.
*/
public function bgGreen()
{
$this->bgColor = self::GREEN;
return $this;
}
/**
* Sets the background color to yellow.
*
* @return static The current instance.
*/
public function bgYellow()
{
$this->bgColor = self::YELLOW;
return $this;
}
/**
* Sets the background color to blue.
*
* @return static The current instance.
*/
public function bgBlue()
{
$this->bgColor = self::BLUE;
return $this;
}
/**
* Sets the background color to magenta.
*
* @return static The current instance.
*/
public function bgMagenta()
{
$this->bgColor = self::MAGENTA;
return $this;
}
/**
* Sets the background color to cyan.
*
* @return static The current instance.
*/
public function bgCyan()
{
$this->bgColor = self::CYAN;
return $this;
}
/**
* Sets the background color to white.
*
* @return static The current instance.
*/
public function bgWhite()
{
$this->bgColor = self::WHITE;
return $this;
}
/**
* Sets the font weight to bold.
*
* @return static The current instance.
*/
public function bold()
{
$this->bold = true;
return $this;
}
/**
* Sets the font weight to normal.
*
* @return static The current instance.
*/
public function notBold()
{
$this->bold = false;
return $this;
}
/**
* Enables underlining.
*
* @return static The current instance.
*/
public function underlined()
{
$this->underlined = true;
return $this;
}
/**
* Disables underlining.
*
* @return static The current instance.
*/
public function notUnderlined()
{
$this->underlined = false;
return $this;
}
/**
* Enables blinking.
*
* @return static The current instance.
*/
public function blinking()
{
$this->blinking = true;
return $this;
}
/**
* Disables blinking.
*
* @return static The current instance.
*/
public function notBlinking()
{
$this->blinking = false;
return $this;
}
/**
* Enables inverse colors.
*
* @return static The current instance.
*/
public function inverse()
{
$this->inverse = true;
return $this;
}
/**
* Disables inverse colors.
*
* @return static The current instance.
*/
public function notInverse()
{
$this->inverse = false;
return $this;
}
/**
* Hides the text.
*
* @return static The current instance.
*/
public function hidden()
{
$this->hidden = true;
return $this;
}
/**
* Does not hide the text.
*
* @return static The current instance.
*/
public function notHidden()
{
$this->hidden = false;
return $this;
}
/**
* Returns the style's tag name.
*
* @return string The tag name or `null` if the style has no tag.
*/
public function getTag()
{
return $this->tag;
}
/**
* Returns the foreground color.
*
* @return string One of the color constants or `null` if the system's
* default should be used.
*/
public function getForegroundColor()
{
return $this->fgColor;
}
/**
* Returns the background color.
*
* @return string One of the color constants or `null` if the system's
* default should be used.
*/
public function getBackgroundColor()
{
return $this->bgColor;
}
/**
* Returns whether the text is bold.
*
* @return bool Returns `true` if text is formatted bold and `false`
* otherwise.
*/
public function isBold()
{
return $this->bold;
}
/**
* Returns whether the text is underlined.
*
* @return bool Returns `true` if text is formatted underlined and `false`
* otherwise.
*/
public function isUnderlined()
{
return $this->underlined;
}
/**
* Returns whether the text is blinking.
*
* @return bool Returns `true` if text is formatted blinking and `false`
* otherwise.
*/
public function isBlinking()
{
return $this->blinking;
}
/**
* Returns whether the text is reversed.
*
* @return bool Returns `true` if text is formatted reversed and `false`
* otherwise.
*/
public function isInverse()
{
return $this->inverse;
}
/**
* Returns whether the text is concealed.
*
* @return bool Returns `true` if text is formatted concealed and `false`
* otherwise.
*/
public function isHidden()
{
return $this->hidden;
}
}