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

  • Webmozart\Console\Adapter\ApplicationAdapter
  • Webmozart\Console\Adapter\ArgsFormatInputDefinition
  • Webmozart\Console\Adapter\ArgsInput
  • Webmozart\Console\Adapter\CommandAdapter
  • Webmozart\Console\Adapter\FormatterAdapter
  • Webmozart\Console\Adapter\IOOutput
  • Webmozart\Console\Adapter\StyleConverter
  • Webmozart\Console\Api\Args\Args
  • Webmozart\Console\Api\Args\Format\AbstractOption
  • Webmozart\Console\Api\Args\Format\ArgsFormat
  • Webmozart\Console\Api\Args\Format\ArgsFormatBuilder
  • Webmozart\Console\Api\Args\Format\Argument
  • Webmozart\Console\Api\Args\Format\CommandName
  • Webmozart\Console\Api\Args\Format\CommandOption
  • Webmozart\Console\Api\Args\Format\Option
  • Webmozart\Console\Api\Command\Command
  • Webmozart\Console\Api\Command\CommandCollection
  • Webmozart\Console\Api\Config\ApplicationConfig
  • Webmozart\Console\Api\Config\CommandConfig
  • Webmozart\Console\Api\Config\Config
  • Webmozart\Console\Api\Config\OptionCommandConfig
  • Webmozart\Console\Api\Config\SubCommandConfig
  • Webmozart\Console\Api\Event\ConfigEvent
  • Webmozart\Console\Api\Event\ConsoleEvents
  • Webmozart\Console\Api\Event\PreHandleEvent
  • Webmozart\Console\Api\Event\PreResolveEvent
  • Webmozart\Console\Api\Formatter\Style
  • Webmozart\Console\Api\Formatter\StyleSet
  • Webmozart\Console\Api\IO\Input
  • Webmozart\Console\Api\IO\IO
  • Webmozart\Console\Api\IO\Output
  • Webmozart\Console\Api\Resolver\ResolvedCommand
  • Webmozart\Console\Args\ArgvArgs
  • Webmozart\Console\Args\DefaultArgsParser
  • Webmozart\Console\Args\StringArgs
  • Webmozart\Console\Args\TokenParser
  • Webmozart\Console\Config\DefaultApplicationConfig
  • Webmozart\Console\ConsoleApplication
  • Webmozart\Console\Formatter\AnsiFormatter
  • Webmozart\Console\Formatter\DefaultStyleSet
  • Webmozart\Console\Formatter\NullFormatter
  • Webmozart\Console\Formatter\PlainFormatter
  • Webmozart\Console\Handler\CallbackHandler
  • Webmozart\Console\Handler\DelegatingHandler
  • Webmozart\Console\Handler\Help\HelpAsciiDocHandler
  • Webmozart\Console\Handler\Help\HelpHandler
  • Webmozart\Console\Handler\Help\HelpJsonHandler
  • Webmozart\Console\Handler\Help\HelpManHandler
  • Webmozart\Console\Handler\Help\HelpTextHandler
  • Webmozart\Console\Handler\Help\HelpXmlHandler
  • Webmozart\Console\Handler\NullHandler
  • Webmozart\Console\IO\BufferedIO
  • Webmozart\Console\IO\ConsoleIO
  • Webmozart\Console\IO\InputStream\NullInputStream
  • Webmozart\Console\IO\InputStream\StandardInputStream
  • Webmozart\Console\IO\InputStream\StreamInputStream
  • Webmozart\Console\IO\InputStream\StringInputStream
  • Webmozart\Console\IO\OutputStream\BufferedOutputStream
  • Webmozart\Console\IO\OutputStream\ErrorOutputStream
  • Webmozart\Console\IO\OutputStream\NullOutputStream
  • Webmozart\Console\IO\OutputStream\StandardOutputStream
  • Webmozart\Console\IO\OutputStream\StreamOutputStream
  • Webmozart\Console\Process\ProcessLauncher
  • Webmozart\Console\Resolver\DefaultResolver
  • Webmozart\Console\Resolver\ResolveResult
  • Webmozart\Console\UI\Alignment\LabelAlignment
  • Webmozart\Console\UI\Component\BorderUtil
  • Webmozart\Console\UI\Component\CellWrapper
  • Webmozart\Console\UI\Component\EmptyLine
  • Webmozart\Console\UI\Component\ExceptionTrace
  • Webmozart\Console\UI\Component\Grid
  • Webmozart\Console\UI\Component\LabeledParagraph
  • Webmozart\Console\UI\Component\NameVersion
  • Webmozart\Console\UI\Component\Paragraph
  • Webmozart\Console\UI\Component\Table
  • Webmozart\Console\UI\Help\AbstractHelp
  • Webmozart\Console\UI\Help\ApplicationHelp
  • Webmozart\Console\UI\Help\CommandHelp
  • Webmozart\Console\UI\Layout\BlockLayout
  • Webmozart\Console\UI\Rectangle
  • Webmozart\Console\UI\Style\Alignment
  • Webmozart\Console\UI\Style\BorderStyle
  • Webmozart\Console\UI\Style\GridStyle
  • Webmozart\Console\UI\Style\TableStyle
  • Webmozart\Console\Util\ProcessTitle
  • Webmozart\Console\Util\SimilarCommandName
  • Webmozart\Console\Util\StringUtil

