Class SimpleTestOptions

Description

Static global directives and options.

Located in /libraries/pear/simpletest/options.php (line 12)


	
			
Method Summary
 void addPartialMockCode ([string $code = ''])
 string getDefaultProxy ()
 string getMockBaseClass ()
 string getPartialMockCode ()
 string getStubBaseClass ()
 string getVersion ()
 void ignore (string $class)
 boolean isIgnored (string $class)
 void setMockBaseClass (string $mock_base)
 void setStubBaseClass (string $stub_base)
 void useProxy (string $proxy, [string $username = false], [string $password = false])
 hash _getDefaults ()
 hash &_getRegistry ()
Methods
addPartialMockCode (line 112)

Adds additional mock code.

  • access: public
void addPartialMockCode ([string $code = ''])
  • string $code: Extra code that can be added to the partial mocks for extra functionality. Useful when a test tool has overridden the mock base classes.
getDefaultProxy (line 149)

Accessor for default proxy host.

  • return: Proxy URL.
  • access: public
string getDefaultProxy ()
getDefaultProxyPassword (line 169)

Accessor for default proxy password.

  • return: Proxy password for authentication.
  • access: public
string getDefaultProxyPassword ()
getDefaultProxyUsername (line 159)

Accessor for default proxy username.

  • return: Proxy username for authentication.
  • access: public
string getDefaultProxyUsername ()
getMockBaseClass (line 98)

Accessor for the currently set mock base class.

  • return: Class name to inherit from.
  • access: public
  • static:
string getMockBaseClass ()
getPartialMockCode (line 122)

Accessor for additional partial mock code.

  • return: Extra code.
  • access: public
string getPartialMockCode ()
getStubBaseClass (line 72)

Accessor for the currently set stub base class.

  • return: Class name to inherit from.
  • access: public
  • static:
string getStubBaseClass ()
getVersion (line 20)

Reads the SimpleTest version from the release file.

  • return: Version string.
  • access: public
  • static:
string getVersion ()
ignore (line 33)

Sets the name of a test case to ignore, usually because the class is an abstract case that should not be run.

  • access: public
  • static:
void ignore (string $class)
  • string $class: Add a class to ignore.
isIgnored (line 46)

Test to see iif a test case is in the ignore list.

  • return: True if should not be run.
  • static:
  • access: public
boolean isIgnored (string $class)
  • string $class: Class name to test.
setMockBaseClass (line 87)

The base class name is settable here. This is the class that a new mock will inherited from.

To modify the generated mocks simply extend the SimpleMock class and set it's name with this method before any mocks are generated.

  • access: public
  • static:
void setMockBaseClass (string $mock_base)
  • string $mock_base: Mock base class to use.
setStubBaseClass (line 61)

The base class name is settable here. This is the class that a new stub will inherited from.

To modify the generated stubs simply extend the SimpleStub class and set it's name with this method before any stubs are generated.

  • access: public
  • static:
void setStubBaseClass (string $stub_base)
  • string $stub_base: Server stub class to use.
useProxy (line 137)

Sets proxy to use on all requests for when testing from behind a firewall. Set host to false to disable. This will take effect if there are no other proxy settings.

  • access: public
void useProxy (string $proxy, [string $username = false], [string $password = false])
  • string $proxy: Proxy host as URL.
  • string $username: Proxy username for authentication.
  • string $password: Proxy password for authentication.
_getDefaults (line 194)

Constant default values.

  • return: All registry defaults.
  • static:
  • access: private
hash _getDefaults ()
_getRegistry (line 180)

Accessor for global registry of options.

  • return: All stored values.
  • static:
  • access: private
hash &_getRegistry ()

Documentation generated on Thu, 20 Jan 2005 17:10:25 +0000 by phpDocumentor 1.3.0RC3