Class Console_Color

Description

A simple class to use ANSI Colorcodes.

A simple class to use ANSI Colorcodes. Of all the functions, you probably only want to use convert() and escape(). They are easier to use. However, if you want to access colorcodes more directly, look into the other functions.

Located in /lib/Color.php (line 73)


	
			
Method Summary
static string bgcolor (string $name)
static string color ([mixed $color = null], [string $style = null], [string $background = null])
static string convert (string $string, [bool $colored = true])
static string escape (string $string)
static string fgcolor (string $name)
static string strip (string $string)
static string style (string $name)
Methods
static bgcolor (line 152)

Returns a BG color controlcode

Returns a BG color controlcode

  • access: public
static string bgcolor (string $name)
  • string $name
static color (line 91)

Returns an ANSI-Controlcode Takes 1 to 3 Arguments: either 1 to 3 strings containing the name of the FG Color, style and BG color, or one array with the indices color, style or background.

Returns an ANSI-Controlcode Takes 1 to 3 Arguments: either 1 to 3 strings containing the name of the FG Color, style and BG color, or one array with the indices color, style or background.

  • access: public
static string color ([mixed $color = null], [string $style = null], [string $background = null])
  • mixed $color: Optional Either a string with the name of the foreground color, or an array with the indices 'color', 'style', 'background' and corresponding names as values.
  • string $style: Optional name of the style
  • string $background: Optional name of the background color
static convert (line 192)

Converts colorcodes in the format %y (for yellow) into ansi-control codes. terminals).

Converts colorcodes in the format %y (for yellow) into ansi-control codes. The conversion table is: ('bold' meaning 'light' on some terminals). It's almost the same conversion table irssi uses.

                  text      text            background
      ------------------------------------------------
      %k %K %0    black     dark grey       black
      %r %R %1    red       bold red        red
      %g %G %2    green     bold green      green
      %y %Y %3    yellow    bold yellow     yellow
      %b %B %4    blue      bold blue       blue
      %m %M %5    magenta   bold magenta    magenta
      %p %P       magenta (think: purple)
      %c %C %6    cyan      bold cyan       cyan
      %w %W %7    white     bold white      white

      %F     Blinking, Flashing
      %U     Underline
      %8     Reverse
      %_,%9  Bold

      %n     Resets the color
      %%     A single %
First param is the string to convert, second is an optional flag if colors should be used. It defaults to true, if set to false, the colorcodes will just be removed (And %% will be transformed into %)

  • access: public
static string convert (string $string, [bool $colored = true])
  • string $string
  • bool $colored
static escape (line 254)

Escapes % so they don't get interpreted as color codes

Escapes % so they don't get interpreted as color codes

  • access: public
static string escape (string $string)
  • string $string: string
static fgcolor (line 126)

Returns a FG color controlcode

Returns a FG color controlcode

  • access: public
static string fgcolor (string $name)
  • string $name
static strip (line 265)

Strips ANSI color codes from a string

Strips ANSI color codes from a string

  • access: public
static string strip (string $string)
  • string $string: string
static style (line 139)

Returns a style controlcode

Returns a style controlcode

  • access: public
static string style (string $name)
  • string $name

Documentation generated on Sun, 15 Mar 2009 09:34:30 -0400 by phpDocumentor 1.4.1