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 12:58:31 (DD-MM-YYYY HH:mm:SS). This documentation is built with Vae Soli! functions and classes!
Assertions count: 0
Assertions successful: 0
Assertion failures: 0
LS_ERRORS_CLASS_PWH
: Define "LS" Errors (Pat Was Here)
VAESOLI_PATH
: Define the path where Vae Soli! is installed
VAESOLI_PLUGINS
: Define the path where plugins are located
LSErrors
Generic services to handle class errors.Name | Visibility | Type | Description |
---|---|---|---|
$aErrors |
public | array | An array of cursor errors (Experimental error messages stack (should make it protected later) |
__construct()
: Class constructor__construct()
None
(void)
WARNING: No Unit Testing found. Please provide assertions with assertion constructs ({*assert ... *}
) or with GuideAssert()
function calls in exec constructs ({*exec ... *}
).
Add()
: Adds a new errorAdd( $szMethod,$iLine,$iErrCode,$szErrMsg,$szFile )
Name | Type | Description |
---|---|---|
$szMethod |
string | Method/function where the error was found |
$iLine |
int | Source line where the error was found |
$iErrCode |
int | Error code |
$szErrMsg |
string | Error message |
$szFile |
string | Optional source code filename |
Add()
uses 5 parameters whereas the suggested limit is 3.
(void)
WARNING: No Unit Testing found. Please provide assertions with assertion constructs ({*assert ... *}
) or with GuideAssert()
function calls in exec constructs ({*exec ... *}
).
Get()
: Get the pile of errorsGet()
None
(array) The internal array of errors
WARNING: No Unit Testing found. Please provide assertions with assertion constructs ({*assert ... *}
) or with GuideAssert()
function calls in exec constructs ({*exec ... *}
).
LastError()
: Returns the last errorLastError()
None
(string) The last error object or null if NO error registered
WARNING: No Unit Testing found. Please provide assertions with assertion constructs ({*assert ... *}
) or with GuideAssert()
function calls in exec constructs ({*exec ... *}
).
LSError
Error className | Visibility | Type | Description |
---|---|---|---|
$iErrCode |
public | int | Error code |
$iLine |
public | int | Source line in $szFunction |
$szErrMsg |
public | string | Error message |
$szFile |
public | string | Original source file |
$szMethod |
public | string | The offending function/method |
__construct()
: Class constructor__construct()
None
(void)
WARNING: No Unit Testing found. Please provide assertions with assertion constructs ({*assert ... *}
) or with GuideAssert()
function calls in exec constructs ({*exec ... *}
).