Niouzes

< Janvier 2021 >
Lu Ma Me Je Ve Sa Di
        1 2 3
4 5 6 7 8 9 10
11 12 13 14 15 16 17
18 19 20 21 22 23 24
25 26 27 28 29 30 31

Citation

Attention

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.

2020-01-18 à 01:24:43

Table Of Contents

  1. FOUNDATION (functions) (01/04/2015)
  2. LSAction (class) (01/04/2015)
  3. LSAddress (class) (01/04/2015)
  4. LSAdministrativeArea (class) (01/04/2015)
  5. LSApplication (class) (14/10/2013)
  6. LSArray (class) (14/10/2013)
  7. LSArticle (class) (18/02/2014)
  8. LSAssertion (class) (14/10/2013)
  9. LSAudience (class) (18/02/2014)
  10. AUTOLOAD (function) (21/04/2014)
  11. LSAutoReference (class) (14/10/2013)
  12. LSBag (class) (14/10/2013)
  13. LSBBCodes (class) (10/06/2014)
  14. LSBrowser (class) (14/10/2013)
  15. LSCache (class) (14/10/2013)
  16. LSCalculator (class) (14/10/2013)
  17. LSCalendar (class) (14/10/2013)
  18. LSCameraSnapshot (class) (14/10/2013)
  19. LSCitation (class) (14/10/2013)
  20. LSClass (class) (14/10/2013)
  21. LSCode (class) ()
  22. Colors (functions) (18/01/2020)
  23. LSContactForm (class) (14/10/2013)
  24. LSContainer (class) (14/10/2013)
  25. LSContents (class) (14/10/2013)
  26. LSContentsAccounts (class) (14/10/2013)
  27. LSContentsArticles (class) (14/10/2013)
  28. LSContentsAtomicClock (class) (14/10/2013)
  29. LSContentsBusinessCoordinates (class) (14/10/2013)
  30. LSContentsBusinessOff (class) (14/10/2013)
  31. LSContentsBusinessOpeningHours (class) (14/10/2013)
  32. LSContentsBreadcrumb (class) (14/10/2013)
  33. LSContentsCalendar (class) (14/10/2013)
  34. LSContentsCatalogue (class) (14/10/2013)
  35. LSContentsCharter (class) (18/02/2014)
  36. LSContentsCitation (class) (14/10/2013)
  37. LSContentsClock (class) (14/10/2013)
  38. LSContentsComments (class) (14/10/2013)
  39. LSContentsCookieUsage (class) (14/10/2013)
  40. LSContentsCountdown (class) (14/10/2013)
  41. LSContentsDatetime (class) (14/10/2013)
  42. LSContentsHeartbeat (class) (14/10/2013)
  43. LSContentsIFrame (class) (14/10/2013)
  44. LSContentsImageGallery (class) (14/10/2013)
  45. LSContentsLanguageSwitchers (class) (14/10/2013)
  46. LSContentsLegal (class) (18/02/2014)
  47. LSContentsMicronews (class) (14/10/2013)
  48. LSContentsMyAccount (class) (14/10/2013)
  49. LSContentsPaymentOptions (class) (14/10/2013)
  50. LSContentsPinboard (class) (14/10/2013)
  51. LSContentsRememberPassword (class) (14/10/2013)
  52. LSContentsRSS (class) (14/10/2013)
  53. LSContentsSiteManager (class) (14/10/2013)
  54. LSContentsSitemap (class) (14/10/2013)
  55. LSContentsShare (class) (14/10/2013)
  56. LSContentsStopwatch (class) (14/10/2013)
  57. LSContentsTagCloud (class) (14/10/2013)
  58. LSContentsTodosOnPage (class) (14/10/2013)
  59. LSContentsW3C (class) (14/10/2013)
  60. LSContentsWeather (class) (14/10/2013)
  61. LSControl (class) (14/10/2013)
  62. LSCreativeWork (class) (18/02/2014)
  63. LSCursor (class) (09/03/2015)
  64. LSCustomer (class) (14/10/2013)
  65. LSDataEnvironment (class) (14/10/2013)
  66. Dates (functions) (01/04/2015)
  67. LSDate (class) (14/10/2013)
  68. LSDictionary (class) (14/10/2013)
  69. LSDom, LSDomNode and LSXPath (class) (30/04/2014)
  70. LSErrors and LSError (classes) (14/10/2013)
  71. LSException (class) (16/10/2013)
  72. LSExplorer (class) (14/10/2013)
  73. LSFieldset (class) (14/10/2013)
  74. LSFile (class) (14/10/2013)
  75. LSFileProperties (class) (14/10/2013)
  76. Files (functions) (01/04/2015)
  77. Finance (functions) (01/04/2015)
  78. LSFootnotes (class) (22/02/2014)
  79. LSForm (class) (09/06/2014)
  80. LSFunction (class) (14/10/2013)
  81. LSGeorama (class) (24/10/2013)
  82. LSGeoramaVar (class) (24/10/2013)
  83. LSGlossary (class) (09/03/2015)
  84. LSGroup (class) (14/10/2013)
  85. HTML (functions) (01/04/2015)
  86. LSHttp (class) (14/10/2013)
  87. HTTP (functions) (01/04/2015)
  88. LSImageGallery (class) (14/10/2013)
  89. Images (functions) (01/04/2015)
  90. LSInput (class) (26/04/2014)
  91. IP (functions) (01/04/2015)
  92. LSIslandAbstract (14/10/2013)
  93. LSIslandFormAbstract (class) (14/10/2013)
  94. LSLabel (class) (14/10/2013)
  95. LSLanguageSwitchers (class) (14/10/2013)
  96. LSLatin (class) (14/10/2013)
  97. LSLegalPerson (class) (14/10/2013)
  98. LSLinkedList (class) (14/10/2013)
  99. LSList (class) (14/10/2013)
  100. Mails (functions) (01/04/2015)
  101. LSMap (class) (14/10/2013)
  102. Math (functions) (01/04/2015)
  103. LSMicronews (class) (18/02/2014)
  104. Miscellaneous (functions) (01/04/2015)
  105. LSModuleAbstract (class) (14/10/2013)
  106. LSNaturalPerson (class) (14/10/2013)
  107. LSNewsArticle (class) (18/02/2014)
  108. LSNote (class) (14/10/2013)
  109. LSMotherNature (class) (16/10/2013)
  110. LSPage (class) (18/02/2014)
  111. LSParameter (class) (14/10/2013)
  112. LSPaymentOptions (class) (14/10/2013)
  113. LSPeopleAudience (class) (18/02/2014)
  114. LSPerson (class) (14/10/2013)
  115. LSPlace (class) (18/02/2014)
  116. LSProperty (class) (14/10/2013)
  117. LSPublication (class) (14/10/2013)
  118. LSRequirement (class) (14/10/2013)
  119. LSReturn (class) (24/10/2013)
  120. LSRisk (class) (14/10/2013)
  121. LSSentanaiAbstract (14/10/2013)
  122. LSServiceMessage (class) (14/10/2013)
  123. LSSession (class) (14/10/2013)
  124. LSSiteManager (class) (14/10/2013)
  125. LSSitemap (class) (14/10/2013)
  126. LSSockets (class) (14/10/2013)
  127. LSSoftwareApplication (class) (18/02/2014)
  128. LSSource (class) (14/10/2013)
  129. Strings (functions) (31/07/2016)
  130. LSSupplier (class) (14/10/2013)
  131. System (functions) (01/04/2015)
  132. LSTag (class) (21/04/2014)
  133. LSTagCloud (class) (14/10/2013)
  134. LSTechArticle (class) (18/02/2014)
  135. LSThing (class) (18/02/2014)
  136. LSTimeline (class) (14/10/2013)
  137. LSTimer (class) (16/10/2013)
  138. LSTracer (class) (09/03/2015)
  139. LSUnitTesting (class) (14/10/2013)
  140. URL (functions) (01/04/2015)
  141. LSUser (class) (09/03/2015)
  142. LSUserMgr (class) (14/10/2013)
  143. LSVaesoli (class) (09/06/2014)
  144. LSVersion (class) (14/10/2013)
  145. LSWebSite (class) (14/10/2013)
  146. LSWidget (class) (14/10/2013)
  147. LSWireTransferForm (class) (14/10/2013)
  148. LSXMLSitemap (class) (14/10/2013)
  149. XML (functions) (01/04/2015)

