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)

LSForm.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/LSForm.class.phpC:\websites\vaesoli.org\www\httpdocs\vaesoli\include\LSForm.class.phpapplication/force-downloadC:\websites\vaesoli.org\www\httpdocs\vaesoli\include105553 bytes03/08/2013 23:27:5204/06/2014 05:39:5204/06/2014 05:39:52

Compliance

Assertions count: 0

Assertions successful: 0

Assertion failures: 0

Early Warning

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

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

Manifest Constants

LS_FORM_CLASS_PWH: Define "LS" forms (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

LSLabel.class.php: <label> class

LSInput.class.php: <input> class

LSDataEnvironment.class.php: Data environment class

LSFieldset.class.php: Data environment class

Classes

LSForm extends LSContainerGeneric services to create HTML forms

Notes
Note: Genome

A special note about the genome:

The genome of a form makes it possible to activate and annihilate constituents of the form (say input zones, labels, divisions, and the likes). If the constituents do not have the proper genes, they are annihilated (not expressed).

For as smart as it sounds, the implementation of the genome in a form is actually technically straightforward. Genes are coded as cells in an array. Genome is a string. If a gene (a value stored in the array) is found in the genome (the string), the component is rendered. Period! Quite simple as a matter of fact!

Despite this inner simplicity, the genome can achieve great results such as having a form being expressed for PHONES or for TABLETS. A simple variation of the genome (a string) dictates how the form must be rendered. The variation itself can either be introduced manually or programmatically which brings enormous additional value to the mechanism.

Properties
NameVisibilityTypeDescription
$HasFile public boolean Indicates whether the form is supposed to handle files (can be set manually; otherwise, it is treated automatically by examining all controls)
$NoECMA public bool Indicates whether we need to have the ECMA scripts be generated.false by default (= ECMA scripts generated)
$NoValidate public bool Novalidate attribute of the form (HTML5)
$PostRenderFnc public string Callback to play after rendering of the form
$PreRenderFnc public string Callback to play before rendering of the form
$WithPreviousValues public bool Indicates if previous control values must be saved in the form
$WithTabIndex public bool Determines whether tabindex must be used or not. true by default
$aECMA public array Internal array of scripts to be generated by Vae Soli! for entry checks and form validation
$aObjects public array Array of objects that are contained within the form
$iTabIndex public int tabindex in the form (use the $iTabIndex property of the current page (LSPage) to hold a precise count between forms)
$oDataEnvironment public LSDataEnvironment A LSDataEnvironment object. Warning: not really used at this stage (04-09-13 07:46)
$oPage public LSPage The page in which this form must be rendered. null by default
$szAction public string Action fo the form (usually a URL or self to submit the form to the current script)
$szAfterword public string Text that must follow the rendering of the form
$szAutocomplete public string Enumerated type (on, off). The off state indicates that by default, form controls in the form will have their resulting autocompletion state set to off; the on state indicates that by default, form controls in the form will have their resulting autocompletion state set to automatic.
$szForeword public string Text that must precede the rendering of the form
$szMethod public string HTTP method to be invoked when the form is to be submitted
$szMode public string Mode the form is entered. Can be 'edit' (modification of an existing record) or 'add' (add a new record). 'add' by default
$szTarget public string Enumerated type (_blank, _self, _parent, _top). Specifies where to display the response that is received after submitting the form
$szType public string Container type. 'form' by default
$szVersion public string Form version. 'Web form 1.0' by default. Set to 'Web form 2.0' to benefit from HTML5 controls
Parent Properties (LSContainer)
NameType
Databag boolean
IsHTML5 boolean
IsMandatory boolean
IsReadonly boolean
IsVisible boolean
WithDataBag boolean
aGenes NULL
aHTML5Match array
iHeight NULL
iIndentLevel integer
iIndentSpaces integer
iInstance integer
iInstances integer
iLeft NULL
iLevel integer
iMaxLength NULL
iSize NULL
iTop NULL
iWidth NULL
oContainer NULL
szBrowser string
szClass NULL
szComment NULL
szDataBag string
szDesc NULL
szErrorMsg string
szGUID NULL
szGenome NULL
szID NULL
szInnerLeader NULL
szInnerTrailer NULL
szLang string
szLeader NULL
szName NULL
szOnBlur NULL
szOnChange NULL
szOnClick NULL
szOnFocus NULL
szOnKeyDown NULL
szOnKeyPress NULL
szOnKeyUp NULL
szOnLoad NULL
szOnMouseOver NULL
szOnSelect NULL
szOnSubmit NULL
szOnUnLoad NULL
szPixels string
szPlatform string
szStyle NULL
szText NULL
szTitle NULL
szTooltip NULL
szTrailer NULL
szType NULL
szValue NULL
Methods
  1. __construct(): Class constructor. No assertion found for __construct() (0 - 0)
  2. __get(): Magic method. Called when trying to access a property which seems to be not accessible No assertion found for __get() (0 - 0)
  3. AddObject(): Adds an object to the container No assertion found for AddObject() (0 - 0)
  4. BuildAutocomplete(): Builds the autocomplete attribute of a form No assertion found for BuildAutocomplete() (0 - 0)
  5. BuildNoValidate(): Builds the 'novalidate' attribute of a form No assertion found for BuildNoValidate() (0 - 0)
  6. BuildTarget(): Builds the target attribute of a form No assertion found for BuildTarget() (0 - 0)
  7. GenerateECMA(): Generates the ECMAScript of the form No assertion found for GenerateECMA() (0 - 0)
  8. Render(): Generates the HTML code of the form No assertion found for Render() (0 - 0)
  9. RenderECMA(): Generates all the ECMA scripts that are needed by the form. If the same validation code is needed by several LSInput controls, the code is rendered only once. No assertion found for RenderECMA() (0 - 0)
__construct(): Class constructor.

[ back to method list ]

Syntax

__construct( $szID,$szAction,$szClass,$szMethod,$szVersion )

Parameters
NameTypeDescription
$szID string ID of the form. Optional.
$szAction string Action of the form. Optional.
$szClass string CSS Class of the form. Optional.
$szMethod string Post or Get. Optional
$szVersion string Version of the form. Optional. $oPage (LSPage) The page in which this form must be rendered. Optional.
Parameters Warning

__construct() 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 LSUnitTesting::assert(...); *}).