Interfaces

  • Webmozart\Console\Api\Application\Application
  • Webmozart\Console\Api\Args\ArgsParser
  • Webmozart\Console\Api\Args\RawArgs
  • Webmozart\Console\Api\Formatter\Formatter
  • Webmozart\Console\Api\IO\InputStream
  • Webmozart\Console\Api\IO\OutputStream
  • Webmozart\Console\Api\Resolver\CommandResolver
  • Webmozart\Console\UI\Component

Exceptions

  • Webmozart\Console\Api\Args\CannotAddArgumentException
  • Webmozart\Console\Api\Args\CannotAddOptionException
  • Webmozart\Console\Api\Args\CannotParseArgsException
  • Webmozart\Console\Api\Args\Format\InvalidValueException
  • Webmozart\Console\Api\Args\NoSuchArgumentException
  • Webmozart\Console\Api\Args\NoSuchOptionException
  • Webmozart\Console\Api\Command\CannotAddCommandException
  • Webmozart\Console\Api\Command\NoSuchCommandException
  • Webmozart\Console\Api\IO\IOException
  • Webmozart\Console\Api\Resolver\CannotResolveCommandException
  • Overview
  • Namespace
  • Class
  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: 
<?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\Console\Api\Formatter\Style;

/**
 * Defines the style of a border.
 *
 * Use {@link none()}, {@link ascii()} or {@link solid()} to obtain predefined
 * border styles.
 *
 * @since  1.0
 *
 * @author Bernhard Schussek <bschussek@gmail.com>
 */
class BorderStyle
{
    /**
     * @var BorderStyle
     */
    private static $none;

    /**
     * @var BorderStyle
     */
    private static $ascii;

    /**
     * @var BorderStyle
     */
    private static $solid;

    /**
     * @var string
     */
    private $lineHTChar = '-';

    /**
     * @var string
     */
    private $lineHCChar = '-';

    /**
     * @var string
     */
    private $lineHBChar = '-';

    /**
     * @var string
     */
    private $lineVLChar = '|';

    /**
     * @var string
     */
    private $lineVCChar = '|';

    /**
     * @var string
     */
    private $lineVRChar = '|';

    /**
     * @var string
     */
    private $cornerTLChar = '+';

    /**
     * @var string
     */
    private $cornerTRChar = '+';

    /**
     * @var string
     */
    private $cornerBLChar = '+';

    /**
     * @var string
     */
    private $cornerBRChar = '+';

    /**
     * @var string
     */
    private $crossingCChar = '+';

    /**
     * @var string
     */
    private $crossingLChar = '+';

    /**
     * @var string
     */
    private $crossingRChar = '+';

    /**
     * @var string
     */
    private $crossingTChar = '+';

    /**
     * @var string
     */
    private $crossingBChar = '+';

    /**
     * @var Style
     */
    private $style;

    /**
     * A borderless style.
     *
     * @return BorderStyle The style.
     */
    public static function none()
    {
        if (!self::$none) {
            self::$none = new static();
            self::$none->lineVLChar = '';
            self::$none->lineVCChar = ' ';
            self::$none->lineVRChar = '';
            self::$none->lineHTChar = '';
            self::$none->lineHCChar = '';
            self::$none->lineHBChar = '';
            self::$none->cornerTLChar = '';
            self::$none->cornerTRChar = '';
            self::$none->cornerBLChar = '';
            self::$none->cornerBRChar = '';
            self::$none->crossingCChar = '';
            self::$none->crossingLChar = '';
            self::$none->crossingRChar = '';
            self::$none->crossingTChar = '';
            self::$none->crossingBChar = '';
        }

        return clone self::$none;
    }

