The documentation is incomplete. The Vae Soli! team works hard to make it as exhaustive as possible with tons of useful examples and easy to understand explanations.
On top of that, we have decided to use our own tool to generate the documentation you read. This also takes time to fine-tune. Our goal is have better documentation, easier to read, easier to use, completely integrated with our site.
Even though NOT finalized, you can now link back to our documentation pages as we have decided once and for all about the structure of our documents and where they all reside on our server.
Thank you very much
The Vae Soli! team.
Generated by The Vae Soli! Documentor: Guide v. 1.3.0015 on 14-10-2013 13:09:56 (DD-MM-YYYY HH:mm:SS). This documentation is built with Vae Soli! functions and classes!
Assertions count: 2
Assertions successful: 2
Assertion failures: 0
LS_UNIT_TESTING_CLASS_PWH
: Define "LS" Unit Testing class (Pat Was Here)
VAESOLI_PATH
: Define the path where Vae Soli! is installed
VAESOLI_PLUGINS
: Define the path where plugins are located
LSUnitTesting
Provides a simple Unit Testing oriented set of routines that is used
in Vae Soli! classes and functions when being documented (guide.php)$bExpr
) is TRUE$bExpr
) is FALSEassert()
: Checks if assertion ($bExpr
) is TRUEassert( $bExpr,$szSuccessMsg,$szFailureMsg,$szCallback )
Name | Type | Description |
---|---|---|
$bExpr |
boolean | Boolean expression |
$szSuccessMsg |
string | Message to be returned in case of
success (if $bExpr evaluates to
true ). Optional. null by
default. |
$szFailureMsg |
string | Message to be returned in case of
failiure (if $bExpr evaluates to
false ). Optional. null by
default. |
$szCallback |
string | Callback function. Optional. null
by default. If passed and if exists the
function is called with 4 parameters:
$bExpr ,$szSuccessMsg ,$szFailureMsg and
the anticipated return value. The
callback function can return its own
value and this will eventually
be returned to the caller. |
assert()
uses 4 parameters whereas the suggested limit is 3.
(string) if $bExpr
evaluates to true
... $szSuccessMsg
if
not null
or 'SUCCESS'
otherwise
if $bExpr
evaluates to false
... $szFailureMsg
if
not null
or 'FAILURE'
otherwise.
echo LSUnitTesting::assert( true , 'ASSERTION SUCCESS' , 'ASSERTION FAILURE' , 'GuideAssert' );
GuideAssert() ... ASSERTION SUCCESS
1 assertions: 1 successful; 0 failed
assertFalse()
: Checks if assertion ($bExpr
) is FALSEassertFalse( $bExpr,$szSuccessMsg,$szFailureMsg,$szCallback )
Name | Type | Description |
---|---|---|
$bExpr |
boolean | Boolean expression |
$szSuccessMsg |
string | Message to be returned in case of
success (if $bExpr evaluates to
false ). Optional. null by
default. |
$szFailureMsg |
string | Message to be returned in case of
failiure (if $bExpr evaluates to
true ). Optional. null by
default. |
$szCallback |
string | Callback function. Optional. null
by default. If passed and if exists the
function is called with 4 parameters:
$bExpr ,$szSuccessMsg ,$szFailureMsg and
the anticipated return value. The
callback function can return its own
value and this will eventually
be returned to the caller. |
assertFalse()
uses 4 parameters whereas the suggested limit is 3.
(string) if $bExpr
evaluates to false
... $szSuccessMsg
if
not null
or 'SUCCESS'
otherwise
if $bExpr
evaluates to true
... $szFailureMsg
if
not null
or 'FAILURE'
otherwise.
echo LSUnitTesting::assertFalse( false , 'ASSERTION SUCCESS' , 'ASSERTION FAILURE' , 'GuideAssert' );
GuideAssert() ... ASSERTION SUCCESS
1 assertions: 1 successful; 0 failed