Niouzes

< Janvier 2022 >
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)

LSTracer.class.php

Generated by The Vae Soli! Documentor: Guide v. 1.3.0018 on 09-03-2015 09:36:39 (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/LSTracer.class.phpC:\websites\vaesoli.org\www\httpdocs\vaesoli\include\LSTracer.class.phpapplication/force-downloadC:\websites\vaesoli.org\www\httpdocs\vaesoli\include21638 bytes03/08/2013 23:27:5324/01/2015 08:12:3024/01/2015 08:12:30

Compliance

Assertions count: 0

Assertions successful: 0

Assertion failures: 0

Manifest Constants

LS_TRACER_CLASS_PWH: Define "LS" tracer 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

LSApplication.errors.inc: Vae Soli! Foundation error codes

LSV.functions.php: Vae Soli! Foundation functions

LSTracingLevels.inc: Vae Soli! Tracing levels

Classes

LSTracerTracing/Logging services

Properties
NameVisibilityTypeDescription
$TracingFilter public string Filter to be applied on the traces that are produced
$TracingLevel public int Tracing level required
$TracingOutput public string The output of the traces ('stdout','none','',File)
$aTraces public array An array of traces that must be dumb in a trace/log file
$szType public string Log type (traces, analytics, ...)
Methods
  1. __construct(): Class constructor No assertion found for __construct() (0 - 0)
  2. Clean(): Eliminates (deletes) the tracing file physically No assertion found for Clean() (0 - 0)
  3. Clear(): Eliminates all traces stored in the tracing file (sets the physical file to 0 bytes). No assertion found for Clear() (0 - 0)
  4. Flush(): Flushes the pending traces (if they can be flushed!) No assertion found for Flush() (0 - 0)
  5. Push(): Piles up a trace that must be, later on, committed to the tracing file. Used at a time the physical output is not known yet. No assertion found for Push() (0 - 0)
  6. Separator(): Outputs a separator line to the tracing file No assertion found for Separator() (0 - 0)
  7. Trace(): Writes $szText to the log file if $iLevel matches the tracing level set for the object. No assertion found for Trace() (0 - 0)
  8. Write(): Outputs $szText to the tracing file if $iLevel matches the object tracing level. No assertion found for Write() (0 - 0)
__construct(): Class constructor

[ back to method list ]

Syntax

__construct( $iLevel,$szOutput,$szFilter )

Parameters
NameTypeDescription
$iLevel int Required Tracing level
$szOutput string Trace file (physical file)
$szFilter string Filter that is applied when traces are produced
Return

(void)

Example(s)
$oTracer = new LSTracer();
$oTracer->TracingOutput = 'C:/mylogs/traces.log';
$oTracer->TracingLevel  = 16;

...
$oTracer->Trace( "Hello World",0 );
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(...); *}).

Clean(): Eliminates (deletes) the tracing file physically

[ back to method list ]

Author

Caution

Use with extra caution: the physical tracing file is deleted! This method should NOT be confused with the Clear() method.

Syntax

Clean()

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

See Also

Clear()

Clear(): Eliminates all traces stored in the tracing file (sets the physical file to 0 bytes).

[ back to method list ]

Author

Remark

Do not confuse this method with the Clean() method

Syntax

Clear()

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

See Also

Clean()

Flush(): Flushes the pending traces (if they can be flushed!)

[ back to method list ]

Author

Remark

If the tracing output is undefined, the message is piled in an internal structure; each call to Trace() checks the internal structure for pending messages. When not committed traces are still on the pile, the Flush() method can write them physically to the tracing output file (if specified)

Syntax

Flush()

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

Push(): Piles up a trace that must be, later on, committed to the tracing file. Used at a time the physical output is not known yet.

[ back to method list ]

Author

Syntax

Push( $szText,$iLevel,$WithDates )

Parameters
NameTypeDescription
$szText string The text to output to the tracing file
$iLevel int The level required to write $szText to the tracing file. Optional. TRACING_INFO_LEVEL by default.
$WithDates bool Should the trace output be preceded with dates (date time) in the output tracing file. Optional. true by default.
Return

(int) Number of pending traces (this one included)

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

See Also

Trace(), Flush()

Separator(): Outputs a separator line to the tracing file

[ back to method list ]

Author

Remark

Useful to separate phases in a log file

Syntax

Separator()

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

Trace(): Writes $szText to the log file if $iLevel matches the tracing level set for the object.

[ back to method list ]

Author

Remark

If the tracing output is undefined, the message is piled in an internal structure; each call to Trace() checks the internal structure for pending messages.

Syntax

Trace( $szText,$iLevel )

Parameters
NameTypeDescription
$szText string The text to be written to the log file
$iLevel int The desired tracing level
TRACING_NONE_LEVEL ... 0
TRACING_ERROR_LEVEL ... 16
TRACING_QUESTION_LEVEL ... 32
TRACING_INFO_LEVEL ... 64 (default)
Return

(void)

Example(s)
$oTracer = new LSTracer();
$oTracer->TracingOutput = 'C:/mylogs/traces.log';
$oTracer->TracingLevel  = 16;

...
$oTracer->Trace( "Hello World",0 );
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(...); *}).

Write(): Outputs $szText to the tracing file if $iLevel matches the object tracing level.

[ back to method list ]

Author

Remark

Use either Push() or Trace() preferably to this method.

Syntax

Write( $szText,$iLevel,$WithDates )

Parameters
NameTypeDescription
$szText string The text to output to the tracing file
$iLevel int The level required to write $szText to the tracing file
$WithDates bool Should the trace output be preceded with dates (date time) in the output tracing file. Optional. true by default.
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