Overview

Namespaces

  • Contrib
    • Bundle
      • CoverallsBundle
        • Console
        • Entity
      • CoverallsV1Bundle
        • Api
        • Collector
        • Command
        • Config
        • Entity
          • Git
    • Component
      • File
      • Log
      • System
        • Git
  • Guzzle
    • Batch
      • Exception
    • Cache
    • Common
      • Exception
    • Http
      • Curl
      • Exception
      • Message
      • QueryAggregator
    • Inflection
    • Iterator
    • Log
    • Parser
      • Cookie
      • Message
      • UriTemplate
      • Url
    • Plugin
      • Async
      • Backoff
      • Cache
      • Cookie
        • CookieJar
        • Exception
      • CurlAuth
      • ErrorResponse
        • Exception
      • History
      • Log
      • Md5
      • Mock
      • Oauth
    • Service
      • Builder
      • Command
        • Factory
        • LocationVisitor
          • Request
          • Response
      • Description
      • Exception
      • Resource
    • Stream
  • PHP
  • Psr
    • Log
  • Symfony
    • Component
      • Config
        • Definition
          • Builder
          • Exception
        • Exception
        • Loader
        • Resource
        • Util
      • Console
        • Command
        • Formatter
        • Helper
        • Input
        • Output
        • Tester
      • EventDispatcher
        • Debug
      • Finder
        • Adapter
        • Comparator
        • Exception
        • Expression
        • Iterator
        • Shell
      • Stopwatch
      • Yaml
        • Exception

Classes

  • OutputFormatter
  • OutputFormatterStyle
  • OutputFormatterStyleStack

Interfaces

  • OutputFormatterInterface
  • OutputFormatterStyleInterface
  • Overview
  • Namespace
  • Class
  • Tree
  • Todo

Interface OutputFormatterInterface

Formatter interface for console output.

Direct known implementers

Symfony\Component\Console\Formatter\OutputFormatter
Namespace: Symfony\Component\Console\Formatter
Author: Konstantin Kudryashov <ever.zet@gmail.com>
Api
Located at console/Symfony/Component/Console/Formatter/OutputFormatterInterface.php
Methods summary
public
# setDecorated( Boolean $decorated )

Sets the decorated flag.

Sets the decorated flag.

Parameters

$decorated
Boolean
$decorated Whether to decorate the messages or not

Api

public Boolean
# isDecorated( )

Gets the decorated flag.

Gets the decorated flag.

Returns

Boolean
true if the output will decorate messages, false otherwise

Api

public
# setStyle( string $name, Symfony\Component\Console\Formatter\OutputFormatterStyleInterface $style )

Sets a new style.

Sets a new style.

Parameters

$name
string
$name The style name
$style
Symfony\Component\Console\Formatter\OutputFormatterStyleInterface
$style The style instance

Api

public Boolean
# hasStyle( string $name )

Checks if output formatter has style with specified name.

Checks if output formatter has style with specified name.

Parameters

$name
string
$name

Returns

Boolean

Api

public Symfony\Component\Console\Formatter\OutputFormatterStyleInterface
# getStyle( string $name )

Gets style options from style with specified name.

Gets style options from style with specified name.

Parameters

$name
string
$name

Returns

Symfony\Component\Console\Formatter\OutputFormatterStyleInterface

Api

public string
# format( string $message )

Formats a message according to the given styles.

Formats a message according to the given styles.

Parameters

$message
string
$message The message to style

Returns

string
The styled message

Api

php-coveralls API documentation generated by ApiGen 2.8.0