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: 
<?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\Component;

use Webmozart\Console\Api\Formatter\Style;
use Webmozart\Console\Api\IO\IO;
use Webmozart\Console\UI\Style\Alignment;
use Webmozart\Console\UI\Style\BorderStyle;
use Webmozart\Console\Util\StringUtil;

/**
 * Contains utility methods to draw borders and bordered cells.
 *
 * @since  1.0
 *
 * @author Bernhard Schussek <bschussek@gmail.com>
 */
class BorderUtil
{
    /**
     * Draws a top border.
     *
     * Crossings are drawn between each pair of columns if more than one column
     * length is passed.
     *
     * @param IO          $io            The I/O.
     * @param BorderStyle $style         The border style.
     * @param int[]       $columnLengths An array of column lengths.
     * @param int         $indentation   The number of spaces to indent.
     */
    public static function drawTopBorder(IO $io, BorderStyle $style, array $columnLengths, $indentation = 0)
    {
        self::drawBorder(
            $io,
            $columnLengths,
            $indentation,
            $style->getLineHTChar(),
            $style->getCornerTLChar(),
            $style->getCrossingTChar(),
            $style->getCornerTRChar(),
            $style->getStyle()
        );
    }

    /**
     * Draws a middle border.
     *
     * Crossings are drawn between each pair of columns if more than one column
     * length is passed.
     *
     * @param IO          $io            The I/O.
     * @param BorderStyle $style         The border style.
     * @param int[]       $columnLengths An array of column lengths.
     * @param int         $indentation   The number of spaces to indent.
     */
    public static function drawMiddleBorder(IO $io, BorderStyle $style, array $columnLengths, $indentation = 0)
    {
        self::drawBorder(
            $io,
            $columnLengths,
            $indentation,
            $style->getLineHCChar(),
            $style->getCrossingLChar(),
            $style->getCrossingCChar(),
            $style->getCrossingRChar(),
            $style->getStyle()
        );
    }

    /**
     * Draws a bottom border.
     *
     * Crossings are drawn between each pair of columns if more than one column
     * length is passed.
     *
     * @param IO          $io            The I/O.
     * @param BorderStyle $style         The border style.
     * @param int[]       $columnLengths An array of column lengths.
     * @param int         $indentation   The number of spaces to indent.
     */
    public static function drawBottomBorder(IO $io, BorderStyle $style, array $columnLengths, $indentation = 0)
    {
        self::drawBorder(
            $io,
            $columnLengths,
            $indentation,
            $style->getLineHBChar(),
            $style->getCornerBLChar(),
            $style->getCrossingBChar(),
            $style->getCornerBRChar(),
            $style->getStyle()
        );
    }

    /**
     * Draws a bordered row of cells.
     *
     * @param IO          $io            The I/O.
     * @param BorderStyle $style         The border style.
     * @param string[]    $row           The row cells.
     * @param int[]       $columnLengths The lengths of the cells.
     * @param int[]       $alignments    The alignments of the cells.
     * @param string      $cellFormat    The cell format.
     * @param Style       $cellStyle     The cell style.
     * @param string      $paddingChar   The character used to pad cells.
     * @param int         $indentation   The number of spaces to indent.
     */
    public static function drawRow(IO $io, BorderStyle $style, array $row, array $columnLengths, array $alignments, $cellFormat, Style $cellStyle = null, $paddingChar, $indentation = 0)
    {
        $totalLines = 0;

        // Split all cells into lines
        foreach ($row as $col => $cell) {
            $row[$col] = explode("\n", $cell);
            $totalLines = max($totalLines, count($row[$col]));
        }

        $nbColumns = count($row);
        $borderVLChar = $io->format($style->getLineVLChar(), $style->getStyle());
        $borderVCChar = $io->format($style->getLineVCChar(), $style->getStyle());
        $borderVRChar = $io->format($style->getLineVRChar(), $style->getStyle());

        for ($i = 0; $i < $totalLines; ++$i) {
            $line = str_repeat(' ', $indentation);
            $line .= $borderVLChar;

            foreach ($row as $col => &$remainingLines) {
                $cellLine = $remainingLines ? array_shift($remainingLines) : '';
                $totalPadLength = $columnLengths[$col] - StringUtil::getLength($cellLine, $io);
                $paddingLeft = '';
                $paddingRight = '';

                if ($totalPadLength > 0) {
                    $alignment = isset($alignments[$col]) ? $alignments[$col] : Alignment::LEFT;

                    switch ($alignment) {
                        case Alignment::LEFT:
                            $paddingRight = str_repeat($paddingChar, $totalPadLength);
                            break;
                        case Alignment::RIGHT:
                            $paddingLeft = str_repeat($paddingChar, $totalPadLength);
                            break;
                        case Alignment::CENTER:
                            $leftPadLength = floor($totalPadLength / 2);
                            $paddingLeft = str_repeat($paddingChar, $leftPadLength);
                            $paddingRight = str_repeat($paddingChar, $totalPadLength - $leftPadLength);
                            break;
                    }
                }

                $line .= $io->format(sprintf($cellFormat, $paddingLeft.$cellLine.$paddingRight), $cellStyle);
                $line .= $col < $nbColumns - 1 ? $borderVCChar : $borderVRChar;
            }

            // Remove trailing space
            $io->write(rtrim($line)."\n");
        }
    }

    private static function drawBorder(IO $io, array $columnLengths, $indentation, $lineChar, $crossingLChar, $crossingCChar, $crossingRChar, Style $style = null)
    {
        $line = str_repeat(' ', $indentation);
        $line .= $crossingLChar;

        for ($i = 0, $l = count($columnLengths); $i < $l; ++$i) {
            $line .= str_repeat($lineChar, $columnLengths[$i]);
            $line .= $i < $l - 1 ? $crossingCChar : $crossingRChar;
        }

        // Remove trailing space
        $line = rtrim($line);

        // Render only non-empty separators
        if ($line) {
            $io->write($io->format($line, $style)."\n");
        }
    }

    private function __construct()
    {
    }
}
Webmozart Console API API documentation generated by ApiGen