LSFootnotes.class.php

Generated by The Vae Soli! Documentor: Guide v. 1.3.0018 on 22-02-2014 18:04:34 (DD-MM-YYYY HH:mm:SS). This documentation is built with Vae Soli! functions and classes!

File Properties

C:\websites\vaesoli.org\www\httpdocs/vaesoli/include/LSFootnotes.class.phpC:\websites\vaesoli.org\www\httpdocs\vaesoli\include\LSFootnotes.class.phpapplication/force-downloadC:\websites\vaesoli.org\www\httpdocs\vaesoli\include17811 bytes03/08/2013 23:27:5222/02/2014 18:04:3222/02/2014 18:04:32

Compliance

Assertions count: 2

Assertions successful: 2

Assertion failures: 0

Manifest Constants

LSFootnotes: Define "LS" footnotes (Pat Was Here)

VAESOLI_PATH: Define the path where Vae Soli! is installed

VAESOLI_PLUGINS: Define the path where plugins are located

Sources required

LSV.functions.php: Vae Soli! Foundation functions

LSVfc.class.php: Vae Soli! Foundation classes

Classes

LSFootnotesA LSFootnotes object gathers notes in an array. The full array of notes can then be rendered later at some point. Notes can be added in the flow of a text. Each note is replaced by a superscript reference that points to the actual note. When notes are all rendered, it is easy to go back to the original text where the note was added in the first place.