__get(): Magic method. Called when trying to access a property which seems to be not accessible

[ back to method list ]

Syntax

__get()

Parameters

None

Return

(mixed) property we look for (can also be an object). null is returned when $szName does not correspond to any known control of the current form

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

FindControlByName(), FindControlById()

AddObject(): Adds an object to the container

[ back to method list ]

Syntax

AddObject( $oObj )

Parameters
NameTypeDescription
$oObj mixed Can be a LSInput, LSLabel, LSFieldset, LSTag (supported LSTag types :'p','div', 'datalist' or 'hr') or LSCursor object. In the case of a LSCursor object, it is actually added to the $oDataEnvironment member of the form (LSDataEnvironment)
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(...); *}).

PROTECTED BuildAutocomplete(): Builds the autocomplete attribute of a form

[ back to method list ]

Syntax

BuildAutocomplete()

Parameters

None

Return

(string) The autocomplete attribute of the form

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

PROTECTED BuildNoValidate(): Builds the 'novalidate' attribute of a form

[ back to method list ]

Syntax

BuildNoValidate()

Parameters

None

Return

(string) The novalidate attribute of the form

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

PROTECTED BuildTarget(): Builds the target attribute of a form

[ back to method list ]

Syntax

BuildTarget()

Parameters

None

Return

(string) The target attribute of the form

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

PROTECTED GenerateECMA(): Generates the ECMAScript of the form

[ back to method list ]

Syntax

GenerateECMA( $aFuncs,$szType )

Parameters
NameTypeDescription
$aFuncs array An array of function signatures. Updated upon return. By reference.
$szType string Type of ECMAScript to generate: ltrim, rtrim or trim.
Return

(string) The ECMA script or empty ('') if $szType is not supported.

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

Render(): Generates the HTML code of the form

[ back to method list ]

Modified: 05/09/2013 Genome taken into account

Syntax

Render( $oContainer )

Parameters
NameTypeDescription
$oContainer LSControl The container of the current control. Optional. null by default
Return

(void) No return is provided

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

RenderECMA(): Generates all the ECMA scripts that are needed by the form. If the same validation code is needed by several LSInput controls, the code is rendered only once.

[ back to method list ]

Syntax

RenderECMA()

Parameters

None

Return

(string) The ECMA script code that has been generated (javascript)

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