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

Class: PHP_Shell_Extensions_Colour

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

Class Overview




Variables

Methods


Inherited Variables

Inherited Methods


Class Details

[line 3]


[ Top ]


Class Variables

$colours =

[line 32]

shell colours
  • See: applyColourScheme
  • Access: protected

Type:   array


[ Top ]

$colour_scheme =

[line 40]

shell colour schemes
  • See: registerColourScheme
  • Access: protected

Type:   array


[ Top ]

$instance =

[line 4]

  • Access: protected

Type:   mixed


[ Top ]



Method Detail

applyColourScheme   [line 97]

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 87]

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 70]

void optSetBackground( $key, $value)

background colours
  • Access: public

Parameters:

   $key   — 
   $value   — 

[ Top ]

register   [line 42]

void register( )

  • Access: public

[ Top ]

registerColourScheme   [line 111]

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, 11 Mar 2019 14:40:32 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.