Properties
NameVisibilityTypeDescription
$aNotes public array An array of notes that must be rendered at some point
$iStart public int Counter start. 0 by default. DO NOT USE NEGATIVE NUMBERS.
$iTeaserLength public int The length of the teaser
$szPrefix public string A prefix that will be added to the note counter when it is rendered
Methods
  1. __construct(): Constructs a footnote object
  2. Add(): Adds a new note to the internal array of notes.
  3. Clear(): Clears all footnotes
  4. Ref(): Refers to an existing footnote
  5. Render(): Renders all footnotes
__construct(): Constructs a footnote object

[ back to method list ]

Syntax

__construct( $x )

Parameters
NameTypeDescription
$x mixed Either an integer or a LSFootnotes object that is used to initialize the $iStart reference of the new footnotes object to be created. Optional. null by default.
Return

(void)

Example(s)
$oNotes = new LSFootnotes();

<!-- Here you have HTML code where footnotes will be added in
     a similar way :

<p>Our slogan is OSF <?php echo $oNotes->Add( 'Open, simple, fast' ); ?>

-->

echo $oNotes->Render();
Example Executed
$oNotes1 = new LSFootnotes( 3 );
$oNotes1->Add( "Third note" );
$oNotes1->Add( "Fourth note" );

$oNotes2 = new LSFootnotes( $oNotes1 );
$oNotes2->Add( "Fifth note" );
$oNotes2->Add( "Sixth note" );

echo $oNotes1->Render();
echo $oNotes2->Render();

[3] … Third note

[4] … Fourth note

[5] … Fifth note

[6] … Sixth note

Unit Testing

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 note to the internal array of notes.

[ back to method list ]

Syntax

Add( $x,$szRef,$bAdd )

Parameters
NameTypeDescription
$x mixed Can be either a string or a tag (LSTag). Later on, this parameter might be something different such as a reference, a citation, ...
$szRef string Reference that will be assigned to the note that must be added. Optional. null by default in which case the class will create an internal reference that might change at each generation (md5(guid())).
$bAdd bool Should the note be added or not. Optional. true by default. If false, then $szRef must be passed for the note to be added as it is supposed to replace the existing reference.
Return

(string) HTML code that represents the superscript reference

Example(s)
$oNotes = new LSFootnotes();

<!-- Here you have HTML code where footnotes will be added in
     a similar way :

<p>Our slogan is OSF <?php echo $oNotes->Add( 'Open, simple, fast' ); ?>

-->

echo $oNotes->Render();
Example Executed
$oNotes                 = new LSFootnotes();
$oNotes->szPrefix       = 'Ex-';
$oNotes->iTeaserLength  = 30;

