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

Class: Foo

Source Location: /Testing_DocTest-0.6.0/docs/test1.php

Class Overview

Bar
   |
   --Foo

Foo class.


Author(s):

Version:

  • Release: 0.6.0

Copyright:

  • 2008 David JEAN LOUIS

Variables

Methods


Inherited Variables

Inherited Methods


Class Details

[line 94]
Foo class.

Below, an example of class level doc test.

  1.  // we can name our doctest explicitely, if a name is not provided it
  2.  // defaults to "class ClassName" (here "class Foo")
  3.  
  4.  // doctest: my test for class Foo
  5.  $foo1 = new Foo();
  6.  $foo1->attr1 = 'value1';
  7.  $foo1->attr2 = 'value2';
  8.  echo $foo1 "\n";
  9.  $foo1->attr1 = null;
  10.  echo $foo1;
  11.  
  12.  // expects:
  13.  // value1_value2
  14.  // value2



[ Top ]


Class Variables

$attr1 =  null

[line 104]

Properties doc blocs do not accept doc tests.
  • Access: public

Type:   string


[ Top ]

$attr2 =  null

[line 112]

Properties doc blocs do not accept doc tests.
  • Access: public

Type:   string


[ Top ]



Method Detail

__construct (Constructor)   [line 124]

Foo __construct( [array $params = array()])

Constructor.
  • Access: public

Parameters:

array   $params   —  an optional array of parameters

[ Top ]

testArray   [line 257]

array testArray( )

$foo = new Foo(); print_r($foo->testArray()); // expects: // Array // ( // [foo] => foo value // [bar] => bar value // ) </code>

  • Access: public

[ Top ]

testBool   [line 196]

boolean testBool( [bool $ret = true])

$foo = new Foo(); var_dump($foo->testBool()); var_dump($foo->testBool(false)); // expects: // bool(true) // bool(false) </code>

  • Access: public

Parameters:

bool   $ret   —  return value

[ Top ]

testBug16372   [line 436]

int testBug16372( )

// flags: ELLIPSIS $foo = new Foo(); echo $foo->testBug16372(); // expects: // 2 </code>

  • Access: public

[ Top ]

testBug16372pre   [line 414]

int testBug16372pre( )

// flags: ELLIPSIS $foo = new Foo(); echo $foo->testBug16372pre(); // expects: // 2 </code>

  • Access: public

[ Top ]

testError   [line 394]

null testError( int $level)

// flags: ELLIPSIS $foo = new Foo(); echo $foo->testError(E_USER_ERROR); // expects: // Fatal error: Foo ! in [...] on line [...] </code>

  1.  // flags: ELLIPSIS
  2.  // ini-set: display_errors=Off
  3.  $foo = new Foo(E_USER_ERROR);
  4.  echo $foo->testError();
  5.  // expects:

  1.  // flags: ELLIPSIS
  2.  $foo = new Foo();
  3.  echo $foo->testError(E_USER_WARNING);
  4.  // expects:
  5.  // Warning: Foo ! in [...] on line [...]

  1.  // flags: ELLIPSIS
  2.  $foo = new Foo();
  3.  echo $foo->testError(E_USER_NOTICE);
  4.  // expects:
  5.  // Notice: Foo ! in [...] on line [...]

  • Access: public

Parameters:

int   $level   —  error level

[ Top ]

testException   [line 326]

Exception testException( )

$foo = new Foo(); try { $foo->testException(); } catch (Exception $exc) { echo $exc->getMessage(); } // expects: // Some descriptive message </code>

  • Throws: Exception
  • Access: public

[ Top ]

testFloat   [line 234]

float testFloat( )

$foo = new Foo(); var_dump($foo->testFloat()); // expects: // float(12.34) </code>

  • Access: public

[ Top ]

testInt   [line 215]

int testInt( )

$foo = new Foo(); var_dump($foo->testInt()); // expects: // int(7) </code>

  • Access: public

[ Top ]

testNull   [line 348]

null testNull( )

When an instruction does not return a value or return the value NULL, accepted syntaxes are: // expects: null

  1.  $foo = new Foo();
  2.  echo $foo->testNull();
  3.  // expects:

  • Access: public

[ Top ]

testObject   [line 281]

object Foo testObject( )

$foo = new Foo(array('attr1'=>'foo', 'attr2'=>'bar')); echo $foo . "\n"; echo get_class($foo); // expects: // foo_bar // Foo </code>

  • Access: public

[ Top ]

testResource   [line 302]

ressource testResource( )

$foo = new Foo(); var_dump(is_resource($foo->testResource())); echo get_resource_type($foo->testResource()); // expects: // bool(true) // stream </code>

  • Return: file
  • Access: public

[ Top ]

testString   [line 173]

string testString( )

// doctest: my test for method Foo::testString $foo = new Foo(); echo $foo->testString(); // expects: // bar </code>

  • Access: public

[ Top ]

__toString   [line 143]

string __toString( )

toString method.
  • Access: public

[ Top ]


Documentation generated on Mon, 11 Mar 2019 15:52:27 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.