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)

LSSiteManager.class.php

Generated by The Vae Soli! Documentor: Guide v. 1.3.0015 on 14-10-2013 13:08:46 (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/LSSiteManager.class.phpC:\websites\vaesoli.org\www\httpdocs\vaesoli\include\LSSiteManager.class.phpapplication/force-downloadC:\websites\vaesoli.org\www\httpdocs\vaesoli\include193394 bytes03/08/2013 23:27:5306/10/2013 18:40:3706/10/2013 18:40:37

Compliance

Assertions count: 0

Assertions successful: 0

Assertion failures: 0

Early Warning

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

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

Manifest Constants

LS_SITE_MANAGER_CLASS_PWH: Define "LS" Site Manager (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

LSV.defines.inc: Vae Soli! Foundation constants

LSVfc.class.php: Vae Soli! Foundation classes

Classes

LSSiteManager extends LSMotherNatureCreates and renders a Site Manager for a site constructed with Vae Soli!

Properties
NameVisibilityTypeDescription
$aGeoramaFiles public array An array of files which are included via <xi:include />
$aGeoramaVars public array An array of variables defined in the georama
$aIcons public array An array of icons
$aPages public array An array of LSSitepage objects
$aSections public array An array of sections to show
$iUploadMaxSize public int The maximum file zize for a file upload
$oApp public LSApplication Application object
$oDom public LSDomNode DOM object
$oGeorama public LSGeorama The georama object
$oPage public LSPage Page object
$oXPath public LSXPath XPath object
$szAjaxCall public string Ajax script to call
$szAjaxCallback public string Name of the javascript callback function (readystatechange)
$szBGColorOnDragDrop public string BG spec for drag & drop operations
$szCSSClass public string Name of the CSS Class that applies to all Site Manager items
$szGUID public string Site Manager ID
$szHaltConstruction public string URL for Under construction
$szHaltMaintenance public string URL for maintenance window
$szHaltRedirect public string URL for Site redirected
$szHaltStopped public string URL for Site Stopped
$szHaltType public string Halt type
$szSubmit public string Submit action
$szSubmitImg public string Optional submit button image
$szUploadPermittedTypes public string A set of MIME types for acceptable uploads (null by default = no type check)
$szVaesoliPath public string Path to Vae Soli! to consider
$szXMLReq public string Name of the XML HTTP Request object
Parent Properties (LSMotherNature)
NameType
Cargo NULL
GodStamp string
Shelter NULL
__LS_Consciousness NULL
cargo NULL
fPerf double
fPerfThreshold double
id NULL
oApp NULL
oTracer NULL
szNow NULL
szToday NULL
Methods
  1. __construct(): Class constructor
  2. CreateHelp(): Creates the help of a given section
  3. CreateReturnTOC(): Creates the return to TOC button
  4. CreateSection(): Creates the help of a given section
  5. MemSize(): Turns a memory size into a number of bytes (typically the size comes from the PHP.INI file
__construct(): Class constructor

[ back to method list ]

Syntax

__construct( $oPage,$xGeorama,$aIcons,$aSections,$szBGColorOnDragDrop,$szAjaxCall,$szSubmit,$szSubmitImg,$szCSSClass,$szVaesoliPath )

Parameters
NameTypeDescription
$oPage LSPage The page the site manager must be inserted in
$xGeorama mixed The georama of the site
$aIcons array An array of icons needed by the site manager
$aSections array An array of sections that must be rendered
$szBGColorOnDragDrop string The background color that must be applied on drag and drop operations
$szAjaxCall string The URL used to invoke Ajax calls
$szSubmit string Submit button
$szSubmitImg string Submit image
$szCSSClass string The CSS class that must be applied on the Site Manager
$szVaesoliPath string The path to Vae Soli!
Parameters Warning

__construct() uses 10 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 ... *}).

CreateHelp(): Creates the help of a given section

[ back to method list ]

Syntax

CreateHelp( $szSection )

Parameters
NameTypeDescription
$szSection string Section whose help is required
Return

(string) Section help (HTML code)

Unit Testing

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

CreateReturnTOC(): Creates the return to TOC button

[ back to method list ]

Syntax

CreateReturnTOC()

Parameters

None

Return

(string) Return to TOC (HTML code)

Unit Testing

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

CreateSection(): Creates the help of a given section

[ back to method list ]

Syntax

CreateSection( $szSectionName,$szTOCTitle,$szTitle,$szTOC )

Parameters
NameTypeDescription
$szSectionName string Name of the section that must be created
$szTOCTitle string Title of the TOC section
$szTitle string Title of the section
$szTOC string Title Title of the TOC section $szTitle Title of the section $szTOC TOC code (by reference)
Parameters Warning

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

Return

(string) Section code (HTML code)

Unit Testing

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

MemSize(): Turns a memory size into a number of bytes (typically the size comes from the PHP.INI file

[ back to method list ]

Syntax

MemSize( $szSize )

Parameters
NameTypeDescription
$szSize string Memory size (e.g. "8M" or "128KB")
Return

(int) Memory size in bytes

Example(s)
$iUploadMaxFilesize = this->MemSize( ini_get( "upload_max_filesize" ) );
$iPostMaxSize       = this->MemSize( ini_get( "post_max_size"       ) );
$iMemoryLimit       = this->MemSize( ini_get( "memory_limit"        ) );
Unit Testing

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

LSSitePageA page of a Vae Soli! site

LSSiteMgrDetailSite Manager detail

LSSiteGeoVarGeorama variable

Précédent Suivant