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

/**
 * Formats strings.
 *
 * @since  1.0
 *
 * @author Bernhard Schussek <bschussek@gmail.com>
 */
interface Formatter
{
    /**
     * Formats the given string.
     *
     * @param string $string The string to format.
     * @param Style  $style  The style to use.
     *
     * @return string The formatted string.
     */
    public function format($string, Style $style = null);

    /**
     * Removes the format tags from the given string.
     *
     * @param string $string The string to remove the format tags from.
     *
     * @return string The string without format tags.
     */
    public function removeFormat($string);
}
Webmozart Console API API documentation generated by ApiGen