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

Class: PHP_Shell_Options

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

Class Overview




Variables

Methods


Inherited Variables

Inherited Methods


Class Details

[line 8]


[ Top ]


Class Variables

$instance =

[line 14]

  • Access: protected

Type:   mixed


[ Top ]

$options = array()

[line 22]

known options and their setors
  • See: registerOption
  • Access: protected

Type:   array


[ Top ]

$option_aliases = array()

[line 30]

known options and their setors
  • See: registerOptionAlias
  • Access: protected

Type:   array


[ Top ]



Method Detail

cmdSet   [line 59]

void cmdSet( $l)

set a shell-var

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

  • Access: public

Parameters:

   $l   — 

[ Top ]

getInstance   [line 123]

void getInstance( )


[ Top ]

getOptions   [line 73]

array getOptions( )

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

[ Top ]

register   [line 32]

void register( )

  • Access: public

[ Top ]

registerOption   [line 45]

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

register a option
  • Access: public

Parameters:

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

[ Top ]

registerOptionAlias   [line 85]

void registerOptionAlias( string $alias, string $option)

map a option to another option

e.g.: bg maps to background

  • Access: public

Parameters:

string   $alias   —  alias
string   $option   —  option

[ Top ]


Documentation generated on Mon, 11 Mar 2019 14:40:33 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.