symfony API

sfAnsiColorFormatter Class

You are currently browsing
the website for symfony 1

Visit the Symfony2 website


« Back to API menu

1.1 API OpenSearch

Packages

You are currently browsing the symfony API for the 1.1 version. Switch to:
This version of symfony is not maintained anymore.
If some of your projects still use this version, consider upgrading as soon as possible.

sfAnsiColorFormatter provides methods to colorize text to be displayed on a console.

Inheritence

sfAnsiColorFormatter  <  sfFormatter

Method Summary

  • string excerpt($text, $size)
    Truncates a line.
  • string format($text, $parameters, $stream)
    Formats a text according to the given style or parameters.
  • formatSection($section, $text, $size, $style)
    Formats a message within a section.
  • setStyle($name, $options)
    Sets a new style.
  • Boolean supportsColors($stream)
    Returns true if the stream supports colorization.

Methods inherited from sfFormatter

excerpt , format , formatSection , setMaxLineSize , __construct

Method Details

  • (string) excerpt ($text, $size) Browse code

    $text The text
    $size The maximum size of the returned string (65 by default)

    Truncates a line.

    returns The truncated string

  • (string) format ($text, $parameters, $stream) Browse code

    $text The test to style
    $parameters An array of options or a style name
    $stream The stream to format for

    Formats a text according to the given style or parameters.

    returns The styled text

  • formatSection ($section, $text, $size, $style) Browse code

    $section The section name
    $text The text message
    $size The maximum size allowed for a line (65 by default)
    $style The color scheme to apply to the section string (INFO, ERROR, or COMMAND)

    Formats a message within a section.

  • setStyle ($name, $options) Browse code

    $name The style name
    $options An array of options

    Sets a new style.

  • (Boolean) supportsColors ($stream) Browse code

    $stream A stream

    Returns true if the stream supports colorization.


    Colorization is disabled if not supported by the stream:

    - windows
    - non tty consoles

    returns true if the stream supports colorization, false otherwise