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)

LSVaesoli.class.php

Generated by The Vae Soli! Documentor: Guide v. 1.3.0018 on 09-06-2014 09:09:29 (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/LSVaesoli.class.phpC:\websites\vaesoli.org\www\httpdocs\vaesoli\include\LSVaesoli.class.phpapplication/force-downloadC:\websites\vaesoli.org\www\httpdocs\vaesoli\include46542 bytes02/01/2014 15:40:2309/06/2014 08:57:5809/06/2014 08:57:58

Compliance

Assertions count: 8

Assertions successful: 8

Assertion failures: 0

Manifest Constants

VER_MAJOR: Vae Soli! major version number

VER_MINOR: Vae Soli! minor version number

VER_REVISION: Vae Soli! revision number

VER_DATE: Vae Soli! release date and time

VER_RELEASE: Vae Soli! release type (alpha, beta, final)

VAESOLI_PATH: Define the path where Vae Soli! is installed

VAESOLI_PLUGINS: Define the path where plugins are located

Sources required

LSApplication.errors.inc: Application error codes

LSV.functions.php: Vae Soli! Foundation functions

LSContents.class.php: LSContents class

LSDoc.class.php: Doc class

LSDate.functions.php: Date functions

LSUnitTesting.class.php: Vae Soli! Unit Testing

Classes

LSVaesoliHolds detailed and high-level info about all the classes that compose Vae Soli!

Constants
NameTypeDescription
NAME (string) The name of the framework
FWK_TYPE (string) The framework type (either 'Web' or 'EAI'
Properties
NameVisibilityTypeDescription
$aClasses public array Set of classes included in Vae Soli!
$aFunctions public array Set of function sources included in Vae Soli!
$aJS public array Set of JavaScript sources included in Vae Soli!
$dBirthDate public date Date & time Vae Soli! was born (the EAI part -- the web part is born on 20051024 !)
$oVersion public LSVersion Version object
Methods
  1. __construct(): Class constructor
  2. __toString(): Allows the class to decide how it will react when it is treated like a string. A call to ThrowUp() is performed. No assertion found for __toString() (0 - 0)
  3. Age(): Returns the age of Vae Soli! in seconds No assertion found for Age() (0 - 0)
  4. CountFiles(): Counts the number of files involved in the current version of Vae Soli! No assertion found for CountFiles() (0 - 0)
  5. CountLinesOfCode(): Counts the lines of code involved in the current version of Vae Soli! No assertion found for CountLinesOfCode() (0 - 0)
  6. Speak(): Let the object speak and present itself No assertion found for Speak() (0 - 0)
  7. ThrowUp(): Returns a parsable string representation of the array No assertion found for ThrowUp() (0 - 0)
  8. Toolbox(): Presents a toolbox with all content classes No assertion found for Toolbox() (0 - 0)
__construct(): Class constructor

[ back to method list ]

Created: 01/04/2013 09:19

Since version 5.2.0000

Modified: 13/09/2013 17:00

Syntax

__construct()

Parameters

None

Return

(void)

Example Executed
$oFramework = new LSVaesoli();
echo LSUnitTesting::assert( $oFramework instanceof LSVaesoli                                    ,
                            'ASSERTION SUCCESS: we\'re alive and kicking!'                       ,
                            'ASSERTION FAILURE: there is someone in my head but it\'s not me'   ,
                            'GuideAssert' );

GuideAssert() ... ASSERTION SUCCESS: we're alive and kicking!

Unit Testing

1 assertions: 1 successful; 0 failed

__toString(): Allows the class to decide how it will react when it is treated like a string. A call to ThrowUp() is performed.

[ back to method list ]

Syntax

__toString()

Parameters

None

Return

(string) HTML code that represents Vae Soli!

Example Executed
$x = (string) new LSVaesoli();

echo LSUnitTesting::assert( strstr( $x,'LSUserMgr.class.php' ) &&
                            strstr( $x,'LSVaesoli.class.php' )                                  ,
                            'ASSERTION SUCCESS: we\'re alive and kicking!'                      ,
                            'ASSERTION FAILURE: there is someone in my head but it\'s not me'   ,
                            'GuideAssert' );

GuideAssert() ... ASSERTION SUCCESS: we're alive and kicking!

Unit Testing

1 assertions: 1 successful; 0 failed

Age(): Returns the age of Vae Soli! in seconds

[ back to method list ]

Syntax

Age()

Parameters

None

Return

(int) Age of Vae Soli! in seconds

Example Executed
$oVaesoli = new LSVaesoli();
echo ($iAge = $oVaesoli->Age() ),' sec';

echo LSUnitTesting::assert( $iAge > ( 3600 * 24 * 365.25 )                                      ,
                            'ASSERTION SUCCESS: Vae Soli! is more than 10 years old!'           ,
                            'ASSERTION FAILURE: there is someone in my head but it\'s not me'   ,
                            'GuideAssert' );

343472970 sec

GuideAssert() ... ASSERTION SUCCESS: Vae Soli! is more than 10 years old!

Unit Testing

1 assertions: 1 successful; 0 failed

CountFiles(): Counts the number of files involved in the current version of Vae Soli!

[ back to method list ]

Created: 03/10/2013 18:49

Since version 5.6.0000

Syntax

CountFiles()

Parameters

None

Return

(int) The number of files

Example Executed
$oVaesoli = new LSVaesoli();
echo '<p>Number of files in classes: ',$oVaesoli->CountFiles( array( 'classes' => true ) ),'</p>';
echo '<p>Number of files in functions: ',$oVaesoli->CountFiles( array( 'functions' => true )),'</p>';
echo '<p>Number of files in javascript: ',$oVaesoli->CountFiles( array( 'js' => true )),'</p>';
echo '<p>Number of files in Vae Soli!: ',$oVaesoli->CountFiles(),'</p>';

echo LSUnitTesting::assert( $oVaesoli->CountFiles( array( 'classes' => true ) ) > 200           ,
                            'ASSERTION SUCCESS: More than 200 class files!'                     ,
                            'ASSERTION FAILURE: there is someone in my head but it\'s not me'   ,
                            'GuideAssert' );

echo LSUnitTesting::assert( $oVaesoli->CountFiles( array( 'functions' => true ) ) > 15          ,
                            'ASSERTION SUCCESS: More than 15 function files!'                   ,
                            'ASSERTION FAILURE: there is someone in my head but it\'s not me'   ,
                            'GuideAssert' );

echo LSUnitTesting::assert( $oVaesoli->CountFiles( array( 'js' => true ) ) > 20                 ,
                            'ASSERTION SUCCESS: More than 20 javascript files!'                 ,
                            'ASSERTION FAILURE: there is someone in my head but it\'s not me'   ,
                            'GuideAssert' );

Number of files in classes: 244

Number of files in functions: 17

Number of files in javascript: 26

Number of files in Vae Soli!: 287

GuideAssert() ... ASSERTION SUCCESS: More than 200 class files!

GuideAssert() ... ASSERTION SUCCESS: More than 15 function files!

GuideAssert() ... ASSERTION SUCCESS: More than 20 javascript files!

Unit Testing

3 assertions: 3 successful; 0 failed

CountLinesOfCode(): Counts the lines of code involved in the current version of Vae Soli!

[ back to method list ]

Created: 03/10/2013 06:17

Since version 5.6.0000

Syntax

CountLinesOfCode()

Parameters

None

Return

(int) The number of lines

Example Executed
$oVaesoli = new LSVaesoli();
echo '<p>Lines of code in classes: ',$oVaesoli->CountLinesOfCode( array( 'classes' => true ) ),'</p>';
echo '<p>Lines of code in functions: ',$oVaesoli->CountLinesOfCode( array( 'functions' => true )),'</p>';
echo '<p>Lines of code in javascript: ',$oVaesoli->CountLinesOfCode( array( 'js' => true )),'</p>';
echo '<p>Lines of code in Vae Soli!: ',$oVaesoli->CountLinesOfCode(),'</p>';

echo LSUnitTesting::assert( $oVaesoli->CountLinesOfCode( array( 'classes' => true ) ) > 100000  ,
                            'ASSERTION SUCCESS: More than 100000 lines of code!'                ,
                            'ASSERTION FAILURE: there is someone in my head but it\'s not me'   ,
                            'GuideAssert' );

Lines of code in classes: 123333

Lines of code in functions: 21415

Lines of code in javascript: 5028

Lines of code in Vae Soli!: 149776

GuideAssert() ... ASSERTION SUCCESS: More than 100000 lines of code!

Unit Testing

1 assertions: 1 successful; 0 failed

Speak(): Let the object speak and present itself

[ back to method list ]

Created: 01/04/2013 09:20

Since version 5.2.0000

Modified: 17/10/2013 08:27

Warning

This method is NOT operational yet

Syntax

Speak( $szVerb )

Parameters
NameTypeDescription
$szVerb string Type of yell
Return

(string) What the object had to say

Unit Testing

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

ThrowUp(): Returns a parsable string representation of the array

[ back to method list ]

Syntax

ThrowUp()

Parameters

None

Return

(string) String representation of the array

Example Executed
$x = (string) new LSVaesoli();

echo LSUnitTesting::assert( strstr( $x,'LSUserMgr.class.php' ) &&
                            strstr( $x,'LSVaesoli.class.php' )                                  ,
                            'ASSERTION SUCCESS: we\'re alive and kicking!'                      ,
                            'ASSERTION FAILURE: there is someone in my head but it\'s not me'   ,
                            'GuideAssert' );

GuideAssert() ... ASSERTION SUCCESS: we're alive and kicking!

Unit Testing

1 assertions: 1 successful; 0 failed

Toolbox(): Presents a toolbox with all content classes

[ back to method list ]

Created: 01/04/2013 09:20

Since version 5.2.0000

Warning

This method is still empty. DO NOT USE IT AT THIS STAGE (03-10-13 15:32:36)

Syntax

Toolbox()

Parameters

None

Return

(void)

Unit Testing

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

Précédent Suivant