PHP_Shell
[ class tree: PHP_Shell ] [ index: PHP_Shell ] [ all elements ]

Class: PHP_Shell_Extensions_Colour

Source Location: /PHP_Shell-0.3.2/PHP/Shell/Extensions/Colour.php

Class Overview


PHP_Shell_Extensions_Colour


Author(s):

Version:

  • Release: @package_version@

Copyright:

  • 2006 Jan Kneschke

Variables

Methods


Inherited Variables

Inherited Methods


Class Details

[line 27]
PHP_Shell_Extensions_Colour


[ Top ]


Class Variables

$colours =

[line 57]

shell colours

Type:   array


[ Top ]

$colour_scheme =

[line 65]

shell colour schemes

Type:   array


[ Top ]

$instance =

[line 29]

  • Access: protected

Type:   mixed


[ Top ]



Method Detail

applyColourScheme   [line 143]

false applyColourScheme( string $scheme)

apply a colour scheme to the current shell
  • Return: if colourscheme is not known, otherwise true
  • Access: public

Parameters:

string   $scheme     name of the scheme

[ Top ]

getColour   [line 131]

string getColour( string $type)

get a colour for the shell
  • Return: a colour string or a empty string
  • Access: public

Parameters:

string   $type     one of (value|exception|reset|default)

[ Top ]

optSetBackground   [line 112]

void optSetBackground( string $key, string $value)

background colours
  • Access: public

Parameters:

string   $key     the config name
string   $value     the value to set

[ Top ]

register   [line 73]

void register( )

register a extension
  • Access: public

[ Top ]

registerColourScheme   [line 162]

void registerColourScheme( string $scheme, array $colours)

registers a colour scheme
  • Access: public

Parameters:

string   $scheme     name of the colour scheme
array   $colours     a array of colours

[ Top ]


Documentation generated on Mon, 12 Dec 2011 23:00:07 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.