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:48:49 (DD-MM-YYYY HH:mm:SS). This documentation is built with Vae Soli! functions and classes!
Assertions count: 1
Assertions successful: 1
Assertion failures: 0
LS_AUTO_REFERENCE_CLASS_PWH
: Define "LS" automatic reference (Pat Was Here)
VAESOLI_PATH
: Define the path where Vae Soli! is installed
VAESOLI_PLUGINS
: Define the path where plugins are located
LSV.functions.php
: Vae Soli! Foundation functions
LSVfc.class.php
: Vae Soli! Foundation classes
LSAutoReference
A LSAutoReference
object gathers automatic references
and assicates notes to each referenceName | Visibility | Type | Description |
---|---|---|---|
$aNotes |
public | array | An array of notes that must be rendered at some point |
$bEnclose |
public | bool | Must the reference be enclosed in the left and right markers
($szLeftMarker and $szRightMarker ).
true by default. |
$iIndex |
public | int | Index start. 1 by default. |
$szLeftMarker |
public | string | Left marker used to enclose the reference. '(' by default. |
$szRightMarker |
public | string | Right marker used to enclose the reference. ')' by default. |
__construct()
: Constructs an automatic reference object__construct()
None
(void)
$oRef = new LSAutoReference(); echo $oRef->Add( 'pourquoi vous souhaitez vous lancer dans un projet' ); echo $oRef->Render(); echo LSUnitTesting::assert( $oRef instanceof LSAutoReference , 'ASSERTION SUCCESS: proper class created' , 'ASSERTION FAILURE: invalid class' , 'GuideAssert' );
(1) pourquoi vous souhaitez vous lancer dans un projet(1) pourquoi vous souhaitez vous lancer dans un projetGuideAssert() ... ASSERTION SUCCESS: proper class created
1 assertions: 1 successful; 0 failed
Add()
: Adds a new reference to the internal array of references.Add( $x )
Name | Type | Description |
---|---|---|
$x |
string | The note associated to the reference. Optional. |
(string) HTML code that represents the superscript reference
$oRef = new LSAutoReference(); echo $oRef->Add( 'pourquoi vous souhaitez vous lancer dans un projet' ); echo $oRef->Render();
WARNING: No Unit Testing found. Please provide assertions with assertion constructs ({*assert ... *}
) or with GuideAssert()
function calls in exec constructs ({*exec ... *}
).
Clear()
: Clears all referencesClear()
None
(void)
WARNING: No Unit Testing found. Please provide assertions with assertion constructs ({*assert ... *}
) or with GuideAssert()
function calls in exec constructs ({*exec ... *}
).
Render()
: Renders all referencesRender()
None
(string) HTML code that represents all the footnotes
$oRef = new LSAutoReference(); echo $oRef->Add( 'pourquoi vous souhaitez vous lancer dans un projet' ); echo $oRef->Render();
WARNING: No Unit Testing found. Please provide assertions with assertion constructs ({*assert ... *}
) or with GuideAssert()
function calls in exec constructs ({*exec ... *}
).
Reset()
: Reset the internal array of notes and indexReset()
None
(void)
WARNING: No Unit Testing found. Please provide assertions with assertion constructs ({*assert ... *}
) or with GuideAssert()
function calls in exec constructs ({*exec ... *}
).