You are currently viewing the 0.11 branch api documentation. Switch to 1.0 or 1.1

0.11 Doctrine_Cli_Formatter

Doctrine Cli Formatter

Doctrine_Cli_Formatter provides methods to format text to be displayed on a console.

This class was taken from the symfony-project source

Direct Sub-Classes

Method Summary

Returns Name Description
string excerpt
string format
formatSection
setMaxLineSize
__construct

Method Details

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

    (string) excerpt($text, $size = null)

    Truncates a line.

    Doctrine_Cli_Formatter


  • $text The test to style
    $parameters An array of parameters
    $stream A stream (default to STDOUT)

    (string) format($text = '', $parameters = array(), (stream) $stream = STDOUT)

    Formats a text according to the given parameters.

    Doctrine_Cli_Formatter


  • $section The section name
    $text The text message
    $size The maximum size allowed for a line (65 by default)

    formatSection($section, $text, $size = null)

    Formats a message within a section.


  • $size The maximum line size for a message

    setMaxLineSize($size)

    Sets the maximum line size.


  • __construct($maxLineSize = 65)