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)

LSFunction.class.php

Generated by The Vae Soli! Documentor: Guide v. 1.3.0015 on 14-10-2013 13:08:03 (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/LSFunction.class.phpC:\websites\vaesoli.org\www\httpdocs\vaesoli\include\LSFunction.class.phpapplication/force-downloadC:\websites\vaesoli.org\www\httpdocs\vaesoli\include29817 bytes02/10/2013 06:07:0614/10/2013 12:22:4914/10/2013 12:22:49

Compliance

Assertions count: 2

Assertions successful: 2

Assertion failures: 0

Manifest Constants

LS_FUNCTION_CLASS_PWH: Define "LS" function/method 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

LSUnitTesting.class.php: Vae Soli! Unit Testing

Classes

LSFunctionClass that defines a function or a method. Source code analysis.

Properties
NameVisibilityTypeDescription
$IsObsolete public bool Is obsolete?
$MustIgnore public bool Must this function remain ignored?
$aAliases public array Array of aliases
$aAssertions public array Array of assertions
$aExecAssertions public array Array of assertions found in 'exec' constructs
$aExecs public array Array of code that must be executed
$aFileUses public array Array of files needed by this function (if any)
$aModules public array Array of potential modules
$aNotes public array Array of notes attached to the function/method (if any)
$aParams public array Array of parameters
$aSeeAlsos public array Array of See Also
$aTODOs public array Array of TODOs
$aUses public array Array of uses (list of functions used by this one - if any)
$oContext public object Context of the function/method (if any)
$oReturn public LSReturn Return object
$oSource public LSSource Source this function/method belongs to
$szAbstract public string Abstract of the method/function
$szAuthor public string Author of the function/method
$szCDate public string Creation date of the function (if any)
$szCaution public string Caution that is inherent to the method/function
$szCredits public string Credits of the function/method
$szDeprecatedSince public string Deprecated since a specific date
$szDeprecatedVersion public string Deprecated since a specific version
$szDesc public string Description of the method/function
$szDocs public string Documents to be included in Guide
$szExamples public string Set of examples for this function/method
$szIntent public string Intent followed in the method/function (clarification of decisions)
$szInternalNote public string Internal note related to THIS function
$szMDate public string Modification date of the function (if any)
$szName public string Name of the function
$szRemark public string Remark that is inherent to the method/function
$szVersion public string Version of Vae Soli! this function first appeared
$szVisibility public string Visibility of the function/method
$szWarning public string Warning that is inherent to the method/function
Methods
  1. __toString(): Allows to decide how it will react when it is treated like a string
  2. GetID(): Generates a unique ID for the function/method. ID is deterministic
  3. ThrowUp(): Returns a parsable string representation of the function
__toString(): Allows to decide how it will react when it is treated like a string

[ back to method list ]

Syntax

__toString()

Parameters

None

Return

(string) String representation of the function

Example Executed
$oFunc = new LSFunction();
$oFunc->szName = 'ChangeParams';
echo $oFunc;

LSFunction::__set_state(array(
   'szName' => 'ChangeParams',
   'aParams' => 
  array (
  ),
   'aAliases' => 
  array (
  ),
   'aAssertions' => 
  array (
  ),
   'aExecAssertions' => 
  array (
  ),
   'aTODOs' => 
  array (
  ),
   'aSeeAlsos' => NULL,
   'szDesc' => NULL,
   'szAbstract' => NULL,
   'szIntent' => NULL,
   'szRemark' => NULL,
   'szWarning' => NULL,
   'szCaution' => NULL,
   'szExamples' => NULL,
   'aExecs' => 
  array (
  ),
   'oReturn' => NULL,
   'szDocs' => NULL,
   'szCredits' => NULL,
   'szAuthor' => NULL,
   'szVersion' => NULL,
   'szCDate' => NULL,
   'szMDate' => NULL,
   'szDeprecatedSince' => NULL,
   'szDeprecatedVersion' => NULL,
   'MustIgnore' => false,
   'szInternalNote' => NULL,
   'aUses' => 
  array (
  ),
   'aFileUses' => 
  array (
  ),
   'aModules' => 
  array (
  ),
   'IsObsolete' => false,
   'szObsoleteDate' => NULL,
   'szVisibility' => 'public',
   'aNotes' => 
  array (
  ),
   'oContext' => NULL,
   'oSource' => NULL,
))
Unit Testing

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

GetID(): Generates a unique ID for the function/method. ID is deterministic

[ back to method list ]

Syntax

GetID()

Parameters

None

Return

(string) ID generated

Example Executed
$oFunc = new LSFunction();
$oFunc->szName = 'ChangeParams';
echo '<p>ID: ',$oFunc->GetID(),'</p>';
echo LSUnitTesting::assert( $oFunc->GetID() == 'LS-129fdae783aefe88e6934c26b8d098a4' );

ID: LS-129fdae783aefe88e6934c26b8d098a4

SUCCESS
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 function

[ back to method list ]

Syntax

ThrowUp()

Parameters

None

Return

(string) String representation of the function

Example Executed
$oFunc = new LSFunction();
$oFunc->szName = 'ChangeParams';
echo "<pre>\n",( $x = $oFunc->ThrowUp() ),"\n</pre>";
echo LSUnitTesting::assert( is_string( $x )                             ,
                            'ASSERTION SUCCESS: return is a string'     ,
                            'ASSERTION FAILURE: return is NOT a string' ,
                            'GuideAssert' );
echo LSUnitTesting::assert( strstr( $x,'szCredits' )                ,
                            'ASSERTION SUCCESS: credits found'      ,
                            'ASSERTION FAILURE: credits NOT found'  ,
                            'GuideAssert' );

LSFunction::__set_state(array(
   'szName' => 'ChangeParams',
   'aParams' => 
  array (
  ),
   'aAliases' => 
  array (
  ),
   'aAssertions' => 
  array (
  ),
   'aExecAssertions' => 
  array (
  ),
   'aTODOs' => 
  array (
  ),
   'aSeeAlsos' => NULL,
   'szDesc' => NULL,
   'szAbstract' => NULL,
   'szIntent' => NULL,
   'szRemark' => NULL,
   'szWarning' => NULL,
   'szCaution' => NULL,
   'szExamples' => NULL,
   'aExecs' => 
  array (
  ),
   'oReturn' => NULL,
   'szDocs' => NULL,
   'szCredits' => NULL,
   'szAuthor' => NULL,
   'szVersion' => NULL,
   'szCDate' => NULL,
   'szMDate' => NULL,
   'szDeprecatedSince' => NULL,
   'szDeprecatedVersion' => NULL,
   'MustIgnore' => false,
   'szInternalNote' => NULL,
   'aUses' => 
  array (
  ),
   'aFileUses' => 
  array (
  ),
   'aModules' => 
  array (
  ),
   'IsObsolete' => false,
   'szObsoleteDate' => NULL,
   'szVisibility' => 'public',
   'aNotes' => 
  array (
  ),
   'oContext' => NULL,
   'oSource' => NULL,
))

GuideAssert() ... ASSERTION SUCCESS: return is a string

GuideAssert() ... ASSERTION SUCCESS: credits found

Unit Testing

2 assertions: 2 successful; 0 failed

Précédent Suivant