Niouzes

< Octobre 2018 >
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.

2018-10-14 à 17:13:57

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) (14/10/2018)
  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)

LSVfc.class.php

Generated by The Vae Soli! Documentor: Guide v. 1.3.0015 on 16-10-2013 13:54:15 (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/LSVfc.class.phpC:\websites\vaesoli.org\www\httpdocs\vaesoli\include\LSVfc.class.phpapplication/force-downloadC:\websites\vaesoli.org\www\httpdocs\vaesoli\include63070 bytes03/08/2013 23:27:5314/10/2013 15:13:2014/10/2013 15:13:20

Compliance

Assertions count: 3

Assertions successful: 3

Assertion failures: 0

Early Warning

LSVfc.class.php exceeds 51200 bytes. We suggest this file got broken down in smaller chunks!

LSVfc.class.php contains 1190 lines of code, which exceeds the suggested limit of 1024 lines. We suggest this file got broken down in smaller chunks!

Manifest Constants

LS_VAESOLI_FOUNDATION_CLASS: Define "LS" Vae Soli! Foundation Class (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

LSTracingLevels.inc: Site documentation class

LSDom.class.php: DOM document class

LSV.defines.inc: Vae Soli! constants

LSGeorama.class.php: Georama class

LSPage.class.php: Page class

LSSubject.class.php: Subject class (cfr. user)

LSUnitTesting.class.php: Vae Soli! Unit Testing

Classes

LSMotherNatureMother class of most classes of the framework

Properties
NameVisibilityTypeDescription
$Cargo public mixed Cargo container #2 (use it freely)
$GodStamp public string God marker (when did God create this object)
$Shelter public string Shelter file name
$__LS_Consciousness public LSConsciousness Consciousness object : icon, description, tooltip, ...
$cargo public mixed Cargo container #1 (use it freely)
$fPerf public float Performance counter (float): microseconds
$fPerfThreshold public float Performance threshold before alert
$id public string Object ID
$oApp public LSApplication Application object
$oTracer public LSTracer Tracer object
$szNow public string YYYYMMDDHHmmSS string
$szToday public string YYYYMMDD string
Methods
  1. __construct(): Class constructor
  2. DetectBrowser(): Detects the main name of the browser via user agent parsing
  3. DieGracefully(): Dies gracefully with an optional message
  4. MayCache(): Determines whether caching is permitted or not
  5. Start(): Starts performance testing and writes signature in log file
  6. Stop(): Stops performance testing and writes signature in log file. Performance counter is updated.
  7. ThrowUp(): Returns a parsable string representation of the object
__construct(): Class constructor

[ back to method list ]

Syntax

__construct( $szFile )

Parameters
NameTypeDescription
$szFile string Shelter file (serialize() and unserialize(). Optional. Rarely used.
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 ... *}).

DetectBrowser(): Detects the main name of the browser via user agent parsing

[ back to method list ]

Deprecated

Version: 5.5.0000

Syntax

DetectBrowser()

Parameters

None

Return

(string) Returns the main name of the browser

Example Executed
$oMN = new LSMotherNature();
echo $oMN->DetectBrowser();

OPERA 9
Assertions

true === true successful

Unit Testing

1 assertions: 1 successful; 0 failed

DieGracefully(): Dies gracefully with an optional message

[ back to method list ]

Syntax

DieGracefully( $szText )

Parameters
NameTypeDescription
$szText string Optional message.
Return

(void)

Assertions

true === true successful

Unit Testing

1 assertions: 1 successful; 0 failed

MayCache(): Determines whether caching is permitted or not

[ back to method list ]

Syntax

MayCache()

Parameters

None

Return

(bool) true if caching is permitted in the application; false if not.

Unit Testing

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

Start(): Starts performance testing and writes signature in log file

[ back to method list ]

Syntax

Start( $szMethod,$iLine,$iLevel,$szMsg )

Parameters
NameTypeDescription
$szMethod string Method that initiated the call
$iLine int Line at which the call has been placed
$iLevel int Tracing level. Optional. Default = TRACING_INFO_LEVEL
$szMsg string Message to be written to the log file. Optional. Default = null
Parameters Warning

Start() uses 4 parameters whereas the suggested limit is 3.

Return

(float) Microtime

Unit Testing

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

Stop(): Stops performance testing and writes signature in log file. Performance counter is updated.

[ back to method list ]

Syntax

Stop( $szMethod,$iLine,$iStart,$iLevel,$szMsg )

Parameters
NameTypeDescription
$szMethod string Method that initiated the call
$iLine int Line at which the call has been placed
$iStart int Start at which the call to Start() has been placed
$iLevel int Tracing level. Optional. Default = TRACING_INFO_LEVEL
$szMsg string Message to be written to the log file. Optional. Default = null
Parameters Warning

Stop() uses 5 parameters whereas the suggested limit is 3.

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 ... *}).

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

[ back to method list ]

Syntax

ThrowUp()

Parameters

None

Return

(string) String representation of the object

Example Executed
$oMN = new LSMotherNature();
echo ( $szObject = $oMN->ThrowUp() );
echo LSUnitTesting::assert( preg_match('/\{.+?-.+?-.+?-.+?-.+?\}/s', $szObject ),
                            'ASSERTION SUCCESSFUL: object has a God Stamp'      ,
                            'ASSERTION SUCCESSFUL: no God Stamp found'          ,
                            'GuideAssert' );

LSMotherNature::__set_state(array(
   'Shelter' => NULL,
   'cargo' => NULL,
   'Cargo' => NULL,
   'GodStamp' => '{8EC25ABB-38EE-4E72-ADB9-E773AB3AF764}',
   'oApp' => NULL,
   'oTracer' => 
  LSTracer::__set_state(array(
     'aTraces' => 
    array (
    ),
     'TracingLevel' => 256,
     'TracingOutput' => '',
     'TracingFilter' => '',
     'szType' => 'traces',
  )),
   'fPerf' => -1,
   'fPerfThreshold' => INF,
   'id' => NULL,
   'szNow' => '20131016135415',
   'szToday' => '20131016',
   '__LS_Consciousness' => 
  LSConsciousness::__set_state(array(
     'szIcon' => NULL,
     'szDesc' => NULL,
     'szTooltip' => NULL,
  )),
))

GuideAssert() ... ASSERTION SUCCESSFUL: object has a God Stamp

Unit Testing

1 assertions: 1 successful; 0 failed

Précédent Suivant