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

Class: PHP_Shell_Options

Source Location: /PHP_Shell-0.3.2/PHP/Shell/Options.php

Class Overview


PHP_Shell_Options Class


Author(s):

Version:

  • Release: @package_version@

Copyright:

  • 2006 Jan Kneschke

Variables

Methods


Inherited Variables

Inherited Methods


Class Details

[line 36]
PHP_Shell_Options Class

This class is a basic extension that provide the funcionality of set options to other extensions or to the whole PHP_Shell.



[ Top ]


Class Variables

$instance =

[line 43]

instance of the current class
  • Access: protected

Type:   PHP_Shell_Options


[ Top ]

$options = array()

[line 51]

known options and their setors

Type:   array


[ Top ]

$option_aliases = array()

[line 59]

known options and their setors

Type:   array


[ Top ]



Method Detail

cmdSet   [line 112]

void cmdSet( string $l)

set a shell-var

:set al to enable autoload :set bg=dark to enable highlighting with a dark backgroud

  • Access: public

Parameters:

string   $l     Unknown

[ Top ]

execute   [line 162]

void execute( string $key, mixed $value)

execute a :set command

calls the setor for the :set <option>

  • Access: protected

Parameters:

string   $key     Key to set
mixed   $value     Value to write

[ Top ]

getInstance   [line 192]

PHP_Shell_Options getInstance( )

Return an instance of this
  • Todo: Remove this! Singletons are bad

[ Top ]

getOptions   [line 127]

array getOptions( )

get all the option names
  • Return: names of all options
  • Access: public

[ Top ]

register   [line 66]

void register( )

Register
  • Access: public

[ Top ]

registerOption   [line 88]

void registerOption( string $option, object $obj, string $setor, [string $getor = null])

register a option
  • Access: public

Parameters:

string   $option     name of the option
object   $obj     a object handle
string   $setor     method-name of the setor in the object
string   $getor     (unused)

[ Top ]

registerOptionAlias   [line 142]

void registerOptionAlias( string $alias, string $option)

map a option to another option

e.g.: bg maps to background

  • Access: public

Parameters:

string   $alias     Alias (name)
string   $option     Option

[ Top ]


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