echo "<p>Slogan is OSF " . $oNotes->Add( 'Open, simple, fast ... this has been our motto for 25 years' ) . "</p>";
echo "<p>What's yours?"  . $oNotes->Add( 'Mine is to be true' ) . "</p>";

LSUnitTesting::assert( strlen( $oNotes->aNotes[0][1] ) === 32                              ,
                       'ASSERTION SUCCESSFUL: footnote has received a plausible reference' ,
                       'ASSERTION FAILURE: incorrect reference'                            ,
                       'GuideAssert' );

LSUnitTesting::assert( count( $oNotes->aNotes ) === 2                      ,
                       'ASSERTION SUCCESSFUL: right number of footnotes'   ,
                       'ASSERTION FAILURE: incorrect count of footnotes'   ,
                       'GuideAssert' );

echo "<p>Footnotes</p>";
echo $oNotes->Render();

Slogan is OSF [Ex-1]

What's yours?[Ex-2]

Footnotes

[Ex-1] … Open, simple, fast ... this has been our motto for 25 years

[Ex-2] … Mine is to be true

Unit Testing

2 assertions: 2 successful; 0 failed

See Also

Ref()

Clear(): Clears all footnotes

[ back to method list ]

Syntax

Clear()

Parameters

None

Return

(void)

Example Executed
$oNotes                 = new LSFootnotes();
$oNotes->iTeaserLength  = 30;

echo "<p>Slogan is OSF " . $oNotes->Add( 'Open, simple, fast ... this has been our motto for 25 years' ) . "</p>";
echo "<p>Our next slogan is WSWWTWDWWSWAWWD " . $oNotes->Add( 'We Say What We Think; We Do What We Say; We Are What We Do!' ) . "</p>";

$oNotes->Clear();

if ( count( $oNotes->aNotes ) > 0 )
{
    echo "<p>Footnotes</p>";
    echo $oNotes->Render();
}
else
{
    echo "<p>No footnote found!</p>";
}

Slogan is OSF [1]

Our next slogan is WSWWTWDWWSWAWWD [2]

No footnote found!

Unit Testing

WARNING: No Unit Testing found. Please provide assertions with assertion constructs ({*assert ... *}) or with GuideAssert() function calls in exec constructs ({*exec ... *}).

Ref(): Refers to an existing footnote

[ back to method list ]

Remark

A call to Ref() is identical to a call to Add( '',$szRef,false );

Syntax

Ref( $szRef )

Parameters
NameTypeDescription
$szRef string Reference of the existing footnote
Return

(string) HTML code that represents the reference.

Example Executed
$oNotes                 = new LSFootnotes();
$oNotes->iTeaserLength  = 30;
$oNotes->iStart         = 4;

echo "<p>Slogan is OSF " . $oNotes->Add( 'Open, simple, fast ... this has been our motto for 25 years','OSF' ) . "</p>";
echo "<p>A lot of blahblablah</p>";
echo "<p>Remember our slogan " . $oNotes->Ref( 'OSF' ) . "</p>";

echo "<p>Footnotes</p>";
echo $oNotes->Render();

Slogan is OSF [4]

A lot of blahblablah

Remember our slogan [4]

Footnotes

[4] … Open, simple, fast ... this has been our motto for 25 years

Unit Testing

WARNING: No Unit Testing found. Please provide assertions with assertion constructs ({*assert ... *}) or with GuideAssert() function calls in exec constructs ({*exec ... *}).

See Also

Add()

Render(): Renders all footnotes

[ back to method list ]

Remark

Notes are rendered in paragraphs:

... ...

Syntax

Render()

Parameters

None

Return

(string) HTML code that represents all the footnotes

Example(s)
$oNotes = new LSFootnotes();

<!-- Here you have HTML code where footnotes will be added in
     a similar way :

<p>Our slogan is OSF <?php echo $oNotes->Add( 'Open, simple, fast' ); ?>

-->

echo $oNotes->Render();
Unit Testing

WARNING: No Unit Testing found. Please provide assertions with assertion constructs ({*assert ... *}) or with GuideAssert() function calls in exec constructs ({*exec ... *}).

Précédent Suivant