    /**
     * A style that uses ASCII characters only.
     *
     * @return BorderStyle The style.
     */
    public static function ascii()
    {
        if (!self::$ascii) {
            self::$ascii = new static();
            self::$ascii->lineVLChar = '|';
            self::$ascii->lineVCChar = '|';
            self::$ascii->lineVRChar = '|';
            self::$ascii->lineHTChar = '-';
            self::$ascii->lineHCChar = '-';
            self::$ascii->lineHBChar = '-';
            self::$ascii->cornerTLChar = '+';
            self::$ascii->cornerTRChar = '+';
            self::$ascii->cornerBLChar = '+';
            self::$ascii->cornerBRChar = '+';
            self::$ascii->crossingCChar = '+';
            self::$ascii->crossingLChar = '+';
            self::$ascii->crossingRChar = '+';
            self::$ascii->crossingTChar = '+';
            self::$ascii->crossingBChar = '+';
        }

        return clone self::$ascii;
    }

    /**
     * A style that uses Unicode characters to draw solid lines.
     *
     * @return BorderStyle The style.
     */
    public static function solid()
    {
        if (!self::$solid) {
            self::$solid = new static();
            self::$solid->lineVLChar = '│';
            self::$solid->lineVCChar = '│';
            self::$solid->lineVRChar = '│';
            self::$solid->lineHTChar = '─';
            self::$solid->lineHCChar = '─';
            self::$solid->lineHBChar = '─';
            self::$solid->cornerTLChar = '┌';
            self::$solid->cornerTRChar = '┐';
            self::$solid->cornerBLChar = '└';
            self::$solid->cornerBRChar = '┘';
            self::$solid->crossingCChar = '┼';
            self::$solid->crossingLChar = '├';
            self::$solid->crossingRChar = '┤';
            self::$solid->crossingTChar = '┬';
            self::$solid->crossingBChar = '┴';
        }

        return clone self::$solid;
    }

    /**
     * Returns the character used to draw a horizontal line at the top.
     *
     * @return string The line character.
     */
    public function getLineHTChar()
    {
        return $this->lineHTChar;
    }

    /**
     * Sets the character used to draw a horizontal line at the top.
     *
     * @param string $char The line character.
     *
     * @return static The current instance.
     */
    public function setLineHTChar($char)
    {
        $this->lineHTChar = $char;

        return $this;
    }

    /**
     * Returns the character used to draw a horizontal line at the center.
     *
     * @return string The line character.
     */
    public function getLineHCChar()
    {
        return $this->lineHCChar;
    }

    /**
     * Sets the character used to draw a horizontal line at the center.
     *
     * @param string $char The line character.
     *
     * @return static The current instance.
     */
    public function setLineHCChar($char)
    {
        $this->lineHCChar = $char;

        return $this;
    }

    /**
     * Returns the character used to draw a horizontal line at the bottom.
     *
     * @return string The line character.
     */
    public function getLineHBChar()
    {
        return $this->lineHBChar;
    }

    /**
     * Sets the character used to draw a horizontal line at the bottom.
     *
     * @param string $char The line character.
     *
     * @return static The current instance.
     */
    public function setLineHBChar($char)
    {
        $this->lineHBChar = $char;

        return $this;
    }

    /**
     * Returns the character used to draw a vertical line on the left.
     *
     * @return string The line character.
     */
    public function getLineVLChar()
    {
        return $this->lineVLChar;
    }

    /**
     * Sets the character used to draw a vertical line on the left.
     *
     * @param string $char The line character.
     *
     * @return static The current instance.
     */
    public function setLineVLChar($char)
    {
        $this->lineVLChar = $char;

        return $this;
    }

    /**
     * Returns the character used to draw a vertical line in the middle.
     *
     * @return string The line character.
     */
    public function getLineVCChar()
    {
        return $this->lineVCChar;
    }

    /**
     * Sets the character used to draw a vertical line in the middle.
     *
     * @param string $char The line character.
     *
     * @return static The current instance.
     */
    public function setLineVCChar($char)
    {
        $this->lineVCChar = $char;

        return $this;
    }

    /**
     * Returns the character used to draw a vertical line on the right.
     *
     * @return string The line character.
     */
    public function getLineVRChar()
    {
        return $this->lineVRChar;
    }

    /**
     * Sets the character used to draw a vertical line on the right.
     *
     * @param string $char The line character.
     *
     * @return static The current instance.
     */
    public function setLineVRChar($char)
    {
        $this->lineVRChar = $char;

        return $this;
    }

    /**
     * Returns the character used to draw a corner on the top left.
     *
     * @return string The corner character.
     */
    public function getCornerTLChar()
    {
        return $this->cornerTLChar;
    }

    /**
     * Sets the character used to draw a corner on the top left.
     *
     * @param string $char The corner character.
     *
     * @return static The current instance.
     */
    public function setCornerTLChar($char)
    {
        $this->cornerTLChar = $char;

        return $this;
    }

    /**
     * Returns the character used to draw a corner on the top right.
     *
     * @return string The corner character.
     */
    public function getCornerTRChar()
    {
        return $this->cornerTRChar;
    }

    /**
     * Sets the character used to draw a corner on the top right.
     *
     * @param string $char The corner character.
     *
     * @return static The current instance.
     */
    public function setCornerTRChar($char)
    {
        $this->cornerTRChar = $char;

        return $this;
    }

    /**
     * Returns the character used to draw a corner on the bottom left.
     *
     * @return string The corner character.
     */
    public function getCornerBLChar()
    {
        return $this->cornerBLChar;
    }

    /**
     * Sets the character used to draw a corner on the bottom left.
     *
     * @param string $char The corner character.
     *
     * @return static The current instance.
     */
    public function setCornerBLChar($char)
    {
        $this->cornerBLChar = $char;

        return $this;
    }

    /**
     * Returns the character used to draw a corner on the bottom right.
     *
     * @return string The corner character.
     */
    public function getCornerBRChar()
    {
        return $this->cornerBRChar;
    }

    /**
     * Sets the character used to draw a corner on the bottom right.
     *
     * @param string $char The corner character.
     *
     * @return static The current instance.
     */
    public function setCornerBRChar($char)
    {
        $this->cornerBRChar = $char;

        return $this;
    }

    /**
     * Returns the character used to draw a crossing at the center.
     *
     * @return string The crossing character.
     */
    public function getCrossingCChar()
    {
        return $this->crossingCChar;
    }

    /**
     * Sets the character used to draw a crossing at the center.
     *
     * @param string $char The crossing character.
     *
     * @return static The current instance.
     */
    public function setCrossingCChar($char)
    {
        $this->crossingCChar = $char;

        return $this;
    }

    /**
     * Returns the character used to draw a crossing on the left.
     *
     * @return string The crossing character.
     */
    public function getCrossingLChar()
    {
        return $this->crossingLChar;
    }

    /**
     * Sets the character used to draw a crossing on the left.
     *
     * @param string $char The crossing character.
     *
     * @return static The current instance.
     */
    public function setCrossingLChar($char)
    {
        $this->crossingLChar = $char;

        return $this;
    }

    /**
     * Returns the character used to draw a crossing on the right.
     *
     * @return string The crossing character.
     */
    public function getCrossingRChar()
    {
        return $this->crossingRChar;
    }

    /**
     * Sets the character used to draw a crossing on the right.
     *
     * @param string $char The crossing character.
     *
     * @return static The current instance.
     */
    public function setCrossingRChar($char)
    {
        $this->crossingRChar = $char;

        return $this;
    }

    /**
     * Returns the character used to draw a crossing at the top.
     *
     * @return string The crossing character.
     */
    public function getCrossingTChar()
    {
        return $this->crossingTChar;
    }

    /**
     * Sets the character used to draw a crossing at the top.
     *
     * @param string $char The crossing character.
     *
     * @return static The current instance.
     */
    public function setCrossingTChar($char)
    {
        $this->crossingTChar = $char;

        return $this;
    }

    /**
     * Returns the character used to draw a crossing at the bottom.
     *
     * @return string The crossing character.
     */
    public function getCrossingBChar()
    {
        return $this->crossingBChar;
    }

    /**
     * Sets the character used to draw a crossing at the bottom.
     *
     * @param string $char The crossing character.
     *
     * @return static The current instance.
     */
    public function setCrossingBChar($char)
    {
        $this->crossingBChar = $char;

        return $this;
    }

    /**
     * Returns the border style.
     *
     * @return Style The border style.
     */
    public function getStyle()
    {
        return $this->style;
    }

    /**
     * Sets the border style.
     *
     * @param Style $style The border style.
     *
     * @return static The current instance.
     */
    public function setStyle(Style $style)
    {
        $this->style = $style;

        return $this;
    }
}
Webmozart Console API API documentation generated by ApiGen